rustici_software_cloud_v2 1.1.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +355 -356
- data/lib/rustici_software_cloud_v2/api/about_api.rb +5 -5
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +191 -63
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +10 -18
- data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +236 -0
- data/lib/rustici_software_cloud_v2/api/course_api.rb +1046 -225
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +634 -269
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +213 -171
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +49 -49
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +256 -270
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +20 -24
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +82 -67
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +125 -56
- data/lib/rustici_software_cloud_v2/api_client.rb +3 -3
- data/lib/rustici_software_cloud_v2/api_error.rb +1 -1
- data/lib/rustici_software_cloud_v2/configuration.rb +11 -4
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +9 -37
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/application_token.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/connector_schema.rb +226 -0
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +218 -0
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +3 -20
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +35 -6
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +186 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +44 -4
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
- data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +207 -0
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +30 -7
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +9 -37
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +6 -4
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +261 -0
- data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +236 -0
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +11 -9
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +12 -44
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +9 -37
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +6 -4
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +17 -6
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/response_error.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +9 -37
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +16 -4
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +6 -30
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +5 -2
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +14 -2
- data/lib/rustici_software_cloud_v2/version.rb +2 -2
- data/lib/rustici_software_cloud_v2.rb +23 -1
- data/rustici_software_cloud_v2.gemspec +3 -2
- data/spec/api_client_spec.rb +18 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +45 -3
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.
|
9
|
+
Swagger Codegen version: 2.4.27
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,8 +19,8 @@ module RusticiSoftwareCloudV2
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Create a group of Destinations
|
23
|
+
# Creates a group of destinations. A destination is a label used to identify an entity outside of SCORM Cloud, such as an LMS. Used in conjunction with dispatches to provide access control mechanisms for the courses distributed to the destination.
|
24
24
|
# @param destinations_list
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
@@ -29,8 +29,8 @@ module RusticiSoftwareCloudV2
|
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
|
-
#
|
33
|
-
#
|
32
|
+
# Create a group of Destinations
|
33
|
+
# Creates a group of destinations. A destination is a label used to identify an entity outside of SCORM Cloud, such as an LMS. Used in conjunction with dispatches to provide access control mechanisms for the courses distributed to the destination.
|
34
34
|
# @param destinations_list
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -39,7 +39,7 @@ module RusticiSoftwareCloudV2
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: DispatchApi.create_destinations ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'destinations_list' is set
|
42
|
-
if
|
42
|
+
if destinations_list.nil?
|
43
43
|
fail ArgumentError, "Missing the required parameter 'destinations_list' when calling DispatchApi.create_destinations"
|
44
44
|
end
|
45
45
|
# resource path
|
@@ -72,8 +72,8 @@ module RusticiSoftwareCloudV2
|
|
72
72
|
end
|
73
73
|
return data, status_code, headers
|
74
74
|
end
|
75
|
-
# Create
|
76
|
-
#
|
75
|
+
# Create a group of Dispatches
|
76
|
+
# Creates a group of dispatches. Dispatches are the connection between a course and a destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination. >**Caution:** >Only one dispatch can exist for a given course-destination combination. If calling this method with the same course and destination supplied, the old one will be loaded for modification. An exception to this is if a dispatchId is passed in the body, the request will fail with a 400 response warning that the dispatch already exists. This is to prevent confusion over which dispatchId is to be used in future requests.
|
77
77
|
# @param dispatch_list
|
78
78
|
# @param [Hash] opts the optional parameters
|
79
79
|
# @return [nil]
|
@@ -82,8 +82,8 @@ module RusticiSoftwareCloudV2
|
|
82
82
|
nil
|
83
83
|
end
|
84
84
|
|
85
|
-
# Create
|
86
|
-
#
|
85
|
+
# Create a group of Dispatches
|
86
|
+
# Creates a group of dispatches. Dispatches are the connection between a course and a destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination. >**Caution:** >Only one dispatch can exist for a given course-destination combination. If calling this method with the same course and destination supplied, the old one will be loaded for modification. An exception to this is if a dispatchId is passed in the body, the request will fail with a 400 response warning that the dispatch already exists. This is to prevent confusion over which dispatchId is to be used in future requests.
|
87
87
|
# @param dispatch_list
|
88
88
|
# @param [Hash] opts the optional parameters
|
89
89
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -92,7 +92,7 @@ module RusticiSoftwareCloudV2
|
|
92
92
|
@api_client.config.logger.debug 'Calling API: DispatchApi.create_dispatches ...'
|
93
93
|
end
|
94
94
|
# verify the required parameter 'dispatch_list' is set
|
95
|
-
if
|
95
|
+
if dispatch_list.nil?
|
96
96
|
fail ArgumentError, "Missing the required parameter 'dispatch_list' when calling DispatchApi.create_dispatches"
|
97
97
|
end
|
98
98
|
# resource path
|
@@ -125,8 +125,8 @@ module RusticiSoftwareCloudV2
|
|
125
125
|
end
|
126
126
|
return data, status_code, headers
|
127
127
|
end
|
128
|
-
# Delete
|
129
|
-
#
|
128
|
+
# Delete a Destination
|
129
|
+
# Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
|
130
130
|
# @param destination_id Identifier for the destination
|
131
131
|
# @param [Hash] opts the optional parameters
|
132
132
|
# @return [nil]
|
@@ -135,8 +135,8 @@ module RusticiSoftwareCloudV2
|
|
135
135
|
nil
|
136
136
|
end
|
137
137
|
|
138
|
-
# Delete
|
139
|
-
#
|
138
|
+
# Delete a Destination
|
139
|
+
# Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
|
140
140
|
# @param destination_id Identifier for the destination
|
141
141
|
# @param [Hash] opts the optional parameters
|
142
142
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -145,7 +145,7 @@ module RusticiSoftwareCloudV2
|
|
145
145
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination ...'
|
146
146
|
end
|
147
147
|
# verify the required parameter 'destination_id' is set
|
148
|
-
if
|
148
|
+
if destination_id.nil?
|
149
149
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination"
|
150
150
|
end
|
151
151
|
# resource path
|
@@ -178,8 +178,8 @@ module RusticiSoftwareCloudV2
|
|
178
178
|
end
|
179
179
|
return data, status_code, headers
|
180
180
|
end
|
181
|
-
# Delete
|
182
|
-
#
|
181
|
+
# Delete a Destination's Dispatches
|
182
|
+
# Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
183
183
|
# @param destination_id Identifier for the destination
|
184
184
|
# @param [Hash] opts the optional parameters
|
185
185
|
# @return [nil]
|
@@ -188,8 +188,8 @@ module RusticiSoftwareCloudV2
|
|
188
188
|
nil
|
189
189
|
end
|
190
190
|
|
191
|
-
# Delete
|
192
|
-
#
|
191
|
+
# Delete a Destination's Dispatches
|
192
|
+
# Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
193
193
|
# @param destination_id Identifier for the destination
|
194
194
|
# @param [Hash] opts the optional parameters
|
195
195
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -198,7 +198,7 @@ module RusticiSoftwareCloudV2
|
|
198
198
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_dispatches ...'
|
199
199
|
end
|
200
200
|
# verify the required parameter 'destination_id' is set
|
201
|
-
if
|
201
|
+
if destination_id.nil?
|
202
202
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_dispatches"
|
203
203
|
end
|
204
204
|
# resource path
|
@@ -231,8 +231,8 @@ module RusticiSoftwareCloudV2
|
|
231
231
|
end
|
232
232
|
return data, status_code, headers
|
233
233
|
end
|
234
|
-
# Delete
|
235
|
-
#
|
234
|
+
# Delete tags from a Destination
|
235
|
+
# Deletes the specified tags from the destination. Deleting tags that do not exist will still result in a success.
|
236
236
|
# @param destination_id Identifier for the destination
|
237
237
|
# @param tags
|
238
238
|
# @param [Hash] opts the optional parameters
|
@@ -242,8 +242,8 @@ module RusticiSoftwareCloudV2
|
|
242
242
|
nil
|
243
243
|
end
|
244
244
|
|
245
|
-
# Delete
|
246
|
-
#
|
245
|
+
# Delete tags from a Destination
|
246
|
+
# Deletes the specified tags from the destination. Deleting tags that do not exist will still result in a success.
|
247
247
|
# @param destination_id Identifier for the destination
|
248
248
|
# @param tags
|
249
249
|
# @param [Hash] opts the optional parameters
|
@@ -253,11 +253,11 @@ module RusticiSoftwareCloudV2
|
|
253
253
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_tags ...'
|
254
254
|
end
|
255
255
|
# verify the required parameter 'destination_id' is set
|
256
|
-
if
|
256
|
+
if destination_id.nil?
|
257
257
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_tags"
|
258
258
|
end
|
259
259
|
# verify the required parameter 'tags' is set
|
260
|
-
if
|
260
|
+
if tags.nil?
|
261
261
|
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_destination_tags"
|
262
262
|
end
|
263
263
|
# resource path
|
@@ -290,8 +290,8 @@ module RusticiSoftwareCloudV2
|
|
290
290
|
end
|
291
291
|
return data, status_code, headers
|
292
292
|
end
|
293
|
-
# Delete
|
294
|
-
#
|
293
|
+
# Delete a Dispatch
|
294
|
+
# Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
295
295
|
# @param dispatch_id Identifier for the dispatch
|
296
296
|
# @param [Hash] opts the optional parameters
|
297
297
|
# @return [nil]
|
@@ -300,8 +300,8 @@ module RusticiSoftwareCloudV2
|
|
300
300
|
nil
|
301
301
|
end
|
302
302
|
|
303
|
-
# Delete
|
304
|
-
#
|
303
|
+
# Delete a Dispatch
|
304
|
+
# Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
305
305
|
# @param dispatch_id Identifier for the dispatch
|
306
306
|
# @param [Hash] opts the optional parameters
|
307
307
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -310,7 +310,7 @@ module RusticiSoftwareCloudV2
|
|
310
310
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch ...'
|
311
311
|
end
|
312
312
|
# verify the required parameter 'dispatch_id' is set
|
313
|
-
if
|
313
|
+
if dispatch_id.nil?
|
314
314
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch"
|
315
315
|
end
|
316
316
|
# resource path
|
@@ -343,8 +343,8 @@ module RusticiSoftwareCloudV2
|
|
343
343
|
end
|
344
344
|
return data, status_code, headers
|
345
345
|
end
|
346
|
-
#
|
347
|
-
#
|
346
|
+
# Delete postback information from a Dispatch
|
347
|
+
# Clears the postback settings from the dispatch. This causes the postback settings to inherit a value from a higher level (e.g. application). If there is no setting at the application level, this will disable postbacks for the dispatch.
|
348
348
|
# @param dispatch_id Identifier for the dispatch
|
349
349
|
# @param [Hash] opts the optional parameters
|
350
350
|
# @return [nil]
|
@@ -353,8 +353,8 @@ module RusticiSoftwareCloudV2
|
|
353
353
|
nil
|
354
354
|
end
|
355
355
|
|
356
|
-
#
|
357
|
-
#
|
356
|
+
# Delete postback information from a Dispatch
|
357
|
+
# Clears the postback settings from the dispatch. This causes the postback settings to inherit a value from a higher level (e.g. application). If there is no setting at the application level, this will disable postbacks for the dispatch.
|
358
358
|
# @param dispatch_id Identifier for the dispatch
|
359
359
|
# @param [Hash] opts the optional parameters
|
360
360
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -363,7 +363,7 @@ module RusticiSoftwareCloudV2
|
|
363
363
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_postback_info ...'
|
364
364
|
end
|
365
365
|
# verify the required parameter 'dispatch_id' is set
|
366
|
-
if
|
366
|
+
if dispatch_id.nil?
|
367
367
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_postback_info"
|
368
368
|
end
|
369
369
|
# resource path
|
@@ -396,8 +396,8 @@ module RusticiSoftwareCloudV2
|
|
396
396
|
end
|
397
397
|
return data, status_code, headers
|
398
398
|
end
|
399
|
-
# Delete
|
400
|
-
#
|
399
|
+
# Delete tags from a Dispatch
|
400
|
+
# Deletes the specified tags from the dispatch. Deleting tags that do not exist will still result in a success.
|
401
401
|
# @param dispatch_id Identifier for the dispatch
|
402
402
|
# @param tags
|
403
403
|
# @param [Hash] opts the optional parameters
|
@@ -407,8 +407,8 @@ module RusticiSoftwareCloudV2
|
|
407
407
|
nil
|
408
408
|
end
|
409
409
|
|
410
|
-
# Delete
|
411
|
-
#
|
410
|
+
# Delete tags from a Dispatch
|
411
|
+
# Deletes the specified tags from the dispatch. Deleting tags that do not exist will still result in a success.
|
412
412
|
# @param dispatch_id Identifier for the dispatch
|
413
413
|
# @param tags
|
414
414
|
# @param [Hash] opts the optional parameters
|
@@ -418,11 +418,11 @@ module RusticiSoftwareCloudV2
|
|
418
418
|
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_tags ...'
|
419
419
|
end
|
420
420
|
# verify the required parameter 'dispatch_id' is set
|
421
|
-
if
|
421
|
+
if dispatch_id.nil?
|
422
422
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_tags"
|
423
423
|
end
|
424
424
|
# verify the required parameter 'tags' is set
|
425
|
-
if
|
425
|
+
if tags.nil?
|
426
426
|
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_dispatch_tags"
|
427
427
|
end
|
428
428
|
# resource path
|
@@ -455,8 +455,76 @@ module RusticiSoftwareCloudV2
|
|
455
455
|
end
|
456
456
|
return data, status_code, headers
|
457
457
|
end
|
458
|
-
#
|
459
|
-
#
|
458
|
+
# Delete a group of Dispatches
|
459
|
+
# Deletes the specified group of dispatches. Can be filtered using the request parameters to provide a subset of results. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental deletion of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
|
460
|
+
# @param [Hash] opts the optional parameters
|
461
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
462
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
463
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
464
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
465
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
466
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
467
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
468
|
+
# @return [nil]
|
469
|
+
def delete_dispatches(opts = {})
|
470
|
+
delete_dispatches_with_http_info(opts)
|
471
|
+
nil
|
472
|
+
end
|
473
|
+
|
474
|
+
# Delete a group of Dispatches
|
475
|
+
# Deletes the specified group of dispatches. Can be filtered using the request parameters to provide a subset of results. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental deletion of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
|
476
|
+
# @param [Hash] opts the optional parameters
|
477
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
478
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
479
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
480
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
481
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
482
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
483
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
484
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
485
|
+
def delete_dispatches_with_http_info(opts = {})
|
486
|
+
if @api_client.config.debugging
|
487
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatches ...'
|
488
|
+
end
|
489
|
+
# resource path
|
490
|
+
local_var_path = '/dispatch/dispatches'
|
491
|
+
|
492
|
+
# query parameters
|
493
|
+
query_params = {}
|
494
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
495
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
496
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
497
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
498
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
499
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
500
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
501
|
+
|
502
|
+
# header parameters
|
503
|
+
header_params = {}
|
504
|
+
# HTTP header 'Accept' (if needed)
|
505
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
506
|
+
# HTTP header 'Content-Type'
|
507
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
508
|
+
|
509
|
+
# form parameters
|
510
|
+
form_params = {}
|
511
|
+
|
512
|
+
# http body (model)
|
513
|
+
post_body = nil
|
514
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
515
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
516
|
+
:header_params => header_params,
|
517
|
+
:query_params => query_params,
|
518
|
+
:form_params => form_params,
|
519
|
+
:body => post_body,
|
520
|
+
:auth_names => auth_names)
|
521
|
+
if @api_client.config.debugging
|
522
|
+
@api_client.config.logger.debug "API called: DispatchApi#delete_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
523
|
+
end
|
524
|
+
return data, status_code, headers
|
525
|
+
end
|
526
|
+
# Update registration instancing status for a Destination's Dispatches
|
527
|
+
# Updates the restration instancing status for all dispatches distributed to the destination. Registration instancing is the default for dispatches, in order to support versioning of dispatches. A small portion of users may experience duplicate registrations with content dispatched to some LMS platforms. If you happen to be dispatching content to an LMS with this issue, disabling registration instancing here will resolve the problems. However, dispatch versioning will also be disabled.
|
460
528
|
# @param destination_id Identifier for the destination
|
461
529
|
# @param enabled
|
462
530
|
# @param [Hash] opts the optional parameters
|
@@ -466,8 +534,8 @@ module RusticiSoftwareCloudV2
|
|
466
534
|
nil
|
467
535
|
end
|
468
536
|
|
469
|
-
#
|
470
|
-
#
|
537
|
+
# Update registration instancing status for a Destination's Dispatches
|
538
|
+
# Updates the restration instancing status for all dispatches distributed to the destination. Registration instancing is the default for dispatches, in order to support versioning of dispatches. A small portion of users may experience duplicate registrations with content dispatched to some LMS platforms. If you happen to be dispatching content to an LMS with this issue, disabling registration instancing here will resolve the problems. However, dispatch versioning will also be disabled.
|
471
539
|
# @param destination_id Identifier for the destination
|
472
540
|
# @param enabled
|
473
541
|
# @param [Hash] opts the optional parameters
|
@@ -477,11 +545,11 @@ module RusticiSoftwareCloudV2
|
|
477
545
|
@api_client.config.logger.debug 'Calling API: DispatchApi.enable_registration_instancing ...'
|
478
546
|
end
|
479
547
|
# verify the required parameter 'destination_id' is set
|
480
|
-
if
|
548
|
+
if destination_id.nil?
|
481
549
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.enable_registration_instancing"
|
482
550
|
end
|
483
551
|
# verify the required parameter 'enabled' is set
|
484
|
-
if
|
552
|
+
if enabled.nil?
|
485
553
|
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.enable_registration_instancing"
|
486
554
|
end
|
487
555
|
# resource path
|
@@ -514,8 +582,8 @@ module RusticiSoftwareCloudV2
|
|
514
582
|
end
|
515
583
|
return data, status_code, headers
|
516
584
|
end
|
517
|
-
# Get
|
518
|
-
#
|
585
|
+
# Get detailed information about a Destination
|
586
|
+
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
519
587
|
# @param destination_id Identifier for the destination
|
520
588
|
# @param [Hash] opts the optional parameters
|
521
589
|
# @return [DestinationSchema]
|
@@ -524,8 +592,8 @@ module RusticiSoftwareCloudV2
|
|
524
592
|
data
|
525
593
|
end
|
526
594
|
|
527
|
-
# Get
|
528
|
-
#
|
595
|
+
# Get detailed information about a Destination
|
596
|
+
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
529
597
|
# @param destination_id Identifier for the destination
|
530
598
|
# @param [Hash] opts the optional parameters
|
531
599
|
# @return [Array<(DestinationSchema, Fixnum, Hash)>] DestinationSchema data, response status code and response headers
|
@@ -534,7 +602,7 @@ module RusticiSoftwareCloudV2
|
|
534
602
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination ...'
|
535
603
|
end
|
536
604
|
# verify the required parameter 'destination_id' is set
|
537
|
-
if
|
605
|
+
if destination_id.nil?
|
538
606
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination"
|
539
607
|
end
|
540
608
|
# resource path
|
@@ -568,8 +636,8 @@ module RusticiSoftwareCloudV2
|
|
568
636
|
end
|
569
637
|
return data, status_code, headers
|
570
638
|
end
|
571
|
-
#
|
572
|
-
#
|
639
|
+
# Get registration count for a Destination's Dispatches
|
640
|
+
# Returns the registration count for all dispatches distributed to the destination. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
|
573
641
|
# @param destination_id Identifier for the destination
|
574
642
|
# @param [Hash] opts the optional parameters
|
575
643
|
# @return [IntegerResultSchema]
|
@@ -578,8 +646,8 @@ module RusticiSoftwareCloudV2
|
|
578
646
|
data
|
579
647
|
end
|
580
648
|
|
581
|
-
#
|
582
|
-
#
|
649
|
+
# Get registration count for a Destination's Dispatches
|
650
|
+
# Returns the registration count for all dispatches distributed to the destination. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
|
583
651
|
# @param destination_id Identifier for the destination
|
584
652
|
# @param [Hash] opts the optional parameters
|
585
653
|
# @return [Array<(IntegerResultSchema, Fixnum, Hash)>] IntegerResultSchema data, response status code and response headers
|
@@ -588,7 +656,7 @@ module RusticiSoftwareCloudV2
|
|
588
656
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_registration_count ...'
|
589
657
|
end
|
590
658
|
# verify the required parameter 'destination_id' is set
|
591
|
-
if
|
659
|
+
if destination_id.nil?
|
592
660
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_registration_count"
|
593
661
|
end
|
594
662
|
# resource path
|
@@ -622,38 +690,35 @@ module RusticiSoftwareCloudV2
|
|
622
690
|
end
|
623
691
|
return data, status_code, headers
|
624
692
|
end
|
625
|
-
#
|
626
|
-
#
|
693
|
+
# Download a zip file for a Destination's Dispatches
|
694
|
+
# Downloads a zip file containing all of the dispatch packages for the destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud.
|
627
695
|
# @param destination_id Identifier for the destination
|
628
696
|
# @param [Hash] opts the optional parameters
|
629
|
-
# @option opts [String] :type The type of dispatch package to export (
|
697
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM_12 only supported in SCORM Cloud today) (default to SCORM_12)
|
630
698
|
# @option opts [String] :css_url
|
631
|
-
# @option opts [Array<String>] :tags
|
699
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
632
700
|
# @return [File]
|
633
701
|
def get_destination_dispatch_zip(destination_id, opts = {})
|
634
702
|
data, _status_code, _headers = get_destination_dispatch_zip_with_http_info(destination_id, opts)
|
635
703
|
data
|
636
704
|
end
|
637
705
|
|
638
|
-
#
|
639
|
-
#
|
706
|
+
# Download a zip file for a Destination's Dispatches
|
707
|
+
# Downloads a zip file containing all of the dispatch packages for the destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud.
|
640
708
|
# @param destination_id Identifier for the destination
|
641
709
|
# @param [Hash] opts the optional parameters
|
642
|
-
# @option opts [String] :type The type of dispatch package to export (
|
710
|
+
# @option opts [String] :type The type of dispatch package to export (SCORM_12 only supported in SCORM Cloud today)
|
643
711
|
# @option opts [String] :css_url
|
644
|
-
# @option opts [Array<String>] :tags
|
712
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
645
713
|
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
646
714
|
def get_destination_dispatch_zip_with_http_info(destination_id, opts = {})
|
647
715
|
if @api_client.config.debugging
|
648
716
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_zip ...'
|
649
717
|
end
|
650
718
|
# verify the required parameter 'destination_id' is set
|
651
|
-
if
|
719
|
+
if destination_id.nil?
|
652
720
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_zip"
|
653
721
|
end
|
654
|
-
if @api_client.config.client_side_validation && opts[:'type'] && !['SCORM12'].include?(opts[:'type'])
|
655
|
-
fail ArgumentError, 'invalid value for "type", must be one of SCORM12'
|
656
|
-
end
|
657
722
|
# resource path
|
658
723
|
local_var_path = '/dispatch/destinations/{destinationId}/dispatches/zip'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
659
724
|
|
@@ -688,61 +753,61 @@ module RusticiSoftwareCloudV2
|
|
688
753
|
end
|
689
754
|
return data, status_code, headers
|
690
755
|
end
|
691
|
-
# Get a list of
|
692
|
-
#
|
756
|
+
# Get a list of a Destination's Dispatches
|
757
|
+
# Returns a list of dispatches belonging to the destination. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter should only ever yield 0 or 1 results, as a dispatch is the intersection of a course and a destination. This can be useful for identifying if a certain course is dispatched to the destination. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
693
758
|
# @param destination_id Identifier for the destination
|
694
759
|
# @param [Hash] opts the optional parameters
|
695
|
-
# @option opts [String] :course_id Only
|
696
|
-
# @option opts [
|
697
|
-
# @option opts [DateTime] :
|
698
|
-
# @option opts [
|
699
|
-
# @option opts [Array<String>] :tags
|
700
|
-
# @option opts [String] :
|
701
|
-
# @option opts [String] :
|
760
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
761
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
762
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
763
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
764
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
765
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
766
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
767
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
768
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
702
769
|
# @return [DispatchListSchema]
|
703
770
|
def get_destination_dispatches(destination_id, opts = {})
|
704
771
|
data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
|
705
772
|
data
|
706
773
|
end
|
707
774
|
|
708
|
-
# Get a list of
|
709
|
-
#
|
775
|
+
# Get a list of a Destination's Dispatches
|
776
|
+
# Returns a list of dispatches belonging to the destination. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter should only ever yield 0 or 1 results, as a dispatch is the intersection of a course and a destination. This can be useful for identifying if a certain course is dispatched to the destination. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
710
777
|
# @param destination_id Identifier for the destination
|
711
778
|
# @param [Hash] opts the optional parameters
|
712
|
-
# @option opts [String] :course_id Only
|
713
|
-
# @option opts [
|
714
|
-
# @option opts [DateTime] :
|
715
|
-
# @option opts [
|
716
|
-
# @option opts [Array<String>] :tags
|
717
|
-
# @option opts [String] :
|
718
|
-
# @option opts [String] :
|
779
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
780
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
781
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
782
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
783
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
784
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
785
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
786
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
787
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
719
788
|
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
720
789
|
def get_destination_dispatches_with_http_info(destination_id, opts = {})
|
721
790
|
if @api_client.config.debugging
|
722
791
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatches ...'
|
723
792
|
end
|
724
793
|
# verify the required parameter 'destination_id' is set
|
725
|
-
if
|
794
|
+
if destination_id.nil?
|
726
795
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatches"
|
727
796
|
end
|
728
|
-
if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
729
|
-
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
730
|
-
end
|
731
|
-
if @api_client.config.client_side_validation && opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
|
732
|
-
fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
|
733
|
-
end
|
734
797
|
# resource path
|
735
798
|
local_var_path = '/dispatch/destinations/{destinationId}/dispatches'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
736
799
|
|
737
800
|
# query parameters
|
738
801
|
query_params = {}
|
739
802
|
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
740
|
-
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
741
803
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
742
804
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
743
|
-
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
744
805
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
806
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
807
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
808
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
745
809
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
810
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
746
811
|
|
747
812
|
# header parameters
|
748
813
|
header_params = {}
|
@@ -769,8 +834,8 @@ module RusticiSoftwareCloudV2
|
|
769
834
|
end
|
770
835
|
return data, status_code, headers
|
771
836
|
end
|
772
|
-
#
|
773
|
-
#
|
837
|
+
# Get user PII hashing status for a Destination
|
838
|
+
# Returns whether or not user PII hashing is enabled for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
774
839
|
# @param destination_id Identifier for the destination
|
775
840
|
# @param [Hash] opts the optional parameters
|
776
841
|
# @return [EnabledSchema]
|
@@ -779,8 +844,8 @@ module RusticiSoftwareCloudV2
|
|
779
844
|
data
|
780
845
|
end
|
781
846
|
|
782
|
-
#
|
783
|
-
#
|
847
|
+
# Get user PII hashing status for a Destination
|
848
|
+
# Returns whether or not user PII hashing is enabled for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
784
849
|
# @param destination_id Identifier for the destination
|
785
850
|
# @param [Hash] opts the optional parameters
|
786
851
|
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
@@ -789,7 +854,7 @@ module RusticiSoftwareCloudV2
|
|
789
854
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_hash_user_info ...'
|
790
855
|
end
|
791
856
|
# verify the required parameter 'destination_id' is set
|
792
|
-
if
|
857
|
+
if destination_id.nil?
|
793
858
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_hash_user_info"
|
794
859
|
end
|
795
860
|
# resource path
|
@@ -823,8 +888,8 @@ module RusticiSoftwareCloudV2
|
|
823
888
|
end
|
824
889
|
return data, status_code, headers
|
825
890
|
end
|
826
|
-
# Get
|
827
|
-
#
|
891
|
+
# Get tags for a Destination
|
892
|
+
# Returns the tags for the destination.
|
828
893
|
# @param destination_id Identifier for the destination
|
829
894
|
# @param [Hash] opts the optional parameters
|
830
895
|
# @return [TagListSchema]
|
@@ -833,8 +898,8 @@ module RusticiSoftwareCloudV2
|
|
833
898
|
data
|
834
899
|
end
|
835
900
|
|
836
|
-
# Get
|
837
|
-
#
|
901
|
+
# Get tags for a Destination
|
902
|
+
# Returns the tags for the destination.
|
838
903
|
# @param destination_id Identifier for the destination
|
839
904
|
# @param [Hash] opts the optional parameters
|
840
905
|
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
@@ -843,7 +908,7 @@ module RusticiSoftwareCloudV2
|
|
843
908
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_tags ...'
|
844
909
|
end
|
845
910
|
# verify the required parameter 'destination_id' is set
|
846
|
-
if
|
911
|
+
if destination_id.nil?
|
847
912
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_tags"
|
848
913
|
end
|
849
914
|
# resource path
|
@@ -877,55 +942,55 @@ module RusticiSoftwareCloudV2
|
|
877
942
|
end
|
878
943
|
return data, status_code, headers
|
879
944
|
end
|
880
|
-
#
|
881
|
-
#
|
882
|
-
# @param [Hash] opts the optional parameters
|
883
|
-
# @option opts [String] :course_id Only
|
884
|
-
# @option opts [
|
885
|
-
# @option opts [DateTime] :
|
886
|
-
# @option opts [
|
887
|
-
# @option opts [Array<String>] :tags
|
888
|
-
# @option opts [String] :
|
889
|
-
# @option opts [String] :
|
945
|
+
# Get a list of Destinations
|
946
|
+
# Returns a list of destinations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
947
|
+
# @param [Hash] opts the optional parameters
|
948
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
949
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
950
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
951
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
952
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
953
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
954
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to destination_id)
|
955
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
956
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
890
957
|
# @return [DestinationListSchema]
|
891
958
|
def get_destinations(opts = {})
|
892
959
|
data, _status_code, _headers = get_destinations_with_http_info(opts)
|
893
960
|
data
|
894
961
|
end
|
895
962
|
|
896
|
-
#
|
897
|
-
#
|
963
|
+
# Get a list of Destinations
|
964
|
+
# Returns a list of destinations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
898
965
|
# @param [Hash] opts the optional parameters
|
899
|
-
# @option opts [String] :course_id Only
|
900
|
-
# @option opts [
|
901
|
-
# @option opts [DateTime] :
|
902
|
-
# @option opts [
|
903
|
-
# @option opts [Array<String>] :tags
|
904
|
-
# @option opts [String] :
|
905
|
-
# @option opts [String] :
|
966
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
967
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
968
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
969
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
970
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
971
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
972
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
973
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
974
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
906
975
|
# @return [Array<(DestinationListSchema, Fixnum, Hash)>] DestinationListSchema data, response status code and response headers
|
907
976
|
def get_destinations_with_http_info(opts = {})
|
908
977
|
if @api_client.config.debugging
|
909
978
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destinations ...'
|
910
979
|
end
|
911
|
-
if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
912
|
-
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
913
|
-
end
|
914
|
-
if @api_client.config.client_side_validation && opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
|
915
|
-
fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
|
916
|
-
end
|
917
980
|
# resource path
|
918
981
|
local_var_path = '/dispatch/destinations'
|
919
982
|
|
920
983
|
# query parameters
|
921
984
|
query_params = {}
|
922
985
|
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
923
|
-
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
924
986
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
925
987
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
926
|
-
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
927
988
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
989
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
990
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
991
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
928
992
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
993
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
929
994
|
|
930
995
|
# header parameters
|
931
996
|
header_params = {}
|
@@ -952,8 +1017,8 @@ module RusticiSoftwareCloudV2
|
|
952
1017
|
end
|
953
1018
|
return data, status_code, headers
|
954
1019
|
end
|
955
|
-
# Get
|
956
|
-
#
|
1020
|
+
# Get detailed information about a Dispatch
|
1021
|
+
# Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
|
957
1022
|
# @param dispatch_id Identifier for the dispatch
|
958
1023
|
# @param [Hash] opts the optional parameters
|
959
1024
|
# @return [DispatchSchema]
|
@@ -962,8 +1027,8 @@ module RusticiSoftwareCloudV2
|
|
962
1027
|
data
|
963
1028
|
end
|
964
1029
|
|
965
|
-
# Get
|
966
|
-
#
|
1030
|
+
# Get detailed information about a Dispatch
|
1031
|
+
# Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
|
967
1032
|
# @param dispatch_id Identifier for the dispatch
|
968
1033
|
# @param [Hash] opts the optional parameters
|
969
1034
|
# @return [Array<(DispatchSchema, Fixnum, Hash)>] DispatchSchema data, response status code and response headers
|
@@ -972,7 +1037,7 @@ module RusticiSoftwareCloudV2
|
|
972
1037
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch ...'
|
973
1038
|
end
|
974
1039
|
# verify the required parameter 'dispatch_id' is set
|
975
|
-
if
|
1040
|
+
if dispatch_id.nil?
|
976
1041
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch"
|
977
1042
|
end
|
978
1043
|
# resource path
|
@@ -1006,8 +1071,8 @@ module RusticiSoftwareCloudV2
|
|
1006
1071
|
end
|
1007
1072
|
return data, status_code, headers
|
1008
1073
|
end
|
1009
|
-
# Get
|
1010
|
-
#
|
1074
|
+
# Get enabled status of a Dispatch
|
1075
|
+
# Returns the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1011
1076
|
# @param dispatch_id Identifier for the dispatch
|
1012
1077
|
# @param [Hash] opts the optional parameters
|
1013
1078
|
# @return [EnabledSchema]
|
@@ -1016,8 +1081,8 @@ module RusticiSoftwareCloudV2
|
|
1016
1081
|
data
|
1017
1082
|
end
|
1018
1083
|
|
1019
|
-
# Get
|
1020
|
-
#
|
1084
|
+
# Get enabled status of a Dispatch
|
1085
|
+
# Returns the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1021
1086
|
# @param dispatch_id Identifier for the dispatch
|
1022
1087
|
# @param [Hash] opts the optional parameters
|
1023
1088
|
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
@@ -1026,7 +1091,7 @@ module RusticiSoftwareCloudV2
|
|
1026
1091
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_enabled ...'
|
1027
1092
|
end
|
1028
1093
|
# verify the required parameter 'dispatch_id' is set
|
1029
|
-
if
|
1094
|
+
if dispatch_id.nil?
|
1030
1095
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_enabled"
|
1031
1096
|
end
|
1032
1097
|
# resource path
|
@@ -1060,8 +1125,8 @@ module RusticiSoftwareCloudV2
|
|
1060
1125
|
end
|
1061
1126
|
return data, status_code, headers
|
1062
1127
|
end
|
1063
|
-
# Get
|
1064
|
-
#
|
1128
|
+
# Get user PII hashing status for a Dispatch
|
1129
|
+
# Returns whether or not user PII hashing is enabled for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1065
1130
|
# @param dispatch_id Identifier for the dispatch
|
1066
1131
|
# @param [Hash] opts the optional parameters
|
1067
1132
|
# @return [EnabledSchema]
|
@@ -1070,8 +1135,8 @@ module RusticiSoftwareCloudV2
|
|
1070
1135
|
data
|
1071
1136
|
end
|
1072
1137
|
|
1073
|
-
# Get
|
1074
|
-
#
|
1138
|
+
# Get user PII hashing status for a Dispatch
|
1139
|
+
# Returns whether or not user PII hashing is enabled for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1075
1140
|
# @param dispatch_id Identifier for the dispatch
|
1076
1141
|
# @param [Hash] opts the optional parameters
|
1077
1142
|
# @return [Array<(EnabledSchema, Fixnum, Hash)>] EnabledSchema data, response status code and response headers
|
@@ -1080,7 +1145,7 @@ module RusticiSoftwareCloudV2
|
|
1080
1145
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_hash_user_info ...'
|
1081
1146
|
end
|
1082
1147
|
# verify the required parameter 'dispatch_id' is set
|
1083
|
-
if
|
1148
|
+
if dispatch_id.nil?
|
1084
1149
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_hash_user_info"
|
1085
1150
|
end
|
1086
1151
|
# resource path
|
@@ -1114,8 +1179,8 @@ module RusticiSoftwareCloudV2
|
|
1114
1179
|
end
|
1115
1180
|
return data, status_code, headers
|
1116
1181
|
end
|
1117
|
-
# Get
|
1118
|
-
#
|
1182
|
+
# Get registration count for a Dispatch
|
1183
|
+
# Returns the registration count for the dispatch, as well as the date and time of the last count reset, if any. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
|
1119
1184
|
# @param dispatch_id Identifier for the dispatch
|
1120
1185
|
# @param [Hash] opts the optional parameters
|
1121
1186
|
# @return [DispatchRegistrationCountSchema]
|
@@ -1124,8 +1189,8 @@ module RusticiSoftwareCloudV2
|
|
1124
1189
|
data
|
1125
1190
|
end
|
1126
1191
|
|
1127
|
-
# Get
|
1128
|
-
#
|
1192
|
+
# Get registration count for a Dispatch
|
1193
|
+
# Returns the registration count for the dispatch, as well as the date and time of the last count reset, if any. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
|
1129
1194
|
# @param dispatch_id Identifier for the dispatch
|
1130
1195
|
# @param [Hash] opts the optional parameters
|
1131
1196
|
# @return [Array<(DispatchRegistrationCountSchema, Fixnum, Hash)>] DispatchRegistrationCountSchema data, response status code and response headers
|
@@ -1134,7 +1199,7 @@ module RusticiSoftwareCloudV2
|
|
1134
1199
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_registration_count ...'
|
1135
1200
|
end
|
1136
1201
|
# verify the required parameter 'dispatch_id' is set
|
1137
|
-
if
|
1202
|
+
if dispatch_id.nil?
|
1138
1203
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_registration_count"
|
1139
1204
|
end
|
1140
1205
|
# resource path
|
@@ -1168,8 +1233,8 @@ module RusticiSoftwareCloudV2
|
|
1168
1233
|
end
|
1169
1234
|
return data, status_code, headers
|
1170
1235
|
end
|
1171
|
-
# Get
|
1172
|
-
#
|
1236
|
+
# Get tags for a Dispatch
|
1237
|
+
# Returns the tags for the dispatch.
|
1173
1238
|
# @param dispatch_id Identifier for the dispatch
|
1174
1239
|
# @param [Hash] opts the optional parameters
|
1175
1240
|
# @return [TagListSchema]
|
@@ -1178,8 +1243,8 @@ module RusticiSoftwareCloudV2
|
|
1178
1243
|
data
|
1179
1244
|
end
|
1180
1245
|
|
1181
|
-
# Get
|
1182
|
-
#
|
1246
|
+
# Get tags for a Dispatch
|
1247
|
+
# Returns the tags for the dispatch.
|
1183
1248
|
# @param dispatch_id Identifier for the dispatch
|
1184
1249
|
# @param [Hash] opts the optional parameters
|
1185
1250
|
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
@@ -1188,7 +1253,7 @@ module RusticiSoftwareCloudV2
|
|
1188
1253
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_tags ...'
|
1189
1254
|
end
|
1190
1255
|
# verify the required parameter 'dispatch_id' is set
|
1191
|
-
if
|
1256
|
+
if dispatch_id.nil?
|
1192
1257
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_tags"
|
1193
1258
|
end
|
1194
1259
|
# resource path
|
@@ -1222,36 +1287,33 @@ module RusticiSoftwareCloudV2
|
|
1222
1287
|
end
|
1223
1288
|
return data, status_code, headers
|
1224
1289
|
end
|
1225
|
-
#
|
1226
|
-
#
|
1290
|
+
# Download a zip package for a Dispatch
|
1291
|
+
# Downloads a zip package for the dispatch. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination.
|
1227
1292
|
# @param dispatch_id Identifier for the dispatch
|
1228
1293
|
# @param [Hash] opts the optional parameters
|
1229
|
-
# @option opts [String] :type The type of dispatch package to export (
|
1230
|
-
# @option opts [String] :css_url
|
1294
|
+
# @option opts [String] :type The type of dispatch package to export (currently only SCORM_12 available) (default to SCORM_12)
|
1295
|
+
# @option opts [String] :css_url Custom CSS to apply to the dispatch package
|
1231
1296
|
# @return [File]
|
1232
1297
|
def get_dispatch_zip(dispatch_id, opts = {})
|
1233
1298
|
data, _status_code, _headers = get_dispatch_zip_with_http_info(dispatch_id, opts)
|
1234
1299
|
data
|
1235
1300
|
end
|
1236
1301
|
|
1237
|
-
#
|
1238
|
-
#
|
1302
|
+
# Download a zip package for a Dispatch
|
1303
|
+
# Downloads a zip package for the dispatch. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination.
|
1239
1304
|
# @param dispatch_id Identifier for the dispatch
|
1240
1305
|
# @param [Hash] opts the optional parameters
|
1241
|
-
# @option opts [String] :type The type of dispatch package to export (
|
1242
|
-
# @option opts [String] :css_url
|
1306
|
+
# @option opts [String] :type The type of dispatch package to export (currently only SCORM_12 available)
|
1307
|
+
# @option opts [String] :css_url Custom CSS to apply to the dispatch package
|
1243
1308
|
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
1244
1309
|
def get_dispatch_zip_with_http_info(dispatch_id, opts = {})
|
1245
1310
|
if @api_client.config.debugging
|
1246
1311
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_zip ...'
|
1247
1312
|
end
|
1248
1313
|
# verify the required parameter 'dispatch_id' is set
|
1249
|
-
if
|
1314
|
+
if dispatch_id.nil?
|
1250
1315
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_zip"
|
1251
1316
|
end
|
1252
|
-
if @api_client.config.client_side_validation && opts[:'type'] && !['SCORM12'].include?(opts[:'type'])
|
1253
|
-
fail ArgumentError, 'invalid value for "type", must be one of SCORM12'
|
1254
|
-
end
|
1255
1317
|
# resource path
|
1256
1318
|
local_var_path = '/dispatch/dispatches/{dispatchId}/zip'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1257
1319
|
|
@@ -1285,55 +1347,55 @@ module RusticiSoftwareCloudV2
|
|
1285
1347
|
end
|
1286
1348
|
return data, status_code, headers
|
1287
1349
|
end
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
# @param [Hash] opts the optional parameters
|
1291
|
-
# @option opts [String] :course_id Only
|
1292
|
-
# @option opts [
|
1293
|
-
# @option opts [DateTime] :
|
1294
|
-
# @option opts [
|
1295
|
-
# @option opts [Array<String>] :tags
|
1296
|
-
# @option opts [String] :
|
1297
|
-
# @option opts [String] :
|
1350
|
+
# Get a list of Dispatches
|
1351
|
+
# Returns a list of dispatches. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter will allow for viewing which destinations the course has been dispatched to. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
1352
|
+
# @param [Hash] opts the optional parameters
|
1353
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
1354
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1355
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1356
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
1357
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
1358
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
1359
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
1360
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
1361
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
1298
1362
|
# @return [DispatchListSchema]
|
1299
1363
|
def get_dispatches(opts = {})
|
1300
1364
|
data, _status_code, _headers = get_dispatches_with_http_info(opts)
|
1301
1365
|
data
|
1302
1366
|
end
|
1303
1367
|
|
1304
|
-
#
|
1305
|
-
#
|
1368
|
+
# Get a list of Dispatches
|
1369
|
+
# Returns a list of dispatches. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter will allow for viewing which destinations the course has been dispatched to. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
1306
1370
|
# @param [Hash] opts the optional parameters
|
1307
|
-
# @option opts [String] :course_id Only
|
1308
|
-
# @option opts [
|
1309
|
-
# @option opts [DateTime] :
|
1310
|
-
# @option opts [
|
1311
|
-
# @option opts [Array<String>] :tags
|
1312
|
-
# @option opts [String] :
|
1313
|
-
# @option opts [String] :
|
1371
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
1372
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1373
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
1374
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
1375
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
1376
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
1377
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
1378
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
1379
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
1314
1380
|
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
1315
1381
|
def get_dispatches_with_http_info(opts = {})
|
1316
1382
|
if @api_client.config.debugging
|
1317
1383
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatches ...'
|
1318
1384
|
end
|
1319
|
-
if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
1320
|
-
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
1321
|
-
end
|
1322
|
-
if @api_client.config.client_side_validation && opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
|
1323
|
-
fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
|
1324
|
-
end
|
1325
1385
|
# resource path
|
1326
1386
|
local_var_path = '/dispatch/dispatches'
|
1327
1387
|
|
1328
1388
|
# query parameters
|
1329
1389
|
query_params = {}
|
1330
1390
|
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
1331
|
-
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1332
1391
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1333
1392
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
1334
|
-
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
1335
1393
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
1394
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
1395
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1396
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
1336
1397
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
1398
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1337
1399
|
|
1338
1400
|
# header parameters
|
1339
1401
|
header_params = {}
|
@@ -1360,8 +1422,235 @@ module RusticiSoftwareCloudV2
|
|
1360
1422
|
end
|
1361
1423
|
return data, status_code, headers
|
1362
1424
|
end
|
1363
|
-
#
|
1364
|
-
#
|
1425
|
+
# Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification.
|
1426
|
+
# Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step.
|
1427
|
+
# @param dispatch_id Identifier for the dispatch
|
1428
|
+
# @param [Hash] opts the optional parameters
|
1429
|
+
# @return [DispatchLti13InfoSchema]
|
1430
|
+
def get_lti13_dispatch(dispatch_id, opts = {})
|
1431
|
+
data, _status_code, _headers = get_lti13_dispatch_with_http_info(dispatch_id, opts)
|
1432
|
+
data
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification.
|
1436
|
+
# Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step.
|
1437
|
+
# @param dispatch_id Identifier for the dispatch
|
1438
|
+
# @param [Hash] opts the optional parameters
|
1439
|
+
# @return [Array<(DispatchLti13InfoSchema, Fixnum, Hash)>] DispatchLti13InfoSchema data, response status code and response headers
|
1440
|
+
def get_lti13_dispatch_with_http_info(dispatch_id, opts = {})
|
1441
|
+
if @api_client.config.debugging
|
1442
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch ...'
|
1443
|
+
end
|
1444
|
+
# verify the required parameter 'dispatch_id' is set
|
1445
|
+
if dispatch_id.nil?
|
1446
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti13_dispatch"
|
1447
|
+
end
|
1448
|
+
# resource path
|
1449
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/lti13'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1450
|
+
|
1451
|
+
# query parameters
|
1452
|
+
query_params = {}
|
1453
|
+
|
1454
|
+
# header parameters
|
1455
|
+
header_params = {}
|
1456
|
+
# HTTP header 'Accept' (if needed)
|
1457
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1458
|
+
# HTTP header 'Content-Type'
|
1459
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1460
|
+
|
1461
|
+
# form parameters
|
1462
|
+
form_params = {}
|
1463
|
+
|
1464
|
+
# http body (model)
|
1465
|
+
post_body = nil
|
1466
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1467
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1468
|
+
:header_params => header_params,
|
1469
|
+
:query_params => query_params,
|
1470
|
+
:form_params => form_params,
|
1471
|
+
:body => post_body,
|
1472
|
+
:auth_names => auth_names,
|
1473
|
+
:return_type => 'DispatchLti13InfoSchema')
|
1474
|
+
if @api_client.config.debugging
|
1475
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_lti13_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1476
|
+
end
|
1477
|
+
return data, status_code, headers
|
1478
|
+
end
|
1479
|
+
# Launch this dispatch using the IMS LTI 1.3 specification.
|
1480
|
+
# Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course).
|
1481
|
+
# @param dispatch_id Identifier for the dispatch
|
1482
|
+
# @param external_config External configuration object
|
1483
|
+
# @param jwt
|
1484
|
+
# @param [Hash] opts the optional parameters
|
1485
|
+
# @return [nil]
|
1486
|
+
def get_lti13_dispatch_launch(dispatch_id, external_config, jwt, opts = {})
|
1487
|
+
get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts)
|
1488
|
+
nil
|
1489
|
+
end
|
1490
|
+
|
1491
|
+
# Launch this dispatch using the IMS LTI 1.3 specification.
|
1492
|
+
# Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course).
|
1493
|
+
# @param dispatch_id Identifier for the dispatch
|
1494
|
+
# @param external_config External configuration object
|
1495
|
+
# @param jwt
|
1496
|
+
# @param [Hash] opts the optional parameters
|
1497
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1498
|
+
def get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts = {})
|
1499
|
+
if @api_client.config.debugging
|
1500
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch_launch ...'
|
1501
|
+
end
|
1502
|
+
# verify the required parameter 'dispatch_id' is set
|
1503
|
+
if dispatch_id.nil?
|
1504
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti13_dispatch_launch"
|
1505
|
+
end
|
1506
|
+
# verify the required parameter 'external_config' is set
|
1507
|
+
if external_config.nil?
|
1508
|
+
fail ArgumentError, "Missing the required parameter 'external_config' when calling DispatchApi.get_lti13_dispatch_launch"
|
1509
|
+
end
|
1510
|
+
# verify the required parameter 'jwt' is set
|
1511
|
+
if jwt.nil?
|
1512
|
+
fail ArgumentError, "Missing the required parameter 'jwt' when calling DispatchApi.get_lti13_dispatch_launch"
|
1513
|
+
end
|
1514
|
+
# resource path
|
1515
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/launches'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1516
|
+
|
1517
|
+
# query parameters
|
1518
|
+
query_params = {}
|
1519
|
+
query_params[:'externalConfig'] = external_config
|
1520
|
+
query_params[:'jwt'] = jwt
|
1521
|
+
|
1522
|
+
# header parameters
|
1523
|
+
header_params = {}
|
1524
|
+
# HTTP header 'Accept' (if needed)
|
1525
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1526
|
+
# HTTP header 'Content-Type'
|
1527
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1528
|
+
|
1529
|
+
# form parameters
|
1530
|
+
form_params = {}
|
1531
|
+
|
1532
|
+
# http body (model)
|
1533
|
+
post_body = nil
|
1534
|
+
auth_names = ['UNSECURED']
|
1535
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1536
|
+
:header_params => header_params,
|
1537
|
+
:query_params => query_params,
|
1538
|
+
:form_params => form_params,
|
1539
|
+
:body => post_body,
|
1540
|
+
:auth_names => auth_names)
|
1541
|
+
if @api_client.config.debugging
|
1542
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_lti13_dispatch_launch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1543
|
+
end
|
1544
|
+
return data, status_code, headers
|
1545
|
+
end
|
1546
|
+
# Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId`
|
1547
|
+
# @param destination_id Identifier for the destination
|
1548
|
+
# @param [Hash] opts the optional parameters
|
1549
|
+
# @return [Lti13ToolConfigurationSchema]
|
1550
|
+
def get_lti13_tool_configuration_schema(destination_id, opts = {})
|
1551
|
+
data, _status_code, _headers = get_lti13_tool_configuration_schema_with_http_info(destination_id, opts)
|
1552
|
+
data
|
1553
|
+
end
|
1554
|
+
|
1555
|
+
# Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId`
|
1556
|
+
# @param destination_id Identifier for the destination
|
1557
|
+
# @param [Hash] opts the optional parameters
|
1558
|
+
# @return [Array<(Lti13ToolConfigurationSchema, Fixnum, Hash)>] Lti13ToolConfigurationSchema data, response status code and response headers
|
1559
|
+
def get_lti13_tool_configuration_schema_with_http_info(destination_id, opts = {})
|
1560
|
+
if @api_client.config.debugging
|
1561
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_tool_configuration_schema ...'
|
1562
|
+
end
|
1563
|
+
# verify the required parameter 'destination_id' is set
|
1564
|
+
if destination_id.nil?
|
1565
|
+
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_lti13_tool_configuration_schema"
|
1566
|
+
end
|
1567
|
+
# resource path
|
1568
|
+
local_var_path = '/dispatch/destinations/{destinationId}/lti13'.sub('{' + 'destinationId' + '}', destination_id.to_s)
|
1569
|
+
|
1570
|
+
# query parameters
|
1571
|
+
query_params = {}
|
1572
|
+
|
1573
|
+
# header parameters
|
1574
|
+
header_params = {}
|
1575
|
+
# HTTP header 'Accept' (if needed)
|
1576
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1577
|
+
# HTTP header 'Content-Type'
|
1578
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1579
|
+
|
1580
|
+
# form parameters
|
1581
|
+
form_params = {}
|
1582
|
+
|
1583
|
+
# http body (model)
|
1584
|
+
post_body = nil
|
1585
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1586
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1587
|
+
:header_params => header_params,
|
1588
|
+
:query_params => query_params,
|
1589
|
+
:form_params => form_params,
|
1590
|
+
:body => post_body,
|
1591
|
+
:auth_names => auth_names,
|
1592
|
+
:return_type => 'Lti13ToolConfigurationSchema')
|
1593
|
+
if @api_client.config.debugging
|
1594
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_lti13_tool_configuration_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1595
|
+
end
|
1596
|
+
return data, status_code, headers
|
1597
|
+
end
|
1598
|
+
# Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
|
1599
|
+
# Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch.
|
1600
|
+
# @param dispatch_id Identifier for the dispatch
|
1601
|
+
# @param [Hash] opts the optional parameters
|
1602
|
+
# @return [DispatchLtiInfoSchema]
|
1603
|
+
def get_lti_dispatch(dispatch_id, opts = {})
|
1604
|
+
data, _status_code, _headers = get_lti_dispatch_with_http_info(dispatch_id, opts)
|
1605
|
+
data
|
1606
|
+
end
|
1607
|
+
|
1608
|
+
# Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
|
1609
|
+
# Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch.
|
1610
|
+
# @param dispatch_id Identifier for the dispatch
|
1611
|
+
# @param [Hash] opts the optional parameters
|
1612
|
+
# @return [Array<(DispatchLtiInfoSchema, Fixnum, Hash)>] DispatchLtiInfoSchema data, response status code and response headers
|
1613
|
+
def get_lti_dispatch_with_http_info(dispatch_id, opts = {})
|
1614
|
+
if @api_client.config.debugging
|
1615
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.get_lti_dispatch ...'
|
1616
|
+
end
|
1617
|
+
# verify the required parameter 'dispatch_id' is set
|
1618
|
+
if dispatch_id.nil?
|
1619
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti_dispatch"
|
1620
|
+
end
|
1621
|
+
# resource path
|
1622
|
+
local_var_path = '/dispatch/dispatches/{dispatchId}/lti'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
|
1623
|
+
|
1624
|
+
# query parameters
|
1625
|
+
query_params = {}
|
1626
|
+
|
1627
|
+
# header parameters
|
1628
|
+
header_params = {}
|
1629
|
+
# HTTP header 'Accept' (if needed)
|
1630
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1631
|
+
# HTTP header 'Content-Type'
|
1632
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1633
|
+
|
1634
|
+
# form parameters
|
1635
|
+
form_params = {}
|
1636
|
+
|
1637
|
+
# http body (model)
|
1638
|
+
post_body = nil
|
1639
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1640
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1641
|
+
:header_params => header_params,
|
1642
|
+
:query_params => query_params,
|
1643
|
+
:form_params => form_params,
|
1644
|
+
:body => post_body,
|
1645
|
+
:auth_names => auth_names,
|
1646
|
+
:return_type => 'DispatchLtiInfoSchema')
|
1647
|
+
if @api_client.config.debugging
|
1648
|
+
@api_client.config.logger.debug "API called: DispatchApi#get_lti_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1649
|
+
end
|
1650
|
+
return data, status_code, headers
|
1651
|
+
end
|
1652
|
+
# Add tags to a Destination
|
1653
|
+
# Applies the provided tags to the destination. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
|
1365
1654
|
# @param destination_id Identifier for the destination
|
1366
1655
|
# @param tags
|
1367
1656
|
# @param [Hash] opts the optional parameters
|
@@ -1371,8 +1660,8 @@ module RusticiSoftwareCloudV2
|
|
1371
1660
|
nil
|
1372
1661
|
end
|
1373
1662
|
|
1374
|
-
#
|
1375
|
-
#
|
1663
|
+
# Add tags to a Destination
|
1664
|
+
# Applies the provided tags to the destination. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
|
1376
1665
|
# @param destination_id Identifier for the destination
|
1377
1666
|
# @param tags
|
1378
1667
|
# @param [Hash] opts the optional parameters
|
@@ -1382,11 +1671,11 @@ module RusticiSoftwareCloudV2
|
|
1382
1671
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags ...'
|
1383
1672
|
end
|
1384
1673
|
# verify the required parameter 'destination_id' is set
|
1385
|
-
if
|
1674
|
+
if destination_id.nil?
|
1386
1675
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.put_destination_tags"
|
1387
1676
|
end
|
1388
1677
|
# verify the required parameter 'tags' is set
|
1389
|
-
if
|
1678
|
+
if tags.nil?
|
1390
1679
|
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_destination_tags"
|
1391
1680
|
end
|
1392
1681
|
# resource path
|
@@ -1419,9 +1708,9 @@ module RusticiSoftwareCloudV2
|
|
1419
1708
|
end
|
1420
1709
|
return data, status_code, headers
|
1421
1710
|
end
|
1422
|
-
#
|
1423
|
-
#
|
1424
|
-
# @param batch
|
1711
|
+
# Add a group of tags to a group of Destinations
|
1712
|
+
# Applies all of the provided tags on all of the provided destinations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
|
1713
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1425
1714
|
# @param [Hash] opts the optional parameters
|
1426
1715
|
# @return [nil]
|
1427
1716
|
def put_destination_tags_batch(batch, opts = {})
|
@@ -1429,9 +1718,9 @@ module RusticiSoftwareCloudV2
|
|
1429
1718
|
nil
|
1430
1719
|
end
|
1431
1720
|
|
1432
|
-
#
|
1433
|
-
#
|
1434
|
-
# @param batch
|
1721
|
+
# Add a group of tags to a group of Destinations
|
1722
|
+
# Applies all of the provided tags on all of the provided destinations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
|
1723
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1435
1724
|
# @param [Hash] opts the optional parameters
|
1436
1725
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1437
1726
|
def put_destination_tags_batch_with_http_info(batch, opts = {})
|
@@ -1439,7 +1728,7 @@ module RusticiSoftwareCloudV2
|
|
1439
1728
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags_batch ...'
|
1440
1729
|
end
|
1441
1730
|
# verify the required parameter 'batch' is set
|
1442
|
-
if
|
1731
|
+
if batch.nil?
|
1443
1732
|
fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_destination_tags_batch"
|
1444
1733
|
end
|
1445
1734
|
# resource path
|
@@ -1472,8 +1761,8 @@ module RusticiSoftwareCloudV2
|
|
1472
1761
|
end
|
1473
1762
|
return data, status_code, headers
|
1474
1763
|
end
|
1475
|
-
#
|
1476
|
-
#
|
1764
|
+
# Add tags to a Dispatch
|
1765
|
+
# Applies the provided tags to the dispatch. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
|
1477
1766
|
# @param dispatch_id Identifier for the dispatch
|
1478
1767
|
# @param tags
|
1479
1768
|
# @param [Hash] opts the optional parameters
|
@@ -1483,8 +1772,8 @@ module RusticiSoftwareCloudV2
|
|
1483
1772
|
nil
|
1484
1773
|
end
|
1485
1774
|
|
1486
|
-
#
|
1487
|
-
#
|
1775
|
+
# Add tags to a Dispatch
|
1776
|
+
# Applies the provided tags to the dispatch. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
|
1488
1777
|
# @param dispatch_id Identifier for the dispatch
|
1489
1778
|
# @param tags
|
1490
1779
|
# @param [Hash] opts the optional parameters
|
@@ -1494,11 +1783,11 @@ module RusticiSoftwareCloudV2
|
|
1494
1783
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags ...'
|
1495
1784
|
end
|
1496
1785
|
# verify the required parameter 'dispatch_id' is set
|
1497
|
-
if
|
1786
|
+
if dispatch_id.nil?
|
1498
1787
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.put_dispatch_tags"
|
1499
1788
|
end
|
1500
1789
|
# verify the required parameter 'tags' is set
|
1501
|
-
if
|
1790
|
+
if tags.nil?
|
1502
1791
|
fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_dispatch_tags"
|
1503
1792
|
end
|
1504
1793
|
# resource path
|
@@ -1531,9 +1820,9 @@ module RusticiSoftwareCloudV2
|
|
1531
1820
|
end
|
1532
1821
|
return data, status_code, headers
|
1533
1822
|
end
|
1534
|
-
#
|
1535
|
-
#
|
1536
|
-
# @param batch
|
1823
|
+
# Add a group of tags to a group of Dispatches
|
1824
|
+
# Applies all of the provided tags on all of the provided dispatches. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
|
1825
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1537
1826
|
# @param [Hash] opts the optional parameters
|
1538
1827
|
# @return [nil]
|
1539
1828
|
def put_dispatch_tags_batch(batch, opts = {})
|
@@ -1541,9 +1830,9 @@ module RusticiSoftwareCloudV2
|
|
1541
1830
|
nil
|
1542
1831
|
end
|
1543
1832
|
|
1544
|
-
#
|
1545
|
-
#
|
1546
|
-
# @param batch
|
1833
|
+
# Add a group of tags to a group of Dispatches
|
1834
|
+
# Applies all of the provided tags on all of the provided dispatches. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
|
1835
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
1547
1836
|
# @param [Hash] opts the optional parameters
|
1548
1837
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1549
1838
|
def put_dispatch_tags_batch_with_http_info(batch, opts = {})
|
@@ -1551,7 +1840,7 @@ module RusticiSoftwareCloudV2
|
|
1551
1840
|
@api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags_batch ...'
|
1552
1841
|
end
|
1553
1842
|
# verify the required parameter 'batch' is set
|
1554
|
-
if
|
1843
|
+
if batch.nil?
|
1555
1844
|
fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_dispatch_tags_batch"
|
1556
1845
|
end
|
1557
1846
|
# resource path
|
@@ -1584,8 +1873,8 @@ module RusticiSoftwareCloudV2
|
|
1584
1873
|
end
|
1585
1874
|
return data, status_code, headers
|
1586
1875
|
end
|
1587
|
-
#
|
1588
|
-
#
|
1876
|
+
# Reset registration counts for a Destination's Dispatches
|
1877
|
+
# Clears the registration count for all dispatches distributed to the destination. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
|
1589
1878
|
# @param destination_id Identifier for the destination
|
1590
1879
|
# @param [Hash] opts the optional parameters
|
1591
1880
|
# @return [nil]
|
@@ -1594,8 +1883,8 @@ module RusticiSoftwareCloudV2
|
|
1594
1883
|
nil
|
1595
1884
|
end
|
1596
1885
|
|
1597
|
-
#
|
1598
|
-
#
|
1886
|
+
# Reset registration counts for a Destination's Dispatches
|
1887
|
+
# Clears the registration count for all dispatches distributed to the destination. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
|
1599
1888
|
# @param destination_id Identifier for the destination
|
1600
1889
|
# @param [Hash] opts the optional parameters
|
1601
1890
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -1604,7 +1893,7 @@ module RusticiSoftwareCloudV2
|
|
1604
1893
|
@api_client.config.logger.debug 'Calling API: DispatchApi.reset_destination_dispatch_registration_count ...'
|
1605
1894
|
end
|
1606
1895
|
# verify the required parameter 'destination_id' is set
|
1607
|
-
if
|
1896
|
+
if destination_id.nil?
|
1608
1897
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.reset_destination_dispatch_registration_count"
|
1609
1898
|
end
|
1610
1899
|
# resource path
|
@@ -1637,8 +1926,8 @@ module RusticiSoftwareCloudV2
|
|
1637
1926
|
end
|
1638
1927
|
return data, status_code, headers
|
1639
1928
|
end
|
1640
|
-
# Reset registration count
|
1641
|
-
#
|
1929
|
+
# Reset registration count for a Dispatch
|
1930
|
+
# Clears the registration count for the dispatch. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
|
1642
1931
|
# @param dispatch_id Identifier for the dispatch
|
1643
1932
|
# @param [Hash] opts the optional parameters
|
1644
1933
|
# @return [nil]
|
@@ -1647,8 +1936,8 @@ module RusticiSoftwareCloudV2
|
|
1647
1936
|
nil
|
1648
1937
|
end
|
1649
1938
|
|
1650
|
-
# Reset registration count
|
1651
|
-
#
|
1939
|
+
# Reset registration count for a Dispatch
|
1940
|
+
# Clears the registration count for the dispatch. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
|
1652
1941
|
# @param dispatch_id Identifier for the dispatch
|
1653
1942
|
# @param [Hash] opts the optional parameters
|
1654
1943
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -1657,7 +1946,7 @@ module RusticiSoftwareCloudV2
|
|
1657
1946
|
@api_client.config.logger.debug 'Calling API: DispatchApi.reset_dispatch_registration_count ...'
|
1658
1947
|
end
|
1659
1948
|
# verify the required parameter 'dispatch_id' is set
|
1660
|
-
if
|
1949
|
+
if dispatch_id.nil?
|
1661
1950
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.reset_dispatch_registration_count"
|
1662
1951
|
end
|
1663
1952
|
# resource path
|
@@ -1690,7 +1979,8 @@ module RusticiSoftwareCloudV2
|
|
1690
1979
|
end
|
1691
1980
|
return data, status_code, headers
|
1692
1981
|
end
|
1693
|
-
#
|
1982
|
+
# Create or update a Destination
|
1983
|
+
# Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. >**Note:** >While the \"updated\" and \"created\" values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored.
|
1694
1984
|
# @param destination_id Identifier for the destination
|
1695
1985
|
# @param destination
|
1696
1986
|
# @param [Hash] opts the optional parameters
|
@@ -1700,7 +1990,8 @@ module RusticiSoftwareCloudV2
|
|
1700
1990
|
nil
|
1701
1991
|
end
|
1702
1992
|
|
1703
|
-
#
|
1993
|
+
# Create or update a Destination
|
1994
|
+
# Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. >**Note:** >While the \"updated\" and \"created\" values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored.
|
1704
1995
|
# @param destination_id Identifier for the destination
|
1705
1996
|
# @param destination
|
1706
1997
|
# @param [Hash] opts the optional parameters
|
@@ -1710,11 +2001,11 @@ module RusticiSoftwareCloudV2
|
|
1710
2001
|
@api_client.config.logger.debug 'Calling API: DispatchApi.set_destination ...'
|
1711
2002
|
end
|
1712
2003
|
# verify the required parameter 'destination_id' is set
|
1713
|
-
if
|
2004
|
+
if destination_id.nil?
|
1714
2005
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination"
|
1715
2006
|
end
|
1716
2007
|
# verify the required parameter 'destination' is set
|
1717
|
-
if
|
2008
|
+
if destination.nil?
|
1718
2009
|
fail ArgumentError, "Missing the required parameter 'destination' when calling DispatchApi.set_destination"
|
1719
2010
|
end
|
1720
2011
|
# resource path
|
@@ -1747,8 +2038,8 @@ module RusticiSoftwareCloudV2
|
|
1747
2038
|
end
|
1748
2039
|
return data, status_code, headers
|
1749
2040
|
end
|
1750
|
-
#
|
1751
|
-
#
|
2041
|
+
# Update enabled status for a Destination's Dispatches
|
2042
|
+
# Updates the enabled status for all dispatches distributed to the destination. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1752
2043
|
# @param destination_id Identifier for the destination
|
1753
2044
|
# @param enabled
|
1754
2045
|
# @param [Hash] opts the optional parameters
|
@@ -1758,8 +2049,8 @@ module RusticiSoftwareCloudV2
|
|
1758
2049
|
nil
|
1759
2050
|
end
|
1760
2051
|
|
1761
|
-
#
|
1762
|
-
#
|
2052
|
+
# Update enabled status for a Destination's Dispatches
|
2053
|
+
# Updates the enabled status for all dispatches distributed to the destination. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1763
2054
|
# @param destination_id Identifier for the destination
|
1764
2055
|
# @param enabled
|
1765
2056
|
# @param [Hash] opts the optional parameters
|
@@ -1769,11 +2060,11 @@ module RusticiSoftwareCloudV2
|
|
1769
2060
|
@api_client.config.logger.debug 'Calling API: DispatchApi.set_destination_dispatch_enabled ...'
|
1770
2061
|
end
|
1771
2062
|
# verify the required parameter 'destination_id' is set
|
1772
|
-
if
|
2063
|
+
if destination_id.nil?
|
1773
2064
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination_dispatch_enabled"
|
1774
2065
|
end
|
1775
2066
|
# verify the required parameter 'enabled' is set
|
1776
|
-
if
|
2067
|
+
if enabled.nil?
|
1777
2068
|
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_destination_dispatch_enabled"
|
1778
2069
|
end
|
1779
2070
|
# resource path
|
@@ -1806,8 +2097,8 @@ module RusticiSoftwareCloudV2
|
|
1806
2097
|
end
|
1807
2098
|
return data, status_code, headers
|
1808
2099
|
end
|
1809
|
-
#
|
1810
|
-
#
|
2100
|
+
# Update enabled status for a Dispatch
|
2101
|
+
# Updates the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1811
2102
|
# @param dispatch_id Identifier for the dispatch
|
1812
2103
|
# @param enabled
|
1813
2104
|
# @param [Hash] opts the optional parameters
|
@@ -1817,8 +2108,8 @@ module RusticiSoftwareCloudV2
|
|
1817
2108
|
nil
|
1818
2109
|
end
|
1819
2110
|
|
1820
|
-
#
|
1821
|
-
#
|
2111
|
+
# Update enabled status for a Dispatch
|
2112
|
+
# Updates the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1822
2113
|
# @param dispatch_id Identifier for the dispatch
|
1823
2114
|
# @param enabled
|
1824
2115
|
# @param [Hash] opts the optional parameters
|
@@ -1828,11 +2119,11 @@ module RusticiSoftwareCloudV2
|
|
1828
2119
|
@api_client.config.logger.debug 'Calling API: DispatchApi.set_dispatch_enabled ...'
|
1829
2120
|
end
|
1830
2121
|
# verify the required parameter 'dispatch_id' is set
|
1831
|
-
if
|
2122
|
+
if dispatch_id.nil?
|
1832
2123
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.set_dispatch_enabled"
|
1833
2124
|
end
|
1834
2125
|
# verify the required parameter 'enabled' is set
|
1835
|
-
if
|
2126
|
+
if enabled.nil?
|
1836
2127
|
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_dispatch_enabled"
|
1837
2128
|
end
|
1838
2129
|
# resource path
|
@@ -1865,8 +2156,8 @@ module RusticiSoftwareCloudV2
|
|
1865
2156
|
end
|
1866
2157
|
return data, status_code, headers
|
1867
2158
|
end
|
1868
|
-
#
|
1869
|
-
#
|
2159
|
+
# Update user PII hashing status for a Destination
|
2160
|
+
# Updates user PII hashing status for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1870
2161
|
# @param destination_id Identifier for the destination
|
1871
2162
|
# @param enabled
|
1872
2163
|
# @param [Hash] opts the optional parameters
|
@@ -1876,8 +2167,8 @@ module RusticiSoftwareCloudV2
|
|
1876
2167
|
nil
|
1877
2168
|
end
|
1878
2169
|
|
1879
|
-
#
|
1880
|
-
#
|
2170
|
+
# Update user PII hashing status for a Destination
|
2171
|
+
# Updates user PII hashing status for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1881
2172
|
# @param destination_id Identifier for the destination
|
1882
2173
|
# @param enabled
|
1883
2174
|
# @param [Hash] opts the optional parameters
|
@@ -1887,11 +2178,11 @@ module RusticiSoftwareCloudV2
|
|
1887
2178
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_destination_hash_user_info ...'
|
1888
2179
|
end
|
1889
2180
|
# verify the required parameter 'destination_id' is set
|
1890
|
-
if
|
2181
|
+
if destination_id.nil?
|
1891
2182
|
fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.update_destination_hash_user_info"
|
1892
2183
|
end
|
1893
2184
|
# verify the required parameter 'enabled' is set
|
1894
|
-
if
|
2185
|
+
if enabled.nil?
|
1895
2186
|
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_destination_hash_user_info"
|
1896
2187
|
end
|
1897
2188
|
# resource path
|
@@ -1924,8 +2215,8 @@ module RusticiSoftwareCloudV2
|
|
1924
2215
|
end
|
1925
2216
|
return data, status_code, headers
|
1926
2217
|
end
|
1927
|
-
# Update
|
1928
|
-
#
|
2218
|
+
# Update information about a Dispatch
|
2219
|
+
# Updates information about the dispatch, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
1929
2220
|
# @param dispatch_id Identifier for the dispatch
|
1930
2221
|
# @param dispatch_properties
|
1931
2222
|
# @param [Hash] opts the optional parameters
|
@@ -1935,8 +2226,8 @@ module RusticiSoftwareCloudV2
|
|
1935
2226
|
nil
|
1936
2227
|
end
|
1937
2228
|
|
1938
|
-
# Update
|
1939
|
-
#
|
2229
|
+
# Update information about a Dispatch
|
2230
|
+
# Updates information about the dispatch, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
1940
2231
|
# @param dispatch_id Identifier for the dispatch
|
1941
2232
|
# @param dispatch_properties
|
1942
2233
|
# @param [Hash] opts the optional parameters
|
@@ -1946,11 +2237,11 @@ module RusticiSoftwareCloudV2
|
|
1946
2237
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch ...'
|
1947
2238
|
end
|
1948
2239
|
# verify the required parameter 'dispatch_id' is set
|
1949
|
-
if
|
2240
|
+
if dispatch_id.nil?
|
1950
2241
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch"
|
1951
2242
|
end
|
1952
2243
|
# verify the required parameter 'dispatch_properties' is set
|
1953
|
-
if
|
2244
|
+
if dispatch_properties.nil?
|
1954
2245
|
fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatch"
|
1955
2246
|
end
|
1956
2247
|
# resource path
|
@@ -1983,8 +2274,8 @@ module RusticiSoftwareCloudV2
|
|
1983
2274
|
end
|
1984
2275
|
return data, status_code, headers
|
1985
2276
|
end
|
1986
|
-
#
|
1987
|
-
#
|
2277
|
+
# Update user PII hashing status for a Dispatch
|
2278
|
+
# Updates user PII hashing status for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1988
2279
|
# @param dispatch_id Identifier for the dispatch
|
1989
2280
|
# @param enabled
|
1990
2281
|
# @param [Hash] opts the optional parameters
|
@@ -1994,8 +2285,8 @@ module RusticiSoftwareCloudV2
|
|
1994
2285
|
nil
|
1995
2286
|
end
|
1996
2287
|
|
1997
|
-
#
|
1998
|
-
#
|
2288
|
+
# Update user PII hashing status for a Dispatch
|
2289
|
+
# Updates user PII hashing status for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1999
2290
|
# @param dispatch_id Identifier for the dispatch
|
2000
2291
|
# @param enabled
|
2001
2292
|
# @param [Hash] opts the optional parameters
|
@@ -2005,11 +2296,11 @@ module RusticiSoftwareCloudV2
|
|
2005
2296
|
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch_hash_user_info ...'
|
2006
2297
|
end
|
2007
2298
|
# verify the required parameter 'dispatch_id' is set
|
2008
|
-
if
|
2299
|
+
if dispatch_id.nil?
|
2009
2300
|
fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch_hash_user_info"
|
2010
2301
|
end
|
2011
2302
|
# verify the required parameter 'enabled' is set
|
2012
|
-
if
|
2303
|
+
if enabled.nil?
|
2013
2304
|
fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_dispatch_hash_user_info"
|
2014
2305
|
end
|
2015
2306
|
# resource path
|
@@ -2042,5 +2333,79 @@ module RusticiSoftwareCloudV2
|
|
2042
2333
|
end
|
2043
2334
|
return data, status_code, headers
|
2044
2335
|
end
|
2336
|
+
# Update a group of Dispatches
|
2337
|
+
# Updates information about a group of dispatches, such as registration cap, expiration date, and postback information. Can be filtered using the request parameters to provide a subset of results. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental modification of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
|
2338
|
+
# @param dispatch_properties
|
2339
|
+
# @param [Hash] opts the optional parameters
|
2340
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
2341
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2342
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2343
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
2344
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
2345
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
2346
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
2347
|
+
# @return [nil]
|
2348
|
+
def update_dispatches(dispatch_properties, opts = {})
|
2349
|
+
update_dispatches_with_http_info(dispatch_properties, opts)
|
2350
|
+
nil
|
2351
|
+
end
|
2352
|
+
|
2353
|
+
# Update a group of Dispatches
|
2354
|
+
# Updates information about a group of dispatches, such as registration cap, expiration date, and postback information. Can be filtered using the request parameters to provide a subset of results. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental modification of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
|
2355
|
+
# @param dispatch_properties
|
2356
|
+
# @param [Hash] opts the optional parameters
|
2357
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
2358
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2359
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
2360
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
2361
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
2362
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
2363
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
2364
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2365
|
+
def update_dispatches_with_http_info(dispatch_properties, opts = {})
|
2366
|
+
if @api_client.config.debugging
|
2367
|
+
@api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatches ...'
|
2368
|
+
end
|
2369
|
+
# verify the required parameter 'dispatch_properties' is set
|
2370
|
+
if dispatch_properties.nil?
|
2371
|
+
fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatches"
|
2372
|
+
end
|
2373
|
+
# resource path
|
2374
|
+
local_var_path = '/dispatch/dispatches'
|
2375
|
+
|
2376
|
+
# query parameters
|
2377
|
+
query_params = {}
|
2378
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
2379
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2380
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
2381
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
2382
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
2383
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2384
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
2385
|
+
|
2386
|
+
# header parameters
|
2387
|
+
header_params = {}
|
2388
|
+
# HTTP header 'Accept' (if needed)
|
2389
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2390
|
+
# HTTP header 'Content-Type'
|
2391
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2392
|
+
|
2393
|
+
# form parameters
|
2394
|
+
form_params = {}
|
2395
|
+
|
2396
|
+
# http body (model)
|
2397
|
+
post_body = @api_client.object_to_http_body(dispatch_properties)
|
2398
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
2399
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2400
|
+
:header_params => header_params,
|
2401
|
+
:query_params => query_params,
|
2402
|
+
:form_params => form_params,
|
2403
|
+
:body => post_body,
|
2404
|
+
:auth_names => auth_names)
|
2405
|
+
if @api_client.config.debugging
|
2406
|
+
@api_client.config.logger.debug "API called: DispatchApi#update_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2407
|
+
end
|
2408
|
+
return data, status_code, headers
|
2409
|
+
end
|
2045
2410
|
end
|
2046
2411
|
end
|