rustici_software_cloud_v2 3.0.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -5
- data/lib/rustici_software_cloud_v2/api/about_api.rb +1 -1
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +19 -19
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +2 -2
- data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +4 -4
- data/lib/rustici_software_cloud_v2/api/course_api.rb +46 -37
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +59 -47
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +28 -22
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +6 -6
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +1 -1
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +27 -27
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +3 -3
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +10 -10
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/{zoomi_company_id.rb → destination_info_id_schema.rb} +19 -9
- data/lib/rustici_software_cloud_v2/models/{zoomi_course_options_schema.rb → destination_info_list_schema.rb} +19 -25
- data/lib/rustici_software_cloud_v2/models/destination_info_schema.rb +263 -0
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +5 -15
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +2 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +12 -2
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/{credential_created_schema.rb → invitation_email_update_schema.rb} +17 -46
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +16 -5
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/paginated_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/preview_launch_link_request_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +26 -6
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +3 -3
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +15 -16
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +4 -6
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -1
- data/lib/rustici_software_cloud_v2.rb +5 -4
- data/rustici_software_cloud_v2.gemspec +9 -13
- data/spec/api_client_spec.rb +1 -1
- metadata +33 -121
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +0 -538
|
@@ -35,7 +35,7 @@ module RusticiSoftwareCloudV2
|
|
|
35
35
|
# 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.
|
|
36
36
|
# @param destinations_list
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
|
-
# @return [Array<(nil,
|
|
38
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
39
39
|
def create_destinations_with_http_info(destinations_list, opts = {})
|
|
40
40
|
if @api_client.config.debugging
|
|
41
41
|
@api_client.config.logger.debug 'Calling API: DispatchApi.create_destinations ...'
|
|
@@ -89,7 +89,7 @@ module RusticiSoftwareCloudV2
|
|
|
89
89
|
# 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.
|
|
90
90
|
# @param dispatch_list
|
|
91
91
|
# @param [Hash] opts the optional parameters
|
|
92
|
-
# @return [Array<(nil,
|
|
92
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
93
93
|
def create_dispatches_with_http_info(dispatch_list, opts = {})
|
|
94
94
|
if @api_client.config.debugging
|
|
95
95
|
@api_client.config.logger.debug 'Calling API: DispatchApi.create_dispatches ...'
|
|
@@ -143,7 +143,7 @@ module RusticiSoftwareCloudV2
|
|
|
143
143
|
# Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
|
|
144
144
|
# @param destination_id Identifier for the destination
|
|
145
145
|
# @param [Hash] opts the optional parameters
|
|
146
|
-
# @return [Array<(nil,
|
|
146
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
147
147
|
def delete_destination_with_http_info(destination_id, opts = {})
|
|
148
148
|
if @api_client.config.debugging
|
|
149
149
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination ...'
|
|
@@ -197,7 +197,7 @@ module RusticiSoftwareCloudV2
|
|
|
197
197
|
# Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
|
198
198
|
# @param destination_id Identifier for the destination
|
|
199
199
|
# @param [Hash] opts the optional parameters
|
|
200
|
-
# @return [Array<(nil,
|
|
200
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
201
201
|
def delete_destination_dispatches_with_http_info(destination_id, opts = {})
|
|
202
202
|
if @api_client.config.debugging
|
|
203
203
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_dispatches ...'
|
|
@@ -253,7 +253,7 @@ module RusticiSoftwareCloudV2
|
|
|
253
253
|
# @param destination_id Identifier for the destination
|
|
254
254
|
# @param tags
|
|
255
255
|
# @param [Hash] opts the optional parameters
|
|
256
|
-
# @return [Array<(nil,
|
|
256
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
257
257
|
def delete_destination_tags_with_http_info(destination_id, tags, opts = {})
|
|
258
258
|
if @api_client.config.debugging
|
|
259
259
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_tags ...'
|
|
@@ -311,7 +311,7 @@ module RusticiSoftwareCloudV2
|
|
|
311
311
|
# Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
|
312
312
|
# @param dispatch_id Identifier for the dispatch
|
|
313
313
|
# @param [Hash] opts the optional parameters
|
|
314
|
-
# @return [Array<(nil,
|
|
314
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
315
315
|
def delete_dispatch_with_http_info(dispatch_id, opts = {})
|
|
316
316
|
if @api_client.config.debugging
|
|
317
317
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch ...'
|
|
@@ -365,7 +365,7 @@ module RusticiSoftwareCloudV2
|
|
|
365
365
|
# 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.
|
|
366
366
|
# @param dispatch_id Identifier for the dispatch
|
|
367
367
|
# @param [Hash] opts the optional parameters
|
|
368
|
-
# @return [Array<(nil,
|
|
368
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
369
369
|
def delete_dispatch_postback_info_with_http_info(dispatch_id, opts = {})
|
|
370
370
|
if @api_client.config.debugging
|
|
371
371
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_postback_info ...'
|
|
@@ -421,7 +421,7 @@ module RusticiSoftwareCloudV2
|
|
|
421
421
|
# @param dispatch_id Identifier for the dispatch
|
|
422
422
|
# @param tags
|
|
423
423
|
# @param [Hash] opts the optional parameters
|
|
424
|
-
# @return [Array<(nil,
|
|
424
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
425
425
|
def delete_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
|
|
426
426
|
if @api_client.config.debugging
|
|
427
427
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_tags ...'
|
|
@@ -491,7 +491,7 @@ module RusticiSoftwareCloudV2
|
|
|
491
491
|
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
|
492
492
|
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
|
493
493
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
|
494
|
-
# @return [Array<(nil,
|
|
494
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
495
495
|
def delete_dispatches_with_http_info(opts = {})
|
|
496
496
|
if @api_client.config.debugging
|
|
497
497
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatches ...'
|
|
@@ -550,7 +550,7 @@ module RusticiSoftwareCloudV2
|
|
|
550
550
|
# @param destination_id Identifier for the destination
|
|
551
551
|
# @param enabled
|
|
552
552
|
# @param [Hash] opts the optional parameters
|
|
553
|
-
# @return [Array<(nil,
|
|
553
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
554
554
|
def enable_registration_instancing_with_http_info(destination_id, enabled, opts = {})
|
|
555
555
|
if @api_client.config.debugging
|
|
556
556
|
@api_client.config.logger.debug 'Calling API: DispatchApi.enable_registration_instancing ...'
|
|
@@ -598,7 +598,8 @@ module RusticiSoftwareCloudV2
|
|
|
598
598
|
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
|
599
599
|
# @param destination_id Identifier for the destination
|
|
600
600
|
# @param [Hash] opts the optional parameters
|
|
601
|
-
# @
|
|
601
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for the destination. (default to false)
|
|
602
|
+
# @return [DestinationInfoSchema]
|
|
602
603
|
def get_destination(destination_id, opts = {})
|
|
603
604
|
data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
|
|
604
605
|
data
|
|
@@ -608,7 +609,8 @@ module RusticiSoftwareCloudV2
|
|
|
608
609
|
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
|
609
610
|
# @param destination_id Identifier for the destination
|
|
610
611
|
# @param [Hash] opts the optional parameters
|
|
611
|
-
# @
|
|
612
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for the destination.
|
|
613
|
+
# @return [Array<(DestinationInfoSchema, Integer, Hash)>] DestinationInfoSchema data, response status code and response headers
|
|
612
614
|
def get_destination_with_http_info(destination_id, opts = {})
|
|
613
615
|
if @api_client.config.debugging
|
|
614
616
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination ...'
|
|
@@ -622,6 +624,7 @@ module RusticiSoftwareCloudV2
|
|
|
622
624
|
|
|
623
625
|
# query parameters
|
|
624
626
|
query_params = {}
|
|
627
|
+
query_params[:'includeDispatchCount'] = opts[:'include_dispatch_count'] if !opts[:'include_dispatch_count'].nil?
|
|
625
628
|
|
|
626
629
|
# header parameters
|
|
627
630
|
header_params = {}
|
|
@@ -642,7 +645,7 @@ module RusticiSoftwareCloudV2
|
|
|
642
645
|
:form_params => form_params,
|
|
643
646
|
:body => post_body,
|
|
644
647
|
:auth_names => auth_names,
|
|
645
|
-
:return_type => '
|
|
648
|
+
:return_type => 'DestinationInfoSchema')
|
|
646
649
|
if @api_client.config.debugging
|
|
647
650
|
@api_client.config.logger.debug "API called: DispatchApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
648
651
|
end
|
|
@@ -663,7 +666,7 @@ module RusticiSoftwareCloudV2
|
|
|
663
666
|
# 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.
|
|
664
667
|
# @param destination_id Identifier for the destination
|
|
665
668
|
# @param [Hash] opts the optional parameters
|
|
666
|
-
# @return [Array<(IntegerResultSchema,
|
|
669
|
+
# @return [Array<(IntegerResultSchema, Integer, Hash)>] IntegerResultSchema data, response status code and response headers
|
|
667
670
|
def get_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
|
|
668
671
|
if @api_client.config.debugging
|
|
669
672
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_registration_count ...'
|
|
@@ -724,7 +727,7 @@ module RusticiSoftwareCloudV2
|
|
|
724
727
|
# @option opts [String] :type The type of dispatch package to export (SCORM_12 only supported in SCORM Cloud today)
|
|
725
728
|
# @option opts [String] :css_url
|
|
726
729
|
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
|
727
|
-
# @return [Array<(File,
|
|
730
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
728
731
|
def get_destination_dispatch_zip_with_http_info(destination_id, opts = {})
|
|
729
732
|
if @api_client.config.debugging
|
|
730
733
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_zip ...'
|
|
@@ -773,6 +776,7 @@ module RusticiSoftwareCloudV2
|
|
|
773
776
|
# @param destination_id Identifier for the destination
|
|
774
777
|
# @param [Hash] opts the optional parameters
|
|
775
778
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
779
|
+
# @option opts [BOOLEAN] :is_enabled Optional boolean parameter used to filter the list of dispatches so that only enabled or disabled dispatches are retrieved.
|
|
776
780
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
777
781
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
778
782
|
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
|
@@ -793,6 +797,7 @@ module RusticiSoftwareCloudV2
|
|
|
793
797
|
# @param destination_id Identifier for the destination
|
|
794
798
|
# @param [Hash] opts the optional parameters
|
|
795
799
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
800
|
+
# @option opts [BOOLEAN] :is_enabled Optional boolean parameter used to filter the list of dispatches so that only enabled or disabled dispatches are retrieved.
|
|
796
801
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
797
802
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
798
803
|
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
|
@@ -802,7 +807,7 @@ module RusticiSoftwareCloudV2
|
|
|
802
807
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
|
803
808
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
804
809
|
# @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.
|
|
805
|
-
# @return [Array<(DispatchListSchema,
|
|
810
|
+
# @return [Array<(DispatchListSchema, Integer, Hash)>] DispatchListSchema data, response status code and response headers
|
|
806
811
|
def get_destination_dispatches_with_http_info(destination_id, opts = {})
|
|
807
812
|
if @api_client.config.debugging
|
|
808
813
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatches ...'
|
|
@@ -817,6 +822,7 @@ module RusticiSoftwareCloudV2
|
|
|
817
822
|
# query parameters
|
|
818
823
|
query_params = {}
|
|
819
824
|
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
825
|
+
query_params[:'isEnabled'] = opts[:'is_enabled'] if !opts[:'is_enabled'].nil?
|
|
820
826
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
821
827
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
822
828
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
@@ -867,7 +873,7 @@ module RusticiSoftwareCloudV2
|
|
|
867
873
|
# 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.
|
|
868
874
|
# @param destination_id Identifier for the destination
|
|
869
875
|
# @param [Hash] opts the optional parameters
|
|
870
|
-
# @return [Array<(EnabledSchema,
|
|
876
|
+
# @return [Array<(EnabledSchema, Integer, Hash)>] EnabledSchema data, response status code and response headers
|
|
871
877
|
def get_destination_hash_user_info_with_http_info(destination_id, opts = {})
|
|
872
878
|
if @api_client.config.debugging
|
|
873
879
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_hash_user_info ...'
|
|
@@ -922,7 +928,7 @@ module RusticiSoftwareCloudV2
|
|
|
922
928
|
# Returns the tags for the destination.
|
|
923
929
|
# @param destination_id Identifier for the destination
|
|
924
930
|
# @param [Hash] opts the optional parameters
|
|
925
|
-
# @return [Array<(TagListSchema,
|
|
931
|
+
# @return [Array<(TagListSchema, Integer, Hash)>] TagListSchema data, response status code and response headers
|
|
926
932
|
def get_destination_tags_with_http_info(destination_id, opts = {})
|
|
927
933
|
if @api_client.config.debugging
|
|
928
934
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_tags ...'
|
|
@@ -964,7 +970,7 @@ module RusticiSoftwareCloudV2
|
|
|
964
970
|
end
|
|
965
971
|
|
|
966
972
|
# Get a list of Destinations
|
|
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.
|
|
973
|
+
# 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. >**Info:** >This endpoint caches the dispatch count of a destination for 24 hours if the `includeDispatchCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of dispatches for a destination will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the dispatch count for a single destination within the caching period, use the GetDestination endpoint with `includeDispatchCount` set to `true`. GetDestination *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that destination.
|
|
968
974
|
# @param [Hash] opts the optional parameters
|
|
969
975
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
970
976
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -975,15 +981,16 @@ module RusticiSoftwareCloudV2
|
|
|
975
981
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to destination_id)
|
|
976
982
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
|
977
983
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
984
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for each destination. (default to false)
|
|
978
985
|
# @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)
|
|
979
|
-
# @return [
|
|
986
|
+
# @return [DestinationInfoListSchema]
|
|
980
987
|
def get_destinations(opts = {})
|
|
981
988
|
data, _status_code, _headers = get_destinations_with_http_info(opts)
|
|
982
989
|
data
|
|
983
990
|
end
|
|
984
991
|
|
|
985
992
|
# Get a list of Destinations
|
|
986
|
-
# 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.
|
|
993
|
+
# 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. >**Info:** >This endpoint caches the dispatch count of a destination for 24 hours if the `includeDispatchCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of dispatches for a destination will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the dispatch count for a single destination within the caching period, use the GetDestination endpoint with `includeDispatchCount` set to `true`. GetDestination *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that destination.
|
|
987
994
|
# @param [Hash] opts the optional parameters
|
|
988
995
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
989
996
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -994,8 +1001,9 @@ module RusticiSoftwareCloudV2
|
|
|
994
1001
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
|
995
1002
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
|
996
1003
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
1004
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for each destination.
|
|
997
1005
|
# @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.
|
|
998
|
-
# @return [Array<(
|
|
1006
|
+
# @return [Array<(DestinationInfoListSchema, Integer, Hash)>] DestinationInfoListSchema data, response status code and response headers
|
|
999
1007
|
def get_destinations_with_http_info(opts = {})
|
|
1000
1008
|
if @api_client.config.debugging
|
|
1001
1009
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destinations ...'
|
|
@@ -1014,6 +1022,7 @@ module RusticiSoftwareCloudV2
|
|
|
1014
1022
|
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
|
1015
1023
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
1016
1024
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
1025
|
+
query_params[:'includeDispatchCount'] = opts[:'include_dispatch_count'] if !opts[:'include_dispatch_count'].nil?
|
|
1017
1026
|
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
|
1018
1027
|
|
|
1019
1028
|
# header parameters
|
|
@@ -1035,7 +1044,7 @@ module RusticiSoftwareCloudV2
|
|
|
1035
1044
|
:form_params => form_params,
|
|
1036
1045
|
:body => post_body,
|
|
1037
1046
|
:auth_names => auth_names,
|
|
1038
|
-
:return_type => '
|
|
1047
|
+
:return_type => 'DestinationInfoListSchema')
|
|
1039
1048
|
if @api_client.config.debugging
|
|
1040
1049
|
@api_client.config.logger.debug "API called: DispatchApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1041
1050
|
end
|
|
@@ -1056,7 +1065,7 @@ module RusticiSoftwareCloudV2
|
|
|
1056
1065
|
# Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
|
|
1057
1066
|
# @param dispatch_id Identifier for the dispatch
|
|
1058
1067
|
# @param [Hash] opts the optional parameters
|
|
1059
|
-
# @return [Array<(DispatchSchema,
|
|
1068
|
+
# @return [Array<(DispatchSchema, Integer, Hash)>] DispatchSchema data, response status code and response headers
|
|
1060
1069
|
def get_dispatch_with_http_info(dispatch_id, opts = {})
|
|
1061
1070
|
if @api_client.config.debugging
|
|
1062
1071
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch ...'
|
|
@@ -1111,7 +1120,7 @@ module RusticiSoftwareCloudV2
|
|
|
1111
1120
|
# 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.
|
|
1112
1121
|
# @param dispatch_id Identifier for the dispatch
|
|
1113
1122
|
# @param [Hash] opts the optional parameters
|
|
1114
|
-
# @return [Array<(EnabledSchema,
|
|
1123
|
+
# @return [Array<(EnabledSchema, Integer, Hash)>] EnabledSchema data, response status code and response headers
|
|
1115
1124
|
def get_dispatch_enabled_with_http_info(dispatch_id, opts = {})
|
|
1116
1125
|
if @api_client.config.debugging
|
|
1117
1126
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_enabled ...'
|
|
@@ -1166,7 +1175,7 @@ module RusticiSoftwareCloudV2
|
|
|
1166
1175
|
# 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.
|
|
1167
1176
|
# @param dispatch_id Identifier for the dispatch
|
|
1168
1177
|
# @param [Hash] opts the optional parameters
|
|
1169
|
-
# @return [Array<(EnabledSchema,
|
|
1178
|
+
# @return [Array<(EnabledSchema, Integer, Hash)>] EnabledSchema data, response status code and response headers
|
|
1170
1179
|
def get_dispatch_hash_user_info_with_http_info(dispatch_id, opts = {})
|
|
1171
1180
|
if @api_client.config.debugging
|
|
1172
1181
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_hash_user_info ...'
|
|
@@ -1221,7 +1230,7 @@ module RusticiSoftwareCloudV2
|
|
|
1221
1230
|
# 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.
|
|
1222
1231
|
# @param dispatch_id Identifier for the dispatch
|
|
1223
1232
|
# @param [Hash] opts the optional parameters
|
|
1224
|
-
# @return [Array<(DispatchRegistrationCountSchema,
|
|
1233
|
+
# @return [Array<(DispatchRegistrationCountSchema, Integer, Hash)>] DispatchRegistrationCountSchema data, response status code and response headers
|
|
1225
1234
|
def get_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
|
|
1226
1235
|
if @api_client.config.debugging
|
|
1227
1236
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_registration_count ...'
|
|
@@ -1276,7 +1285,7 @@ module RusticiSoftwareCloudV2
|
|
|
1276
1285
|
# Returns the tags for the dispatch.
|
|
1277
1286
|
# @param dispatch_id Identifier for the dispatch
|
|
1278
1287
|
# @param [Hash] opts the optional parameters
|
|
1279
|
-
# @return [Array<(TagListSchema,
|
|
1288
|
+
# @return [Array<(TagListSchema, Integer, Hash)>] TagListSchema data, response status code and response headers
|
|
1280
1289
|
def get_dispatch_tags_with_http_info(dispatch_id, opts = {})
|
|
1281
1290
|
if @api_client.config.debugging
|
|
1282
1291
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_tags ...'
|
|
@@ -1335,7 +1344,7 @@ module RusticiSoftwareCloudV2
|
|
|
1335
1344
|
# @param [Hash] opts the optional parameters
|
|
1336
1345
|
# @option opts [String] :type The type of dispatch package to export (currently only SCORM_12 available)
|
|
1337
1346
|
# @option opts [String] :css_url Custom CSS to apply to the dispatch package
|
|
1338
|
-
# @return [Array<(File,
|
|
1347
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
1339
1348
|
def get_dispatch_zip_with_http_info(dispatch_id, opts = {})
|
|
1340
1349
|
if @api_client.config.debugging
|
|
1341
1350
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_zip ...'
|
|
@@ -1382,6 +1391,7 @@ module RusticiSoftwareCloudV2
|
|
|
1382
1391
|
# 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.
|
|
1383
1392
|
# @param [Hash] opts the optional parameters
|
|
1384
1393
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
1394
|
+
# @option opts [BOOLEAN] :is_enabled Optional boolean parameter used to filter the list of dispatches so that only enabled or disabled dispatches are retrieved.
|
|
1385
1395
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
1386
1396
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
1387
1397
|
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
|
@@ -1401,6 +1411,7 @@ module RusticiSoftwareCloudV2
|
|
|
1401
1411
|
# 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.
|
|
1402
1412
|
# @param [Hash] opts the optional parameters
|
|
1403
1413
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
1414
|
+
# @option opts [BOOLEAN] :is_enabled Optional boolean parameter used to filter the list of dispatches so that only enabled or disabled dispatches are retrieved.
|
|
1404
1415
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
1405
1416
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
1406
1417
|
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
|
@@ -1410,7 +1421,7 @@ module RusticiSoftwareCloudV2
|
|
|
1410
1421
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
|
1411
1422
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
1412
1423
|
# @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.
|
|
1413
|
-
# @return [Array<(DispatchListSchema,
|
|
1424
|
+
# @return [Array<(DispatchListSchema, Integer, Hash)>] DispatchListSchema data, response status code and response headers
|
|
1414
1425
|
def get_dispatches_with_http_info(opts = {})
|
|
1415
1426
|
if @api_client.config.debugging
|
|
1416
1427
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatches ...'
|
|
@@ -1421,6 +1432,7 @@ module RusticiSoftwareCloudV2
|
|
|
1421
1432
|
# query parameters
|
|
1422
1433
|
query_params = {}
|
|
1423
1434
|
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
1435
|
+
query_params[:'isEnabled'] = opts[:'is_enabled'] if !opts[:'is_enabled'].nil?
|
|
1424
1436
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
1425
1437
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
1426
1438
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
@@ -1471,7 +1483,7 @@ module RusticiSoftwareCloudV2
|
|
|
1471
1483
|
# 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
1484
|
# @param dispatch_id Identifier for the dispatch
|
|
1473
1485
|
# @param [Hash] opts the optional parameters
|
|
1474
|
-
# @return [Array<(DispatchLti13InfoSchema,
|
|
1486
|
+
# @return [Array<(DispatchLti13InfoSchema, Integer, Hash)>] DispatchLti13InfoSchema data, response status code and response headers
|
|
1475
1487
|
def get_lti13_dispatch_with_http_info(dispatch_id, opts = {})
|
|
1476
1488
|
if @api_client.config.debugging
|
|
1477
1489
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch ...'
|
|
@@ -1530,7 +1542,7 @@ module RusticiSoftwareCloudV2
|
|
|
1530
1542
|
# @param external_config External configuration object
|
|
1531
1543
|
# @param jwt
|
|
1532
1544
|
# @param [Hash] opts the optional parameters
|
|
1533
|
-
# @return [Array<(nil,
|
|
1545
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1534
1546
|
def get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts = {})
|
|
1535
1547
|
if @api_client.config.debugging
|
|
1536
1548
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch_launch ...'
|
|
@@ -1592,7 +1604,7 @@ module RusticiSoftwareCloudV2
|
|
|
1592
1604
|
# Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId`
|
|
1593
1605
|
# @param destination_id Identifier for the destination
|
|
1594
1606
|
# @param [Hash] opts the optional parameters
|
|
1595
|
-
# @return [Array<(Lti13ToolConfigurationSchema,
|
|
1607
|
+
# @return [Array<(Lti13ToolConfigurationSchema, Integer, Hash)>] Lti13ToolConfigurationSchema data, response status code and response headers
|
|
1596
1608
|
def get_lti13_tool_configuration_schema_with_http_info(destination_id, opts = {})
|
|
1597
1609
|
if @api_client.config.debugging
|
|
1598
1610
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_tool_configuration_schema ...'
|
|
@@ -1647,7 +1659,7 @@ module RusticiSoftwareCloudV2
|
|
|
1647
1659
|
# 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.
|
|
1648
1660
|
# @param dispatch_id Identifier for the dispatch
|
|
1649
1661
|
# @param [Hash] opts the optional parameters
|
|
1650
|
-
# @return [Array<(DispatchLtiInfoSchema,
|
|
1662
|
+
# @return [Array<(DispatchLtiInfoSchema, Integer, Hash)>] DispatchLtiInfoSchema data, response status code and response headers
|
|
1651
1663
|
def get_lti_dispatch_with_http_info(dispatch_id, opts = {})
|
|
1652
1664
|
if @api_client.config.debugging
|
|
1653
1665
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti_dispatch ...'
|
|
@@ -1704,7 +1716,7 @@ module RusticiSoftwareCloudV2
|
|
|
1704
1716
|
# @param destination_id Identifier for the destination
|
|
1705
1717
|
# @param tags
|
|
1706
1718
|
# @param [Hash] opts the optional parameters
|
|
1707
|
-
# @return [Array<(nil,
|
|
1719
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1708
1720
|
def put_destination_tags_with_http_info(destination_id, tags, opts = {})
|
|
1709
1721
|
if @api_client.config.debugging
|
|
1710
1722
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags ...'
|
|
@@ -1762,7 +1774,7 @@ module RusticiSoftwareCloudV2
|
|
|
1762
1774
|
# 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).
|
|
1763
1775
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
|
1764
1776
|
# @param [Hash] opts the optional parameters
|
|
1765
|
-
# @return [Array<(nil,
|
|
1777
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1766
1778
|
def put_destination_tags_batch_with_http_info(batch, opts = {})
|
|
1767
1779
|
if @api_client.config.debugging
|
|
1768
1780
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags_batch ...'
|
|
@@ -1818,7 +1830,7 @@ module RusticiSoftwareCloudV2
|
|
|
1818
1830
|
# @param dispatch_id Identifier for the dispatch
|
|
1819
1831
|
# @param tags
|
|
1820
1832
|
# @param [Hash] opts the optional parameters
|
|
1821
|
-
# @return [Array<(nil,
|
|
1833
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1822
1834
|
def put_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
|
|
1823
1835
|
if @api_client.config.debugging
|
|
1824
1836
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags ...'
|
|
@@ -1876,7 +1888,7 @@ module RusticiSoftwareCloudV2
|
|
|
1876
1888
|
# 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).
|
|
1877
1889
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
|
1878
1890
|
# @param [Hash] opts the optional parameters
|
|
1879
|
-
# @return [Array<(nil,
|
|
1891
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1880
1892
|
def put_dispatch_tags_batch_with_http_info(batch, opts = {})
|
|
1881
1893
|
if @api_client.config.debugging
|
|
1882
1894
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags_batch ...'
|
|
@@ -1930,7 +1942,7 @@ module RusticiSoftwareCloudV2
|
|
|
1930
1942
|
# 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.
|
|
1931
1943
|
# @param destination_id Identifier for the destination
|
|
1932
1944
|
# @param [Hash] opts the optional parameters
|
|
1933
|
-
# @return [Array<(nil,
|
|
1945
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1934
1946
|
def reset_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
|
|
1935
1947
|
if @api_client.config.debugging
|
|
1936
1948
|
@api_client.config.logger.debug 'Calling API: DispatchApi.reset_destination_dispatch_registration_count ...'
|
|
@@ -1984,7 +1996,7 @@ module RusticiSoftwareCloudV2
|
|
|
1984
1996
|
# 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.
|
|
1985
1997
|
# @param dispatch_id Identifier for the dispatch
|
|
1986
1998
|
# @param [Hash] opts the optional parameters
|
|
1987
|
-
# @return [Array<(nil,
|
|
1999
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1988
2000
|
def reset_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
|
|
1989
2001
|
if @api_client.config.debugging
|
|
1990
2002
|
@api_client.config.logger.debug 'Calling API: DispatchApi.reset_dispatch_registration_count ...'
|
|
@@ -2040,7 +2052,7 @@ module RusticiSoftwareCloudV2
|
|
|
2040
2052
|
# @param destination_id Identifier for the destination
|
|
2041
2053
|
# @param destination
|
|
2042
2054
|
# @param [Hash] opts the optional parameters
|
|
2043
|
-
# @return [Array<(nil,
|
|
2055
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2044
2056
|
def set_destination_with_http_info(destination_id, destination, opts = {})
|
|
2045
2057
|
if @api_client.config.debugging
|
|
2046
2058
|
@api_client.config.logger.debug 'Calling API: DispatchApi.set_destination ...'
|
|
@@ -2100,7 +2112,7 @@ module RusticiSoftwareCloudV2
|
|
|
2100
2112
|
# @param destination_id Identifier for the destination
|
|
2101
2113
|
# @param enabled
|
|
2102
2114
|
# @param [Hash] opts the optional parameters
|
|
2103
|
-
# @return [Array<(nil,
|
|
2115
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2104
2116
|
def set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts = {})
|
|
2105
2117
|
if @api_client.config.debugging
|
|
2106
2118
|
@api_client.config.logger.debug 'Calling API: DispatchApi.set_destination_dispatch_enabled ...'
|
|
@@ -2160,7 +2172,7 @@ module RusticiSoftwareCloudV2
|
|
|
2160
2172
|
# @param dispatch_id Identifier for the dispatch
|
|
2161
2173
|
# @param enabled
|
|
2162
2174
|
# @param [Hash] opts the optional parameters
|
|
2163
|
-
# @return [Array<(nil,
|
|
2175
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2164
2176
|
def set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts = {})
|
|
2165
2177
|
if @api_client.config.debugging
|
|
2166
2178
|
@api_client.config.logger.debug 'Calling API: DispatchApi.set_dispatch_enabled ...'
|
|
@@ -2220,7 +2232,7 @@ module RusticiSoftwareCloudV2
|
|
|
2220
2232
|
# @param destination_id Identifier for the destination
|
|
2221
2233
|
# @param enabled
|
|
2222
2234
|
# @param [Hash] opts the optional parameters
|
|
2223
|
-
# @return [Array<(nil,
|
|
2235
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2224
2236
|
def update_destination_hash_user_info_with_http_info(destination_id, enabled, opts = {})
|
|
2225
2237
|
if @api_client.config.debugging
|
|
2226
2238
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_destination_hash_user_info ...'
|
|
@@ -2280,7 +2292,7 @@ module RusticiSoftwareCloudV2
|
|
|
2280
2292
|
# @param dispatch_id Identifier for the dispatch
|
|
2281
2293
|
# @param dispatch_properties
|
|
2282
2294
|
# @param [Hash] opts the optional parameters
|
|
2283
|
-
# @return [Array<(nil,
|
|
2295
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2284
2296
|
def update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts = {})
|
|
2285
2297
|
if @api_client.config.debugging
|
|
2286
2298
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch ...'
|
|
@@ -2340,7 +2352,7 @@ module RusticiSoftwareCloudV2
|
|
|
2340
2352
|
# @param dispatch_id Identifier for the dispatch
|
|
2341
2353
|
# @param enabled
|
|
2342
2354
|
# @param [Hash] opts the optional parameters
|
|
2343
|
-
# @return [Array<(nil,
|
|
2355
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2344
2356
|
def update_dispatch_hash_user_info_with_http_info(dispatch_id, enabled, opts = {})
|
|
2345
2357
|
if @api_client.config.debugging
|
|
2346
2358
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch_hash_user_info ...'
|
|
@@ -2412,7 +2424,7 @@ module RusticiSoftwareCloudV2
|
|
|
2412
2424
|
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
|
2413
2425
|
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
|
2414
2426
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
|
2415
|
-
# @return [Array<(nil,
|
|
2427
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2416
2428
|
def update_dispatches_with_http_info(dispatch_properties, opts = {})
|
|
2417
2429
|
if @api_client.config.debugging
|
|
2418
2430
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatches ...'
|