rustici_software_cloud_v2 1.0.0beta → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +1 -1
- data/README.md +354 -243
- data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +253 -63
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +11 -17
- data/lib/rustici_software_cloud_v2/api/course_api.rb +910 -160
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +2236 -0
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +1025 -0
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +367 -0
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +6 -4
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +448 -295
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +581 -0
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +528 -0
- data/lib/rustici_software_cloud_v2/api_client.rb +5 -5
- data/lib/rustici_software_cloud_v2/api_error.rb +2 -2
- data/lib/rustici_software_cloud_v2/configuration.rb +11 -20
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +10 -38
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/{link_schema.rb → application_request_schema.rb} +14 -16
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/application_token.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +21 -17
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +6 -3
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → create_dispatch_id_schema.rb} +25 -25
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +306 -0
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +252 -0
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +250 -0
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +195 -0
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +227 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +197 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +326 -0
- data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +17 -6
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +31 -8
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +214 -0
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +226 -0
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +225 -0
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +212 -0
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +10 -38
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +25 -9
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -10
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +13 -45
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +21 -15
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +24 -42
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +264 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +287 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +6 -3
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +17 -4
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +257 -0
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +212 -0
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/response_error.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +10 -38
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +266 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +234 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +213 -0
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +193 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +193 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +255 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +264 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +202 -0
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +192 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/version.rb +3 -3
- data/lib/rustici_software_cloud_v2.rb +68 -6
- data/rustici_software_cloud_v2.gemspec +8 -7
- data/spec/api_client_spec.rb +53 -47
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -13
- metadata +142 -270
- data/docs/ActivityResultSchema.md +0 -20
- data/docs/ApplicationListSchema.md +0 -8
- data/docs/ApplicationManagementApi.md +0 -570
- data/docs/ApplicationSchema.md +0 -9
- data/docs/ApplicationToken.md +0 -10
- data/docs/AuthenticationApi.md +0 -64
- data/docs/CommentSchema.md +0 -10
- data/docs/CompletionAmountSchema.md +0 -8
- data/docs/CourseActivitySchema.md +0 -15
- data/docs/CourseApi.md +0 -1459
- data/docs/CourseListNonPagedSchema.md +0 -8
- data/docs/CourseListSchema.md +0 -9
- data/docs/CourseReferenceSchema.md +0 -10
- data/docs/CourseSchema.md +0 -20
- data/docs/CourseTagsBatchSchema.md +0 -9
- data/docs/CreateRegistrationSchema.md +0 -17
- data/docs/CredentialCreatedSchema.md +0 -12
- data/docs/CredentialListSchema.md +0 -8
- data/docs/CredentialRequestSchema.md +0 -9
- data/docs/CredentialSchema.md +0 -12
- data/docs/ImportFetchRequestSchema.md +0 -8
- data/docs/ImportJobResultSchema.md +0 -11
- data/docs/ImportResultSchema.md +0 -11
- data/docs/IntegerResultSchema.md +0 -8
- data/docs/ItemValuePairSchema.md +0 -9
- data/docs/LaunchHistoryListSchema.md +0 -8
- data/docs/LaunchHistorySchema.md +0 -17
- data/docs/LaunchLinkRequestSchema.md +0 -17
- data/docs/LaunchLinkSchema.md +0 -8
- data/docs/LearnerPreferenceSchema.md +0 -11
- data/docs/LearnerSchema.md +0 -11
- data/docs/LinkSchema.md +0 -8
- data/docs/MessageSchema.md +0 -8
- data/docs/MetadataSchema.md +0 -14
- data/docs/ObjectiveSchema.md +0 -20
- data/docs/PermissionsSchema.md +0 -9
- data/docs/PingApi.md +0 -57
- data/docs/PingSchema.md +0 -8
- data/docs/PostBackSchema.md +0 -12
- data/docs/RegistrationApi.md +0 -1490
- data/docs/RegistrationCompletion.md +0 -7
- data/docs/RegistrationListSchema.md +0 -9
- data/docs/RegistrationSchema.md +0 -27
- data/docs/RegistrationSuccess.md +0 -7
- data/docs/RegistrationTagsBatchSchema.md +0 -9
- data/docs/ResponseError.md +0 -8
- data/docs/RuntimeInteractionSchema.md +0 -18
- data/docs/RuntimeObjectiveSchema.md +0 -16
- data/docs/RuntimeSchema.md +0 -27
- data/docs/ScoreSchema.md +0 -8
- data/docs/SettingItem.md +0 -12
- data/docs/SettingListSchema.md +0 -8
- data/docs/SettingMetadata.md +0 -15
- data/docs/SettingMetadataValidValues.md +0 -9
- data/docs/SettingValidValue.md +0 -9
- data/docs/SettingsIndividualSchema.md +0 -10
- data/docs/SettingsPostSchema.md +0 -8
- data/docs/SharedDataEntrySchema.md +0 -9
- data/docs/StaticPropertiesSchema.md +0 -13
- data/docs/StringResultSchema.md +0 -8
- data/docs/TagListSchema.md +0 -8
- data/docs/TagPostSchema.md +0 -7
- data/docs/TitleSchema.md +0 -8
- data/docs/TokenRequestSchema.md +0 -9
- data/docs/XapiAccount.md +0 -9
- data/docs/XapiActivity.md +0 -10
- data/docs/XapiActivityDefinition.md +0 -19
- data/docs/XapiAgentGroup.md +0 -14
- data/docs/XapiAttachment.md +0 -14
- data/docs/XapiContext.md +0 -16
- data/docs/XapiContextActivity.md +0 -11
- data/docs/XapiInteractionComponent.md +0 -9
- data/docs/XapiResult.md +0 -13
- data/docs/XapiScore.md +0 -11
- data/docs/XapiStatement.md +0 -20
- data/docs/XapiStatementReference.md +0 -9
- data/docs/XapiStatementResult.md +0 -9
- data/docs/XapiVerb.md +0 -9
- data/git_push.sh +0 -55
- data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +0 -209
- data/spec/models/activity_result_schema_spec.rb +0 -133
- data/spec/models/application_list_schema_spec.rb +0 -53
- data/spec/models/application_schema_spec.rb +0 -59
- data/spec/models/application_token_spec.rb +0 -65
- data/spec/models/comment_schema_spec.rb +0 -65
- data/spec/models/completion_amount_schema_spec.rb +0 -53
- data/spec/models/course_activity_schema_spec.rb +0 -99
- data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
- data/spec/models/course_list_schema_spec.rb +0 -59
- data/spec/models/course_reference_schema_spec.rb +0 -65
- data/spec/models/course_schema_spec.rb +0 -129
- data/spec/models/create_registration_schema_spec.rb +0 -107
- data/spec/models/credential_created_schema_spec.rb +0 -77
- data/spec/models/credential_list_schema_spec.rb +0 -53
- data/spec/models/credential_request_schema_spec.rb +0 -59
- data/spec/models/credential_schema_spec.rb +0 -77
- data/spec/models/import_fetch_request_schema_spec.rb +0 -53
- data/spec/models/import_job_result_schema_spec.rb +0 -75
- data/spec/models/import_result_schema_spec.rb +0 -71
- data/spec/models/integer_result_schema_spec.rb +0 -53
- data/spec/models/item_value_pair_schema_spec.rb +0 -59
- data/spec/models/launch_history_list_schema_spec.rb +0 -53
- data/spec/models/launch_history_schema_spec.rb +0 -115
- data/spec/models/launch_link_request_schema_spec.rb +0 -107
- data/spec/models/launch_link_schema_spec.rb +0 -53
- data/spec/models/learner_preference_schema_spec.rb +0 -71
- data/spec/models/learner_schema_spec.rb +0 -71
- data/spec/models/link_schema_spec.rb +0 -53
- data/spec/models/message_schema_spec.rb +0 -53
- data/spec/models/metadata_schema_spec.rb +0 -89
- data/spec/models/objective_schema_spec.rb +0 -137
- data/spec/models/permissions_schema_spec.rb +0 -59
- data/spec/models/ping_schema_spec.rb +0 -53
- data/spec/models/post_back_schema_spec.rb +0 -85
- data/spec/models/registration_completion_spec.rb +0 -47
- data/spec/models/registration_list_schema_spec.rb +0 -59
- data/spec/models/registration_schema_spec.rb +0 -167
- data/spec/models/registration_success_spec.rb +0 -47
- data/spec/models/response_error_spec.rb +0 -53
- data/spec/models/runtime_interaction_schema_spec.rb +0 -117
- data/spec/models/runtime_objective_schema_spec.rb +0 -109
- data/spec/models/runtime_schema_spec.rb +0 -171
- data/spec/models/score_schema_spec.rb +0 -53
- data/spec/models/setting_item_spec.rb +0 -81
- data/spec/models/setting_list_schema_spec.rb +0 -53
- data/spec/models/setting_metadata_spec.rb +0 -99
- data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
- data/spec/models/settings_individual_schema_spec.rb +0 -65
- data/spec/models/settings_post_schema_spec.rb +0 -53
- data/spec/models/shared_data_entry_schema_spec.rb +0 -59
- data/spec/models/static_properties_schema_spec.rb +0 -83
- data/spec/models/string_result_schema_spec.rb +0 -53
- data/spec/models/title_schema_spec.rb +0 -53
- data/spec/models/token_request_schema_spec.rb +0 -59
- data/swagger-codegen.config +0 -11
@@ -0,0 +1,2236 @@
|
|
1
|
+
=begin
|
2
|
+
#SCORM Cloud Rest API
|
3
|
+
|
4
|
+
#REST API used for SCORM Cloud integrations.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module RusticiSoftwareCloudV2
|
16
|
+
class DispatchApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Create a group of Destinations
|
23
|
+
# 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
|
+
# @param destinations_list
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def create_destinations(destinations_list, opts = {})
|
28
|
+
create_destinations_with_http_info(destinations_list, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Create a group of Destinations
|
33
|
+
# 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.
|
34
|
+
# @param destinations_list
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
37
|
+
def create_destinations_with_http_info(destinations_list, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.create_destinations ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'destinations_list' is set
|
42
|
+
if destinations_list.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'destinations_list' when calling DispatchApi.create_destinations"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/dispatch/destinations'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = @api_client.object_to_http_body(destinations_list)
|
63
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
64
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
65
|
+
:header_params => header_params,
|
66
|
+
:query_params => query_params,
|
67
|
+
:form_params => form_params,
|
68
|
+
:body => post_body,
|
69
|
+
:auth_names => auth_names)
|
70
|
+
if @api_client.config.debugging
|
71
|
+
@api_client.config.logger.debug "API called: DispatchApi#create_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
72
|
+
end
|
73
|
+
return data, status_code, headers
|
74
|
+
end
|
75
|
+
# Create a group of Dispatches
|
76
|
+
# 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
|
+
# @param dispatch_list
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @return [nil]
|
80
|
+
def create_dispatches(dispatch_list, opts = {})
|
81
|
+
create_dispatches_with_http_info(dispatch_list, opts)
|
82
|
+
nil
|
83
|
+
end
|
84
|
+
|
85
|
+
# Create a group of Dispatches
|
86
|
+
# 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.
|
87
|
+
# @param dispatch_list
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
90
|
+
def create_dispatches_with_http_info(dispatch_list, opts = {})
|
91
|
+
if @api_client.config.debugging
|
92
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.create_dispatches ...'
|
93
|
+
end
|
94
|
+
# verify the required parameter 'dispatch_list' is set
|
95
|
+
if dispatch_list.nil?
|
96
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_list' when calling DispatchApi.create_dispatches"
|
97
|
+
end
|
98
|
+
# resource path
|
99
|
+
local_var_path = '/dispatch/dispatches'
|
100
|
+
|
101
|
+
# query parameters
|
102
|
+
query_params = {}
|
103
|
+
|
104
|
+
# header parameters
|
105
|
+
header_params = {}
|
106
|
+
# HTTP header 'Accept' (if needed)
|
107
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
108
|
+
# HTTP header 'Content-Type'
|
109
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
110
|
+
|
111
|
+
# form parameters
|
112
|
+
form_params = {}
|
113
|
+
|
114
|
+
# http body (model)
|
115
|
+
post_body = @api_client.object_to_http_body(dispatch_list)
|
116
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
117
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
118
|
+
:header_params => header_params,
|
119
|
+
:query_params => query_params,
|
120
|
+
:form_params => form_params,
|
121
|
+
:body => post_body,
|
122
|
+
:auth_names => auth_names)
|
123
|
+
if @api_client.config.debugging
|
124
|
+
@api_client.config.logger.debug "API called: DispatchApi#create_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
125
|
+
end
|
126
|
+
return data, status_code, headers
|
127
|
+
end
|
128
|
+
# Delete a Destination
|
129
|
+
# Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
|
130
|
+
# @param destination_id Identifier for the destination
|
131
|
+
# @param [Hash] opts the optional parameters
|
132
|
+
# @return [nil]
|
133
|
+
def delete_destination(destination_id, opts = {})
|
134
|
+
delete_destination_with_http_info(destination_id, opts)
|
135
|
+
nil
|
136
|
+
end
|
137
|
+
|
138
|
+
# Delete a Destination
|
139
|
+
# Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
|
140
|
+
# @param destination_id Identifier for the destination
|
141
|
+
# @param [Hash] opts the optional parameters
|
142
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
143
|
+
def delete_destination_with_http_info(destination_id, opts = {})
|
144
|
+
if @api_client.config.debugging
|
145
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination ...'
|
146
|
+
end
|
147
|
+
# verify the required parameter 'destination_id' is set
|
148
|
+
if destination_id.nil?
|
149
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination"
|
150
|
+
end
|
151
|
+
# resource path
|
152
|
+
local_var_path = '/dispatch/destinations/{destinationId}'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
153
|
+
|
154
|
+
# query parameters
|
155
|
+
query_params = {}
|
156
|
+
|
157
|
+
# header parameters
|
158
|
+
header_params = {}
|
159
|
+
# HTTP header 'Accept' (if needed)
|
160
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
161
|
+
# HTTP header 'Content-Type'
|
162
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
163
|
+
|
164
|
+
# form parameters
|
165
|
+
form_params = {}
|
166
|
+
|
167
|
+
# http body (model)
|
168
|
+
post_body = nil
|
169
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
170
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
171
|
+
:header_params => header_params,
|
172
|
+
:query_params => query_params,
|
173
|
+
:form_params => form_params,
|
174
|
+
:body => post_body,
|
175
|
+
:auth_names => auth_names)
|
176
|
+
if @api_client.config.debugging
|
177
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
178
|
+
end
|
179
|
+
return data, status_code, headers
|
180
|
+
end
|
181
|
+
# Delete a Destination's Dispatches
|
182
|
+
# Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
183
|
+
# @param destination_id Identifier for the destination
|
184
|
+
# @param [Hash] opts the optional parameters
|
185
|
+
# @return [nil]
|
186
|
+
def delete_destination_dispatches(destination_id, opts = {})
|
187
|
+
delete_destination_dispatches_with_http_info(destination_id, opts)
|
188
|
+
nil
|
189
|
+
end
|
190
|
+
|
191
|
+
# Delete a Destination's Dispatches
|
192
|
+
# Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
193
|
+
# @param destination_id Identifier for the destination
|
194
|
+
# @param [Hash] opts the optional parameters
|
195
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
196
|
+
def delete_destination_dispatches_with_http_info(destination_id, opts = {})
|
197
|
+
if @api_client.config.debugging
|
198
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_dispatches ...'
|
199
|
+
end
|
200
|
+
# verify the required parameter 'destination_id' is set
|
201
|
+
if destination_id.nil?
|
202
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_dispatches"
|
203
|
+
end
|
204
|
+
# resource path
|
205
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
206
|
+
|
207
|
+
# query parameters
|
208
|
+
query_params = {}
|
209
|
+
|
210
|
+
# header parameters
|
211
|
+
header_params = {}
|
212
|
+
# HTTP header 'Accept' (if needed)
|
213
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
214
|
+
# HTTP header 'Content-Type'
|
215
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
216
|
+
|
217
|
+
# form parameters
|
218
|
+
form_params = {}
|
219
|
+
|
220
|
+
# http body (model)
|
221
|
+
post_body = nil
|
222
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
223
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
224
|
+
:header_params => header_params,
|
225
|
+
:query_params => query_params,
|
226
|
+
:form_params => form_params,
|
227
|
+
:body => post_body,
|
228
|
+
:auth_names => auth_names)
|
229
|
+
if @api_client.config.debugging
|
230
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_destination_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
231
|
+
end
|
232
|
+
return data, status_code, headers
|
233
|
+
end
|
234
|
+
# Delete tags from a Destination
|
235
|
+
# Deletes the specified tags from the destination. Deleting tags that do not exist will still result in a success.
|
236
|
+
# @param destination_id Identifier for the destination
|
237
|
+
# @param tags
|
238
|
+
# @param [Hash] opts the optional parameters
|
239
|
+
# @return [nil]
|
240
|
+
def delete_destination_tags(destination_id, tags, opts = {})
|
241
|
+
delete_destination_tags_with_http_info(destination_id, tags, opts)
|
242
|
+
nil
|
243
|
+
end
|
244
|
+
|
245
|
+
# Delete tags from a Destination
|
246
|
+
# Deletes the specified tags from the destination. Deleting tags that do not exist will still result in a success.
|
247
|
+
# @param destination_id Identifier for the destination
|
248
|
+
# @param tags
|
249
|
+
# @param [Hash] opts the optional parameters
|
250
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
251
|
+
def delete_destination_tags_with_http_info(destination_id, tags, opts = {})
|
252
|
+
if @api_client.config.debugging
|
253
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_tags ...'
|
254
|
+
end
|
255
|
+
# verify the required parameter 'destination_id' is set
|
256
|
+
if destination_id.nil?
|
257
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_tags"
|
258
|
+
end
|
259
|
+
# verify the required parameter 'tags' is set
|
260
|
+
if tags.nil?
|
261
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_destination_tags"
|
262
|
+
end
|
263
|
+
# resource path
|
264
|
+
local_var_path = '/dispatch/destinations/{destinationId}/tags'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
265
|
+
|
266
|
+
# query parameters
|
267
|
+
query_params = {}
|
268
|
+
|
269
|
+
# header parameters
|
270
|
+
header_params = {}
|
271
|
+
# HTTP header 'Accept' (if needed)
|
272
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
273
|
+
# HTTP header 'Content-Type'
|
274
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
275
|
+
|
276
|
+
# form parameters
|
277
|
+
form_params = {}
|
278
|
+
|
279
|
+
# http body (model)
|
280
|
+
post_body = @api_client.object_to_http_body(tags)
|
281
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
282
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
283
|
+
:header_params => header_params,
|
284
|
+
:query_params => query_params,
|
285
|
+
:form_params => form_params,
|
286
|
+
:body => post_body,
|
287
|
+
:auth_names => auth_names)
|
288
|
+
if @api_client.config.debugging
|
289
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
290
|
+
end
|
291
|
+
return data, status_code, headers
|
292
|
+
end
|
293
|
+
# Delete a Dispatch
|
294
|
+
# Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
295
|
+
# @param dispatch_id Identifier for the dispatch
|
296
|
+
# @param [Hash] opts the optional parameters
|
297
|
+
# @return [nil]
|
298
|
+
def delete_dispatch(dispatch_id, opts = {})
|
299
|
+
delete_dispatch_with_http_info(dispatch_id, opts)
|
300
|
+
nil
|
301
|
+
end
|
302
|
+
|
303
|
+
# Delete a Dispatch
|
304
|
+
# Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
305
|
+
# @param dispatch_id Identifier for the dispatch
|
306
|
+
# @param [Hash] opts the optional parameters
|
307
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
308
|
+
def delete_dispatch_with_http_info(dispatch_id, opts = {})
|
309
|
+
if @api_client.config.debugging
|
310
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch ...'
|
311
|
+
end
|
312
|
+
# verify the required parameter 'dispatch_id' is set
|
313
|
+
if dispatch_id.nil?
|
314
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch"
|
315
|
+
end
|
316
|
+
# resource path
|
317
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
318
|
+
|
319
|
+
# query parameters
|
320
|
+
query_params = {}
|
321
|
+
|
322
|
+
# header parameters
|
323
|
+
header_params = {}
|
324
|
+
# HTTP header 'Accept' (if needed)
|
325
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
326
|
+
# HTTP header 'Content-Type'
|
327
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
328
|
+
|
329
|
+
# form parameters
|
330
|
+
form_params = {}
|
331
|
+
|
332
|
+
# http body (model)
|
333
|
+
post_body = nil
|
334
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
335
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
336
|
+
:header_params => header_params,
|
337
|
+
:query_params => query_params,
|
338
|
+
:form_params => form_params,
|
339
|
+
:body => post_body,
|
340
|
+
:auth_names => auth_names)
|
341
|
+
if @api_client.config.debugging
|
342
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
343
|
+
end
|
344
|
+
return data, status_code, headers
|
345
|
+
end
|
346
|
+
# Delete postback information from a Dispatch
|
347
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
349
|
+
# @param [Hash] opts the optional parameters
|
350
|
+
# @return [nil]
|
351
|
+
def delete_dispatch_postback_info(dispatch_id, opts = {})
|
352
|
+
delete_dispatch_postback_info_with_http_info(dispatch_id, opts)
|
353
|
+
nil
|
354
|
+
end
|
355
|
+
|
356
|
+
# Delete postback information from a Dispatch
|
357
|
+
# 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.
|
358
|
+
# @param dispatch_id Identifier for the dispatch
|
359
|
+
# @param [Hash] opts the optional parameters
|
360
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
361
|
+
def delete_dispatch_postback_info_with_http_info(dispatch_id, opts = {})
|
362
|
+
if @api_client.config.debugging
|
363
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_postback_info ...'
|
364
|
+
end
|
365
|
+
# verify the required parameter 'dispatch_id' is set
|
366
|
+
if dispatch_id.nil?
|
367
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_postback_info"
|
368
|
+
end
|
369
|
+
# resource path
|
370
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/postback'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
371
|
+
|
372
|
+
# query parameters
|
373
|
+
query_params = {}
|
374
|
+
|
375
|
+
# header parameters
|
376
|
+
header_params = {}
|
377
|
+
# HTTP header 'Accept' (if needed)
|
378
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
379
|
+
# HTTP header 'Content-Type'
|
380
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
381
|
+
|
382
|
+
# form parameters
|
383
|
+
form_params = {}
|
384
|
+
|
385
|
+
# http body (model)
|
386
|
+
post_body = nil
|
387
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
388
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
389
|
+
:header_params => header_params,
|
390
|
+
:query_params => query_params,
|
391
|
+
:form_params => form_params,
|
392
|
+
:body => post_body,
|
393
|
+
:auth_names => auth_names)
|
394
|
+
if @api_client.config.debugging
|
395
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatch_postback_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
396
|
+
end
|
397
|
+
return data, status_code, headers
|
398
|
+
end
|
399
|
+
# Delete tags from a Dispatch
|
400
|
+
# Deletes the specified tags from the dispatch. Deleting tags that do not exist will still result in a success.
|
401
|
+
# @param dispatch_id Identifier for the dispatch
|
402
|
+
# @param tags
|
403
|
+
# @param [Hash] opts the optional parameters
|
404
|
+
# @return [nil]
|
405
|
+
def delete_dispatch_tags(dispatch_id, tags, opts = {})
|
406
|
+
delete_dispatch_tags_with_http_info(dispatch_id, tags, opts)
|
407
|
+
nil
|
408
|
+
end
|
409
|
+
|
410
|
+
# Delete tags from a Dispatch
|
411
|
+
# Deletes the specified tags from the dispatch. Deleting tags that do not exist will still result in a success.
|
412
|
+
# @param dispatch_id Identifier for the dispatch
|
413
|
+
# @param tags
|
414
|
+
# @param [Hash] opts the optional parameters
|
415
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
416
|
+
def delete_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
|
417
|
+
if @api_client.config.debugging
|
418
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_tags ...'
|
419
|
+
end
|
420
|
+
# verify the required parameter 'dispatch_id' is set
|
421
|
+
if dispatch_id.nil?
|
422
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_tags"
|
423
|
+
end
|
424
|
+
# verify the required parameter 'tags' is set
|
425
|
+
if tags.nil?
|
426
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_dispatch_tags"
|
427
|
+
end
|
428
|
+
# resource path
|
429
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/tags'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
430
|
+
|
431
|
+
# query parameters
|
432
|
+
query_params = {}
|
433
|
+
|
434
|
+
# header parameters
|
435
|
+
header_params = {}
|
436
|
+
# HTTP header 'Accept' (if needed)
|
437
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
438
|
+
# HTTP header 'Content-Type'
|
439
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
440
|
+
|
441
|
+
# form parameters
|
442
|
+
form_params = {}
|
443
|
+
|
444
|
+
# http body (model)
|
445
|
+
post_body = @api_client.object_to_http_body(tags)
|
446
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
447
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
448
|
+
:header_params => header_params,
|
449
|
+
:query_params => query_params,
|
450
|
+
:form_params => form_params,
|
451
|
+
:body => post_body,
|
452
|
+
:auth_names => auth_names)
|
453
|
+
if @api_client.config.debugging
|
454
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
455
|
+
end
|
456
|
+
return data, status_code, headers
|
457
|
+
end
|
458
|
+
# Delete a group of Dispatches
|
459
|
+
# 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
|
+
# @param [Hash] opts the optional parameters
|
461
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
462
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
463
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
464
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
465
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
466
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
467
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
468
|
+
# @return [nil]
|
469
|
+
def delete_dispatches(opts = {})
|
470
|
+
delete_dispatches_with_http_info(opts)
|
471
|
+
nil
|
472
|
+
end
|
473
|
+
|
474
|
+
# Delete a group of Dispatches
|
475
|
+
# 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.
|
476
|
+
# @param [Hash] opts the optional parameters
|
477
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
478
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
479
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
480
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
481
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
482
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
483
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
484
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
485
|
+
def delete_dispatches_with_http_info(opts = {})
|
486
|
+
if @api_client.config.debugging
|
487
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatches ...'
|
488
|
+
end
|
489
|
+
# resource path
|
490
|
+
local_var_path = '/dispatch/dispatches'
|
491
|
+
|
492
|
+
# query parameters
|
493
|
+
query_params = {}
|
494
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
495
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
496
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
497
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
498
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
499
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
500
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
501
|
+
|
502
|
+
# header parameters
|
503
|
+
header_params = {}
|
504
|
+
# HTTP header 'Accept' (if needed)
|
505
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
506
|
+
# HTTP header 'Content-Type'
|
507
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
508
|
+
|
509
|
+
# form parameters
|
510
|
+
form_params = {}
|
511
|
+
|
512
|
+
# http body (model)
|
513
|
+
post_body = nil
|
514
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
515
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
516
|
+
:header_params => header_params,
|
517
|
+
:query_params => query_params,
|
518
|
+
:form_params => form_params,
|
519
|
+
:body => post_body,
|
520
|
+
:auth_names => auth_names)
|
521
|
+
if @api_client.config.debugging
|
522
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
523
|
+
end
|
524
|
+
return data, status_code, headers
|
525
|
+
end
|
526
|
+
# Update registration instancing status for a Destination's Dispatches
|
527
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
529
|
+
# @param enabled
|
530
|
+
# @param [Hash] opts the optional parameters
|
531
|
+
# @return [nil]
|
532
|
+
def enable_registration_instancing(destination_id, enabled, opts = {})
|
533
|
+
enable_registration_instancing_with_http_info(destination_id, enabled, opts)
|
534
|
+
nil
|
535
|
+
end
|
536
|
+
|
537
|
+
# Update registration instancing status for a Destination's Dispatches
|
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.
|
539
|
+
# @param destination_id Identifier for the destination
|
540
|
+
# @param enabled
|
541
|
+
# @param [Hash] opts the optional parameters
|
542
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
543
|
+
def enable_registration_instancing_with_http_info(destination_id, enabled, opts = {})
|
544
|
+
if @api_client.config.debugging
|
545
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.enable_registration_instancing ...'
|
546
|
+
end
|
547
|
+
# verify the required parameter 'destination_id' is set
|
548
|
+
if destination_id.nil?
|
549
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.enable_registration_instancing"
|
550
|
+
end
|
551
|
+
# verify the required parameter 'enabled' is set
|
552
|
+
if enabled.nil?
|
553
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.enable_registration_instancing"
|
554
|
+
end
|
555
|
+
# resource path
|
556
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/registrationInstancing'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
557
|
+
|
558
|
+
# query parameters
|
559
|
+
query_params = {}
|
560
|
+
|
561
|
+
# header parameters
|
562
|
+
header_params = {}
|
563
|
+
# HTTP header 'Accept' (if needed)
|
564
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
565
|
+
# HTTP header 'Content-Type'
|
566
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
567
|
+
|
568
|
+
# form parameters
|
569
|
+
form_params = {}
|
570
|
+
|
571
|
+
# http body (model)
|
572
|
+
post_body = @api_client.object_to_http_body(enabled)
|
573
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
574
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
575
|
+
:header_params => header_params,
|
576
|
+
:query_params => query_params,
|
577
|
+
:form_params => form_params,
|
578
|
+
:body => post_body,
|
579
|
+
:auth_names => auth_names)
|
580
|
+
if @api_client.config.debugging
|
581
|
+
@api_client.config.logger.debug "API called: DispatchApi#enable_registration_instancing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
582
|
+
end
|
583
|
+
return data, status_code, headers
|
584
|
+
end
|
585
|
+
# Get detailed information about a Destination
|
586
|
+
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
587
|
+
# @param destination_id Identifier for the destination
|
588
|
+
# @param [Hash] opts the optional parameters
|
589
|
+
# @return [DestinationSchema]
|
590
|
+
def get_destination(destination_id, opts = {})
|
591
|
+
data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
|
592
|
+
data
|
593
|
+
end
|
594
|
+
|
595
|
+
# Get detailed information about a Destination
|
596
|
+
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
597
|
+
# @param destination_id Identifier for the destination
|
598
|
+
# @param [Hash] opts the optional parameters
|
599
|
+
# @return [Array<(DestinationSchema, Fixnum, Hash)>] DestinationSchema data, response status code and response headers
|
600
|
+
def get_destination_with_http_info(destination_id, opts = {})
|
601
|
+
if @api_client.config.debugging
|
602
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination ...'
|
603
|
+
end
|
604
|
+
# verify the required parameter 'destination_id' is set
|
605
|
+
if destination_id.nil?
|
606
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination"
|
607
|
+
end
|
608
|
+
# resource path
|
609
|
+
local_var_path = '/dispatch/destinations/{destinationId}'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
610
|
+
|
611
|
+
# query parameters
|
612
|
+
query_params = {}
|
613
|
+
|
614
|
+
# header parameters
|
615
|
+
header_params = {}
|
616
|
+
# HTTP header 'Accept' (if needed)
|
617
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
618
|
+
# HTTP header 'Content-Type'
|
619
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
620
|
+
|
621
|
+
# form parameters
|
622
|
+
form_params = {}
|
623
|
+
|
624
|
+
# http body (model)
|
625
|
+
post_body = nil
|
626
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
627
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
628
|
+
:header_params => header_params,
|
629
|
+
:query_params => query_params,
|
630
|
+
:form_params => form_params,
|
631
|
+
:body => post_body,
|
632
|
+
:auth_names => auth_names,
|
633
|
+
:return_type => 'DestinationSchema')
|
634
|
+
if @api_client.config.debugging
|
635
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
636
|
+
end
|
637
|
+
return data, status_code, headers
|
638
|
+
end
|
639
|
+
# Get registration count for a Destination's Dispatches
|
640
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
642
|
+
# @param [Hash] opts the optional parameters
|
643
|
+
# @return [IntegerResultSchema]
|
644
|
+
def get_destination_dispatch_registration_count(destination_id, opts = {})
|
645
|
+
data, _status_code, _headers = get_destination_dispatch_registration_count_with_http_info(destination_id, opts)
|
646
|
+
data
|
647
|
+
end
|
648
|
+
|
649
|
+
# Get registration count for a Destination's Dispatches
|
650
|
+
# 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.
|
651
|
+
# @param destination_id Identifier for the destination
|
652
|
+
# @param [Hash] opts the optional parameters
|
653
|
+
# @return [Array<(IntegerResultSchema, Fixnum, Hash)>] IntegerResultSchema data, response status code and response headers
|
654
|
+
def get_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
|
655
|
+
if @api_client.config.debugging
|
656
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_registration_count ...'
|
657
|
+
end
|
658
|
+
# verify the required parameter 'destination_id' is set
|
659
|
+
if destination_id.nil?
|
660
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_registration_count"
|
661
|
+
end
|
662
|
+
# resource path
|
663
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/registrationCount'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
664
|
+
|
665
|
+
# query parameters
|
666
|
+
query_params = {}
|
667
|
+
|
668
|
+
# header parameters
|
669
|
+
header_params = {}
|
670
|
+
# HTTP header 'Accept' (if needed)
|
671
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
672
|
+
# HTTP header 'Content-Type'
|
673
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
674
|
+
|
675
|
+
# form parameters
|
676
|
+
form_params = {}
|
677
|
+
|
678
|
+
# http body (model)
|
679
|
+
post_body = nil
|
680
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
681
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
682
|
+
:header_params => header_params,
|
683
|
+
:query_params => query_params,
|
684
|
+
:form_params => form_params,
|
685
|
+
:body => post_body,
|
686
|
+
:auth_names => auth_names,
|
687
|
+
:return_type => 'IntegerResultSchema')
|
688
|
+
if @api_client.config.debugging
|
689
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
690
|
+
end
|
691
|
+
return data, status_code, headers
|
692
|
+
end
|
693
|
+
# Download a zip file for a Destination's Dispatches
|
694
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
696
|
+
# @param [Hash] opts the optional parameters
|
697
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM_12 only supported in SCORM Cloud today) (default to SCORM_12)
|
698
|
+
# @option opts [String] :css_url
|
699
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
700
|
+
# @return [File]
|
701
|
+
def get_destination_dispatch_zip(destination_id, opts = {})
|
702
|
+
data, _status_code, _headers = get_destination_dispatch_zip_with_http_info(destination_id, opts)
|
703
|
+
data
|
704
|
+
end
|
705
|
+
|
706
|
+
# Download a zip file for a Destination's Dispatches
|
707
|
+
# 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.
|
708
|
+
# @param destination_id Identifier for the destination
|
709
|
+
# @param [Hash] opts the optional parameters
|
710
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM_12 only supported in SCORM Cloud today)
|
711
|
+
# @option opts [String] :css_url
|
712
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
713
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
714
|
+
def get_destination_dispatch_zip_with_http_info(destination_id, opts = {})
|
715
|
+
if @api_client.config.debugging
|
716
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_zip ...'
|
717
|
+
end
|
718
|
+
# verify the required parameter 'destination_id' is set
|
719
|
+
if destination_id.nil?
|
720
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_zip"
|
721
|
+
end
|
722
|
+
# resource path
|
723
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/zip'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
724
|
+
|
725
|
+
# query parameters
|
726
|
+
query_params = {}
|
727
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
728
|
+
query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
|
729
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
730
|
+
|
731
|
+
# header parameters
|
732
|
+
header_params = {}
|
733
|
+
# HTTP header 'Accept' (if needed)
|
734
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
|
735
|
+
# HTTP header 'Content-Type'
|
736
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
737
|
+
|
738
|
+
# form parameters
|
739
|
+
form_params = {}
|
740
|
+
|
741
|
+
# http body (model)
|
742
|
+
post_body = nil
|
743
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
744
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
745
|
+
:header_params => header_params,
|
746
|
+
:query_params => query_params,
|
747
|
+
:form_params => form_params,
|
748
|
+
:body => post_body,
|
749
|
+
:auth_names => auth_names,
|
750
|
+
:return_type => 'File')
|
751
|
+
if @api_client.config.debugging
|
752
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatch_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
753
|
+
end
|
754
|
+
return data, status_code, headers
|
755
|
+
end
|
756
|
+
# Get a list of a Destination's Dispatches
|
757
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
759
|
+
# @param [Hash] opts the optional parameters
|
760
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
761
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
762
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
763
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
764
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
765
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
766
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
767
|
+
# @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
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
769
|
+
# @return [DispatchListSchema]
|
770
|
+
def get_destination_dispatches(destination_id, opts = {})
|
771
|
+
data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
|
772
|
+
data
|
773
|
+
end
|
774
|
+
|
775
|
+
# Get a list of a Destination's Dispatches
|
776
|
+
# 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.
|
777
|
+
# @param destination_id Identifier for the destination
|
778
|
+
# @param [Hash] opts the optional parameters
|
779
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
780
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
781
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
782
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
783
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
784
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
785
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
786
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
787
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
788
|
+
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
789
|
+
def get_destination_dispatches_with_http_info(destination_id, opts = {})
|
790
|
+
if @api_client.config.debugging
|
791
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatches ...'
|
792
|
+
end
|
793
|
+
# verify the required parameter 'destination_id' is set
|
794
|
+
if destination_id.nil?
|
795
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatches"
|
796
|
+
end
|
797
|
+
# resource path
|
798
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
799
|
+
|
800
|
+
# query parameters
|
801
|
+
query_params = {}
|
802
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
803
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
804
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
805
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
806
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
807
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
808
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
809
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
810
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
811
|
+
|
812
|
+
# header parameters
|
813
|
+
header_params = {}
|
814
|
+
# HTTP header 'Accept' (if needed)
|
815
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
816
|
+
# HTTP header 'Content-Type'
|
817
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
818
|
+
|
819
|
+
# form parameters
|
820
|
+
form_params = {}
|
821
|
+
|
822
|
+
# http body (model)
|
823
|
+
post_body = nil
|
824
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
825
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
826
|
+
:header_params => header_params,
|
827
|
+
:query_params => query_params,
|
828
|
+
:form_params => form_params,
|
829
|
+
:body => post_body,
|
830
|
+
:auth_names => auth_names,
|
831
|
+
:return_type => 'DispatchListSchema')
|
832
|
+
if @api_client.config.debugging
|
833
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
834
|
+
end
|
835
|
+
return data, status_code, headers
|
836
|
+
end
|
837
|
+
# Get user PII hashing status for a Destination
|
838
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
840
|
+
# @param [Hash] opts the optional parameters
|
841
|
+
# @return [EnabledSchema]
|
842
|
+
def get_destination_hash_user_info(destination_id, opts = {})
|
843
|
+
data, _status_code, _headers = get_destination_hash_user_info_with_http_info(destination_id, opts)
|
844
|
+
data
|
845
|
+
end
|
846
|
+
|
847
|
+
# Get user PII hashing status for a Destination
|
848
|
+
# 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.
|
849
|
+
# @param destination_id Identifier for the destination
|
850
|
+
# @param [Hash] opts the optional parameters
|
851
|
+
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
852
|
+
def get_destination_hash_user_info_with_http_info(destination_id, opts = {})
|
853
|
+
if @api_client.config.debugging
|
854
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_hash_user_info ...'
|
855
|
+
end
|
856
|
+
# verify the required parameter 'destination_id' is set
|
857
|
+
if destination_id.nil?
|
858
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_hash_user_info"
|
859
|
+
end
|
860
|
+
# resource path
|
861
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/hashUserInfo'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
862
|
+
|
863
|
+
# query parameters
|
864
|
+
query_params = {}
|
865
|
+
|
866
|
+
# header parameters
|
867
|
+
header_params = {}
|
868
|
+
# HTTP header 'Accept' (if needed)
|
869
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
870
|
+
# HTTP header 'Content-Type'
|
871
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
872
|
+
|
873
|
+
# form parameters
|
874
|
+
form_params = {}
|
875
|
+
|
876
|
+
# http body (model)
|
877
|
+
post_body = nil
|
878
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
879
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
880
|
+
:header_params => header_params,
|
881
|
+
:query_params => query_params,
|
882
|
+
:form_params => form_params,
|
883
|
+
:body => post_body,
|
884
|
+
:auth_names => auth_names,
|
885
|
+
:return_type => 'EnabledSchema')
|
886
|
+
if @api_client.config.debugging
|
887
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
888
|
+
end
|
889
|
+
return data, status_code, headers
|
890
|
+
end
|
891
|
+
# Get tags for a Destination
|
892
|
+
# Returns the tags for the destination.
|
893
|
+
# @param destination_id Identifier for the destination
|
894
|
+
# @param [Hash] opts the optional parameters
|
895
|
+
# @return [TagListSchema]
|
896
|
+
def get_destination_tags(destination_id, opts = {})
|
897
|
+
data, _status_code, _headers = get_destination_tags_with_http_info(destination_id, opts)
|
898
|
+
data
|
899
|
+
end
|
900
|
+
|
901
|
+
# Get tags for a Destination
|
902
|
+
# Returns the tags for the destination.
|
903
|
+
# @param destination_id Identifier for the destination
|
904
|
+
# @param [Hash] opts the optional parameters
|
905
|
+
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
906
|
+
def get_destination_tags_with_http_info(destination_id, opts = {})
|
907
|
+
if @api_client.config.debugging
|
908
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_tags ...'
|
909
|
+
end
|
910
|
+
# verify the required parameter 'destination_id' is set
|
911
|
+
if destination_id.nil?
|
912
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_tags"
|
913
|
+
end
|
914
|
+
# resource path
|
915
|
+
local_var_path = '/dispatch/destinations/{destinationId}/tags'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
916
|
+
|
917
|
+
# query parameters
|
918
|
+
query_params = {}
|
919
|
+
|
920
|
+
# header parameters
|
921
|
+
header_params = {}
|
922
|
+
# HTTP header 'Accept' (if needed)
|
923
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
924
|
+
# HTTP header 'Content-Type'
|
925
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
926
|
+
|
927
|
+
# form parameters
|
928
|
+
form_params = {}
|
929
|
+
|
930
|
+
# http body (model)
|
931
|
+
post_body = nil
|
932
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
933
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
934
|
+
:header_params => header_params,
|
935
|
+
:query_params => query_params,
|
936
|
+
:form_params => form_params,
|
937
|
+
:body => post_body,
|
938
|
+
:auth_names => auth_names,
|
939
|
+
:return_type => 'TagListSchema')
|
940
|
+
if @api_client.config.debugging
|
941
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
942
|
+
end
|
943
|
+
return data, status_code, headers
|
944
|
+
end
|
945
|
+
# Get a list of Destinations
|
946
|
+
# 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
|
+
# @param [Hash] opts the optional parameters
|
948
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
949
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
950
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
951
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
952
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
953
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
954
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to destination_id)
|
955
|
+
# @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
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
957
|
+
# @return [DestinationListSchema]
|
958
|
+
def get_destinations(opts = {})
|
959
|
+
data, _status_code, _headers = get_destinations_with_http_info(opts)
|
960
|
+
data
|
961
|
+
end
|
962
|
+
|
963
|
+
# Get a list of Destinations
|
964
|
+
# 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.
|
965
|
+
# @param [Hash] opts the optional parameters
|
966
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
967
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
968
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
969
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
970
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
971
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
972
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
973
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
974
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
975
|
+
# @return [Array<(DestinationListSchema, Fixnum, Hash)>] DestinationListSchema data, response status code and response headers
|
976
|
+
def get_destinations_with_http_info(opts = {})
|
977
|
+
if @api_client.config.debugging
|
978
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destinations ...'
|
979
|
+
end
|
980
|
+
# resource path
|
981
|
+
local_var_path = '/dispatch/destinations'
|
982
|
+
|
983
|
+
# query parameters
|
984
|
+
query_params = {}
|
985
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
986
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
987
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
988
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
989
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
990
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
991
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
992
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
993
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
994
|
+
|
995
|
+
# header parameters
|
996
|
+
header_params = {}
|
997
|
+
# HTTP header 'Accept' (if needed)
|
998
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
999
|
+
# HTTP header 'Content-Type'
|
1000
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1001
|
+
|
1002
|
+
# form parameters
|
1003
|
+
form_params = {}
|
1004
|
+
|
1005
|
+
# http body (model)
|
1006
|
+
post_body = nil
|
1007
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1008
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1009
|
+
:header_params => header_params,
|
1010
|
+
:query_params => query_params,
|
1011
|
+
:form_params => form_params,
|
1012
|
+
:body => post_body,
|
1013
|
+
:auth_names => auth_names,
|
1014
|
+
:return_type => 'DestinationListSchema')
|
1015
|
+
if @api_client.config.debugging
|
1016
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1017
|
+
end
|
1018
|
+
return data, status_code, headers
|
1019
|
+
end
|
1020
|
+
# Get detailed information about a Dispatch
|
1021
|
+
# Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
|
1022
|
+
# @param dispatch_id Identifier for the dispatch
|
1023
|
+
# @param [Hash] opts the optional parameters
|
1024
|
+
# @return [DispatchSchema]
|
1025
|
+
def get_dispatch(dispatch_id, opts = {})
|
1026
|
+
data, _status_code, _headers = get_dispatch_with_http_info(dispatch_id, opts)
|
1027
|
+
data
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# Get detailed information about a Dispatch
|
1031
|
+
# Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
|
1032
|
+
# @param dispatch_id Identifier for the dispatch
|
1033
|
+
# @param [Hash] opts the optional parameters
|
1034
|
+
# @return [Array<(DispatchSchema, Fixnum, Hash)>] DispatchSchema data, response status code and response headers
|
1035
|
+
def get_dispatch_with_http_info(dispatch_id, opts = {})
|
1036
|
+
if @api_client.config.debugging
|
1037
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch ...'
|
1038
|
+
end
|
1039
|
+
# verify the required parameter 'dispatch_id' is set
|
1040
|
+
if dispatch_id.nil?
|
1041
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch"
|
1042
|
+
end
|
1043
|
+
# resource path
|
1044
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1045
|
+
|
1046
|
+
# query parameters
|
1047
|
+
query_params = {}
|
1048
|
+
|
1049
|
+
# header parameters
|
1050
|
+
header_params = {}
|
1051
|
+
# HTTP header 'Accept' (if needed)
|
1052
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1053
|
+
# HTTP header 'Content-Type'
|
1054
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1055
|
+
|
1056
|
+
# form parameters
|
1057
|
+
form_params = {}
|
1058
|
+
|
1059
|
+
# http body (model)
|
1060
|
+
post_body = nil
|
1061
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1062
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1063
|
+
:header_params => header_params,
|
1064
|
+
:query_params => query_params,
|
1065
|
+
:form_params => form_params,
|
1066
|
+
:body => post_body,
|
1067
|
+
:auth_names => auth_names,
|
1068
|
+
:return_type => 'DispatchSchema')
|
1069
|
+
if @api_client.config.debugging
|
1070
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1071
|
+
end
|
1072
|
+
return data, status_code, headers
|
1073
|
+
end
|
1074
|
+
# Get enabled status of a Dispatch
|
1075
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1077
|
+
# @param [Hash] opts the optional parameters
|
1078
|
+
# @return [EnabledSchema]
|
1079
|
+
def get_dispatch_enabled(dispatch_id, opts = {})
|
1080
|
+
data, _status_code, _headers = get_dispatch_enabled_with_http_info(dispatch_id, opts)
|
1081
|
+
data
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
# Get enabled status of a Dispatch
|
1085
|
+
# 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.
|
1086
|
+
# @param dispatch_id Identifier for the dispatch
|
1087
|
+
# @param [Hash] opts the optional parameters
|
1088
|
+
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
1089
|
+
def get_dispatch_enabled_with_http_info(dispatch_id, opts = {})
|
1090
|
+
if @api_client.config.debugging
|
1091
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_enabled ...'
|
1092
|
+
end
|
1093
|
+
# verify the required parameter 'dispatch_id' is set
|
1094
|
+
if dispatch_id.nil?
|
1095
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_enabled"
|
1096
|
+
end
|
1097
|
+
# resource path
|
1098
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/enabled'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1099
|
+
|
1100
|
+
# query parameters
|
1101
|
+
query_params = {}
|
1102
|
+
|
1103
|
+
# header parameters
|
1104
|
+
header_params = {}
|
1105
|
+
# HTTP header 'Accept' (if needed)
|
1106
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1107
|
+
# HTTP header 'Content-Type'
|
1108
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1109
|
+
|
1110
|
+
# form parameters
|
1111
|
+
form_params = {}
|
1112
|
+
|
1113
|
+
# http body (model)
|
1114
|
+
post_body = nil
|
1115
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1116
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1117
|
+
:header_params => header_params,
|
1118
|
+
:query_params => query_params,
|
1119
|
+
:form_params => form_params,
|
1120
|
+
:body => post_body,
|
1121
|
+
:auth_names => auth_names,
|
1122
|
+
:return_type => 'EnabledSchema')
|
1123
|
+
if @api_client.config.debugging
|
1124
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1125
|
+
end
|
1126
|
+
return data, status_code, headers
|
1127
|
+
end
|
1128
|
+
# Get user PII hashing status for a Dispatch
|
1129
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1131
|
+
# @param [Hash] opts the optional parameters
|
1132
|
+
# @return [EnabledSchema]
|
1133
|
+
def get_dispatch_hash_user_info(dispatch_id, opts = {})
|
1134
|
+
data, _status_code, _headers = get_dispatch_hash_user_info_with_http_info(dispatch_id, opts)
|
1135
|
+
data
|
1136
|
+
end
|
1137
|
+
|
1138
|
+
# Get user PII hashing status for a Dispatch
|
1139
|
+
# 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.
|
1140
|
+
# @param dispatch_id Identifier for the dispatch
|
1141
|
+
# @param [Hash] opts the optional parameters
|
1142
|
+
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
1143
|
+
def get_dispatch_hash_user_info_with_http_info(dispatch_id, opts = {})
|
1144
|
+
if @api_client.config.debugging
|
1145
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_hash_user_info ...'
|
1146
|
+
end
|
1147
|
+
# verify the required parameter 'dispatch_id' is set
|
1148
|
+
if dispatch_id.nil?
|
1149
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_hash_user_info"
|
1150
|
+
end
|
1151
|
+
# resource path
|
1152
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/hashUserInfo'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1153
|
+
|
1154
|
+
# query parameters
|
1155
|
+
query_params = {}
|
1156
|
+
|
1157
|
+
# header parameters
|
1158
|
+
header_params = {}
|
1159
|
+
# HTTP header 'Accept' (if needed)
|
1160
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1161
|
+
# HTTP header 'Content-Type'
|
1162
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1163
|
+
|
1164
|
+
# form parameters
|
1165
|
+
form_params = {}
|
1166
|
+
|
1167
|
+
# http body (model)
|
1168
|
+
post_body = nil
|
1169
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1170
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1171
|
+
:header_params => header_params,
|
1172
|
+
:query_params => query_params,
|
1173
|
+
:form_params => form_params,
|
1174
|
+
:body => post_body,
|
1175
|
+
:auth_names => auth_names,
|
1176
|
+
:return_type => 'EnabledSchema')
|
1177
|
+
if @api_client.config.debugging
|
1178
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1179
|
+
end
|
1180
|
+
return data, status_code, headers
|
1181
|
+
end
|
1182
|
+
# Get registration count for a Dispatch
|
1183
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1185
|
+
# @param [Hash] opts the optional parameters
|
1186
|
+
# @return [DispatchRegistrationCountSchema]
|
1187
|
+
def get_dispatch_registration_count(dispatch_id, opts = {})
|
1188
|
+
data, _status_code, _headers = get_dispatch_registration_count_with_http_info(dispatch_id, opts)
|
1189
|
+
data
|
1190
|
+
end
|
1191
|
+
|
1192
|
+
# Get registration count for a Dispatch
|
1193
|
+
# 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.
|
1194
|
+
# @param dispatch_id Identifier for the dispatch
|
1195
|
+
# @param [Hash] opts the optional parameters
|
1196
|
+
# @return [Array<(DispatchRegistrationCountSchema, Fixnum, Hash)>] DispatchRegistrationCountSchema data, response status code and response headers
|
1197
|
+
def get_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
|
1198
|
+
if @api_client.config.debugging
|
1199
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_registration_count ...'
|
1200
|
+
end
|
1201
|
+
# verify the required parameter 'dispatch_id' is set
|
1202
|
+
if dispatch_id.nil?
|
1203
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_registration_count"
|
1204
|
+
end
|
1205
|
+
# resource path
|
1206
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/registrationCount'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1207
|
+
|
1208
|
+
# query parameters
|
1209
|
+
query_params = {}
|
1210
|
+
|
1211
|
+
# header parameters
|
1212
|
+
header_params = {}
|
1213
|
+
# HTTP header 'Accept' (if needed)
|
1214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1215
|
+
# HTTP header 'Content-Type'
|
1216
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1217
|
+
|
1218
|
+
# form parameters
|
1219
|
+
form_params = {}
|
1220
|
+
|
1221
|
+
# http body (model)
|
1222
|
+
post_body = nil
|
1223
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1224
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1225
|
+
:header_params => header_params,
|
1226
|
+
:query_params => query_params,
|
1227
|
+
:form_params => form_params,
|
1228
|
+
:body => post_body,
|
1229
|
+
:auth_names => auth_names,
|
1230
|
+
:return_type => 'DispatchRegistrationCountSchema')
|
1231
|
+
if @api_client.config.debugging
|
1232
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1233
|
+
end
|
1234
|
+
return data, status_code, headers
|
1235
|
+
end
|
1236
|
+
# Get tags for a Dispatch
|
1237
|
+
# Returns the tags for the dispatch.
|
1238
|
+
# @param dispatch_id Identifier for the dispatch
|
1239
|
+
# @param [Hash] opts the optional parameters
|
1240
|
+
# @return [TagListSchema]
|
1241
|
+
def get_dispatch_tags(dispatch_id, opts = {})
|
1242
|
+
data, _status_code, _headers = get_dispatch_tags_with_http_info(dispatch_id, opts)
|
1243
|
+
data
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
# Get tags for a Dispatch
|
1247
|
+
# Returns the tags for the dispatch.
|
1248
|
+
# @param dispatch_id Identifier for the dispatch
|
1249
|
+
# @param [Hash] opts the optional parameters
|
1250
|
+
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
1251
|
+
def get_dispatch_tags_with_http_info(dispatch_id, opts = {})
|
1252
|
+
if @api_client.config.debugging
|
1253
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_tags ...'
|
1254
|
+
end
|
1255
|
+
# verify the required parameter 'dispatch_id' is set
|
1256
|
+
if dispatch_id.nil?
|
1257
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_tags"
|
1258
|
+
end
|
1259
|
+
# resource path
|
1260
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/tags'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1261
|
+
|
1262
|
+
# query parameters
|
1263
|
+
query_params = {}
|
1264
|
+
|
1265
|
+
# header parameters
|
1266
|
+
header_params = {}
|
1267
|
+
# HTTP header 'Accept' (if needed)
|
1268
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1269
|
+
# HTTP header 'Content-Type'
|
1270
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1271
|
+
|
1272
|
+
# form parameters
|
1273
|
+
form_params = {}
|
1274
|
+
|
1275
|
+
# http body (model)
|
1276
|
+
post_body = nil
|
1277
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1278
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1279
|
+
:header_params => header_params,
|
1280
|
+
:query_params => query_params,
|
1281
|
+
:form_params => form_params,
|
1282
|
+
:body => post_body,
|
1283
|
+
:auth_names => auth_names,
|
1284
|
+
:return_type => 'TagListSchema')
|
1285
|
+
if @api_client.config.debugging
|
1286
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1287
|
+
end
|
1288
|
+
return data, status_code, headers
|
1289
|
+
end
|
1290
|
+
# Download a zip package for a Dispatch
|
1291
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1293
|
+
# @param [Hash] opts the optional parameters
|
1294
|
+
# @option opts [String] :type The type of dispatch package to export (currently only SCORM_12 available) (default to SCORM_12)
|
1295
|
+
# @option opts [String] :css_url Custom CSS to apply to the dispatch package
|
1296
|
+
# @return [File]
|
1297
|
+
def get_dispatch_zip(dispatch_id, opts = {})
|
1298
|
+
data, _status_code, _headers = get_dispatch_zip_with_http_info(dispatch_id, opts)
|
1299
|
+
data
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
# Download a zip package for a Dispatch
|
1303
|
+
# 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.
|
1304
|
+
# @param dispatch_id Identifier for the dispatch
|
1305
|
+
# @param [Hash] opts the optional parameters
|
1306
|
+
# @option opts [String] :type The type of dispatch package to export (currently only SCORM_12 available)
|
1307
|
+
# @option opts [String] :css_url Custom CSS to apply to the dispatch package
|
1308
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
1309
|
+
def get_dispatch_zip_with_http_info(dispatch_id, opts = {})
|
1310
|
+
if @api_client.config.debugging
|
1311
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_zip ...'
|
1312
|
+
end
|
1313
|
+
# verify the required parameter 'dispatch_id' is set
|
1314
|
+
if dispatch_id.nil?
|
1315
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_zip"
|
1316
|
+
end
|
1317
|
+
# resource path
|
1318
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/zip'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1319
|
+
|
1320
|
+
# query parameters
|
1321
|
+
query_params = {}
|
1322
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
1323
|
+
query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
|
1324
|
+
|
1325
|
+
# header parameters
|
1326
|
+
header_params = {}
|
1327
|
+
# HTTP header 'Accept' (if needed)
|
1328
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
|
1329
|
+
# HTTP header 'Content-Type'
|
1330
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1331
|
+
|
1332
|
+
# form parameters
|
1333
|
+
form_params = {}
|
1334
|
+
|
1335
|
+
# http body (model)
|
1336
|
+
post_body = nil
|
1337
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1338
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1339
|
+
:header_params => header_params,
|
1340
|
+
:query_params => query_params,
|
1341
|
+
:form_params => form_params,
|
1342
|
+
:body => post_body,
|
1343
|
+
:auth_names => auth_names,
|
1344
|
+
:return_type => 'File')
|
1345
|
+
if @api_client.config.debugging
|
1346
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1347
|
+
end
|
1348
|
+
return data, status_code, headers
|
1349
|
+
end
|
1350
|
+
# Get a list of Dispatches
|
1351
|
+
# 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
|
+
# @param [Hash] opts the optional parameters
|
1353
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
1354
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1355
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1356
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
1357
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
1358
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
1359
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
1360
|
+
# @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
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
1362
|
+
# @return [DispatchListSchema]
|
1363
|
+
def get_dispatches(opts = {})
|
1364
|
+
data, _status_code, _headers = get_dispatches_with_http_info(opts)
|
1365
|
+
data
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# Get a list of Dispatches
|
1369
|
+
# 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.
|
1370
|
+
# @param [Hash] opts the optional parameters
|
1371
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
1372
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1373
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1374
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
1375
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
1376
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
1377
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
1378
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
1379
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
1380
|
+
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
1381
|
+
def get_dispatches_with_http_info(opts = {})
|
1382
|
+
if @api_client.config.debugging
|
1383
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatches ...'
|
1384
|
+
end
|
1385
|
+
# resource path
|
1386
|
+
local_var_path = '/dispatch/dispatches'
|
1387
|
+
|
1388
|
+
# query parameters
|
1389
|
+
query_params = {}
|
1390
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
1391
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1392
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
1393
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
1394
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
1395
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1396
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
1397
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
1398
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1399
|
+
|
1400
|
+
# header parameters
|
1401
|
+
header_params = {}
|
1402
|
+
# HTTP header 'Accept' (if needed)
|
1403
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1404
|
+
# HTTP header 'Content-Type'
|
1405
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1406
|
+
|
1407
|
+
# form parameters
|
1408
|
+
form_params = {}
|
1409
|
+
|
1410
|
+
# http body (model)
|
1411
|
+
post_body = nil
|
1412
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1413
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1414
|
+
:header_params => header_params,
|
1415
|
+
:query_params => query_params,
|
1416
|
+
:form_params => form_params,
|
1417
|
+
:body => post_body,
|
1418
|
+
:auth_names => auth_names,
|
1419
|
+
:return_type => 'DispatchListSchema')
|
1420
|
+
if @api_client.config.debugging
|
1421
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1422
|
+
end
|
1423
|
+
return data, status_code, headers
|
1424
|
+
end
|
1425
|
+
# Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
|
1426
|
+
# @param dispatch_id Identifier for the dispatch
|
1427
|
+
# @param [Hash] opts the optional parameters
|
1428
|
+
# @return [DispatchLtiInfoSchema]
|
1429
|
+
def get_lti_dispatch(dispatch_id, opts = {})
|
1430
|
+
data, _status_code, _headers = get_lti_dispatch_with_http_info(dispatch_id, opts)
|
1431
|
+
data
|
1432
|
+
end
|
1433
|
+
|
1434
|
+
# Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
|
1435
|
+
# @param dispatch_id Identifier for the dispatch
|
1436
|
+
# @param [Hash] opts the optional parameters
|
1437
|
+
# @return [Array<(DispatchLtiInfoSchema, Fixnum, Hash)>] DispatchLtiInfoSchema data, response status code and response headers
|
1438
|
+
def get_lti_dispatch_with_http_info(dispatch_id, opts = {})
|
1439
|
+
if @api_client.config.debugging
|
1440
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti_dispatch ...'
|
1441
|
+
end
|
1442
|
+
# verify the required parameter 'dispatch_id' is set
|
1443
|
+
if dispatch_id.nil?
|
1444
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti_dispatch"
|
1445
|
+
end
|
1446
|
+
# resource path
|
1447
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/lti'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1448
|
+
|
1449
|
+
# query parameters
|
1450
|
+
query_params = {}
|
1451
|
+
|
1452
|
+
# header parameters
|
1453
|
+
header_params = {}
|
1454
|
+
# HTTP header 'Accept' (if needed)
|
1455
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1456
|
+
# HTTP header 'Content-Type'
|
1457
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1458
|
+
|
1459
|
+
# form parameters
|
1460
|
+
form_params = {}
|
1461
|
+
|
1462
|
+
# http body (model)
|
1463
|
+
post_body = nil
|
1464
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1465
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1466
|
+
:header_params => header_params,
|
1467
|
+
:query_params => query_params,
|
1468
|
+
:form_params => form_params,
|
1469
|
+
:body => post_body,
|
1470
|
+
:auth_names => auth_names,
|
1471
|
+
:return_type => 'DispatchLtiInfoSchema')
|
1472
|
+
if @api_client.config.debugging
|
1473
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_lti_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1474
|
+
end
|
1475
|
+
return data, status_code, headers
|
1476
|
+
end
|
1477
|
+
# Add tags to a Destination
|
1478
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
1480
|
+
# @param tags
|
1481
|
+
# @param [Hash] opts the optional parameters
|
1482
|
+
# @return [nil]
|
1483
|
+
def put_destination_tags(destination_id, tags, opts = {})
|
1484
|
+
put_destination_tags_with_http_info(destination_id, tags, opts)
|
1485
|
+
nil
|
1486
|
+
end
|
1487
|
+
|
1488
|
+
# Add tags to a Destination
|
1489
|
+
# 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).
|
1490
|
+
# @param destination_id Identifier for the destination
|
1491
|
+
# @param tags
|
1492
|
+
# @param [Hash] opts the optional parameters
|
1493
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1494
|
+
def put_destination_tags_with_http_info(destination_id, tags, opts = {})
|
1495
|
+
if @api_client.config.debugging
|
1496
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags ...'
|
1497
|
+
end
|
1498
|
+
# verify the required parameter 'destination_id' is set
|
1499
|
+
if destination_id.nil?
|
1500
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.put_destination_tags"
|
1501
|
+
end
|
1502
|
+
# verify the required parameter 'tags' is set
|
1503
|
+
if tags.nil?
|
1504
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_destination_tags"
|
1505
|
+
end
|
1506
|
+
# resource path
|
1507
|
+
local_var_path = '/dispatch/destinations/{destinationId}/tags'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
1508
|
+
|
1509
|
+
# query parameters
|
1510
|
+
query_params = {}
|
1511
|
+
|
1512
|
+
# header parameters
|
1513
|
+
header_params = {}
|
1514
|
+
# HTTP header 'Accept' (if needed)
|
1515
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1516
|
+
# HTTP header 'Content-Type'
|
1517
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1518
|
+
|
1519
|
+
# form parameters
|
1520
|
+
form_params = {}
|
1521
|
+
|
1522
|
+
# http body (model)
|
1523
|
+
post_body = @api_client.object_to_http_body(tags)
|
1524
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1525
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1526
|
+
:header_params => header_params,
|
1527
|
+
:query_params => query_params,
|
1528
|
+
:form_params => form_params,
|
1529
|
+
:body => post_body,
|
1530
|
+
:auth_names => auth_names)
|
1531
|
+
if @api_client.config.debugging
|
1532
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1533
|
+
end
|
1534
|
+
return data, status_code, headers
|
1535
|
+
end
|
1536
|
+
# Add a group of tags to a group of Destinations
|
1537
|
+
# 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
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1539
|
+
# @param [Hash] opts the optional parameters
|
1540
|
+
# @return [nil]
|
1541
|
+
def put_destination_tags_batch(batch, opts = {})
|
1542
|
+
put_destination_tags_batch_with_http_info(batch, opts)
|
1543
|
+
nil
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# Add a group of tags to a group of Destinations
|
1547
|
+
# 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).
|
1548
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1549
|
+
# @param [Hash] opts the optional parameters
|
1550
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1551
|
+
def put_destination_tags_batch_with_http_info(batch, opts = {})
|
1552
|
+
if @api_client.config.debugging
|
1553
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags_batch ...'
|
1554
|
+
end
|
1555
|
+
# verify the required parameter 'batch' is set
|
1556
|
+
if batch.nil?
|
1557
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_destination_tags_batch"
|
1558
|
+
end
|
1559
|
+
# resource path
|
1560
|
+
local_var_path = '/dispatch/destinations/tags'
|
1561
|
+
|
1562
|
+
# query parameters
|
1563
|
+
query_params = {}
|
1564
|
+
|
1565
|
+
# header parameters
|
1566
|
+
header_params = {}
|
1567
|
+
# HTTP header 'Accept' (if needed)
|
1568
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1569
|
+
# HTTP header 'Content-Type'
|
1570
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1571
|
+
|
1572
|
+
# form parameters
|
1573
|
+
form_params = {}
|
1574
|
+
|
1575
|
+
# http body (model)
|
1576
|
+
post_body = @api_client.object_to_http_body(batch)
|
1577
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1578
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1579
|
+
:header_params => header_params,
|
1580
|
+
:query_params => query_params,
|
1581
|
+
:form_params => form_params,
|
1582
|
+
:body => post_body,
|
1583
|
+
:auth_names => auth_names)
|
1584
|
+
if @api_client.config.debugging
|
1585
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_destination_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1586
|
+
end
|
1587
|
+
return data, status_code, headers
|
1588
|
+
end
|
1589
|
+
# Add tags to a Dispatch
|
1590
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1592
|
+
# @param tags
|
1593
|
+
# @param [Hash] opts the optional parameters
|
1594
|
+
# @return [nil]
|
1595
|
+
def put_dispatch_tags(dispatch_id, tags, opts = {})
|
1596
|
+
put_dispatch_tags_with_http_info(dispatch_id, tags, opts)
|
1597
|
+
nil
|
1598
|
+
end
|
1599
|
+
|
1600
|
+
# Add tags to a Dispatch
|
1601
|
+
# 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).
|
1602
|
+
# @param dispatch_id Identifier for the dispatch
|
1603
|
+
# @param tags
|
1604
|
+
# @param [Hash] opts the optional parameters
|
1605
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1606
|
+
def put_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
|
1607
|
+
if @api_client.config.debugging
|
1608
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags ...'
|
1609
|
+
end
|
1610
|
+
# verify the required parameter 'dispatch_id' is set
|
1611
|
+
if dispatch_id.nil?
|
1612
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.put_dispatch_tags"
|
1613
|
+
end
|
1614
|
+
# verify the required parameter 'tags' is set
|
1615
|
+
if tags.nil?
|
1616
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_dispatch_tags"
|
1617
|
+
end
|
1618
|
+
# resource path
|
1619
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/tags'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1620
|
+
|
1621
|
+
# query parameters
|
1622
|
+
query_params = {}
|
1623
|
+
|
1624
|
+
# header parameters
|
1625
|
+
header_params = {}
|
1626
|
+
# HTTP header 'Accept' (if needed)
|
1627
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1628
|
+
# HTTP header 'Content-Type'
|
1629
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1630
|
+
|
1631
|
+
# form parameters
|
1632
|
+
form_params = {}
|
1633
|
+
|
1634
|
+
# http body (model)
|
1635
|
+
post_body = @api_client.object_to_http_body(tags)
|
1636
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1637
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1638
|
+
:header_params => header_params,
|
1639
|
+
:query_params => query_params,
|
1640
|
+
:form_params => form_params,
|
1641
|
+
:body => post_body,
|
1642
|
+
:auth_names => auth_names)
|
1643
|
+
if @api_client.config.debugging
|
1644
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1645
|
+
end
|
1646
|
+
return data, status_code, headers
|
1647
|
+
end
|
1648
|
+
# Add a group of tags to a group of Dispatches
|
1649
|
+
# 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
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1651
|
+
# @param [Hash] opts the optional parameters
|
1652
|
+
# @return [nil]
|
1653
|
+
def put_dispatch_tags_batch(batch, opts = {})
|
1654
|
+
put_dispatch_tags_batch_with_http_info(batch, opts)
|
1655
|
+
nil
|
1656
|
+
end
|
1657
|
+
|
1658
|
+
# Add a group of tags to a group of Dispatches
|
1659
|
+
# 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).
|
1660
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1661
|
+
# @param [Hash] opts the optional parameters
|
1662
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1663
|
+
def put_dispatch_tags_batch_with_http_info(batch, opts = {})
|
1664
|
+
if @api_client.config.debugging
|
1665
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags_batch ...'
|
1666
|
+
end
|
1667
|
+
# verify the required parameter 'batch' is set
|
1668
|
+
if batch.nil?
|
1669
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_dispatch_tags_batch"
|
1670
|
+
end
|
1671
|
+
# resource path
|
1672
|
+
local_var_path = '/dispatch/dispatches/tags'
|
1673
|
+
|
1674
|
+
# query parameters
|
1675
|
+
query_params = {}
|
1676
|
+
|
1677
|
+
# header parameters
|
1678
|
+
header_params = {}
|
1679
|
+
# HTTP header 'Accept' (if needed)
|
1680
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1681
|
+
# HTTP header 'Content-Type'
|
1682
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1683
|
+
|
1684
|
+
# form parameters
|
1685
|
+
form_params = {}
|
1686
|
+
|
1687
|
+
# http body (model)
|
1688
|
+
post_body = @api_client.object_to_http_body(batch)
|
1689
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1690
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1691
|
+
:header_params => header_params,
|
1692
|
+
:query_params => query_params,
|
1693
|
+
:form_params => form_params,
|
1694
|
+
:body => post_body,
|
1695
|
+
:auth_names => auth_names)
|
1696
|
+
if @api_client.config.debugging
|
1697
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_dispatch_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1698
|
+
end
|
1699
|
+
return data, status_code, headers
|
1700
|
+
end
|
1701
|
+
# Reset registration counts for a Destination's Dispatches
|
1702
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
1704
|
+
# @param [Hash] opts the optional parameters
|
1705
|
+
# @return [nil]
|
1706
|
+
def reset_destination_dispatch_registration_count(destination_id, opts = {})
|
1707
|
+
reset_destination_dispatch_registration_count_with_http_info(destination_id, opts)
|
1708
|
+
nil
|
1709
|
+
end
|
1710
|
+
|
1711
|
+
# Reset registration counts for a Destination's Dispatches
|
1712
|
+
# 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.
|
1713
|
+
# @param destination_id Identifier for the destination
|
1714
|
+
# @param [Hash] opts the optional parameters
|
1715
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1716
|
+
def reset_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
|
1717
|
+
if @api_client.config.debugging
|
1718
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.reset_destination_dispatch_registration_count ...'
|
1719
|
+
end
|
1720
|
+
# verify the required parameter 'destination_id' is set
|
1721
|
+
if destination_id.nil?
|
1722
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.reset_destination_dispatch_registration_count"
|
1723
|
+
end
|
1724
|
+
# resource path
|
1725
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/registrationCount'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
1726
|
+
|
1727
|
+
# query parameters
|
1728
|
+
query_params = {}
|
1729
|
+
|
1730
|
+
# header parameters
|
1731
|
+
header_params = {}
|
1732
|
+
# HTTP header 'Accept' (if needed)
|
1733
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1734
|
+
# HTTP header 'Content-Type'
|
1735
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1736
|
+
|
1737
|
+
# form parameters
|
1738
|
+
form_params = {}
|
1739
|
+
|
1740
|
+
# http body (model)
|
1741
|
+
post_body = nil
|
1742
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1743
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1744
|
+
:header_params => header_params,
|
1745
|
+
:query_params => query_params,
|
1746
|
+
:form_params => form_params,
|
1747
|
+
:body => post_body,
|
1748
|
+
:auth_names => auth_names)
|
1749
|
+
if @api_client.config.debugging
|
1750
|
+
@api_client.config.logger.debug "API called: DispatchApi#reset_destination_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1751
|
+
end
|
1752
|
+
return data, status_code, headers
|
1753
|
+
end
|
1754
|
+
# Reset registration count for a Dispatch
|
1755
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1757
|
+
# @param [Hash] opts the optional parameters
|
1758
|
+
# @return [nil]
|
1759
|
+
def reset_dispatch_registration_count(dispatch_id, opts = {})
|
1760
|
+
reset_dispatch_registration_count_with_http_info(dispatch_id, opts)
|
1761
|
+
nil
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# Reset registration count for a Dispatch
|
1765
|
+
# 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.
|
1766
|
+
# @param dispatch_id Identifier for the dispatch
|
1767
|
+
# @param [Hash] opts the optional parameters
|
1768
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1769
|
+
def reset_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
|
1770
|
+
if @api_client.config.debugging
|
1771
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.reset_dispatch_registration_count ...'
|
1772
|
+
end
|
1773
|
+
# verify the required parameter 'dispatch_id' is set
|
1774
|
+
if dispatch_id.nil?
|
1775
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.reset_dispatch_registration_count"
|
1776
|
+
end
|
1777
|
+
# resource path
|
1778
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/registrationCount'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1779
|
+
|
1780
|
+
# query parameters
|
1781
|
+
query_params = {}
|
1782
|
+
|
1783
|
+
# header parameters
|
1784
|
+
header_params = {}
|
1785
|
+
# HTTP header 'Accept' (if needed)
|
1786
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1787
|
+
# HTTP header 'Content-Type'
|
1788
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1789
|
+
|
1790
|
+
# form parameters
|
1791
|
+
form_params = {}
|
1792
|
+
|
1793
|
+
# http body (model)
|
1794
|
+
post_body = nil
|
1795
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1796
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1797
|
+
:header_params => header_params,
|
1798
|
+
:query_params => query_params,
|
1799
|
+
:form_params => form_params,
|
1800
|
+
:body => post_body,
|
1801
|
+
:auth_names => auth_names)
|
1802
|
+
if @api_client.config.debugging
|
1803
|
+
@api_client.config.logger.debug "API called: DispatchApi#reset_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1804
|
+
end
|
1805
|
+
return data, status_code, headers
|
1806
|
+
end
|
1807
|
+
# 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.
|
1809
|
+
# @param destination_id Identifier for the destination
|
1810
|
+
# @param destination
|
1811
|
+
# @param [Hash] opts the optional parameters
|
1812
|
+
# @return [nil]
|
1813
|
+
def set_destination(destination_id, destination, opts = {})
|
1814
|
+
set_destination_with_http_info(destination_id, destination, opts)
|
1815
|
+
nil
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# 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.
|
1820
|
+
# @param destination_id Identifier for the destination
|
1821
|
+
# @param destination
|
1822
|
+
# @param [Hash] opts the optional parameters
|
1823
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1824
|
+
def set_destination_with_http_info(destination_id, destination, opts = {})
|
1825
|
+
if @api_client.config.debugging
|
1826
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.set_destination ...'
|
1827
|
+
end
|
1828
|
+
# verify the required parameter 'destination_id' is set
|
1829
|
+
if destination_id.nil?
|
1830
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination"
|
1831
|
+
end
|
1832
|
+
# verify the required parameter 'destination' is set
|
1833
|
+
if destination.nil?
|
1834
|
+
fail ArgumentError, "Missing the required parameter 'destination' when calling DispatchApi.set_destination"
|
1835
|
+
end
|
1836
|
+
# resource path
|
1837
|
+
local_var_path = '/dispatch/destinations/{destinationId}'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
1838
|
+
|
1839
|
+
# query parameters
|
1840
|
+
query_params = {}
|
1841
|
+
|
1842
|
+
# header parameters
|
1843
|
+
header_params = {}
|
1844
|
+
# HTTP header 'Accept' (if needed)
|
1845
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1846
|
+
# HTTP header 'Content-Type'
|
1847
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1848
|
+
|
1849
|
+
# form parameters
|
1850
|
+
form_params = {}
|
1851
|
+
|
1852
|
+
# http body (model)
|
1853
|
+
post_body = @api_client.object_to_http_body(destination)
|
1854
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1855
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1856
|
+
:header_params => header_params,
|
1857
|
+
:query_params => query_params,
|
1858
|
+
:form_params => form_params,
|
1859
|
+
:body => post_body,
|
1860
|
+
:auth_names => auth_names)
|
1861
|
+
if @api_client.config.debugging
|
1862
|
+
@api_client.config.logger.debug "API called: DispatchApi#set_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1863
|
+
end
|
1864
|
+
return data, status_code, headers
|
1865
|
+
end
|
1866
|
+
# Update enabled status for a Destination's Dispatches
|
1867
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
1869
|
+
# @param enabled
|
1870
|
+
# @param [Hash] opts the optional parameters
|
1871
|
+
# @return [nil]
|
1872
|
+
def set_destination_dispatch_enabled(destination_id, enabled, opts = {})
|
1873
|
+
set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts)
|
1874
|
+
nil
|
1875
|
+
end
|
1876
|
+
|
1877
|
+
# Update enabled status for a Destination's Dispatches
|
1878
|
+
# 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.
|
1879
|
+
# @param destination_id Identifier for the destination
|
1880
|
+
# @param enabled
|
1881
|
+
# @param [Hash] opts the optional parameters
|
1882
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1883
|
+
def set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts = {})
|
1884
|
+
if @api_client.config.debugging
|
1885
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.set_destination_dispatch_enabled ...'
|
1886
|
+
end
|
1887
|
+
# verify the required parameter 'destination_id' is set
|
1888
|
+
if destination_id.nil?
|
1889
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination_dispatch_enabled"
|
1890
|
+
end
|
1891
|
+
# verify the required parameter 'enabled' is set
|
1892
|
+
if enabled.nil?
|
1893
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_destination_dispatch_enabled"
|
1894
|
+
end
|
1895
|
+
# resource path
|
1896
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/enabled'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
1897
|
+
|
1898
|
+
# query parameters
|
1899
|
+
query_params = {}
|
1900
|
+
|
1901
|
+
# header parameters
|
1902
|
+
header_params = {}
|
1903
|
+
# HTTP header 'Accept' (if needed)
|
1904
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1905
|
+
# HTTP header 'Content-Type'
|
1906
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1907
|
+
|
1908
|
+
# form parameters
|
1909
|
+
form_params = {}
|
1910
|
+
|
1911
|
+
# http body (model)
|
1912
|
+
post_body = @api_client.object_to_http_body(enabled)
|
1913
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1914
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1915
|
+
:header_params => header_params,
|
1916
|
+
:query_params => query_params,
|
1917
|
+
:form_params => form_params,
|
1918
|
+
:body => post_body,
|
1919
|
+
:auth_names => auth_names)
|
1920
|
+
if @api_client.config.debugging
|
1921
|
+
@api_client.config.logger.debug "API called: DispatchApi#set_destination_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1922
|
+
end
|
1923
|
+
return data, status_code, headers
|
1924
|
+
end
|
1925
|
+
# Update enabled status for a Dispatch
|
1926
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
1928
|
+
# @param enabled
|
1929
|
+
# @param [Hash] opts the optional parameters
|
1930
|
+
# @return [nil]
|
1931
|
+
def set_dispatch_enabled(dispatch_id, enabled, opts = {})
|
1932
|
+
set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts)
|
1933
|
+
nil
|
1934
|
+
end
|
1935
|
+
|
1936
|
+
# Update enabled status for a Dispatch
|
1937
|
+
# 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.
|
1938
|
+
# @param dispatch_id Identifier for the dispatch
|
1939
|
+
# @param enabled
|
1940
|
+
# @param [Hash] opts the optional parameters
|
1941
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1942
|
+
def set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts = {})
|
1943
|
+
if @api_client.config.debugging
|
1944
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.set_dispatch_enabled ...'
|
1945
|
+
end
|
1946
|
+
# verify the required parameter 'dispatch_id' is set
|
1947
|
+
if dispatch_id.nil?
|
1948
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.set_dispatch_enabled"
|
1949
|
+
end
|
1950
|
+
# verify the required parameter 'enabled' is set
|
1951
|
+
if enabled.nil?
|
1952
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_dispatch_enabled"
|
1953
|
+
end
|
1954
|
+
# resource path
|
1955
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/enabled'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1956
|
+
|
1957
|
+
# query parameters
|
1958
|
+
query_params = {}
|
1959
|
+
|
1960
|
+
# header parameters
|
1961
|
+
header_params = {}
|
1962
|
+
# HTTP header 'Accept' (if needed)
|
1963
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1964
|
+
# HTTP header 'Content-Type'
|
1965
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1966
|
+
|
1967
|
+
# form parameters
|
1968
|
+
form_params = {}
|
1969
|
+
|
1970
|
+
# http body (model)
|
1971
|
+
post_body = @api_client.object_to_http_body(enabled)
|
1972
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1973
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1974
|
+
:header_params => header_params,
|
1975
|
+
:query_params => query_params,
|
1976
|
+
:form_params => form_params,
|
1977
|
+
:body => post_body,
|
1978
|
+
:auth_names => auth_names)
|
1979
|
+
if @api_client.config.debugging
|
1980
|
+
@api_client.config.logger.debug "API called: DispatchApi#set_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1981
|
+
end
|
1982
|
+
return data, status_code, headers
|
1983
|
+
end
|
1984
|
+
# Update user PII hashing status for a Destination
|
1985
|
+
# 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
|
+
# @param destination_id Identifier for the destination
|
1987
|
+
# @param enabled
|
1988
|
+
# @param [Hash] opts the optional parameters
|
1989
|
+
# @return [nil]
|
1990
|
+
def update_destination_hash_user_info(destination_id, enabled, opts = {})
|
1991
|
+
update_destination_hash_user_info_with_http_info(destination_id, enabled, opts)
|
1992
|
+
nil
|
1993
|
+
end
|
1994
|
+
|
1995
|
+
# Update user PII hashing status for a Destination
|
1996
|
+
# 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.
|
1997
|
+
# @param destination_id Identifier for the destination
|
1998
|
+
# @param enabled
|
1999
|
+
# @param [Hash] opts the optional parameters
|
2000
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2001
|
+
def update_destination_hash_user_info_with_http_info(destination_id, enabled, opts = {})
|
2002
|
+
if @api_client.config.debugging
|
2003
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.update_destination_hash_user_info ...'
|
2004
|
+
end
|
2005
|
+
# verify the required parameter 'destination_id' is set
|
2006
|
+
if destination_id.nil?
|
2007
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.update_destination_hash_user_info"
|
2008
|
+
end
|
2009
|
+
# verify the required parameter 'enabled' is set
|
2010
|
+
if enabled.nil?
|
2011
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_destination_hash_user_info"
|
2012
|
+
end
|
2013
|
+
# resource path
|
2014
|
+
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/hashUserInfo'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
2015
|
+
|
2016
|
+
# query parameters
|
2017
|
+
query_params = {}
|
2018
|
+
|
2019
|
+
# header parameters
|
2020
|
+
header_params = {}
|
2021
|
+
# HTTP header 'Accept' (if needed)
|
2022
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2023
|
+
# HTTP header 'Content-Type'
|
2024
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2025
|
+
|
2026
|
+
# form parameters
|
2027
|
+
form_params = {}
|
2028
|
+
|
2029
|
+
# http body (model)
|
2030
|
+
post_body = @api_client.object_to_http_body(enabled)
|
2031
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
2032
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2033
|
+
:header_params => header_params,
|
2034
|
+
:query_params => query_params,
|
2035
|
+
:form_params => form_params,
|
2036
|
+
:body => post_body,
|
2037
|
+
:auth_names => auth_names)
|
2038
|
+
if @api_client.config.debugging
|
2039
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_destination_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2040
|
+
end
|
2041
|
+
return data, status_code, headers
|
2042
|
+
end
|
2043
|
+
# Update information about a Dispatch
|
2044
|
+
# Updates information about the dispatch, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
2045
|
+
# @param dispatch_id Identifier for the dispatch
|
2046
|
+
# @param dispatch_properties
|
2047
|
+
# @param [Hash] opts the optional parameters
|
2048
|
+
# @return [nil]
|
2049
|
+
def update_dispatch(dispatch_id, dispatch_properties, opts = {})
|
2050
|
+
update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts)
|
2051
|
+
nil
|
2052
|
+
end
|
2053
|
+
|
2054
|
+
# Update information about a Dispatch
|
2055
|
+
# Updates information about the dispatch, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
2056
|
+
# @param dispatch_id Identifier for the dispatch
|
2057
|
+
# @param dispatch_properties
|
2058
|
+
# @param [Hash] opts the optional parameters
|
2059
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2060
|
+
def update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts = {})
|
2061
|
+
if @api_client.config.debugging
|
2062
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch ...'
|
2063
|
+
end
|
2064
|
+
# verify the required parameter 'dispatch_id' is set
|
2065
|
+
if dispatch_id.nil?
|
2066
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch"
|
2067
|
+
end
|
2068
|
+
# verify the required parameter 'dispatch_properties' is set
|
2069
|
+
if dispatch_properties.nil?
|
2070
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatch"
|
2071
|
+
end
|
2072
|
+
# resource path
|
2073
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
2074
|
+
|
2075
|
+
# query parameters
|
2076
|
+
query_params = {}
|
2077
|
+
|
2078
|
+
# header parameters
|
2079
|
+
header_params = {}
|
2080
|
+
# HTTP header 'Accept' (if needed)
|
2081
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2082
|
+
# HTTP header 'Content-Type'
|
2083
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2084
|
+
|
2085
|
+
# form parameters
|
2086
|
+
form_params = {}
|
2087
|
+
|
2088
|
+
# http body (model)
|
2089
|
+
post_body = @api_client.object_to_http_body(dispatch_properties)
|
2090
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
2091
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2092
|
+
:header_params => header_params,
|
2093
|
+
:query_params => query_params,
|
2094
|
+
:form_params => form_params,
|
2095
|
+
:body => post_body,
|
2096
|
+
:auth_names => auth_names)
|
2097
|
+
if @api_client.config.debugging
|
2098
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2099
|
+
end
|
2100
|
+
return data, status_code, headers
|
2101
|
+
end
|
2102
|
+
# Update user PII hashing status for a Dispatch
|
2103
|
+
# 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
|
+
# @param dispatch_id Identifier for the dispatch
|
2105
|
+
# @param enabled
|
2106
|
+
# @param [Hash] opts the optional parameters
|
2107
|
+
# @return [nil]
|
2108
|
+
def update_dispatch_hash_user_info(dispatch_id, enabled, opts = {})
|
2109
|
+
update_dispatch_hash_user_info_with_http_info(dispatch_id, enabled, opts)
|
2110
|
+
nil
|
2111
|
+
end
|
2112
|
+
|
2113
|
+
# Update user PII hashing status for a Dispatch
|
2114
|
+
# 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.
|
2115
|
+
# @param dispatch_id Identifier for the dispatch
|
2116
|
+
# @param enabled
|
2117
|
+
# @param [Hash] opts the optional parameters
|
2118
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2119
|
+
def update_dispatch_hash_user_info_with_http_info(dispatch_id, enabled, opts = {})
|
2120
|
+
if @api_client.config.debugging
|
2121
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch_hash_user_info ...'
|
2122
|
+
end
|
2123
|
+
# verify the required parameter 'dispatch_id' is set
|
2124
|
+
if dispatch_id.nil?
|
2125
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch_hash_user_info"
|
2126
|
+
end
|
2127
|
+
# verify the required parameter 'enabled' is set
|
2128
|
+
if enabled.nil?
|
2129
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_dispatch_hash_user_info"
|
2130
|
+
end
|
2131
|
+
# resource path
|
2132
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/hashUserInfo'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
2133
|
+
|
2134
|
+
# query parameters
|
2135
|
+
query_params = {}
|
2136
|
+
|
2137
|
+
# header parameters
|
2138
|
+
header_params = {}
|
2139
|
+
# HTTP header 'Accept' (if needed)
|
2140
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2141
|
+
# HTTP header 'Content-Type'
|
2142
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2143
|
+
|
2144
|
+
# form parameters
|
2145
|
+
form_params = {}
|
2146
|
+
|
2147
|
+
# http body (model)
|
2148
|
+
post_body = @api_client.object_to_http_body(enabled)
|
2149
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
2150
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2151
|
+
:header_params => header_params,
|
2152
|
+
:query_params => query_params,
|
2153
|
+
:form_params => form_params,
|
2154
|
+
:body => post_body,
|
2155
|
+
:auth_names => auth_names)
|
2156
|
+
if @api_client.config.debugging
|
2157
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_dispatch_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2158
|
+
end
|
2159
|
+
return data, status_code, headers
|
2160
|
+
end
|
2161
|
+
# Update a group of Dispatches
|
2162
|
+
# 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
|
+
# @param dispatch_properties
|
2164
|
+
# @param [Hash] opts the optional parameters
|
2165
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
2166
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2167
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2168
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
2169
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
2170
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
2171
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
2172
|
+
# @return [nil]
|
2173
|
+
def update_dispatches(dispatch_properties, opts = {})
|
2174
|
+
update_dispatches_with_http_info(dispatch_properties, opts)
|
2175
|
+
nil
|
2176
|
+
end
|
2177
|
+
|
2178
|
+
# Update a group of Dispatches
|
2179
|
+
# 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.
|
2180
|
+
# @param dispatch_properties
|
2181
|
+
# @param [Hash] opts the optional parameters
|
2182
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
2183
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2184
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2185
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
2186
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
2187
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
2188
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
2189
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2190
|
+
def update_dispatches_with_http_info(dispatch_properties, opts = {})
|
2191
|
+
if @api_client.config.debugging
|
2192
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatches ...'
|
2193
|
+
end
|
2194
|
+
# verify the required parameter 'dispatch_properties' is set
|
2195
|
+
if dispatch_properties.nil?
|
2196
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatches"
|
2197
|
+
end
|
2198
|
+
# resource path
|
2199
|
+
local_var_path = '/dispatch/dispatches'
|
2200
|
+
|
2201
|
+
# query parameters
|
2202
|
+
query_params = {}
|
2203
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
2204
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2205
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
2206
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
2207
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
2208
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2209
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
2210
|
+
|
2211
|
+
# header parameters
|
2212
|
+
header_params = {}
|
2213
|
+
# HTTP header 'Accept' (if needed)
|
2214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2215
|
+
# HTTP header 'Content-Type'
|
2216
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2217
|
+
|
2218
|
+
# form parameters
|
2219
|
+
form_params = {}
|
2220
|
+
|
2221
|
+
# http body (model)
|
2222
|
+
post_body = @api_client.object_to_http_body(dispatch_properties)
|
2223
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
2224
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2225
|
+
:header_params => header_params,
|
2226
|
+
:query_params => query_params,
|
2227
|
+
:form_params => form_params,
|
2228
|
+
:body => post_body,
|
2229
|
+
:auth_names => auth_names)
|
2230
|
+
if @api_client.config.debugging
|
2231
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2232
|
+
end
|
2233
|
+
return data, status_code, headers
|
2234
|
+
end
|
2235
|
+
end
|
2236
|
+
end
|