rustici_software_cloud_v2 1.0.0beta → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/README.md +194 -88
- data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +161 -97
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +13 -13
- data/lib/rustici_software_cloud_v2/api/course_api.rb +246 -260
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +1994 -0
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +964 -0
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +296 -0
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +10 -8
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +379 -324
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +555 -0
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +448 -0
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -3
- data/lib/rustici_software_cloud_v2/api_error.rb +1 -2
- data/lib/rustici_software_cloud_v2/configuration.rb +9 -19
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +17 -14
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/application_token.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +29 -23
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +225 -0
- data/lib/rustici_software_cloud_v2/models/{link_schema.rb → create_dispatch_list_schema.rb} +22 -21
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +308 -0
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +254 -0
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +252 -0
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +15 -11
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +197 -0
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +200 -0
- data/lib/rustici_software_cloud_v2/models/{setting_metadata_valid_values.rb → destination_schema.rb} +42 -31
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +290 -0
- data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +24 -11
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +253 -0
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +227 -0
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +19 -16
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +17 -8
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +23 -20
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +28 -20
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +33 -20
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +266 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +289 -0
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +5 -14
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +24 -9
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +5 -14
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +259 -0
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +214 -0
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/response_error.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +19 -16
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +15 -12
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +15 -12
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +14 -10
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +258 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +236 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +214 -0
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +14 -12
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +18 -15
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +220 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +220 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +252 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +266 -0
- data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → xapi_credentials_list_schema.rb} +30 -31
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +241 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/version.rb +2 -3
- data/lib/rustici_software_cloud_v2.rb +50 -6
- data/rustici_software_cloud_v2.gemspec +10 -11
- data/spec/api_client_spec.rb +1 -13
- data/spec/configuration_spec.rb +9 -10
- data/spec/spec_helper.rb +1 -13
- metadata +107 -271
- 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/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,1994 @@
|
|
|
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
|
+
|
|
10
|
+
=end
|
|
11
|
+
|
|
12
|
+
require "uri"
|
|
13
|
+
|
|
14
|
+
module RusticiSoftwareCloudV2
|
|
15
|
+
class DispatchApi
|
|
16
|
+
attr_accessor :api_client
|
|
17
|
+
|
|
18
|
+
def initialize(api_client = ApiClient.default)
|
|
19
|
+
@api_client = api_client
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# DestinationsByTenant
|
|
23
|
+
# Create multiple destinations.
|
|
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
|
+
return nil
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# DestinationsByTenant
|
|
33
|
+
# Create multiple destinations.
|
|
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
|
+
fail ArgumentError, "Missing the required parameter 'destinations_list' when calling DispatchApi.create_destinations" if destinations_list.nil?
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = "/dispatch/destinations".sub('{format}','json')
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
53
|
+
# HTTP header 'Content-Type'
|
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = @api_client.object_to_http_body(destinations_list)
|
|
61
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
62
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
63
|
+
:header_params => header_params,
|
|
64
|
+
:query_params => query_params,
|
|
65
|
+
:form_params => form_params,
|
|
66
|
+
:body => post_body,
|
|
67
|
+
:auth_names => auth_names)
|
|
68
|
+
if @api_client.config.debugging
|
|
69
|
+
@api_client.config.logger.debug "API called: DispatchApi#create_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
70
|
+
end
|
|
71
|
+
return data, status_code, headers
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Create dispatches.
|
|
75
|
+
# Create multiple dispatches at once.
|
|
76
|
+
# @param dispatch_list
|
|
77
|
+
# @param [Hash] opts the optional parameters
|
|
78
|
+
# @return [nil]
|
|
79
|
+
def create_dispatches(dispatch_list, opts = {})
|
|
80
|
+
create_dispatches_with_http_info(dispatch_list, opts)
|
|
81
|
+
return nil
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Create dispatches.
|
|
85
|
+
# Create multiple dispatches at once.
|
|
86
|
+
# @param dispatch_list
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
89
|
+
def create_dispatches_with_http_info(dispatch_list, opts = {})
|
|
90
|
+
if @api_client.config.debugging
|
|
91
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.create_dispatches ..."
|
|
92
|
+
end
|
|
93
|
+
# verify the required parameter 'dispatch_list' is set
|
|
94
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_list' when calling DispatchApi.create_dispatches" if dispatch_list.nil?
|
|
95
|
+
# resource path
|
|
96
|
+
local_var_path = "/dispatch/dispatches".sub('{format}','json')
|
|
97
|
+
|
|
98
|
+
# query parameters
|
|
99
|
+
query_params = {}
|
|
100
|
+
|
|
101
|
+
# header parameters
|
|
102
|
+
header_params = {}
|
|
103
|
+
# HTTP header 'Accept' (if needed)
|
|
104
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
105
|
+
# HTTP header 'Content-Type'
|
|
106
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
107
|
+
|
|
108
|
+
# form parameters
|
|
109
|
+
form_params = {}
|
|
110
|
+
|
|
111
|
+
# http body (model)
|
|
112
|
+
post_body = @api_client.object_to_http_body(dispatch_list)
|
|
113
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
114
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
115
|
+
:header_params => header_params,
|
|
116
|
+
:query_params => query_params,
|
|
117
|
+
:form_params => form_params,
|
|
118
|
+
:body => post_body,
|
|
119
|
+
:auth_names => auth_names)
|
|
120
|
+
if @api_client.config.debugging
|
|
121
|
+
@api_client.config.logger.debug "API called: DispatchApi#create_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
122
|
+
end
|
|
123
|
+
return data, status_code, headers
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# Delete destination
|
|
127
|
+
# Delete the destination with `destinationId`
|
|
128
|
+
# @param destination_id Identifier for the destination
|
|
129
|
+
# @param [Hash] opts the optional parameters
|
|
130
|
+
# @return [nil]
|
|
131
|
+
def delete_destination(destination_id, opts = {})
|
|
132
|
+
delete_destination_with_http_info(destination_id, opts)
|
|
133
|
+
return nil
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# Delete destination
|
|
137
|
+
# Delete the destination with `destinationId`
|
|
138
|
+
# @param destination_id Identifier for the destination
|
|
139
|
+
# @param [Hash] opts the optional parameters
|
|
140
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
141
|
+
def delete_destination_with_http_info(destination_id, opts = {})
|
|
142
|
+
if @api_client.config.debugging
|
|
143
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.delete_destination ..."
|
|
144
|
+
end
|
|
145
|
+
# verify the required parameter 'destination_id' is set
|
|
146
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination" if destination_id.nil?
|
|
147
|
+
# resource path
|
|
148
|
+
local_var_path = "/dispatch/destinations/{destinationId}".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
149
|
+
|
|
150
|
+
# query parameters
|
|
151
|
+
query_params = {}
|
|
152
|
+
|
|
153
|
+
# header parameters
|
|
154
|
+
header_params = {}
|
|
155
|
+
# HTTP header 'Accept' (if needed)
|
|
156
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
157
|
+
# HTTP header 'Content-Type'
|
|
158
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
159
|
+
|
|
160
|
+
# form parameters
|
|
161
|
+
form_params = {}
|
|
162
|
+
|
|
163
|
+
# http body (model)
|
|
164
|
+
post_body = nil
|
|
165
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
166
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
167
|
+
:header_params => header_params,
|
|
168
|
+
:query_params => query_params,
|
|
169
|
+
:form_params => form_params,
|
|
170
|
+
:body => post_body,
|
|
171
|
+
:auth_names => auth_names)
|
|
172
|
+
if @api_client.config.debugging
|
|
173
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
174
|
+
end
|
|
175
|
+
return data, status_code, headers
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
# Delete dispatches in destination
|
|
179
|
+
# Delete the dispatches in a destination
|
|
180
|
+
# @param destination_id Identifier for the destination
|
|
181
|
+
# @param [Hash] opts the optional parameters
|
|
182
|
+
# @return [nil]
|
|
183
|
+
def delete_destination_dispatches(destination_id, opts = {})
|
|
184
|
+
delete_destination_dispatches_with_http_info(destination_id, opts)
|
|
185
|
+
return nil
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# Delete dispatches in destination
|
|
189
|
+
# Delete the dispatches in a destination
|
|
190
|
+
# @param destination_id Identifier for the destination
|
|
191
|
+
# @param [Hash] opts the optional parameters
|
|
192
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
193
|
+
def delete_destination_dispatches_with_http_info(destination_id, opts = {})
|
|
194
|
+
if @api_client.config.debugging
|
|
195
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.delete_destination_dispatches ..."
|
|
196
|
+
end
|
|
197
|
+
# verify the required parameter 'destination_id' is set
|
|
198
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_dispatches" if destination_id.nil?
|
|
199
|
+
# resource path
|
|
200
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
201
|
+
|
|
202
|
+
# query parameters
|
|
203
|
+
query_params = {}
|
|
204
|
+
|
|
205
|
+
# header parameters
|
|
206
|
+
header_params = {}
|
|
207
|
+
# HTTP header 'Accept' (if needed)
|
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
209
|
+
# HTTP header 'Content-Type'
|
|
210
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
211
|
+
|
|
212
|
+
# form parameters
|
|
213
|
+
form_params = {}
|
|
214
|
+
|
|
215
|
+
# http body (model)
|
|
216
|
+
post_body = nil
|
|
217
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
218
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
219
|
+
:header_params => header_params,
|
|
220
|
+
:query_params => query_params,
|
|
221
|
+
:form_params => form_params,
|
|
222
|
+
:body => post_body,
|
|
223
|
+
:auth_names => auth_names)
|
|
224
|
+
if @api_client.config.debugging
|
|
225
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_destination_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
226
|
+
end
|
|
227
|
+
return data, status_code, headers
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# Delete the tags for this destination
|
|
231
|
+
# Delete the tags for this destination
|
|
232
|
+
# @param destination_id Identifier for the destination
|
|
233
|
+
# @param tags
|
|
234
|
+
# @param [Hash] opts the optional parameters
|
|
235
|
+
# @return [nil]
|
|
236
|
+
def delete_destination_tags(destination_id, tags, opts = {})
|
|
237
|
+
delete_destination_tags_with_http_info(destination_id, tags, opts)
|
|
238
|
+
return nil
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Delete the tags for this destination
|
|
242
|
+
# Delete the tags for this destination
|
|
243
|
+
# @param destination_id Identifier for the destination
|
|
244
|
+
# @param tags
|
|
245
|
+
# @param [Hash] opts the optional parameters
|
|
246
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
247
|
+
def delete_destination_tags_with_http_info(destination_id, tags, opts = {})
|
|
248
|
+
if @api_client.config.debugging
|
|
249
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.delete_destination_tags ..."
|
|
250
|
+
end
|
|
251
|
+
# verify the required parameter 'destination_id' is set
|
|
252
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_tags" if destination_id.nil?
|
|
253
|
+
# verify the required parameter 'tags' is set
|
|
254
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_destination_tags" if tags.nil?
|
|
255
|
+
# resource path
|
|
256
|
+
local_var_path = "/dispatch/destinations/{destinationId}/tags".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
257
|
+
|
|
258
|
+
# query parameters
|
|
259
|
+
query_params = {}
|
|
260
|
+
|
|
261
|
+
# header parameters
|
|
262
|
+
header_params = {}
|
|
263
|
+
# HTTP header 'Accept' (if needed)
|
|
264
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
265
|
+
# HTTP header 'Content-Type'
|
|
266
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
267
|
+
|
|
268
|
+
# form parameters
|
|
269
|
+
form_params = {}
|
|
270
|
+
|
|
271
|
+
# http body (model)
|
|
272
|
+
post_body = @api_client.object_to_http_body(tags)
|
|
273
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
274
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
275
|
+
:header_params => header_params,
|
|
276
|
+
:query_params => query_params,
|
|
277
|
+
:form_params => form_params,
|
|
278
|
+
:body => post_body,
|
|
279
|
+
:auth_names => auth_names)
|
|
280
|
+
if @api_client.config.debugging
|
|
281
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
282
|
+
end
|
|
283
|
+
return data, status_code, headers
|
|
284
|
+
end
|
|
285
|
+
|
|
286
|
+
# Delete the dispatch with `dispatchId`.
|
|
287
|
+
# Delete the dispatch with `dispatchId`.
|
|
288
|
+
# @param dispatch_id Identifier for the dispatch
|
|
289
|
+
# @param [Hash] opts the optional parameters
|
|
290
|
+
# @return [nil]
|
|
291
|
+
def delete_dispatch(dispatch_id, opts = {})
|
|
292
|
+
delete_dispatch_with_http_info(dispatch_id, opts)
|
|
293
|
+
return nil
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
# Delete the dispatch with `dispatchId`.
|
|
297
|
+
# Delete the dispatch with `dispatchId`.
|
|
298
|
+
# @param dispatch_id Identifier for the dispatch
|
|
299
|
+
# @param [Hash] opts the optional parameters
|
|
300
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
301
|
+
def delete_dispatch_with_http_info(dispatch_id, opts = {})
|
|
302
|
+
if @api_client.config.debugging
|
|
303
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.delete_dispatch ..."
|
|
304
|
+
end
|
|
305
|
+
# verify the required parameter 'dispatch_id' is set
|
|
306
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch" if dispatch_id.nil?
|
|
307
|
+
# resource path
|
|
308
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
309
|
+
|
|
310
|
+
# query parameters
|
|
311
|
+
query_params = {}
|
|
312
|
+
|
|
313
|
+
# header parameters
|
|
314
|
+
header_params = {}
|
|
315
|
+
# HTTP header 'Accept' (if needed)
|
|
316
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
317
|
+
# HTTP header 'Content-Type'
|
|
318
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
319
|
+
|
|
320
|
+
# form parameters
|
|
321
|
+
form_params = {}
|
|
322
|
+
|
|
323
|
+
# http body (model)
|
|
324
|
+
post_body = nil
|
|
325
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
326
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
327
|
+
:header_params => header_params,
|
|
328
|
+
:query_params => query_params,
|
|
329
|
+
:form_params => form_params,
|
|
330
|
+
:body => post_body,
|
|
331
|
+
:auth_names => auth_names)
|
|
332
|
+
if @api_client.config.debugging
|
|
333
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
334
|
+
end
|
|
335
|
+
return data, status_code, headers
|
|
336
|
+
end
|
|
337
|
+
|
|
338
|
+
# DispatchesByTenantAndDispatchId
|
|
339
|
+
# Delete the postback info dispatch with 'dispatchId'.
|
|
340
|
+
# @param dispatch_id Identifier for the dispatch
|
|
341
|
+
# @param [Hash] opts the optional parameters
|
|
342
|
+
# @return [nil]
|
|
343
|
+
def delete_dispatch_postback_info(dispatch_id, opts = {})
|
|
344
|
+
delete_dispatch_postback_info_with_http_info(dispatch_id, opts)
|
|
345
|
+
return nil
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
# DispatchesByTenantAndDispatchId
|
|
349
|
+
# Delete the postback info dispatch with 'dispatchId'.
|
|
350
|
+
# @param dispatch_id Identifier for the dispatch
|
|
351
|
+
# @param [Hash] opts the optional parameters
|
|
352
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
353
|
+
def delete_dispatch_postback_info_with_http_info(dispatch_id, opts = {})
|
|
354
|
+
if @api_client.config.debugging
|
|
355
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.delete_dispatch_postback_info ..."
|
|
356
|
+
end
|
|
357
|
+
# verify the required parameter 'dispatch_id' is set
|
|
358
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_postback_info" if dispatch_id.nil?
|
|
359
|
+
# resource path
|
|
360
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/postback".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
361
|
+
|
|
362
|
+
# query parameters
|
|
363
|
+
query_params = {}
|
|
364
|
+
|
|
365
|
+
# header parameters
|
|
366
|
+
header_params = {}
|
|
367
|
+
# HTTP header 'Accept' (if needed)
|
|
368
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
369
|
+
# HTTP header 'Content-Type'
|
|
370
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
371
|
+
|
|
372
|
+
# form parameters
|
|
373
|
+
form_params = {}
|
|
374
|
+
|
|
375
|
+
# http body (model)
|
|
376
|
+
post_body = nil
|
|
377
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
378
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
379
|
+
:header_params => header_params,
|
|
380
|
+
:query_params => query_params,
|
|
381
|
+
:form_params => form_params,
|
|
382
|
+
:body => post_body,
|
|
383
|
+
:auth_names => auth_names)
|
|
384
|
+
if @api_client.config.debugging
|
|
385
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatch_postback_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
386
|
+
end
|
|
387
|
+
return data, status_code, headers
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# Delete the tags for this dispatch.
|
|
391
|
+
# Delete the tags for this dispatch.
|
|
392
|
+
# @param dispatch_id Identifier for the dispatch
|
|
393
|
+
# @param tags
|
|
394
|
+
# @param [Hash] opts the optional parameters
|
|
395
|
+
# @return [nil]
|
|
396
|
+
def delete_dispatch_tags(dispatch_id, tags, opts = {})
|
|
397
|
+
delete_dispatch_tags_with_http_info(dispatch_id, tags, opts)
|
|
398
|
+
return nil
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
# Delete the tags for this dispatch.
|
|
402
|
+
# Delete the tags for this dispatch.
|
|
403
|
+
# @param dispatch_id Identifier for the dispatch
|
|
404
|
+
# @param tags
|
|
405
|
+
# @param [Hash] opts the optional parameters
|
|
406
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
407
|
+
def delete_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
|
|
408
|
+
if @api_client.config.debugging
|
|
409
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.delete_dispatch_tags ..."
|
|
410
|
+
end
|
|
411
|
+
# verify the required parameter 'dispatch_id' is set
|
|
412
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_tags" if dispatch_id.nil?
|
|
413
|
+
# verify the required parameter 'tags' is set
|
|
414
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_dispatch_tags" if tags.nil?
|
|
415
|
+
# resource path
|
|
416
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/tags".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
417
|
+
|
|
418
|
+
# query parameters
|
|
419
|
+
query_params = {}
|
|
420
|
+
|
|
421
|
+
# header parameters
|
|
422
|
+
header_params = {}
|
|
423
|
+
# HTTP header 'Accept' (if needed)
|
|
424
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
425
|
+
# HTTP header 'Content-Type'
|
|
426
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
427
|
+
|
|
428
|
+
# form parameters
|
|
429
|
+
form_params = {}
|
|
430
|
+
|
|
431
|
+
# http body (model)
|
|
432
|
+
post_body = @api_client.object_to_http_body(tags)
|
|
433
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
434
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
435
|
+
:header_params => header_params,
|
|
436
|
+
:query_params => query_params,
|
|
437
|
+
:form_params => form_params,
|
|
438
|
+
:body => post_body,
|
|
439
|
+
:auth_names => auth_names)
|
|
440
|
+
if @api_client.config.debugging
|
|
441
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
442
|
+
end
|
|
443
|
+
return data, status_code, headers
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
# DestinationsDispatchesRegistrationInstancing
|
|
447
|
+
# Enable or disable registration instancing.
|
|
448
|
+
# @param destination_id Identifier for the destination
|
|
449
|
+
# @param enabled
|
|
450
|
+
# @param [Hash] opts the optional parameters
|
|
451
|
+
# @return [nil]
|
|
452
|
+
def enable_registration_instancing(destination_id, enabled, opts = {})
|
|
453
|
+
enable_registration_instancing_with_http_info(destination_id, enabled, opts)
|
|
454
|
+
return nil
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
# DestinationsDispatchesRegistrationInstancing
|
|
458
|
+
# Enable or disable registration instancing.
|
|
459
|
+
# @param destination_id Identifier for the destination
|
|
460
|
+
# @param enabled
|
|
461
|
+
# @param [Hash] opts the optional parameters
|
|
462
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
463
|
+
def enable_registration_instancing_with_http_info(destination_id, enabled, opts = {})
|
|
464
|
+
if @api_client.config.debugging
|
|
465
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.enable_registration_instancing ..."
|
|
466
|
+
end
|
|
467
|
+
# verify the required parameter 'destination_id' is set
|
|
468
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.enable_registration_instancing" if destination_id.nil?
|
|
469
|
+
# verify the required parameter 'enabled' is set
|
|
470
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.enable_registration_instancing" if enabled.nil?
|
|
471
|
+
# resource path
|
|
472
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/registrationInstancing".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
473
|
+
|
|
474
|
+
# query parameters
|
|
475
|
+
query_params = {}
|
|
476
|
+
|
|
477
|
+
# header parameters
|
|
478
|
+
header_params = {}
|
|
479
|
+
# HTTP header 'Accept' (if needed)
|
|
480
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
481
|
+
# HTTP header 'Content-Type'
|
|
482
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
483
|
+
|
|
484
|
+
# form parameters
|
|
485
|
+
form_params = {}
|
|
486
|
+
|
|
487
|
+
# http body (model)
|
|
488
|
+
post_body = @api_client.object_to_http_body(enabled)
|
|
489
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
490
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
491
|
+
:header_params => header_params,
|
|
492
|
+
:query_params => query_params,
|
|
493
|
+
:form_params => form_params,
|
|
494
|
+
:body => post_body,
|
|
495
|
+
:auth_names => auth_names)
|
|
496
|
+
if @api_client.config.debugging
|
|
497
|
+
@api_client.config.logger.debug "API called: DispatchApi#enable_registration_instancing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
498
|
+
end
|
|
499
|
+
return data, status_code, headers
|
|
500
|
+
end
|
|
501
|
+
|
|
502
|
+
# Get destination information by destinationId.
|
|
503
|
+
# Gets detailed information about a destination belonging to a destinationId.
|
|
504
|
+
# @param destination_id Identifier for the destination
|
|
505
|
+
# @param [Hash] opts the optional parameters
|
|
506
|
+
# @return [DestinationSchema]
|
|
507
|
+
def get_destination(destination_id, opts = {})
|
|
508
|
+
data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
|
|
509
|
+
return data
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
# Get destination information by destinationId.
|
|
513
|
+
# Gets detailed information about a destination belonging to a destinationId.
|
|
514
|
+
# @param destination_id Identifier for the destination
|
|
515
|
+
# @param [Hash] opts the optional parameters
|
|
516
|
+
# @return [Array<(DestinationSchema, Fixnum, Hash)>] DestinationSchema data, response status code and response headers
|
|
517
|
+
def get_destination_with_http_info(destination_id, opts = {})
|
|
518
|
+
if @api_client.config.debugging
|
|
519
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destination ..."
|
|
520
|
+
end
|
|
521
|
+
# verify the required parameter 'destination_id' is set
|
|
522
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination" if destination_id.nil?
|
|
523
|
+
# resource path
|
|
524
|
+
local_var_path = "/dispatch/destinations/{destinationId}".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
525
|
+
|
|
526
|
+
# query parameters
|
|
527
|
+
query_params = {}
|
|
528
|
+
|
|
529
|
+
# header parameters
|
|
530
|
+
header_params = {}
|
|
531
|
+
# HTTP header 'Accept' (if needed)
|
|
532
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
533
|
+
# HTTP header 'Content-Type'
|
|
534
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
535
|
+
|
|
536
|
+
# form parameters
|
|
537
|
+
form_params = {}
|
|
538
|
+
|
|
539
|
+
# http body (model)
|
|
540
|
+
post_body = nil
|
|
541
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
542
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
543
|
+
:header_params => header_params,
|
|
544
|
+
:query_params => query_params,
|
|
545
|
+
:form_params => form_params,
|
|
546
|
+
:body => post_body,
|
|
547
|
+
:auth_names => auth_names,
|
|
548
|
+
:return_type => 'DestinationSchema')
|
|
549
|
+
if @api_client.config.debugging
|
|
550
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
551
|
+
end
|
|
552
|
+
return data, status_code, headers
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
# DestinationsDispatchesRegistrationCount
|
|
556
|
+
# Get an aggregate count of all related dispatch registrations.
|
|
557
|
+
# @param destination_id Identifier for the destination
|
|
558
|
+
# @param [Hash] opts the optional parameters
|
|
559
|
+
# @return [IntegerResultSchema]
|
|
560
|
+
def get_destination_dispatch_registration_count(destination_id, opts = {})
|
|
561
|
+
data, _status_code, _headers = get_destination_dispatch_registration_count_with_http_info(destination_id, opts)
|
|
562
|
+
return data
|
|
563
|
+
end
|
|
564
|
+
|
|
565
|
+
# DestinationsDispatchesRegistrationCount
|
|
566
|
+
# Get an aggregate count of all related dispatch registrations.
|
|
567
|
+
# @param destination_id Identifier for the destination
|
|
568
|
+
# @param [Hash] opts the optional parameters
|
|
569
|
+
# @return [Array<(IntegerResultSchema, Fixnum, Hash)>] IntegerResultSchema data, response status code and response headers
|
|
570
|
+
def get_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
|
|
571
|
+
if @api_client.config.debugging
|
|
572
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destination_dispatch_registration_count ..."
|
|
573
|
+
end
|
|
574
|
+
# verify the required parameter 'destination_id' is set
|
|
575
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_registration_count" if destination_id.nil?
|
|
576
|
+
# resource path
|
|
577
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/registrationCount".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
578
|
+
|
|
579
|
+
# query parameters
|
|
580
|
+
query_params = {}
|
|
581
|
+
|
|
582
|
+
# header parameters
|
|
583
|
+
header_params = {}
|
|
584
|
+
# HTTP header 'Accept' (if needed)
|
|
585
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
586
|
+
# HTTP header 'Content-Type'
|
|
587
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
588
|
+
|
|
589
|
+
# form parameters
|
|
590
|
+
form_params = {}
|
|
591
|
+
|
|
592
|
+
# http body (model)
|
|
593
|
+
post_body = nil
|
|
594
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
595
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
596
|
+
:header_params => header_params,
|
|
597
|
+
:query_params => query_params,
|
|
598
|
+
:form_params => form_params,
|
|
599
|
+
:body => post_body,
|
|
600
|
+
:auth_names => auth_names,
|
|
601
|
+
:return_type => 'IntegerResultSchema')
|
|
602
|
+
if @api_client.config.debugging
|
|
603
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
604
|
+
end
|
|
605
|
+
return data, status_code, headers
|
|
606
|
+
end
|
|
607
|
+
|
|
608
|
+
# Get a ZIP of related dispatches.
|
|
609
|
+
# Returns a zip file containing all of the dispatch packages for a destination.
|
|
610
|
+
# @param destination_id Identifier for the destination
|
|
611
|
+
# @param [Hash] opts the optional parameters
|
|
612
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM12 only supported in cloud today) (default to SCORM12)
|
|
613
|
+
# @option opts [String] :css_url
|
|
614
|
+
# @option opts [Array<String>] :tags
|
|
615
|
+
# @return [File]
|
|
616
|
+
def get_destination_dispatch_zip(destination_id, opts = {})
|
|
617
|
+
data, _status_code, _headers = get_destination_dispatch_zip_with_http_info(destination_id, opts)
|
|
618
|
+
return data
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# Get a ZIP of related dispatches.
|
|
622
|
+
# Returns a zip file containing all of the dispatch packages for a destination.
|
|
623
|
+
# @param destination_id Identifier for the destination
|
|
624
|
+
# @param [Hash] opts the optional parameters
|
|
625
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM12 only supported in cloud today)
|
|
626
|
+
# @option opts [String] :css_url
|
|
627
|
+
# @option opts [Array<String>] :tags
|
|
628
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
|
629
|
+
def get_destination_dispatch_zip_with_http_info(destination_id, opts = {})
|
|
630
|
+
if @api_client.config.debugging
|
|
631
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destination_dispatch_zip ..."
|
|
632
|
+
end
|
|
633
|
+
# verify the required parameter 'destination_id' is set
|
|
634
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_zip" if destination_id.nil?
|
|
635
|
+
if opts[:'type'] && !['SCORM12'].include?(opts[:'type'])
|
|
636
|
+
fail ArgumentError, 'invalid value for "type", must be one of SCORM12'
|
|
637
|
+
end
|
|
638
|
+
# resource path
|
|
639
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/zip".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
640
|
+
|
|
641
|
+
# query parameters
|
|
642
|
+
query_params = {}
|
|
643
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
644
|
+
query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
|
|
645
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
646
|
+
|
|
647
|
+
# header parameters
|
|
648
|
+
header_params = {}
|
|
649
|
+
# HTTP header 'Accept' (if needed)
|
|
650
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
|
|
651
|
+
# HTTP header 'Content-Type'
|
|
652
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
653
|
+
|
|
654
|
+
# form parameters
|
|
655
|
+
form_params = {}
|
|
656
|
+
|
|
657
|
+
# http body (model)
|
|
658
|
+
post_body = nil
|
|
659
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
660
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
661
|
+
:header_params => header_params,
|
|
662
|
+
:query_params => query_params,
|
|
663
|
+
:form_params => form_params,
|
|
664
|
+
:body => post_body,
|
|
665
|
+
:auth_names => auth_names,
|
|
666
|
+
:return_type => 'File')
|
|
667
|
+
if @api_client.config.debugging
|
|
668
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatch_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
669
|
+
end
|
|
670
|
+
return data, status_code, headers
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
# Get a list of dispatches in this destination
|
|
674
|
+
# Get a list of related dispatches.
|
|
675
|
+
# @param destination_id Identifier for the destination
|
|
676
|
+
# @param [Hash] opts the optional parameters
|
|
677
|
+
# @option opts [String] :course_id Only retreive resources having `courseId`
|
|
678
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
679
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
680
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
681
|
+
# @option opts [Array<String>] :tags
|
|
682
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`. (default to updated)
|
|
683
|
+
# @option opts [String] :order_by
|
|
684
|
+
# @return [DispatchListSchema]
|
|
685
|
+
def get_destination_dispatches(destination_id, opts = {})
|
|
686
|
+
data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
|
|
687
|
+
return data
|
|
688
|
+
end
|
|
689
|
+
|
|
690
|
+
# Get a list of dispatches in this destination
|
|
691
|
+
# Get a list of related dispatches.
|
|
692
|
+
# @param destination_id Identifier for the destination
|
|
693
|
+
# @param [Hash] opts the optional parameters
|
|
694
|
+
# @option opts [String] :course_id Only retreive resources having `courseId`
|
|
695
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
696
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
697
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
698
|
+
# @option opts [Array<String>] :tags
|
|
699
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`.
|
|
700
|
+
# @option opts [String] :order_by
|
|
701
|
+
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
|
702
|
+
def get_destination_dispatches_with_http_info(destination_id, opts = {})
|
|
703
|
+
if @api_client.config.debugging
|
|
704
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destination_dispatches ..."
|
|
705
|
+
end
|
|
706
|
+
# verify the required parameter 'destination_id' is set
|
|
707
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatches" if destination_id.nil?
|
|
708
|
+
if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
|
709
|
+
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
|
710
|
+
end
|
|
711
|
+
if opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
|
|
712
|
+
fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
|
|
713
|
+
end
|
|
714
|
+
# resource path
|
|
715
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
716
|
+
|
|
717
|
+
# query parameters
|
|
718
|
+
query_params = {}
|
|
719
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
720
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
721
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
722
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
723
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
724
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
725
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
726
|
+
|
|
727
|
+
# header parameters
|
|
728
|
+
header_params = {}
|
|
729
|
+
# HTTP header 'Accept' (if needed)
|
|
730
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
731
|
+
# HTTP header 'Content-Type'
|
|
732
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
733
|
+
|
|
734
|
+
# form parameters
|
|
735
|
+
form_params = {}
|
|
736
|
+
|
|
737
|
+
# http body (model)
|
|
738
|
+
post_body = nil
|
|
739
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
740
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
741
|
+
:header_params => header_params,
|
|
742
|
+
:query_params => query_params,
|
|
743
|
+
:form_params => form_params,
|
|
744
|
+
:body => post_body,
|
|
745
|
+
:auth_names => auth_names,
|
|
746
|
+
:return_type => 'DispatchListSchema')
|
|
747
|
+
if @api_client.config.debugging
|
|
748
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
749
|
+
end
|
|
750
|
+
return data, status_code, headers
|
|
751
|
+
end
|
|
752
|
+
|
|
753
|
+
# True if the destination is set to hash user info, or false if it is disabled.
|
|
754
|
+
# True if the destination is set to hash user info, or false if it is disabled.
|
|
755
|
+
# @param destination_id Identifier for the destination
|
|
756
|
+
# @param [Hash] opts the optional parameters
|
|
757
|
+
# @return [EnabledSchema]
|
|
758
|
+
def get_destination_hash_user_info(destination_id, opts = {})
|
|
759
|
+
data, _status_code, _headers = get_destination_hash_user_info_with_http_info(destination_id, opts)
|
|
760
|
+
return data
|
|
761
|
+
end
|
|
762
|
+
|
|
763
|
+
# True if the destination is set to hash user info, or false if it is disabled.
|
|
764
|
+
# True if the destination is set to hash user info, or false if it is disabled.
|
|
765
|
+
# @param destination_id Identifier for the destination
|
|
766
|
+
# @param [Hash] opts the optional parameters
|
|
767
|
+
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
|
768
|
+
def get_destination_hash_user_info_with_http_info(destination_id, opts = {})
|
|
769
|
+
if @api_client.config.debugging
|
|
770
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destination_hash_user_info ..."
|
|
771
|
+
end
|
|
772
|
+
# verify the required parameter 'destination_id' is set
|
|
773
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_hash_user_info" if destination_id.nil?
|
|
774
|
+
# resource path
|
|
775
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/hashUserInfo".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
776
|
+
|
|
777
|
+
# query parameters
|
|
778
|
+
query_params = {}
|
|
779
|
+
|
|
780
|
+
# header parameters
|
|
781
|
+
header_params = {}
|
|
782
|
+
# HTTP header 'Accept' (if needed)
|
|
783
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
784
|
+
# HTTP header 'Content-Type'
|
|
785
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
786
|
+
|
|
787
|
+
# form parameters
|
|
788
|
+
form_params = {}
|
|
789
|
+
|
|
790
|
+
# http body (model)
|
|
791
|
+
post_body = nil
|
|
792
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
793
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
794
|
+
:header_params => header_params,
|
|
795
|
+
:query_params => query_params,
|
|
796
|
+
:form_params => form_params,
|
|
797
|
+
:body => post_body,
|
|
798
|
+
:auth_names => auth_names,
|
|
799
|
+
:return_type => 'EnabledSchema')
|
|
800
|
+
if @api_client.config.debugging
|
|
801
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
802
|
+
end
|
|
803
|
+
return data, status_code, headers
|
|
804
|
+
end
|
|
805
|
+
|
|
806
|
+
# Get the tags for this destination
|
|
807
|
+
# Get the tags for this destination
|
|
808
|
+
# @param destination_id Identifier for the destination
|
|
809
|
+
# @param [Hash] opts the optional parameters
|
|
810
|
+
# @return [TagListSchema]
|
|
811
|
+
def get_destination_tags(destination_id, opts = {})
|
|
812
|
+
data, _status_code, _headers = get_destination_tags_with_http_info(destination_id, opts)
|
|
813
|
+
return data
|
|
814
|
+
end
|
|
815
|
+
|
|
816
|
+
# Get the tags for this destination
|
|
817
|
+
# Get the tags for this destination
|
|
818
|
+
# @param destination_id Identifier for the destination
|
|
819
|
+
# @param [Hash] opts the optional parameters
|
|
820
|
+
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
|
821
|
+
def get_destination_tags_with_http_info(destination_id, opts = {})
|
|
822
|
+
if @api_client.config.debugging
|
|
823
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destination_tags ..."
|
|
824
|
+
end
|
|
825
|
+
# verify the required parameter 'destination_id' is set
|
|
826
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_tags" if destination_id.nil?
|
|
827
|
+
# resource path
|
|
828
|
+
local_var_path = "/dispatch/destinations/{destinationId}/tags".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
829
|
+
|
|
830
|
+
# query parameters
|
|
831
|
+
query_params = {}
|
|
832
|
+
|
|
833
|
+
# header parameters
|
|
834
|
+
header_params = {}
|
|
835
|
+
# HTTP header 'Accept' (if needed)
|
|
836
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
837
|
+
# HTTP header 'Content-Type'
|
|
838
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
839
|
+
|
|
840
|
+
# form parameters
|
|
841
|
+
form_params = {}
|
|
842
|
+
|
|
843
|
+
# http body (model)
|
|
844
|
+
post_body = nil
|
|
845
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
846
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
847
|
+
:header_params => header_params,
|
|
848
|
+
:query_params => query_params,
|
|
849
|
+
:form_params => form_params,
|
|
850
|
+
:body => post_body,
|
|
851
|
+
:auth_names => auth_names,
|
|
852
|
+
:return_type => 'TagListSchema')
|
|
853
|
+
if @api_client.config.debugging
|
|
854
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
855
|
+
end
|
|
856
|
+
return data, status_code, headers
|
|
857
|
+
end
|
|
858
|
+
|
|
859
|
+
# getAllDestinations
|
|
860
|
+
# Get a list of destinations.
|
|
861
|
+
# @param [Hash] opts the optional parameters
|
|
862
|
+
# @option opts [String] :course_id Only retreive resources having `courseId`
|
|
863
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
864
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
865
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
866
|
+
# @option opts [Array<String>] :tags
|
|
867
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`. (default to updated)
|
|
868
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc (default to updated_asc)
|
|
869
|
+
# @return [DestinationListSchema]
|
|
870
|
+
def get_destinations(opts = {})
|
|
871
|
+
data, _status_code, _headers = get_destinations_with_http_info(opts)
|
|
872
|
+
return data
|
|
873
|
+
end
|
|
874
|
+
|
|
875
|
+
# getAllDestinations
|
|
876
|
+
# Get a list of destinations.
|
|
877
|
+
# @param [Hash] opts the optional parameters
|
|
878
|
+
# @option opts [String] :course_id Only retreive resources having `courseId`
|
|
879
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
880
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
881
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
882
|
+
# @option opts [Array<String>] :tags
|
|
883
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`.
|
|
884
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc
|
|
885
|
+
# @return [Array<(DestinationListSchema, Fixnum, Hash)>] DestinationListSchema data, response status code and response headers
|
|
886
|
+
def get_destinations_with_http_info(opts = {})
|
|
887
|
+
if @api_client.config.debugging
|
|
888
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_destinations ..."
|
|
889
|
+
end
|
|
890
|
+
if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
|
891
|
+
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
|
892
|
+
end
|
|
893
|
+
if opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
|
|
894
|
+
fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
|
|
895
|
+
end
|
|
896
|
+
# resource path
|
|
897
|
+
local_var_path = "/dispatch/destinations".sub('{format}','json')
|
|
898
|
+
|
|
899
|
+
# query parameters
|
|
900
|
+
query_params = {}
|
|
901
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
902
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
903
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
904
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
905
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
906
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
907
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
908
|
+
|
|
909
|
+
# header parameters
|
|
910
|
+
header_params = {}
|
|
911
|
+
# HTTP header 'Accept' (if needed)
|
|
912
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
913
|
+
# HTTP header 'Content-Type'
|
|
914
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
915
|
+
|
|
916
|
+
# form parameters
|
|
917
|
+
form_params = {}
|
|
918
|
+
|
|
919
|
+
# http body (model)
|
|
920
|
+
post_body = nil
|
|
921
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
922
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
923
|
+
:header_params => header_params,
|
|
924
|
+
:query_params => query_params,
|
|
925
|
+
:form_params => form_params,
|
|
926
|
+
:body => post_body,
|
|
927
|
+
:auth_names => auth_names,
|
|
928
|
+
:return_type => 'DestinationListSchema')
|
|
929
|
+
if @api_client.config.debugging
|
|
930
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
931
|
+
end
|
|
932
|
+
return data, status_code, headers
|
|
933
|
+
end
|
|
934
|
+
|
|
935
|
+
# Get dispatch by id.
|
|
936
|
+
# Get the dispatch with `dispatchId`.
|
|
937
|
+
# @param dispatch_id Identifier for the dispatch
|
|
938
|
+
# @param [Hash] opts the optional parameters
|
|
939
|
+
# @return [DispatchSchema]
|
|
940
|
+
def get_dispatch(dispatch_id, opts = {})
|
|
941
|
+
data, _status_code, _headers = get_dispatch_with_http_info(dispatch_id, opts)
|
|
942
|
+
return data
|
|
943
|
+
end
|
|
944
|
+
|
|
945
|
+
# Get dispatch by id.
|
|
946
|
+
# Get the dispatch with `dispatchId`.
|
|
947
|
+
# @param dispatch_id Identifier for the dispatch
|
|
948
|
+
# @param [Hash] opts the optional parameters
|
|
949
|
+
# @return [Array<(DispatchSchema, Fixnum, Hash)>] DispatchSchema data, response status code and response headers
|
|
950
|
+
def get_dispatch_with_http_info(dispatch_id, opts = {})
|
|
951
|
+
if @api_client.config.debugging
|
|
952
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatch ..."
|
|
953
|
+
end
|
|
954
|
+
# verify the required parameter 'dispatch_id' is set
|
|
955
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch" if dispatch_id.nil?
|
|
956
|
+
# resource path
|
|
957
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
958
|
+
|
|
959
|
+
# query parameters
|
|
960
|
+
query_params = {}
|
|
961
|
+
|
|
962
|
+
# header parameters
|
|
963
|
+
header_params = {}
|
|
964
|
+
# HTTP header 'Accept' (if needed)
|
|
965
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
966
|
+
# HTTP header 'Content-Type'
|
|
967
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
968
|
+
|
|
969
|
+
# form parameters
|
|
970
|
+
form_params = {}
|
|
971
|
+
|
|
972
|
+
# http body (model)
|
|
973
|
+
post_body = nil
|
|
974
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
975
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
976
|
+
:header_params => header_params,
|
|
977
|
+
:query_params => query_params,
|
|
978
|
+
:form_params => form_params,
|
|
979
|
+
:body => post_body,
|
|
980
|
+
:auth_names => auth_names,
|
|
981
|
+
:return_type => 'DispatchSchema')
|
|
982
|
+
if @api_client.config.debugging
|
|
983
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
984
|
+
end
|
|
985
|
+
return data, status_code, headers
|
|
986
|
+
end
|
|
987
|
+
|
|
988
|
+
# Get the `enabled` status for `dispatchId`.
|
|
989
|
+
# Get the `enabled` status for `dispatchId`. True if the dispatch is enabled, or false if it is disabled.
|
|
990
|
+
# @param dispatch_id Identifier for the dispatch
|
|
991
|
+
# @param [Hash] opts the optional parameters
|
|
992
|
+
# @return [EnabledSchema]
|
|
993
|
+
def get_dispatch_enabled(dispatch_id, opts = {})
|
|
994
|
+
data, _status_code, _headers = get_dispatch_enabled_with_http_info(dispatch_id, opts)
|
|
995
|
+
return data
|
|
996
|
+
end
|
|
997
|
+
|
|
998
|
+
# Get the `enabled` status for `dispatchId`.
|
|
999
|
+
# Get the `enabled` status for `dispatchId`. True if the dispatch is enabled, or false if it is disabled.
|
|
1000
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1001
|
+
# @param [Hash] opts the optional parameters
|
|
1002
|
+
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
|
1003
|
+
def get_dispatch_enabled_with_http_info(dispatch_id, opts = {})
|
|
1004
|
+
if @api_client.config.debugging
|
|
1005
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatch_enabled ..."
|
|
1006
|
+
end
|
|
1007
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1008
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_enabled" if dispatch_id.nil?
|
|
1009
|
+
# resource path
|
|
1010
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/enabled".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1011
|
+
|
|
1012
|
+
# query parameters
|
|
1013
|
+
query_params = {}
|
|
1014
|
+
|
|
1015
|
+
# header parameters
|
|
1016
|
+
header_params = {}
|
|
1017
|
+
# HTTP header 'Accept' (if needed)
|
|
1018
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1019
|
+
# HTTP header 'Content-Type'
|
|
1020
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1021
|
+
|
|
1022
|
+
# form parameters
|
|
1023
|
+
form_params = {}
|
|
1024
|
+
|
|
1025
|
+
# http body (model)
|
|
1026
|
+
post_body = nil
|
|
1027
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1028
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1029
|
+
:header_params => header_params,
|
|
1030
|
+
:query_params => query_params,
|
|
1031
|
+
:form_params => form_params,
|
|
1032
|
+
:body => post_body,
|
|
1033
|
+
:auth_names => auth_names,
|
|
1034
|
+
:return_type => 'EnabledSchema')
|
|
1035
|
+
if @api_client.config.debugging
|
|
1036
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1037
|
+
end
|
|
1038
|
+
return data, status_code, headers
|
|
1039
|
+
end
|
|
1040
|
+
|
|
1041
|
+
# Get if this dispatch has PII hashing enabled.
|
|
1042
|
+
# Get if this dispatch has PII hashing enabled. True if the dispatch is set to hash user info, or false if it is disabled.
|
|
1043
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1044
|
+
# @param [Hash] opts the optional parameters
|
|
1045
|
+
# @return [EnabledSchema]
|
|
1046
|
+
def get_dispatch_hash_user_info(dispatch_id, opts = {})
|
|
1047
|
+
data, _status_code, _headers = get_dispatch_hash_user_info_with_http_info(dispatch_id, opts)
|
|
1048
|
+
return data
|
|
1049
|
+
end
|
|
1050
|
+
|
|
1051
|
+
# Get if this dispatch has PII hashing enabled.
|
|
1052
|
+
# Get if this dispatch has PII hashing enabled. True if the dispatch is set to hash user info, or false if it is disabled.
|
|
1053
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1054
|
+
# @param [Hash] opts the optional parameters
|
|
1055
|
+
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
|
1056
|
+
def get_dispatch_hash_user_info_with_http_info(dispatch_id, opts = {})
|
|
1057
|
+
if @api_client.config.debugging
|
|
1058
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatch_hash_user_info ..."
|
|
1059
|
+
end
|
|
1060
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1061
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_hash_user_info" if dispatch_id.nil?
|
|
1062
|
+
# resource path
|
|
1063
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/hashUserInfo".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1064
|
+
|
|
1065
|
+
# query parameters
|
|
1066
|
+
query_params = {}
|
|
1067
|
+
|
|
1068
|
+
# header parameters
|
|
1069
|
+
header_params = {}
|
|
1070
|
+
# HTTP header 'Accept' (if needed)
|
|
1071
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1072
|
+
# HTTP header 'Content-Type'
|
|
1073
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1074
|
+
|
|
1075
|
+
# form parameters
|
|
1076
|
+
form_params = {}
|
|
1077
|
+
|
|
1078
|
+
# http body (model)
|
|
1079
|
+
post_body = nil
|
|
1080
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1081
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1082
|
+
:header_params => header_params,
|
|
1083
|
+
:query_params => query_params,
|
|
1084
|
+
:form_params => form_params,
|
|
1085
|
+
:body => post_body,
|
|
1086
|
+
:auth_names => auth_names,
|
|
1087
|
+
:return_type => 'EnabledSchema')
|
|
1088
|
+
if @api_client.config.debugging
|
|
1089
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1090
|
+
end
|
|
1091
|
+
return data, status_code, headers
|
|
1092
|
+
end
|
|
1093
|
+
|
|
1094
|
+
# Get the registration count for `dispatchId`.
|
|
1095
|
+
# Get the registration count for this dispatch, and the date and time of the last count reset, if any.
|
|
1096
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1097
|
+
# @param [Hash] opts the optional parameters
|
|
1098
|
+
# @return [DispatchRegistrationCountSchema]
|
|
1099
|
+
def get_dispatch_registration_count(dispatch_id, opts = {})
|
|
1100
|
+
data, _status_code, _headers = get_dispatch_registration_count_with_http_info(dispatch_id, opts)
|
|
1101
|
+
return data
|
|
1102
|
+
end
|
|
1103
|
+
|
|
1104
|
+
# Get the registration count for `dispatchId`.
|
|
1105
|
+
# Get the registration count for this dispatch, and the date and time of the last count reset, if any.
|
|
1106
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1107
|
+
# @param [Hash] opts the optional parameters
|
|
1108
|
+
# @return [Array<(DispatchRegistrationCountSchema, Fixnum, Hash)>] DispatchRegistrationCountSchema data, response status code and response headers
|
|
1109
|
+
def get_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
|
|
1110
|
+
if @api_client.config.debugging
|
|
1111
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatch_registration_count ..."
|
|
1112
|
+
end
|
|
1113
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1114
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_registration_count" if dispatch_id.nil?
|
|
1115
|
+
# resource path
|
|
1116
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/registrationCount".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1117
|
+
|
|
1118
|
+
# query parameters
|
|
1119
|
+
query_params = {}
|
|
1120
|
+
|
|
1121
|
+
# header parameters
|
|
1122
|
+
header_params = {}
|
|
1123
|
+
# HTTP header 'Accept' (if needed)
|
|
1124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1125
|
+
# HTTP header 'Content-Type'
|
|
1126
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1127
|
+
|
|
1128
|
+
# form parameters
|
|
1129
|
+
form_params = {}
|
|
1130
|
+
|
|
1131
|
+
# http body (model)
|
|
1132
|
+
post_body = nil
|
|
1133
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1134
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1135
|
+
:header_params => header_params,
|
|
1136
|
+
:query_params => query_params,
|
|
1137
|
+
:form_params => form_params,
|
|
1138
|
+
:body => post_body,
|
|
1139
|
+
:auth_names => auth_names,
|
|
1140
|
+
:return_type => 'DispatchRegistrationCountSchema')
|
|
1141
|
+
if @api_client.config.debugging
|
|
1142
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1143
|
+
end
|
|
1144
|
+
return data, status_code, headers
|
|
1145
|
+
end
|
|
1146
|
+
|
|
1147
|
+
# Get the tags for this dispatch.
|
|
1148
|
+
# Get the tags for this dispatch.
|
|
1149
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1150
|
+
# @param [Hash] opts the optional parameters
|
|
1151
|
+
# @return [TagListSchema]
|
|
1152
|
+
def get_dispatch_tags(dispatch_id, opts = {})
|
|
1153
|
+
data, _status_code, _headers = get_dispatch_tags_with_http_info(dispatch_id, opts)
|
|
1154
|
+
return data
|
|
1155
|
+
end
|
|
1156
|
+
|
|
1157
|
+
# Get the tags for this dispatch.
|
|
1158
|
+
# Get the tags for this dispatch.
|
|
1159
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1160
|
+
# @param [Hash] opts the optional parameters
|
|
1161
|
+
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
|
1162
|
+
def get_dispatch_tags_with_http_info(dispatch_id, opts = {})
|
|
1163
|
+
if @api_client.config.debugging
|
|
1164
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatch_tags ..."
|
|
1165
|
+
end
|
|
1166
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1167
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_tags" if dispatch_id.nil?
|
|
1168
|
+
# resource path
|
|
1169
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/tags".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1170
|
+
|
|
1171
|
+
# query parameters
|
|
1172
|
+
query_params = {}
|
|
1173
|
+
|
|
1174
|
+
# header parameters
|
|
1175
|
+
header_params = {}
|
|
1176
|
+
# HTTP header 'Accept' (if needed)
|
|
1177
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1178
|
+
# HTTP header 'Content-Type'
|
|
1179
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1180
|
+
|
|
1181
|
+
# form parameters
|
|
1182
|
+
form_params = {}
|
|
1183
|
+
|
|
1184
|
+
# http body (model)
|
|
1185
|
+
post_body = nil
|
|
1186
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1187
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1188
|
+
:header_params => header_params,
|
|
1189
|
+
:query_params => query_params,
|
|
1190
|
+
:form_params => form_params,
|
|
1191
|
+
:body => post_body,
|
|
1192
|
+
:auth_names => auth_names,
|
|
1193
|
+
:return_type => 'TagListSchema')
|
|
1194
|
+
if @api_client.config.debugging
|
|
1195
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1196
|
+
end
|
|
1197
|
+
return data, status_code, headers
|
|
1198
|
+
end
|
|
1199
|
+
|
|
1200
|
+
# Get the ZIP for the dispatchId.
|
|
1201
|
+
# Get the ZIP for the dispatch with `dispatchId`
|
|
1202
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1203
|
+
# @param [Hash] opts the optional parameters
|
|
1204
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM12 only supported in cloud today) (default to SCORM12)
|
|
1205
|
+
# @option opts [String] :css_url
|
|
1206
|
+
# @return [File]
|
|
1207
|
+
def get_dispatch_zip(dispatch_id, opts = {})
|
|
1208
|
+
data, _status_code, _headers = get_dispatch_zip_with_http_info(dispatch_id, opts)
|
|
1209
|
+
return data
|
|
1210
|
+
end
|
|
1211
|
+
|
|
1212
|
+
# Get the ZIP for the dispatchId.
|
|
1213
|
+
# Get the ZIP for the dispatch with `dispatchId`
|
|
1214
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1215
|
+
# @param [Hash] opts the optional parameters
|
|
1216
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM12 only supported in cloud today)
|
|
1217
|
+
# @option opts [String] :css_url
|
|
1218
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
|
1219
|
+
def get_dispatch_zip_with_http_info(dispatch_id, opts = {})
|
|
1220
|
+
if @api_client.config.debugging
|
|
1221
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatch_zip ..."
|
|
1222
|
+
end
|
|
1223
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1224
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_zip" if dispatch_id.nil?
|
|
1225
|
+
if opts[:'type'] && !['SCORM12'].include?(opts[:'type'])
|
|
1226
|
+
fail ArgumentError, 'invalid value for "type", must be one of SCORM12'
|
|
1227
|
+
end
|
|
1228
|
+
# resource path
|
|
1229
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/zip".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1230
|
+
|
|
1231
|
+
# query parameters
|
|
1232
|
+
query_params = {}
|
|
1233
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
1234
|
+
query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
|
|
1235
|
+
|
|
1236
|
+
# header parameters
|
|
1237
|
+
header_params = {}
|
|
1238
|
+
# HTTP header 'Accept' (if needed)
|
|
1239
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
|
|
1240
|
+
# HTTP header 'Content-Type'
|
|
1241
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1242
|
+
|
|
1243
|
+
# form parameters
|
|
1244
|
+
form_params = {}
|
|
1245
|
+
|
|
1246
|
+
# http body (model)
|
|
1247
|
+
post_body = nil
|
|
1248
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1249
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1250
|
+
:header_params => header_params,
|
|
1251
|
+
:query_params => query_params,
|
|
1252
|
+
:form_params => form_params,
|
|
1253
|
+
:body => post_body,
|
|
1254
|
+
:auth_names => auth_names,
|
|
1255
|
+
:return_type => 'File')
|
|
1256
|
+
if @api_client.config.debugging
|
|
1257
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatch_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1258
|
+
end
|
|
1259
|
+
return data, status_code, headers
|
|
1260
|
+
end
|
|
1261
|
+
|
|
1262
|
+
# All Dispatches in the system for an AppId
|
|
1263
|
+
# Get a list of dispatches.
|
|
1264
|
+
# @param [Hash] opts the optional parameters
|
|
1265
|
+
# @option opts [String] :course_id Only retreive resources having `courseId`
|
|
1266
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
1267
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
1268
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
1269
|
+
# @option opts [Array<String>] :tags
|
|
1270
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`. (default to updated)
|
|
1271
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc (default to updated_asc)
|
|
1272
|
+
# @return [DispatchListSchema]
|
|
1273
|
+
def get_dispatches(opts = {})
|
|
1274
|
+
data, _status_code, _headers = get_dispatches_with_http_info(opts)
|
|
1275
|
+
return data
|
|
1276
|
+
end
|
|
1277
|
+
|
|
1278
|
+
# All Dispatches in the system for an AppId
|
|
1279
|
+
# Get a list of dispatches.
|
|
1280
|
+
# @param [Hash] opts the optional parameters
|
|
1281
|
+
# @option opts [String] :course_id Only retreive resources having `courseId`
|
|
1282
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
1283
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
1284
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
1285
|
+
# @option opts [Array<String>] :tags
|
|
1286
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`.
|
|
1287
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc
|
|
1288
|
+
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
|
1289
|
+
def get_dispatches_with_http_info(opts = {})
|
|
1290
|
+
if @api_client.config.debugging
|
|
1291
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.get_dispatches ..."
|
|
1292
|
+
end
|
|
1293
|
+
if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
|
1294
|
+
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
|
1295
|
+
end
|
|
1296
|
+
if opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
|
|
1297
|
+
fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
|
|
1298
|
+
end
|
|
1299
|
+
# resource path
|
|
1300
|
+
local_var_path = "/dispatch/dispatches".sub('{format}','json')
|
|
1301
|
+
|
|
1302
|
+
# query parameters
|
|
1303
|
+
query_params = {}
|
|
1304
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
1305
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
1306
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
1307
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
1308
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
1309
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
1310
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
1311
|
+
|
|
1312
|
+
# header parameters
|
|
1313
|
+
header_params = {}
|
|
1314
|
+
# HTTP header 'Accept' (if needed)
|
|
1315
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1316
|
+
# HTTP header 'Content-Type'
|
|
1317
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1318
|
+
|
|
1319
|
+
# form parameters
|
|
1320
|
+
form_params = {}
|
|
1321
|
+
|
|
1322
|
+
# http body (model)
|
|
1323
|
+
post_body = nil
|
|
1324
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1325
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1326
|
+
:header_params => header_params,
|
|
1327
|
+
:query_params => query_params,
|
|
1328
|
+
:form_params => form_params,
|
|
1329
|
+
:body => post_body,
|
|
1330
|
+
:auth_names => auth_names,
|
|
1331
|
+
:return_type => 'DispatchListSchema')
|
|
1332
|
+
if @api_client.config.debugging
|
|
1333
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1334
|
+
end
|
|
1335
|
+
return data, status_code, headers
|
|
1336
|
+
end
|
|
1337
|
+
|
|
1338
|
+
# Set the tags for this destination
|
|
1339
|
+
# Set the tags for this destination
|
|
1340
|
+
# @param destination_id Identifier for the destination
|
|
1341
|
+
# @param tags
|
|
1342
|
+
# @param [Hash] opts the optional parameters
|
|
1343
|
+
# @return [nil]
|
|
1344
|
+
def put_destination_tags(destination_id, tags, opts = {})
|
|
1345
|
+
put_destination_tags_with_http_info(destination_id, tags, opts)
|
|
1346
|
+
return nil
|
|
1347
|
+
end
|
|
1348
|
+
|
|
1349
|
+
# Set the tags for this destination
|
|
1350
|
+
# Set the tags for this destination
|
|
1351
|
+
# @param destination_id Identifier for the destination
|
|
1352
|
+
# @param tags
|
|
1353
|
+
# @param [Hash] opts the optional parameters
|
|
1354
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1355
|
+
def put_destination_tags_with_http_info(destination_id, tags, opts = {})
|
|
1356
|
+
if @api_client.config.debugging
|
|
1357
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.put_destination_tags ..."
|
|
1358
|
+
end
|
|
1359
|
+
# verify the required parameter 'destination_id' is set
|
|
1360
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.put_destination_tags" if destination_id.nil?
|
|
1361
|
+
# verify the required parameter 'tags' is set
|
|
1362
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_destination_tags" if tags.nil?
|
|
1363
|
+
# resource path
|
|
1364
|
+
local_var_path = "/dispatch/destinations/{destinationId}/tags".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
1365
|
+
|
|
1366
|
+
# query parameters
|
|
1367
|
+
query_params = {}
|
|
1368
|
+
|
|
1369
|
+
# header parameters
|
|
1370
|
+
header_params = {}
|
|
1371
|
+
# HTTP header 'Accept' (if needed)
|
|
1372
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1373
|
+
# HTTP header 'Content-Type'
|
|
1374
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1375
|
+
|
|
1376
|
+
# form parameters
|
|
1377
|
+
form_params = {}
|
|
1378
|
+
|
|
1379
|
+
# http body (model)
|
|
1380
|
+
post_body = @api_client.object_to_http_body(tags)
|
|
1381
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1382
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1383
|
+
:header_params => header_params,
|
|
1384
|
+
:query_params => query_params,
|
|
1385
|
+
:form_params => form_params,
|
|
1386
|
+
:body => post_body,
|
|
1387
|
+
:auth_names => auth_names)
|
|
1388
|
+
if @api_client.config.debugging
|
|
1389
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1390
|
+
end
|
|
1391
|
+
return data, status_code, headers
|
|
1392
|
+
end
|
|
1393
|
+
|
|
1394
|
+
# Sets all of the provided tags on all of the provided destinations
|
|
1395
|
+
# Sets all of the provided tags on all of the provided destinations
|
|
1396
|
+
# @param batch Object representing an array of ids to apply an array of tags to.
|
|
1397
|
+
# @param [Hash] opts the optional parameters
|
|
1398
|
+
# @return [nil]
|
|
1399
|
+
def put_destination_tags_batch(batch, opts = {})
|
|
1400
|
+
put_destination_tags_batch_with_http_info(batch, opts)
|
|
1401
|
+
return nil
|
|
1402
|
+
end
|
|
1403
|
+
|
|
1404
|
+
# Sets all of the provided tags on all of the provided destinations
|
|
1405
|
+
# Sets all of the provided tags on all of the provided destinations
|
|
1406
|
+
# @param batch Object representing an array of ids to apply an array of tags to.
|
|
1407
|
+
# @param [Hash] opts the optional parameters
|
|
1408
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1409
|
+
def put_destination_tags_batch_with_http_info(batch, opts = {})
|
|
1410
|
+
if @api_client.config.debugging
|
|
1411
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.put_destination_tags_batch ..."
|
|
1412
|
+
end
|
|
1413
|
+
# verify the required parameter 'batch' is set
|
|
1414
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_destination_tags_batch" if batch.nil?
|
|
1415
|
+
# resource path
|
|
1416
|
+
local_var_path = "/dispatch/destinations/tags".sub('{format}','json')
|
|
1417
|
+
|
|
1418
|
+
# query parameters
|
|
1419
|
+
query_params = {}
|
|
1420
|
+
|
|
1421
|
+
# header parameters
|
|
1422
|
+
header_params = {}
|
|
1423
|
+
# HTTP header 'Accept' (if needed)
|
|
1424
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1425
|
+
# HTTP header 'Content-Type'
|
|
1426
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1427
|
+
|
|
1428
|
+
# form parameters
|
|
1429
|
+
form_params = {}
|
|
1430
|
+
|
|
1431
|
+
# http body (model)
|
|
1432
|
+
post_body = @api_client.object_to_http_body(batch)
|
|
1433
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1434
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1435
|
+
:header_params => header_params,
|
|
1436
|
+
:query_params => query_params,
|
|
1437
|
+
:form_params => form_params,
|
|
1438
|
+
:body => post_body,
|
|
1439
|
+
:auth_names => auth_names)
|
|
1440
|
+
if @api_client.config.debugging
|
|
1441
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_destination_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1442
|
+
end
|
|
1443
|
+
return data, status_code, headers
|
|
1444
|
+
end
|
|
1445
|
+
|
|
1446
|
+
# Set the tags for this dispatch.
|
|
1447
|
+
# Set the tags for this dispatch.
|
|
1448
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1449
|
+
# @param tags
|
|
1450
|
+
# @param [Hash] opts the optional parameters
|
|
1451
|
+
# @return [nil]
|
|
1452
|
+
def put_dispatch_tags(dispatch_id, tags, opts = {})
|
|
1453
|
+
put_dispatch_tags_with_http_info(dispatch_id, tags, opts)
|
|
1454
|
+
return nil
|
|
1455
|
+
end
|
|
1456
|
+
|
|
1457
|
+
# Set the tags for this dispatch.
|
|
1458
|
+
# Set the tags for this dispatch.
|
|
1459
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1460
|
+
# @param tags
|
|
1461
|
+
# @param [Hash] opts the optional parameters
|
|
1462
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1463
|
+
def put_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
|
|
1464
|
+
if @api_client.config.debugging
|
|
1465
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.put_dispatch_tags ..."
|
|
1466
|
+
end
|
|
1467
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1468
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.put_dispatch_tags" if dispatch_id.nil?
|
|
1469
|
+
# verify the required parameter 'tags' is set
|
|
1470
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_dispatch_tags" if tags.nil?
|
|
1471
|
+
# resource path
|
|
1472
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/tags".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1473
|
+
|
|
1474
|
+
# query parameters
|
|
1475
|
+
query_params = {}
|
|
1476
|
+
|
|
1477
|
+
# header parameters
|
|
1478
|
+
header_params = {}
|
|
1479
|
+
# HTTP header 'Accept' (if needed)
|
|
1480
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1481
|
+
# HTTP header 'Content-Type'
|
|
1482
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1483
|
+
|
|
1484
|
+
# form parameters
|
|
1485
|
+
form_params = {}
|
|
1486
|
+
|
|
1487
|
+
# http body (model)
|
|
1488
|
+
post_body = @api_client.object_to_http_body(tags)
|
|
1489
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1490
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1491
|
+
:header_params => header_params,
|
|
1492
|
+
:query_params => query_params,
|
|
1493
|
+
:form_params => form_params,
|
|
1494
|
+
:body => post_body,
|
|
1495
|
+
:auth_names => auth_names)
|
|
1496
|
+
if @api_client.config.debugging
|
|
1497
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1498
|
+
end
|
|
1499
|
+
return data, status_code, headers
|
|
1500
|
+
end
|
|
1501
|
+
|
|
1502
|
+
# Sets all of the provided tags on all of the provided dispatches
|
|
1503
|
+
# Sets all of the provided tags on all of the provided dispatches
|
|
1504
|
+
# @param batch Object representing an array of ids to apply an array of tags to.
|
|
1505
|
+
# @param [Hash] opts the optional parameters
|
|
1506
|
+
# @return [nil]
|
|
1507
|
+
def put_dispatch_tags_batch(batch, opts = {})
|
|
1508
|
+
put_dispatch_tags_batch_with_http_info(batch, opts)
|
|
1509
|
+
return nil
|
|
1510
|
+
end
|
|
1511
|
+
|
|
1512
|
+
# Sets all of the provided tags on all of the provided dispatches
|
|
1513
|
+
# Sets all of the provided tags on all of the provided dispatches
|
|
1514
|
+
# @param batch Object representing an array of ids to apply an array of tags to.
|
|
1515
|
+
# @param [Hash] opts the optional parameters
|
|
1516
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1517
|
+
def put_dispatch_tags_batch_with_http_info(batch, opts = {})
|
|
1518
|
+
if @api_client.config.debugging
|
|
1519
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.put_dispatch_tags_batch ..."
|
|
1520
|
+
end
|
|
1521
|
+
# verify the required parameter 'batch' is set
|
|
1522
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_dispatch_tags_batch" if batch.nil?
|
|
1523
|
+
# resource path
|
|
1524
|
+
local_var_path = "/dispatch/dispatches/tags".sub('{format}','json')
|
|
1525
|
+
|
|
1526
|
+
# query parameters
|
|
1527
|
+
query_params = {}
|
|
1528
|
+
|
|
1529
|
+
# header parameters
|
|
1530
|
+
header_params = {}
|
|
1531
|
+
# HTTP header 'Accept' (if needed)
|
|
1532
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1533
|
+
# HTTP header 'Content-Type'
|
|
1534
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1535
|
+
|
|
1536
|
+
# form parameters
|
|
1537
|
+
form_params = {}
|
|
1538
|
+
|
|
1539
|
+
# http body (model)
|
|
1540
|
+
post_body = @api_client.object_to_http_body(batch)
|
|
1541
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1542
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1543
|
+
:header_params => header_params,
|
|
1544
|
+
:query_params => query_params,
|
|
1545
|
+
:form_params => form_params,
|
|
1546
|
+
:body => post_body,
|
|
1547
|
+
:auth_names => auth_names)
|
|
1548
|
+
if @api_client.config.debugging
|
|
1549
|
+
@api_client.config.logger.debug "API called: DispatchApi#put_dispatch_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1550
|
+
end
|
|
1551
|
+
return data, status_code, headers
|
|
1552
|
+
end
|
|
1553
|
+
|
|
1554
|
+
# DestinationsDispatchesRegistrationCount
|
|
1555
|
+
# Reset registration counts for all related dispatches.
|
|
1556
|
+
# @param destination_id Identifier for the destination
|
|
1557
|
+
# @param [Hash] opts the optional parameters
|
|
1558
|
+
# @return [nil]
|
|
1559
|
+
def reset_destination_dispatch_registration_count(destination_id, opts = {})
|
|
1560
|
+
reset_destination_dispatch_registration_count_with_http_info(destination_id, opts)
|
|
1561
|
+
return nil
|
|
1562
|
+
end
|
|
1563
|
+
|
|
1564
|
+
# DestinationsDispatchesRegistrationCount
|
|
1565
|
+
# Reset registration counts for all related dispatches.
|
|
1566
|
+
# @param destination_id Identifier for the destination
|
|
1567
|
+
# @param [Hash] opts the optional parameters
|
|
1568
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1569
|
+
def reset_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
|
|
1570
|
+
if @api_client.config.debugging
|
|
1571
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.reset_destination_dispatch_registration_count ..."
|
|
1572
|
+
end
|
|
1573
|
+
# verify the required parameter 'destination_id' is set
|
|
1574
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.reset_destination_dispatch_registration_count" if destination_id.nil?
|
|
1575
|
+
# resource path
|
|
1576
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/registrationCount".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
1577
|
+
|
|
1578
|
+
# query parameters
|
|
1579
|
+
query_params = {}
|
|
1580
|
+
|
|
1581
|
+
# header parameters
|
|
1582
|
+
header_params = {}
|
|
1583
|
+
# HTTP header 'Accept' (if needed)
|
|
1584
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1585
|
+
# HTTP header 'Content-Type'
|
|
1586
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1587
|
+
|
|
1588
|
+
# form parameters
|
|
1589
|
+
form_params = {}
|
|
1590
|
+
|
|
1591
|
+
# http body (model)
|
|
1592
|
+
post_body = nil
|
|
1593
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1594
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
1595
|
+
:header_params => header_params,
|
|
1596
|
+
:query_params => query_params,
|
|
1597
|
+
:form_params => form_params,
|
|
1598
|
+
:body => post_body,
|
|
1599
|
+
:auth_names => auth_names)
|
|
1600
|
+
if @api_client.config.debugging
|
|
1601
|
+
@api_client.config.logger.debug "API called: DispatchApi#reset_destination_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1602
|
+
end
|
|
1603
|
+
return data, status_code, headers
|
|
1604
|
+
end
|
|
1605
|
+
|
|
1606
|
+
# Reset registration count.
|
|
1607
|
+
# Reset the registration count for this dispatch.
|
|
1608
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1609
|
+
# @param [Hash] opts the optional parameters
|
|
1610
|
+
# @return [nil]
|
|
1611
|
+
def reset_dispatch_registration_count(dispatch_id, opts = {})
|
|
1612
|
+
reset_dispatch_registration_count_with_http_info(dispatch_id, opts)
|
|
1613
|
+
return nil
|
|
1614
|
+
end
|
|
1615
|
+
|
|
1616
|
+
# Reset registration count.
|
|
1617
|
+
# Reset the registration count for this dispatch.
|
|
1618
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1619
|
+
# @param [Hash] opts the optional parameters
|
|
1620
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1621
|
+
def reset_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
|
|
1622
|
+
if @api_client.config.debugging
|
|
1623
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.reset_dispatch_registration_count ..."
|
|
1624
|
+
end
|
|
1625
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1626
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.reset_dispatch_registration_count" if dispatch_id.nil?
|
|
1627
|
+
# resource path
|
|
1628
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/registrationCount".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1629
|
+
|
|
1630
|
+
# query parameters
|
|
1631
|
+
query_params = {}
|
|
1632
|
+
|
|
1633
|
+
# header parameters
|
|
1634
|
+
header_params = {}
|
|
1635
|
+
# HTTP header 'Accept' (if needed)
|
|
1636
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1637
|
+
# HTTP header 'Content-Type'
|
|
1638
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1639
|
+
|
|
1640
|
+
# form parameters
|
|
1641
|
+
form_params = {}
|
|
1642
|
+
|
|
1643
|
+
# http body (model)
|
|
1644
|
+
post_body = nil
|
|
1645
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1646
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
1647
|
+
:header_params => header_params,
|
|
1648
|
+
:query_params => query_params,
|
|
1649
|
+
:form_params => form_params,
|
|
1650
|
+
:body => post_body,
|
|
1651
|
+
:auth_names => auth_names)
|
|
1652
|
+
if @api_client.config.debugging
|
|
1653
|
+
@api_client.config.logger.debug "API called: DispatchApi#reset_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1654
|
+
end
|
|
1655
|
+
return data, status_code, headers
|
|
1656
|
+
end
|
|
1657
|
+
|
|
1658
|
+
#
|
|
1659
|
+
# Creates or updates the destination identified by the `destinationId` provided in the path. If the destination is being created, a name should be provided in the DestinationSchema, else an error will be thrown. 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. If you do not supply an e-mail address upon the creation of a destination, the owner of the Realm will be used. This can, of course, also be changed via calling this method to update an existing destination.
|
|
1660
|
+
# @param destination_id Identifier for the destination
|
|
1661
|
+
# @param destination
|
|
1662
|
+
# @param [Hash] opts the optional parameters
|
|
1663
|
+
# @return [nil]
|
|
1664
|
+
def set_destination(destination_id, destination, opts = {})
|
|
1665
|
+
set_destination_with_http_info(destination_id, destination, opts)
|
|
1666
|
+
return nil
|
|
1667
|
+
end
|
|
1668
|
+
|
|
1669
|
+
#
|
|
1670
|
+
# Creates or updates the destination identified by the `destinationId` provided in the path. If the destination is being created, a name should be provided in the DestinationSchema, else an error will be thrown. 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. If you do not supply an e-mail address upon the creation of a destination, the owner of the Realm will be used. This can, of course, also be changed via calling this method to update an existing destination.
|
|
1671
|
+
# @param destination_id Identifier for the destination
|
|
1672
|
+
# @param destination
|
|
1673
|
+
# @param [Hash] opts the optional parameters
|
|
1674
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1675
|
+
def set_destination_with_http_info(destination_id, destination, opts = {})
|
|
1676
|
+
if @api_client.config.debugging
|
|
1677
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.set_destination ..."
|
|
1678
|
+
end
|
|
1679
|
+
# verify the required parameter 'destination_id' is set
|
|
1680
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination" if destination_id.nil?
|
|
1681
|
+
# verify the required parameter 'destination' is set
|
|
1682
|
+
fail ArgumentError, "Missing the required parameter 'destination' when calling DispatchApi.set_destination" if destination.nil?
|
|
1683
|
+
# resource path
|
|
1684
|
+
local_var_path = "/dispatch/destinations/{destinationId}".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
1685
|
+
|
|
1686
|
+
# query parameters
|
|
1687
|
+
query_params = {}
|
|
1688
|
+
|
|
1689
|
+
# header parameters
|
|
1690
|
+
header_params = {}
|
|
1691
|
+
# HTTP header 'Accept' (if needed)
|
|
1692
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1693
|
+
# HTTP header 'Content-Type'
|
|
1694
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1695
|
+
|
|
1696
|
+
# form parameters
|
|
1697
|
+
form_params = {}
|
|
1698
|
+
|
|
1699
|
+
# http body (model)
|
|
1700
|
+
post_body = @api_client.object_to_http_body(destination)
|
|
1701
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1702
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1703
|
+
:header_params => header_params,
|
|
1704
|
+
:query_params => query_params,
|
|
1705
|
+
:form_params => form_params,
|
|
1706
|
+
:body => post_body,
|
|
1707
|
+
:auth_names => auth_names)
|
|
1708
|
+
if @api_client.config.debugging
|
|
1709
|
+
@api_client.config.logger.debug "API called: DispatchApi#set_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1710
|
+
end
|
|
1711
|
+
return data, status_code, headers
|
|
1712
|
+
end
|
|
1713
|
+
|
|
1714
|
+
# DestinationsDispatchesEnabledByTenant
|
|
1715
|
+
# Enable or disable all related dispatches.
|
|
1716
|
+
# @param destination_id Identifier for the destination
|
|
1717
|
+
# @param enabled
|
|
1718
|
+
# @param [Hash] opts the optional parameters
|
|
1719
|
+
# @return [nil]
|
|
1720
|
+
def set_destination_dispatch_enabled(destination_id, enabled, opts = {})
|
|
1721
|
+
set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts)
|
|
1722
|
+
return nil
|
|
1723
|
+
end
|
|
1724
|
+
|
|
1725
|
+
# DestinationsDispatchesEnabledByTenant
|
|
1726
|
+
# Enable or disable all related dispatches.
|
|
1727
|
+
# @param destination_id Identifier for the destination
|
|
1728
|
+
# @param enabled
|
|
1729
|
+
# @param [Hash] opts the optional parameters
|
|
1730
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1731
|
+
def set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts = {})
|
|
1732
|
+
if @api_client.config.debugging
|
|
1733
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.set_destination_dispatch_enabled ..."
|
|
1734
|
+
end
|
|
1735
|
+
# verify the required parameter 'destination_id' is set
|
|
1736
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination_dispatch_enabled" if destination_id.nil?
|
|
1737
|
+
# verify the required parameter 'enabled' is set
|
|
1738
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_destination_dispatch_enabled" if enabled.nil?
|
|
1739
|
+
# resource path
|
|
1740
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/enabled".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
1741
|
+
|
|
1742
|
+
# query parameters
|
|
1743
|
+
query_params = {}
|
|
1744
|
+
|
|
1745
|
+
# header parameters
|
|
1746
|
+
header_params = {}
|
|
1747
|
+
# HTTP header 'Accept' (if needed)
|
|
1748
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1749
|
+
# HTTP header 'Content-Type'
|
|
1750
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1751
|
+
|
|
1752
|
+
# form parameters
|
|
1753
|
+
form_params = {}
|
|
1754
|
+
|
|
1755
|
+
# http body (model)
|
|
1756
|
+
post_body = @api_client.object_to_http_body(enabled)
|
|
1757
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1758
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
1759
|
+
:header_params => header_params,
|
|
1760
|
+
:query_params => query_params,
|
|
1761
|
+
:form_params => form_params,
|
|
1762
|
+
:body => post_body,
|
|
1763
|
+
:auth_names => auth_names)
|
|
1764
|
+
if @api_client.config.debugging
|
|
1765
|
+
@api_client.config.logger.debug "API called: DispatchApi#set_destination_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1766
|
+
end
|
|
1767
|
+
return data, status_code, headers
|
|
1768
|
+
end
|
|
1769
|
+
|
|
1770
|
+
# Set the `enabled` status for `dispatchId`.
|
|
1771
|
+
# Set the `enabled` status for `dispatchId`.
|
|
1772
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1773
|
+
# @param enabled
|
|
1774
|
+
# @param [Hash] opts the optional parameters
|
|
1775
|
+
# @return [nil]
|
|
1776
|
+
def set_dispatch_enabled(dispatch_id, enabled, opts = {})
|
|
1777
|
+
set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts)
|
|
1778
|
+
return nil
|
|
1779
|
+
end
|
|
1780
|
+
|
|
1781
|
+
# Set the `enabled` status for `dispatchId`.
|
|
1782
|
+
# Set the `enabled` status for `dispatchId`.
|
|
1783
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1784
|
+
# @param enabled
|
|
1785
|
+
# @param [Hash] opts the optional parameters
|
|
1786
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1787
|
+
def set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts = {})
|
|
1788
|
+
if @api_client.config.debugging
|
|
1789
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.set_dispatch_enabled ..."
|
|
1790
|
+
end
|
|
1791
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1792
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.set_dispatch_enabled" if dispatch_id.nil?
|
|
1793
|
+
# verify the required parameter 'enabled' is set
|
|
1794
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_dispatch_enabled" if enabled.nil?
|
|
1795
|
+
# resource path
|
|
1796
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/enabled".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1797
|
+
|
|
1798
|
+
# query parameters
|
|
1799
|
+
query_params = {}
|
|
1800
|
+
|
|
1801
|
+
# header parameters
|
|
1802
|
+
header_params = {}
|
|
1803
|
+
# HTTP header 'Accept' (if needed)
|
|
1804
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1805
|
+
# HTTP header 'Content-Type'
|
|
1806
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1807
|
+
|
|
1808
|
+
# form parameters
|
|
1809
|
+
form_params = {}
|
|
1810
|
+
|
|
1811
|
+
# http body (model)
|
|
1812
|
+
post_body = @api_client.object_to_http_body(enabled)
|
|
1813
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1814
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1815
|
+
:header_params => header_params,
|
|
1816
|
+
:query_params => query_params,
|
|
1817
|
+
:form_params => form_params,
|
|
1818
|
+
:body => post_body,
|
|
1819
|
+
:auth_names => auth_names)
|
|
1820
|
+
if @api_client.config.debugging
|
|
1821
|
+
@api_client.config.logger.debug "API called: DispatchApi#set_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1822
|
+
end
|
|
1823
|
+
return data, status_code, headers
|
|
1824
|
+
end
|
|
1825
|
+
|
|
1826
|
+
# Enable or disable hashing of the user info for the destination.
|
|
1827
|
+
# Enable or disable hashing of the user info for the destination.
|
|
1828
|
+
# @param destination_id Identifier for the destination
|
|
1829
|
+
# @param enabled
|
|
1830
|
+
# @param [Hash] opts the optional parameters
|
|
1831
|
+
# @return [nil]
|
|
1832
|
+
def update_destination_hash_user_info(destination_id, enabled, opts = {})
|
|
1833
|
+
update_destination_hash_user_info_with_http_info(destination_id, enabled, opts)
|
|
1834
|
+
return nil
|
|
1835
|
+
end
|
|
1836
|
+
|
|
1837
|
+
# Enable or disable hashing of the user info for the destination.
|
|
1838
|
+
# Enable or disable hashing of the user info for the destination.
|
|
1839
|
+
# @param destination_id Identifier for the destination
|
|
1840
|
+
# @param enabled
|
|
1841
|
+
# @param [Hash] opts the optional parameters
|
|
1842
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1843
|
+
def update_destination_hash_user_info_with_http_info(destination_id, enabled, opts = {})
|
|
1844
|
+
if @api_client.config.debugging
|
|
1845
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.update_destination_hash_user_info ..."
|
|
1846
|
+
end
|
|
1847
|
+
# verify the required parameter 'destination_id' is set
|
|
1848
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.update_destination_hash_user_info" if destination_id.nil?
|
|
1849
|
+
# verify the required parameter 'enabled' is set
|
|
1850
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_destination_hash_user_info" if enabled.nil?
|
|
1851
|
+
# resource path
|
|
1852
|
+
local_var_path = "/dispatch/destinations/{destinationId}/dispatches/hashUserInfo".sub('{format}','json').sub('{' + 'destinationId' + '}', destination_id.to_s)
|
|
1853
|
+
|
|
1854
|
+
# query parameters
|
|
1855
|
+
query_params = {}
|
|
1856
|
+
|
|
1857
|
+
# header parameters
|
|
1858
|
+
header_params = {}
|
|
1859
|
+
# HTTP header 'Accept' (if needed)
|
|
1860
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1861
|
+
# HTTP header 'Content-Type'
|
|
1862
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1863
|
+
|
|
1864
|
+
# form parameters
|
|
1865
|
+
form_params = {}
|
|
1866
|
+
|
|
1867
|
+
# http body (model)
|
|
1868
|
+
post_body = @api_client.object_to_http_body(enabled)
|
|
1869
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1870
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1871
|
+
:header_params => header_params,
|
|
1872
|
+
:query_params => query_params,
|
|
1873
|
+
:form_params => form_params,
|
|
1874
|
+
:body => post_body,
|
|
1875
|
+
:auth_names => auth_names)
|
|
1876
|
+
if @api_client.config.debugging
|
|
1877
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_destination_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1878
|
+
end
|
|
1879
|
+
return data, status_code, headers
|
|
1880
|
+
end
|
|
1881
|
+
|
|
1882
|
+
# Update the dispatch with `dispatchId`.
|
|
1883
|
+
# Update the dispatch with `dispatchId`.
|
|
1884
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1885
|
+
# @param dispatch_properties
|
|
1886
|
+
# @param [Hash] opts the optional parameters
|
|
1887
|
+
# @return [nil]
|
|
1888
|
+
def update_dispatch(dispatch_id, dispatch_properties, opts = {})
|
|
1889
|
+
update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts)
|
|
1890
|
+
return nil
|
|
1891
|
+
end
|
|
1892
|
+
|
|
1893
|
+
# Update the dispatch with `dispatchId`.
|
|
1894
|
+
# Update the dispatch with `dispatchId`.
|
|
1895
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1896
|
+
# @param dispatch_properties
|
|
1897
|
+
# @param [Hash] opts the optional parameters
|
|
1898
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1899
|
+
def update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts = {})
|
|
1900
|
+
if @api_client.config.debugging
|
|
1901
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.update_dispatch ..."
|
|
1902
|
+
end
|
|
1903
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1904
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch" if dispatch_id.nil?
|
|
1905
|
+
# verify the required parameter 'dispatch_properties' is set
|
|
1906
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatch" if dispatch_properties.nil?
|
|
1907
|
+
# resource path
|
|
1908
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1909
|
+
|
|
1910
|
+
# query parameters
|
|
1911
|
+
query_params = {}
|
|
1912
|
+
|
|
1913
|
+
# header parameters
|
|
1914
|
+
header_params = {}
|
|
1915
|
+
# HTTP header 'Accept' (if needed)
|
|
1916
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1917
|
+
# HTTP header 'Content-Type'
|
|
1918
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1919
|
+
|
|
1920
|
+
# form parameters
|
|
1921
|
+
form_params = {}
|
|
1922
|
+
|
|
1923
|
+
# http body (model)
|
|
1924
|
+
post_body = @api_client.object_to_http_body(dispatch_properties)
|
|
1925
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1926
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1927
|
+
:header_params => header_params,
|
|
1928
|
+
:query_params => query_params,
|
|
1929
|
+
:form_params => form_params,
|
|
1930
|
+
:body => post_body,
|
|
1931
|
+
:auth_names => auth_names)
|
|
1932
|
+
if @api_client.config.debugging
|
|
1933
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1934
|
+
end
|
|
1935
|
+
return data, status_code, headers
|
|
1936
|
+
end
|
|
1937
|
+
|
|
1938
|
+
# Enable or disable hashing of the user info for the dispatch.
|
|
1939
|
+
# Enable or disable hashing of the user info for the dispatch.
|
|
1940
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1941
|
+
# @param enabled
|
|
1942
|
+
# @param [Hash] opts the optional parameters
|
|
1943
|
+
# @return [nil]
|
|
1944
|
+
def update_dispatch_hash_user_info(dispatch_id, enabled, opts = {})
|
|
1945
|
+
update_dispatch_hash_user_info_with_http_info(dispatch_id, enabled, opts)
|
|
1946
|
+
return nil
|
|
1947
|
+
end
|
|
1948
|
+
|
|
1949
|
+
# Enable or disable hashing of the user info for the dispatch.
|
|
1950
|
+
# Enable or disable hashing of the user info for the dispatch.
|
|
1951
|
+
# @param dispatch_id Identifier for the dispatch
|
|
1952
|
+
# @param enabled
|
|
1953
|
+
# @param [Hash] opts the optional parameters
|
|
1954
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1955
|
+
def update_dispatch_hash_user_info_with_http_info(dispatch_id, enabled, opts = {})
|
|
1956
|
+
if @api_client.config.debugging
|
|
1957
|
+
@api_client.config.logger.debug "Calling API: DispatchApi.update_dispatch_hash_user_info ..."
|
|
1958
|
+
end
|
|
1959
|
+
# verify the required parameter 'dispatch_id' is set
|
|
1960
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch_hash_user_info" if dispatch_id.nil?
|
|
1961
|
+
# verify the required parameter 'enabled' is set
|
|
1962
|
+
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_dispatch_hash_user_info" if enabled.nil?
|
|
1963
|
+
# resource path
|
|
1964
|
+
local_var_path = "/dispatch/dispatches/{dispatchId}/hashUserInfo".sub('{format}','json').sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
|
1965
|
+
|
|
1966
|
+
# query parameters
|
|
1967
|
+
query_params = {}
|
|
1968
|
+
|
|
1969
|
+
# header parameters
|
|
1970
|
+
header_params = {}
|
|
1971
|
+
# HTTP header 'Accept' (if needed)
|
|
1972
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1973
|
+
# HTTP header 'Content-Type'
|
|
1974
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1975
|
+
|
|
1976
|
+
# form parameters
|
|
1977
|
+
form_params = {}
|
|
1978
|
+
|
|
1979
|
+
# http body (model)
|
|
1980
|
+
post_body = @api_client.object_to_http_body(enabled)
|
|
1981
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
1982
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1983
|
+
:header_params => header_params,
|
|
1984
|
+
:query_params => query_params,
|
|
1985
|
+
:form_params => form_params,
|
|
1986
|
+
:body => post_body,
|
|
1987
|
+
:auth_names => auth_names)
|
|
1988
|
+
if @api_client.config.debugging
|
|
1989
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_dispatch_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1990
|
+
end
|
|
1991
|
+
return data, status_code, headers
|
|
1992
|
+
end
|
|
1993
|
+
end
|
|
1994
|
+
end
|