rustici_software_cloud_v2 1.0.2 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/lib/rustici_software_cloud_v2.rb +1 -0
- data/lib/rustici_software_cloud_v2/api/about_api.rb +5 -5
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +77 -79
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +12 -10
- data/lib/rustici_software_cloud_v2/api/course_api.rb +197 -140
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +247 -195
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +104 -85
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +50 -35
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +5 -7
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +262 -150
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +21 -17
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +62 -51
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +53 -42
- data/lib/rustici_software_cloud_v2/api_client.rb +1 -0
- data/lib/rustici_software_cloud_v2/api_error.rb +1 -0
- data/lib/rustici_software_cloud_v2/configuration.rb +1 -0
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +13 -16
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/application_token.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +9 -13
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +7 -10
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +12 -16
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +9 -13
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +10 -14
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +9 -13
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +10 -14
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +8 -11
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +8 -11
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +11 -14
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +19 -22
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +13 -4
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +13 -4
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/response_error.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +11 -14
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +11 -14
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +9 -13
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +7 -10
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +9 -12
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +9 -12
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +11 -13
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +14 -17
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +8 -11
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +7 -10
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +12 -16
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +12 -16
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +9 -12
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +8 -11
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +7 -10
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +7 -10
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +8 -12
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +10 -13
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +8 -11
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +9 -12
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +7 -11
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +7 -11
- data/lib/rustici_software_cloud_v2/version.rb +2 -1
- data/rustici_software_cloud_v2.gemspec +8 -7
- data/spec/api_client_spec.rb +35 -34
- data/spec/configuration_spec.rb +9 -8
- data/spec/spec_helper.rb +1 -0
- metadata +16 -16
@@ -6,10 +6,11 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.12
|
9
10
|
|
10
11
|
=end
|
11
12
|
|
12
|
-
require
|
13
|
+
require 'uri'
|
13
14
|
|
14
15
|
module RusticiSoftwareCloudV2
|
15
16
|
class AuthenticationApi
|
@@ -18,7 +19,6 @@ module RusticiSoftwareCloudV2
|
|
18
19
|
def initialize(api_client = ApiClient.default)
|
19
20
|
@api_client = api_client
|
20
21
|
end
|
21
|
-
|
22
22
|
# Authenticates for a oauth token
|
23
23
|
# Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. >Note: >The token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
|
24
24
|
# @param scope
|
@@ -27,7 +27,7 @@ module RusticiSoftwareCloudV2
|
|
27
27
|
# @return [ApplicationToken]
|
28
28
|
def get_app_token(scope, opts = {})
|
29
29
|
data, _status_code, _headers = get_app_token_with_http_info(scope, opts)
|
30
|
-
|
30
|
+
data
|
31
31
|
end
|
32
32
|
|
33
33
|
# Authenticates for a oauth token
|
@@ -38,20 +38,22 @@ module RusticiSoftwareCloudV2
|
|
38
38
|
# @return [Array<(ApplicationToken, Fixnum, Hash)>] ApplicationToken data, response status code and response headers
|
39
39
|
def get_app_token_with_http_info(scope, opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
|
-
@api_client.config.logger.debug
|
41
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.get_app_token ...'
|
42
42
|
end
|
43
43
|
# verify the required parameter 'scope' is set
|
44
|
-
|
45
|
-
|
44
|
+
if @api_client.config.client_side_validation && scope.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'scope' when calling AuthenticationApi.get_app_token"
|
46
|
+
end
|
47
|
+
if @api_client.config.client_side_validation && !opts[:'expiration'].nil? && opts[:'expiration'] > 43200
|
46
48
|
fail ArgumentError, 'invalid value for "opts[:"expiration"]" when calling AuthenticationApi.get_app_token, must be smaller than or equal to 43200.'
|
47
49
|
end
|
48
50
|
|
49
|
-
if !opts[:'expiration'].nil? && opts[:'expiration'] < 60
|
51
|
+
if @api_client.config.client_side_validation && !opts[:'expiration'].nil? && opts[:'expiration'] < 60
|
50
52
|
fail ArgumentError, 'invalid value for "opts[:"expiration"]" when calling AuthenticationApi.get_app_token, must be greater than or equal to 60.'
|
51
53
|
end
|
52
54
|
|
53
55
|
# resource path
|
54
|
-
local_var_path =
|
56
|
+
local_var_path = '/oauth/authenticate/application/token'
|
55
57
|
|
56
58
|
# query parameters
|
57
59
|
query_params = {}
|
@@ -65,8 +67,8 @@ module RusticiSoftwareCloudV2
|
|
65
67
|
|
66
68
|
# form parameters
|
67
69
|
form_params = {}
|
68
|
-
form_params[
|
69
|
-
form_params[
|
70
|
+
form_params['scope'] = scope
|
71
|
+
form_params['expiration'] = opts[:'expiration'] if !opts[:'expiration'].nil?
|
70
72
|
|
71
73
|
# http body (model)
|
72
74
|
post_body = nil
|
@@ -6,10 +6,11 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.12
|
9
10
|
|
10
11
|
=end
|
11
12
|
|
12
|
-
require
|
13
|
+
require 'uri'
|
13
14
|
|
14
15
|
module RusticiSoftwareCloudV2
|
15
16
|
class CourseApi
|
@@ -18,7 +19,6 @@ module RusticiSoftwareCloudV2
|
|
18
19
|
def initialize(api_client = ApiClient.default)
|
19
20
|
@api_client = api_client
|
20
21
|
end
|
21
|
-
|
22
22
|
# Get a link to preview a course.
|
23
23
|
# Returns the launch link to use to preview this course.
|
24
24
|
# @param course_id
|
@@ -28,7 +28,7 @@ module RusticiSoftwareCloudV2
|
|
28
28
|
# @return [LaunchLinkSchema]
|
29
29
|
def build_course_preview_launch_link(course_id, launch_link_request, opts = {})
|
30
30
|
data, _status_code, _headers = build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts)
|
31
|
-
|
31
|
+
data
|
32
32
|
end
|
33
33
|
|
34
34
|
# Get a link to preview a course.
|
@@ -40,14 +40,18 @@ module RusticiSoftwareCloudV2
|
|
40
40
|
# @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
|
41
41
|
def build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts = {})
|
42
42
|
if @api_client.config.debugging
|
43
|
-
@api_client.config.logger.debug
|
43
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link ...'
|
44
44
|
end
|
45
45
|
# verify the required parameter 'course_id' is set
|
46
|
-
|
46
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link"
|
48
|
+
end
|
47
49
|
# verify the required parameter 'launch_link_request' is set
|
48
|
-
|
50
|
+
if @api_client.config.client_side_validation && launch_link_request.nil?
|
51
|
+
fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link"
|
52
|
+
end
|
49
53
|
# resource path
|
50
|
-
local_var_path =
|
54
|
+
local_var_path = '/courses/{courseId}/preview'.sub('{' + 'courseId' + '}', course_id.to_s)
|
51
55
|
|
52
56
|
# query parameters
|
53
57
|
query_params = {}
|
@@ -78,7 +82,6 @@ module RusticiSoftwareCloudV2
|
|
78
82
|
end
|
79
83
|
return data, status_code, headers
|
80
84
|
end
|
81
|
-
|
82
85
|
# Get a link to preview a particular course version.
|
83
86
|
# Returns the link to use to preview a particular version of a course.
|
84
87
|
# @param course_id
|
@@ -88,7 +91,7 @@ module RusticiSoftwareCloudV2
|
|
88
91
|
# @return [LaunchLinkSchema]
|
89
92
|
def build_course_preview_launch_link_with_version(course_id, version_id, launch_link_request, opts = {})
|
90
93
|
data, _status_code, _headers = build_course_preview_launch_link_with_version_with_http_info(course_id, version_id, launch_link_request, opts)
|
91
|
-
|
94
|
+
data
|
92
95
|
end
|
93
96
|
|
94
97
|
# Get a link to preview a particular course version.
|
@@ -100,16 +103,22 @@ module RusticiSoftwareCloudV2
|
|
100
103
|
# @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
|
101
104
|
def build_course_preview_launch_link_with_version_with_http_info(course_id, version_id, launch_link_request, opts = {})
|
102
105
|
if @api_client.config.debugging
|
103
|
-
@api_client.config.logger.debug
|
106
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link_with_version ...'
|
104
107
|
end
|
105
108
|
# verify the required parameter 'course_id' is set
|
106
|
-
|
109
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
110
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link_with_version"
|
111
|
+
end
|
107
112
|
# verify the required parameter 'version_id' is set
|
108
|
-
|
113
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
114
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.build_course_preview_launch_link_with_version"
|
115
|
+
end
|
109
116
|
# verify the required parameter 'launch_link_request' is set
|
110
|
-
|
117
|
+
if @api_client.config.client_side_validation && launch_link_request.nil?
|
118
|
+
fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link_with_version"
|
119
|
+
end
|
111
120
|
# resource path
|
112
|
-
local_var_path =
|
121
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}/preview'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
|
113
122
|
|
114
123
|
# query parameters
|
115
124
|
query_params = {}
|
@@ -139,7 +148,6 @@ module RusticiSoftwareCloudV2
|
|
139
148
|
end
|
140
149
|
return data, status_code, headers
|
141
150
|
end
|
142
|
-
|
143
151
|
# Fetch and import a course.
|
144
152
|
# An import job will be started to fetch and import the referenced file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided. To check the progress of the import job, GetImportJobStatus should be called with the job ID returned from this call.
|
145
153
|
# @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
|
@@ -150,7 +158,7 @@ module RusticiSoftwareCloudV2
|
|
150
158
|
# @return [StringResultSchema]
|
151
159
|
def create_fetch_and_import_course_job(course_id, import_request, opts = {})
|
152
160
|
data, _status_code, _headers = create_fetch_and_import_course_job_with_http_info(course_id, import_request, opts)
|
153
|
-
|
161
|
+
data
|
154
162
|
end
|
155
163
|
|
156
164
|
# Fetch and import a course.
|
@@ -163,14 +171,18 @@ module RusticiSoftwareCloudV2
|
|
163
171
|
# @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
|
164
172
|
def create_fetch_and_import_course_job_with_http_info(course_id, import_request, opts = {})
|
165
173
|
if @api_client.config.debugging
|
166
|
-
@api_client.config.logger.debug
|
174
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.create_fetch_and_import_course_job ...'
|
167
175
|
end
|
168
176
|
# verify the required parameter 'course_id' is set
|
169
|
-
|
177
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
178
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_fetch_and_import_course_job"
|
179
|
+
end
|
170
180
|
# verify the required parameter 'import_request' is set
|
171
|
-
|
181
|
+
if @api_client.config.client_side_validation && import_request.nil?
|
182
|
+
fail ArgumentError, "Missing the required parameter 'import_request' when calling CourseApi.create_fetch_and_import_course_job"
|
183
|
+
end
|
172
184
|
# resource path
|
173
|
-
local_var_path =
|
185
|
+
local_var_path = '/courses/importJobs'
|
174
186
|
|
175
187
|
# query parameters
|
176
188
|
query_params = {}
|
@@ -203,7 +215,6 @@ module RusticiSoftwareCloudV2
|
|
203
215
|
end
|
204
216
|
return data, status_code, headers
|
205
217
|
end
|
206
|
-
|
207
218
|
# Upload and import a course.
|
208
219
|
# An import job will be started to import the posted file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided. To check the progress of the import job, GetImportJobStatus should be called with the job ID returned from this call.
|
209
220
|
# @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
|
@@ -214,7 +225,7 @@ module RusticiSoftwareCloudV2
|
|
214
225
|
# @return [StringResultSchema]
|
215
226
|
def create_upload_and_import_course_job(course_id, opts = {})
|
216
227
|
data, _status_code, _headers = create_upload_and_import_course_job_with_http_info(course_id, opts)
|
217
|
-
|
228
|
+
data
|
218
229
|
end
|
219
230
|
|
220
231
|
# Upload and import a course.
|
@@ -227,12 +238,14 @@ module RusticiSoftwareCloudV2
|
|
227
238
|
# @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
|
228
239
|
def create_upload_and_import_course_job_with_http_info(course_id, opts = {})
|
229
240
|
if @api_client.config.debugging
|
230
|
-
@api_client.config.logger.debug
|
241
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.create_upload_and_import_course_job ...'
|
231
242
|
end
|
232
243
|
# verify the required parameter 'course_id' is set
|
233
|
-
|
244
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
245
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_upload_and_import_course_job"
|
246
|
+
end
|
234
247
|
# resource path
|
235
|
-
local_var_path =
|
248
|
+
local_var_path = '/courses/importJobs/upload'
|
236
249
|
|
237
250
|
# query parameters
|
238
251
|
query_params = {}
|
@@ -249,7 +262,7 @@ module RusticiSoftwareCloudV2
|
|
249
262
|
|
250
263
|
# form parameters
|
251
264
|
form_params = {}
|
252
|
-
form_params[
|
265
|
+
form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
|
253
266
|
|
254
267
|
# http body (model)
|
255
268
|
post_body = nil
|
@@ -266,7 +279,6 @@ module RusticiSoftwareCloudV2
|
|
266
279
|
end
|
267
280
|
return data, status_code, headers
|
268
281
|
end
|
269
|
-
|
270
282
|
# Delete a course.
|
271
283
|
# Delete course identified by `courseId`. When a course is deleted, so is everything connected to this course. This includes: - Registrations - Invitations - Dispatches - Debug Logs
|
272
284
|
# @param course_id
|
@@ -274,7 +286,7 @@ module RusticiSoftwareCloudV2
|
|
274
286
|
# @return [nil]
|
275
287
|
def delete_course(course_id, opts = {})
|
276
288
|
delete_course_with_http_info(course_id, opts)
|
277
|
-
|
289
|
+
nil
|
278
290
|
end
|
279
291
|
|
280
292
|
# Delete a course.
|
@@ -284,12 +296,14 @@ module RusticiSoftwareCloudV2
|
|
284
296
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
285
297
|
def delete_course_with_http_info(course_id, opts = {})
|
286
298
|
if @api_client.config.debugging
|
287
|
-
@api_client.config.logger.debug
|
299
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.delete_course ...'
|
288
300
|
end
|
289
301
|
# verify the required parameter 'course_id' is set
|
290
|
-
|
302
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
303
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course"
|
304
|
+
end
|
291
305
|
# resource path
|
292
|
-
local_var_path =
|
306
|
+
local_var_path = '/courses/{courseId}'.sub('{' + 'courseId' + '}', course_id.to_s)
|
293
307
|
|
294
308
|
# query parameters
|
295
309
|
query_params = {}
|
@@ -318,7 +332,6 @@ module RusticiSoftwareCloudV2
|
|
318
332
|
end
|
319
333
|
return data, status_code, headers
|
320
334
|
end
|
321
|
-
|
322
335
|
# Clear a course configuration.
|
323
336
|
# Clears the value of the given `settingId` for this course. The effective setting value will become any value set at the application level (if this value is set at the application level) or the default setting.
|
324
337
|
# @param course_id
|
@@ -327,7 +340,7 @@ module RusticiSoftwareCloudV2
|
|
327
340
|
# @return [nil]
|
328
341
|
def delete_course_configuration_setting(course_id, setting_id, opts = {})
|
329
342
|
delete_course_configuration_setting_with_http_info(course_id, setting_id, opts)
|
330
|
-
|
343
|
+
nil
|
331
344
|
end
|
332
345
|
|
333
346
|
# Clear a course configuration.
|
@@ -338,14 +351,18 @@ module RusticiSoftwareCloudV2
|
|
338
351
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
339
352
|
def delete_course_configuration_setting_with_http_info(course_id, setting_id, opts = {})
|
340
353
|
if @api_client.config.debugging
|
341
|
-
@api_client.config.logger.debug
|
354
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.delete_course_configuration_setting ...'
|
342
355
|
end
|
343
356
|
# verify the required parameter 'course_id' is set
|
344
|
-
|
357
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
358
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_configuration_setting"
|
359
|
+
end
|
345
360
|
# verify the required parameter 'setting_id' is set
|
346
|
-
|
361
|
+
if @api_client.config.client_side_validation && setting_id.nil?
|
362
|
+
fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_configuration_setting"
|
363
|
+
end
|
347
364
|
# resource path
|
348
|
-
local_var_path =
|
365
|
+
local_var_path = '/courses/{courseId}/configuration/{settingId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
|
349
366
|
|
350
367
|
# query parameters
|
351
368
|
query_params = {}
|
@@ -374,7 +391,6 @@ module RusticiSoftwareCloudV2
|
|
374
391
|
end
|
375
392
|
return data, status_code, headers
|
376
393
|
end
|
377
|
-
|
378
394
|
# Delete course tags.
|
379
395
|
# Delete the provided tags from this course.
|
380
396
|
# @param course_id
|
@@ -383,7 +399,7 @@ module RusticiSoftwareCloudV2
|
|
383
399
|
# @return [nil]
|
384
400
|
def delete_course_tags(course_id, tags, opts = {})
|
385
401
|
delete_course_tags_with_http_info(course_id, tags, opts)
|
386
|
-
|
402
|
+
nil
|
387
403
|
end
|
388
404
|
|
389
405
|
# Delete course tags.
|
@@ -394,14 +410,18 @@ module RusticiSoftwareCloudV2
|
|
394
410
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
395
411
|
def delete_course_tags_with_http_info(course_id, tags, opts = {})
|
396
412
|
if @api_client.config.debugging
|
397
|
-
@api_client.config.logger.debug
|
413
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.delete_course_tags ...'
|
398
414
|
end
|
399
415
|
# verify the required parameter 'course_id' is set
|
400
|
-
|
416
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
417
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_tags"
|
418
|
+
end
|
401
419
|
# verify the required parameter 'tags' is set
|
402
|
-
|
420
|
+
if @api_client.config.client_side_validation && tags.nil?
|
421
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.delete_course_tags"
|
422
|
+
end
|
403
423
|
# resource path
|
404
|
-
local_var_path =
|
424
|
+
local_var_path = '/courses/{courseId}/tags'.sub('{' + 'courseId' + '}', course_id.to_s)
|
405
425
|
|
406
426
|
# query parameters
|
407
427
|
query_params = {}
|
@@ -430,7 +450,6 @@ module RusticiSoftwareCloudV2
|
|
430
450
|
end
|
431
451
|
return data, status_code, headers
|
432
452
|
end
|
433
|
-
|
434
453
|
# Delete a course version.
|
435
454
|
# Delete `versionId` of `courseId`. If this is the last remaining version of this course, the course itself will be deleted and no longer accessible.
|
436
455
|
# @param course_id
|
@@ -439,7 +458,7 @@ module RusticiSoftwareCloudV2
|
|
439
458
|
# @return [nil]
|
440
459
|
def delete_course_version(course_id, version_id, opts = {})
|
441
460
|
delete_course_version_with_http_info(course_id, version_id, opts)
|
442
|
-
|
461
|
+
nil
|
443
462
|
end
|
444
463
|
|
445
464
|
# Delete a course version.
|
@@ -450,14 +469,18 @@ module RusticiSoftwareCloudV2
|
|
450
469
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
451
470
|
def delete_course_version_with_http_info(course_id, version_id, opts = {})
|
452
471
|
if @api_client.config.debugging
|
453
|
-
@api_client.config.logger.debug
|
472
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version ...'
|
454
473
|
end
|
455
474
|
# verify the required parameter 'course_id' is set
|
456
|
-
|
475
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
476
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version"
|
477
|
+
end
|
457
478
|
# verify the required parameter 'version_id' is set
|
458
|
-
|
479
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
480
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version"
|
481
|
+
end
|
459
482
|
# resource path
|
460
|
-
local_var_path =
|
483
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
|
461
484
|
|
462
485
|
# query parameters
|
463
486
|
query_params = {}
|
@@ -486,7 +509,6 @@ module RusticiSoftwareCloudV2
|
|
486
509
|
end
|
487
510
|
return data, status_code, headers
|
488
511
|
end
|
489
|
-
|
490
512
|
# Clear a configuration setting for a version of a course.
|
491
513
|
# Clears the `settingId` value for this course and version.
|
492
514
|
# @param course_id
|
@@ -496,7 +518,7 @@ module RusticiSoftwareCloudV2
|
|
496
518
|
# @return [nil]
|
497
519
|
def delete_course_version_configuration_setting(course_id, version_id, setting_id, opts = {})
|
498
520
|
delete_course_version_configuration_setting_with_http_info(course_id, version_id, setting_id, opts)
|
499
|
-
|
521
|
+
nil
|
500
522
|
end
|
501
523
|
|
502
524
|
# Clear a configuration setting for a version of a course.
|
@@ -508,16 +530,22 @@ module RusticiSoftwareCloudV2
|
|
508
530
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
509
531
|
def delete_course_version_configuration_setting_with_http_info(course_id, version_id, setting_id, opts = {})
|
510
532
|
if @api_client.config.debugging
|
511
|
-
@api_client.config.logger.debug
|
533
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version_configuration_setting ...'
|
512
534
|
end
|
513
535
|
# verify the required parameter 'course_id' is set
|
514
|
-
|
536
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
537
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version_configuration_setting"
|
538
|
+
end
|
515
539
|
# verify the required parameter 'version_id' is set
|
516
|
-
|
540
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
541
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version_configuration_setting"
|
542
|
+
end
|
517
543
|
# verify the required parameter 'setting_id' is set
|
518
|
-
|
544
|
+
if @api_client.config.client_side_validation && setting_id.nil?
|
545
|
+
fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_version_configuration_setting"
|
546
|
+
end
|
519
547
|
# resource path
|
520
|
-
local_var_path =
|
548
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}/configuration/{settingId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
|
521
549
|
|
522
550
|
# query parameters
|
523
551
|
query_params = {}
|
@@ -546,7 +574,6 @@ module RusticiSoftwareCloudV2
|
|
546
574
|
end
|
547
575
|
return data, status_code, headers
|
548
576
|
end
|
549
|
-
|
550
577
|
# Get course details.
|
551
578
|
# Get detailed information about `courseId`. Futher detail can be obtained with the optional query parameters flags.
|
552
579
|
# @param course_id
|
@@ -556,7 +583,7 @@ module RusticiSoftwareCloudV2
|
|
556
583
|
# @return [CourseSchema]
|
557
584
|
def get_course(course_id, opts = {})
|
558
585
|
data, _status_code, _headers = get_course_with_http_info(course_id, opts)
|
559
|
-
|
586
|
+
data
|
560
587
|
end
|
561
588
|
|
562
589
|
# Get course details.
|
@@ -568,12 +595,14 @@ module RusticiSoftwareCloudV2
|
|
568
595
|
# @return [Array<(CourseSchema, Fixnum, Hash)>] CourseSchema data, response status code and response headers
|
569
596
|
def get_course_with_http_info(course_id, opts = {})
|
570
597
|
if @api_client.config.debugging
|
571
|
-
@api_client.config.logger.debug
|
598
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course ...'
|
572
599
|
end
|
573
600
|
# verify the required parameter 'course_id' is set
|
574
|
-
|
601
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
602
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course"
|
603
|
+
end
|
575
604
|
# resource path
|
576
|
-
local_var_path =
|
605
|
+
local_var_path = '/courses/{courseId}'.sub('{' + 'courseId' + '}', course_id.to_s)
|
577
606
|
|
578
607
|
# query parameters
|
579
608
|
query_params = {}
|
@@ -605,7 +634,6 @@ module RusticiSoftwareCloudV2
|
|
605
634
|
end
|
606
635
|
return data, status_code, headers
|
607
636
|
end
|
608
|
-
|
609
637
|
# Get course configuration.
|
610
638
|
# Returns all effective configuration settings for this course. For any setting which is not explicitly set at the course level, the effective value will be either the value set at the application level (if there is one) or the default value for the setting.
|
611
639
|
# @param course_id
|
@@ -614,7 +642,7 @@ module RusticiSoftwareCloudV2
|
|
614
642
|
# @return [SettingListSchema]
|
615
643
|
def get_course_configuration(course_id, opts = {})
|
616
644
|
data, _status_code, _headers = get_course_configuration_with_http_info(course_id, opts)
|
617
|
-
|
645
|
+
data
|
618
646
|
end
|
619
647
|
|
620
648
|
# Get course configuration.
|
@@ -625,12 +653,14 @@ module RusticiSoftwareCloudV2
|
|
625
653
|
# @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
|
626
654
|
def get_course_configuration_with_http_info(course_id, opts = {})
|
627
655
|
if @api_client.config.debugging
|
628
|
-
@api_client.config.logger.debug
|
656
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_configuration ...'
|
629
657
|
end
|
630
658
|
# verify the required parameter 'course_id' is set
|
631
|
-
|
659
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
660
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_configuration"
|
661
|
+
end
|
632
662
|
# resource path
|
633
|
-
local_var_path =
|
663
|
+
local_var_path = '/courses/{courseId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s)
|
634
664
|
|
635
665
|
# query parameters
|
636
666
|
query_params = {}
|
@@ -661,7 +691,6 @@ module RusticiSoftwareCloudV2
|
|
661
691
|
end
|
662
692
|
return data, status_code, headers
|
663
693
|
end
|
664
|
-
|
665
694
|
# Get course xAPI statements.
|
666
695
|
# Get xAPI statements for `courseId`.
|
667
696
|
# @param course_id
|
@@ -673,7 +702,7 @@ module RusticiSoftwareCloudV2
|
|
673
702
|
# @return [XapiStatementResult]
|
674
703
|
def get_course_statements(course_id, opts = {})
|
675
704
|
data, _status_code, _headers = get_course_statements_with_http_info(course_id, opts)
|
676
|
-
|
705
|
+
data
|
677
706
|
end
|
678
707
|
|
679
708
|
# Get course xAPI statements.
|
@@ -687,12 +716,14 @@ module RusticiSoftwareCloudV2
|
|
687
716
|
# @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
|
688
717
|
def get_course_statements_with_http_info(course_id, opts = {})
|
689
718
|
if @api_client.config.debugging
|
690
|
-
@api_client.config.logger.debug
|
719
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_statements ...'
|
691
720
|
end
|
692
721
|
# verify the required parameter 'course_id' is set
|
693
|
-
|
722
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
723
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_statements"
|
724
|
+
end
|
694
725
|
# resource path
|
695
|
-
local_var_path =
|
726
|
+
local_var_path = '/courses/{courseId}/xAPIStatements'.sub('{' + 'courseId' + '}', course_id.to_s)
|
696
727
|
|
697
728
|
# query parameters
|
698
729
|
query_params = {}
|
@@ -726,7 +757,6 @@ module RusticiSoftwareCloudV2
|
|
726
757
|
end
|
727
758
|
return data, status_code, headers
|
728
759
|
end
|
729
|
-
|
730
760
|
# Get course tags.
|
731
761
|
# Get a list of the tags for this course.
|
732
762
|
# @param course_id
|
@@ -734,7 +764,7 @@ module RusticiSoftwareCloudV2
|
|
734
764
|
# @return [TagListSchema]
|
735
765
|
def get_course_tags(course_id, opts = {})
|
736
766
|
data, _status_code, _headers = get_course_tags_with_http_info(course_id, opts)
|
737
|
-
|
767
|
+
data
|
738
768
|
end
|
739
769
|
|
740
770
|
# Get course tags.
|
@@ -744,12 +774,14 @@ module RusticiSoftwareCloudV2
|
|
744
774
|
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
745
775
|
def get_course_tags_with_http_info(course_id, opts = {})
|
746
776
|
if @api_client.config.debugging
|
747
|
-
@api_client.config.logger.debug
|
777
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_tags ...'
|
748
778
|
end
|
749
779
|
# verify the required parameter 'course_id' is set
|
750
|
-
|
780
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
781
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_tags"
|
782
|
+
end
|
751
783
|
# resource path
|
752
|
-
local_var_path =
|
784
|
+
local_var_path = '/courses/{courseId}/tags'.sub('{' + 'courseId' + '}', course_id.to_s)
|
753
785
|
|
754
786
|
# query parameters
|
755
787
|
query_params = {}
|
@@ -779,7 +811,6 @@ module RusticiSoftwareCloudV2
|
|
779
811
|
end
|
780
812
|
return data, status_code, headers
|
781
813
|
end
|
782
|
-
|
783
814
|
# Get configuration for a version of a course.
|
784
815
|
# Returns all configuration settings for this course and version.
|
785
816
|
# @param course_id
|
@@ -789,7 +820,7 @@ module RusticiSoftwareCloudV2
|
|
789
820
|
# @return [SettingListSchema]
|
790
821
|
def get_course_version_configuration(course_id, version_id, opts = {})
|
791
822
|
data, _status_code, _headers = get_course_version_configuration_with_http_info(course_id, version_id, opts)
|
792
|
-
|
823
|
+
data
|
793
824
|
end
|
794
825
|
|
795
826
|
# Get configuration for a version of a course.
|
@@ -801,14 +832,18 @@ module RusticiSoftwareCloudV2
|
|
801
832
|
# @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
|
802
833
|
def get_course_version_configuration_with_http_info(course_id, version_id, opts = {})
|
803
834
|
if @api_client.config.debugging
|
804
|
-
@api_client.config.logger.debug
|
835
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_configuration ...'
|
805
836
|
end
|
806
837
|
# verify the required parameter 'course_id' is set
|
807
|
-
|
838
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
839
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_configuration"
|
840
|
+
end
|
808
841
|
# verify the required parameter 'version_id' is set
|
809
|
-
|
842
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
843
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_configuration"
|
844
|
+
end
|
810
845
|
# resource path
|
811
|
-
local_var_path =
|
846
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
|
812
847
|
|
813
848
|
# query parameters
|
814
849
|
query_params = {}
|
@@ -839,7 +874,6 @@ module RusticiSoftwareCloudV2
|
|
839
874
|
end
|
840
875
|
return data, status_code, headers
|
841
876
|
end
|
842
|
-
|
843
877
|
# Get details on a course version.
|
844
878
|
# Get specific version `versionId` of `courseId`
|
845
879
|
# @param course_id
|
@@ -850,7 +884,7 @@ module RusticiSoftwareCloudV2
|
|
850
884
|
# @return [CourseSchema]
|
851
885
|
def get_course_version_info(course_id, version_id, opts = {})
|
852
886
|
data, _status_code, _headers = get_course_version_info_with_http_info(course_id, version_id, opts)
|
853
|
-
|
887
|
+
data
|
854
888
|
end
|
855
889
|
|
856
890
|
# Get details on a course version.
|
@@ -863,14 +897,18 @@ module RusticiSoftwareCloudV2
|
|
863
897
|
# @return [Array<(CourseSchema, Fixnum, Hash)>] CourseSchema data, response status code and response headers
|
864
898
|
def get_course_version_info_with_http_info(course_id, version_id, opts = {})
|
865
899
|
if @api_client.config.debugging
|
866
|
-
@api_client.config.logger.debug
|
900
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_info ...'
|
867
901
|
end
|
868
902
|
# verify the required parameter 'course_id' is set
|
869
|
-
|
903
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
904
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_info"
|
905
|
+
end
|
870
906
|
# verify the required parameter 'version_id' is set
|
871
|
-
|
907
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
908
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_info"
|
909
|
+
end
|
872
910
|
# resource path
|
873
|
-
local_var_path =
|
911
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
|
874
912
|
|
875
913
|
# query parameters
|
876
914
|
query_params = {}
|
@@ -902,7 +940,6 @@ module RusticiSoftwareCloudV2
|
|
902
940
|
end
|
903
941
|
return data, status_code, headers
|
904
942
|
end
|
905
|
-
|
906
943
|
# Get xAPI statements for a course version.
|
907
944
|
# Get xAPI statements for version `versionId` of `courseId`
|
908
945
|
# @param course_id
|
@@ -915,7 +952,7 @@ module RusticiSoftwareCloudV2
|
|
915
952
|
# @return [XapiStatementResult]
|
916
953
|
def get_course_version_statements(course_id, version_id, opts = {})
|
917
954
|
data, _status_code, _headers = get_course_version_statements_with_http_info(course_id, version_id, opts)
|
918
|
-
|
955
|
+
data
|
919
956
|
end
|
920
957
|
|
921
958
|
# Get xAPI statements for a course version.
|
@@ -930,14 +967,18 @@ module RusticiSoftwareCloudV2
|
|
930
967
|
# @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
|
931
968
|
def get_course_version_statements_with_http_info(course_id, version_id, opts = {})
|
932
969
|
if @api_client.config.debugging
|
933
|
-
@api_client.config.logger.debug
|
970
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_statements ...'
|
934
971
|
end
|
935
972
|
# verify the required parameter 'course_id' is set
|
936
|
-
|
973
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
974
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_statements"
|
975
|
+
end
|
937
976
|
# verify the required parameter 'version_id' is set
|
938
|
-
|
977
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
978
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_statements"
|
979
|
+
end
|
939
980
|
# resource path
|
940
|
-
local_var_path =
|
981
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}/xAPIStatements'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
|
941
982
|
|
942
983
|
# query parameters
|
943
984
|
query_params = {}
|
@@ -971,7 +1012,6 @@ module RusticiSoftwareCloudV2
|
|
971
1012
|
end
|
972
1013
|
return data, status_code, headers
|
973
1014
|
end
|
974
|
-
|
975
1015
|
# Get details on a course's versions.
|
976
1016
|
# Get information about all versions of `courseId`. This can be useful to see information such as registration counts and modification times across the versions of a course.
|
977
1017
|
# @param course_id
|
@@ -983,7 +1023,7 @@ module RusticiSoftwareCloudV2
|
|
983
1023
|
# @return [CourseListNonPagedSchema]
|
984
1024
|
def get_course_versions(course_id, opts = {})
|
985
1025
|
data, _status_code, _headers = get_course_versions_with_http_info(course_id, opts)
|
986
|
-
|
1026
|
+
data
|
987
1027
|
end
|
988
1028
|
|
989
1029
|
# Get details on a course's versions.
|
@@ -997,12 +1037,14 @@ module RusticiSoftwareCloudV2
|
|
997
1037
|
# @return [Array<(CourseListNonPagedSchema, Fixnum, Hash)>] CourseListNonPagedSchema data, response status code and response headers
|
998
1038
|
def get_course_versions_with_http_info(course_id, opts = {})
|
999
1039
|
if @api_client.config.debugging
|
1000
|
-
@api_client.config.logger.debug
|
1040
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_course_versions ...'
|
1001
1041
|
end
|
1002
1042
|
# verify the required parameter 'course_id' is set
|
1003
|
-
|
1043
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
1044
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_versions"
|
1045
|
+
end
|
1004
1046
|
# resource path
|
1005
|
-
local_var_path =
|
1047
|
+
local_var_path = '/courses/{courseId}/versions'.sub('{' + 'courseId' + '}', course_id.to_s)
|
1006
1048
|
|
1007
1049
|
# query parameters
|
1008
1050
|
query_params = {}
|
@@ -1036,7 +1078,6 @@ module RusticiSoftwareCloudV2
|
|
1036
1078
|
end
|
1037
1079
|
return data, status_code, headers
|
1038
1080
|
end
|
1039
|
-
|
1040
1081
|
# Get all courses.
|
1041
1082
|
# Get all courses for the `appId` which was used to authenticate this call.
|
1042
1083
|
# @param [Hash] opts the optional parameters
|
@@ -1052,7 +1093,7 @@ module RusticiSoftwareCloudV2
|
|
1052
1093
|
# @return [CourseListSchema]
|
1053
1094
|
def get_courses(opts = {})
|
1054
1095
|
data, _status_code, _headers = get_courses_with_http_info(opts)
|
1055
|
-
|
1096
|
+
data
|
1056
1097
|
end
|
1057
1098
|
|
1058
1099
|
# Get all courses.
|
@@ -1070,16 +1111,16 @@ module RusticiSoftwareCloudV2
|
|
1070
1111
|
# @return [Array<(CourseListSchema, Fixnum, Hash)>] CourseListSchema data, response status code and response headers
|
1071
1112
|
def get_courses_with_http_info(opts = {})
|
1072
1113
|
if @api_client.config.debugging
|
1073
|
-
@api_client.config.logger.debug
|
1114
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_courses ...'
|
1074
1115
|
end
|
1075
|
-
if opts[:'filter_by'] && !['title', 'course_id', 'tags'].include?(opts[:'filter_by'])
|
1116
|
+
if @api_client.config.client_side_validation && opts[:'filter_by'] && !['title', 'course_id', 'tags'].include?(opts[:'filter_by'])
|
1076
1117
|
fail ArgumentError, 'invalid value for "filter_by", must be one of title, course_id, tags'
|
1077
1118
|
end
|
1078
|
-
if opts[:'order_by'] && !['title_asc', 'title_desc', 'creation_date_asc', 'creation_date_desc'].include?(opts[:'order_by'])
|
1119
|
+
if @api_client.config.client_side_validation && opts[:'order_by'] && !['title_asc', 'title_desc', 'creation_date_asc', 'creation_date_desc'].include?(opts[:'order_by'])
|
1079
1120
|
fail ArgumentError, 'invalid value for "order_by", must be one of title_asc, title_desc, creation_date_asc, creation_date_desc'
|
1080
1121
|
end
|
1081
1122
|
# resource path
|
1082
|
-
local_var_path =
|
1123
|
+
local_var_path = '/courses'
|
1083
1124
|
|
1084
1125
|
# query parameters
|
1085
1126
|
query_params = {}
|
@@ -1118,7 +1159,6 @@ module RusticiSoftwareCloudV2
|
|
1118
1159
|
end
|
1119
1160
|
return data, status_code, headers
|
1120
1161
|
end
|
1121
|
-
|
1122
1162
|
# Get course import job status.
|
1123
1163
|
# Check the status of an import job. This can be called incrementally to check to progress of a call to either of the import options.
|
1124
1164
|
# @param import_job_id Id received when the import job was submitted to the importJobs resource.
|
@@ -1126,7 +1166,7 @@ module RusticiSoftwareCloudV2
|
|
1126
1166
|
# @return [ImportJobResultSchema]
|
1127
1167
|
def get_import_job_status(import_job_id, opts = {})
|
1128
1168
|
data, _status_code, _headers = get_import_job_status_with_http_info(import_job_id, opts)
|
1129
|
-
|
1169
|
+
data
|
1130
1170
|
end
|
1131
1171
|
|
1132
1172
|
# Get course import job status.
|
@@ -1136,12 +1176,14 @@ module RusticiSoftwareCloudV2
|
|
1136
1176
|
# @return [Array<(ImportJobResultSchema, Fixnum, Hash)>] ImportJobResultSchema data, response status code and response headers
|
1137
1177
|
def get_import_job_status_with_http_info(import_job_id, opts = {})
|
1138
1178
|
if @api_client.config.debugging
|
1139
|
-
@api_client.config.logger.debug
|
1179
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.get_import_job_status ...'
|
1140
1180
|
end
|
1141
1181
|
# verify the required parameter 'import_job_id' is set
|
1142
|
-
|
1182
|
+
if @api_client.config.client_side_validation && import_job_id.nil?
|
1183
|
+
fail ArgumentError, "Missing the required parameter 'import_job_id' when calling CourseApi.get_import_job_status"
|
1184
|
+
end
|
1143
1185
|
# resource path
|
1144
|
-
local_var_path =
|
1186
|
+
local_var_path = '/courses/importJobs/{importJobId}'.sub('{' + 'importJobId' + '}', import_job_id.to_s)
|
1145
1187
|
|
1146
1188
|
# query parameters
|
1147
1189
|
query_params = {}
|
@@ -1171,7 +1213,6 @@ module RusticiSoftwareCloudV2
|
|
1171
1213
|
end
|
1172
1214
|
return data, status_code, headers
|
1173
1215
|
end
|
1174
|
-
|
1175
1216
|
# Set course tags.
|
1176
1217
|
# Set the tags for this course. Note: any tags currently on this course will be overwritten with the new array of tags.
|
1177
1218
|
# @param course_id
|
@@ -1180,7 +1221,7 @@ module RusticiSoftwareCloudV2
|
|
1180
1221
|
# @return [nil]
|
1181
1222
|
def put_course_tags(course_id, tags, opts = {})
|
1182
1223
|
put_course_tags_with_http_info(course_id, tags, opts)
|
1183
|
-
|
1224
|
+
nil
|
1184
1225
|
end
|
1185
1226
|
|
1186
1227
|
# Set course tags.
|
@@ -1191,14 +1232,18 @@ module RusticiSoftwareCloudV2
|
|
1191
1232
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1192
1233
|
def put_course_tags_with_http_info(course_id, tags, opts = {})
|
1193
1234
|
if @api_client.config.debugging
|
1194
|
-
@api_client.config.logger.debug
|
1235
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags ...'
|
1195
1236
|
end
|
1196
1237
|
# verify the required parameter 'course_id' is set
|
1197
|
-
|
1238
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
1239
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.put_course_tags"
|
1240
|
+
end
|
1198
1241
|
# verify the required parameter 'tags' is set
|
1199
|
-
|
1242
|
+
if @api_client.config.client_side_validation && tags.nil?
|
1243
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.put_course_tags"
|
1244
|
+
end
|
1200
1245
|
# resource path
|
1201
|
-
local_var_path =
|
1246
|
+
local_var_path = '/courses/{courseId}/tags'.sub('{' + 'courseId' + '}', course_id.to_s)
|
1202
1247
|
|
1203
1248
|
# query parameters
|
1204
1249
|
query_params = {}
|
@@ -1227,7 +1272,6 @@ module RusticiSoftwareCloudV2
|
|
1227
1272
|
end
|
1228
1273
|
return data, status_code, headers
|
1229
1274
|
end
|
1230
|
-
|
1231
1275
|
# Set tags on courses.
|
1232
1276
|
# Sets all of the provided tags on all of the provided courses.
|
1233
1277
|
# @param batch Object representing an array of ids to apply an array of tags to.
|
@@ -1235,7 +1279,7 @@ module RusticiSoftwareCloudV2
|
|
1235
1279
|
# @return [nil]
|
1236
1280
|
def put_course_tags_batch(batch, opts = {})
|
1237
1281
|
put_course_tags_batch_with_http_info(batch, opts)
|
1238
|
-
|
1282
|
+
nil
|
1239
1283
|
end
|
1240
1284
|
|
1241
1285
|
# Set tags on courses.
|
@@ -1245,12 +1289,14 @@ module RusticiSoftwareCloudV2
|
|
1245
1289
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1246
1290
|
def put_course_tags_batch_with_http_info(batch, opts = {})
|
1247
1291
|
if @api_client.config.debugging
|
1248
|
-
@api_client.config.logger.debug
|
1292
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags_batch ...'
|
1249
1293
|
end
|
1250
1294
|
# verify the required parameter 'batch' is set
|
1251
|
-
|
1295
|
+
if @api_client.config.client_side_validation && batch.nil?
|
1296
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling CourseApi.put_course_tags_batch"
|
1297
|
+
end
|
1252
1298
|
# resource path
|
1253
|
-
local_var_path =
|
1299
|
+
local_var_path = '/courses/tags'
|
1254
1300
|
|
1255
1301
|
# query parameters
|
1256
1302
|
query_params = {}
|
@@ -1279,7 +1325,6 @@ module RusticiSoftwareCloudV2
|
|
1279
1325
|
end
|
1280
1326
|
return data, status_code, headers
|
1281
1327
|
end
|
1282
|
-
|
1283
1328
|
# Set course configuration.
|
1284
1329
|
# Set configuration settings for this course. Setting a value at this level will override any value which is set at the application level.
|
1285
1330
|
# @param course_id
|
@@ -1288,7 +1333,7 @@ module RusticiSoftwareCloudV2
|
|
1288
1333
|
# @return [nil]
|
1289
1334
|
def set_course_configuration(course_id, configuration_settings, opts = {})
|
1290
1335
|
set_course_configuration_with_http_info(course_id, configuration_settings, opts)
|
1291
|
-
|
1336
|
+
nil
|
1292
1337
|
end
|
1293
1338
|
|
1294
1339
|
# Set course configuration.
|
@@ -1299,14 +1344,18 @@ module RusticiSoftwareCloudV2
|
|
1299
1344
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1300
1345
|
def set_course_configuration_with_http_info(course_id, configuration_settings, opts = {})
|
1301
1346
|
if @api_client.config.debugging
|
1302
|
-
@api_client.config.logger.debug
|
1347
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.set_course_configuration ...'
|
1303
1348
|
end
|
1304
1349
|
# verify the required parameter 'course_id' is set
|
1305
|
-
|
1350
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
1351
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_configuration"
|
1352
|
+
end
|
1306
1353
|
# verify the required parameter 'configuration_settings' is set
|
1307
|
-
|
1354
|
+
if @api_client.config.client_side_validation && configuration_settings.nil?
|
1355
|
+
fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_configuration"
|
1356
|
+
end
|
1308
1357
|
# resource path
|
1309
|
-
local_var_path =
|
1358
|
+
local_var_path = '/courses/{courseId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s)
|
1310
1359
|
|
1311
1360
|
# query parameters
|
1312
1361
|
query_params = {}
|
@@ -1335,7 +1384,6 @@ module RusticiSoftwareCloudV2
|
|
1335
1384
|
end
|
1336
1385
|
return data, status_code, headers
|
1337
1386
|
end
|
1338
|
-
|
1339
1387
|
# Set the title of a course.
|
1340
1388
|
# Sets the course title for the provided courseId.
|
1341
1389
|
# @param course_id
|
@@ -1344,7 +1392,7 @@ module RusticiSoftwareCloudV2
|
|
1344
1392
|
# @return [nil]
|
1345
1393
|
def set_course_title(course_id, title, opts = {})
|
1346
1394
|
set_course_title_with_http_info(course_id, title, opts)
|
1347
|
-
|
1395
|
+
nil
|
1348
1396
|
end
|
1349
1397
|
|
1350
1398
|
# Set the title of a course.
|
@@ -1355,14 +1403,18 @@ module RusticiSoftwareCloudV2
|
|
1355
1403
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1356
1404
|
def set_course_title_with_http_info(course_id, title, opts = {})
|
1357
1405
|
if @api_client.config.debugging
|
1358
|
-
@api_client.config.logger.debug
|
1406
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.set_course_title ...'
|
1359
1407
|
end
|
1360
1408
|
# verify the required parameter 'course_id' is set
|
1361
|
-
|
1409
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
1410
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_title"
|
1411
|
+
end
|
1362
1412
|
# verify the required parameter 'title' is set
|
1363
|
-
|
1413
|
+
if @api_client.config.client_side_validation && title.nil?
|
1414
|
+
fail ArgumentError, "Missing the required parameter 'title' when calling CourseApi.set_course_title"
|
1415
|
+
end
|
1364
1416
|
# resource path
|
1365
|
-
local_var_path =
|
1417
|
+
local_var_path = '/courses/{courseId}/title'.sub('{' + 'courseId' + '}', course_id.to_s)
|
1366
1418
|
|
1367
1419
|
# query parameters
|
1368
1420
|
query_params = {}
|
@@ -1391,7 +1443,6 @@ module RusticiSoftwareCloudV2
|
|
1391
1443
|
end
|
1392
1444
|
return data, status_code, headers
|
1393
1445
|
end
|
1394
|
-
|
1395
1446
|
# Set configuration for a version of a course.
|
1396
1447
|
# Set configuration settings for this course and version.
|
1397
1448
|
# @param course_id
|
@@ -1401,7 +1452,7 @@ module RusticiSoftwareCloudV2
|
|
1401
1452
|
# @return [nil]
|
1402
1453
|
def set_course_version_configuration(course_id, version_id, configuration_settings, opts = {})
|
1403
1454
|
set_course_version_configuration_with_http_info(course_id, version_id, configuration_settings, opts)
|
1404
|
-
|
1455
|
+
nil
|
1405
1456
|
end
|
1406
1457
|
|
1407
1458
|
# Set configuration for a version of a course.
|
@@ -1413,16 +1464,22 @@ module RusticiSoftwareCloudV2
|
|
1413
1464
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1414
1465
|
def set_course_version_configuration_with_http_info(course_id, version_id, configuration_settings, opts = {})
|
1415
1466
|
if @api_client.config.debugging
|
1416
|
-
@api_client.config.logger.debug
|
1467
|
+
@api_client.config.logger.debug 'Calling API: CourseApi.set_course_version_configuration ...'
|
1417
1468
|
end
|
1418
1469
|
# verify the required parameter 'course_id' is set
|
1419
|
-
|
1470
|
+
if @api_client.config.client_side_validation && course_id.nil?
|
1471
|
+
fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_version_configuration"
|
1472
|
+
end
|
1420
1473
|
# verify the required parameter 'version_id' is set
|
1421
|
-
|
1474
|
+
if @api_client.config.client_side_validation && version_id.nil?
|
1475
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.set_course_version_configuration"
|
1476
|
+
end
|
1422
1477
|
# verify the required parameter 'configuration_settings' is set
|
1423
|
-
|
1478
|
+
if @api_client.config.client_side_validation && configuration_settings.nil?
|
1479
|
+
fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_version_configuration"
|
1480
|
+
end
|
1424
1481
|
# resource path
|
1425
|
-
local_var_path =
|
1482
|
+
local_var_path = '/courses/{courseId}/versions/{versionId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
|
1426
1483
|
|
1427
1484
|
# query parameters
|
1428
1485
|
query_params = {}
|