rustici_software_cloud_v2 1.1.0 → 2.0.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 +4 -4
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +190 -62
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +9 -17
- data/lib/rustici_software_cloud_v2/api/course_api.rb +903 -196
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +458 -268
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +212 -170
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +48 -48
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +2 -0
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +255 -269
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +19 -23
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +81 -66
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +124 -55
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
- data/lib/rustici_software_cloud_v2/configuration.rb +3 -3
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/application_token.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +2 -19
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +4 -1
- 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 +3 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +43 -3
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +29 -6
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +10 -8
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +11 -43
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +5 -3
- 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 +4 -1
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +6 -4
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/response_error.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +15 -3
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +13 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -1
- data/lib/rustici_software_cloud_v2.rb +13 -0
- data/rustici_software_cloud_v2.gemspec +2 -1
- data/spec/api_client_spec.rb +17 -0
- metadata +35 -2
@@ -19,8 +19,8 @@ module RusticiSoftwareCloudV2
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Get
|
23
|
-
#
|
22
|
+
# Get account information
|
23
|
+
# Returns all of the account information for the specified application.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [ReportageAccountInfoSchema]
|
26
26
|
def get_account_info(opts = {})
|
@@ -28,8 +28,8 @@ module RusticiSoftwareCloudV2
|
|
28
28
|
data
|
29
29
|
end
|
30
30
|
|
31
|
-
# Get
|
32
|
-
#
|
31
|
+
# Get account information
|
32
|
+
# Returns all of the account information for the specified application.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(ReportageAccountInfoSchema, Fixnum, Hash)>] ReportageAccountInfoSchema data, response status code and response headers
|
35
35
|
def get_account_info_with_http_info(opts = {})
|
@@ -67,8 +67,8 @@ module RusticiSoftwareCloudV2
|
|
67
67
|
end
|
68
68
|
return data, status_code, headers
|
69
69
|
end
|
70
|
-
# Get a session authentication token
|
71
|
-
#
|
70
|
+
# Get a Reportage session authentication token
|
71
|
+
# Returns a session authentication token to use when launching Reportage.
|
72
72
|
# @param nav_permission The navigation permissions for this Reportage session
|
73
73
|
# @param [Hash] opts the optional parameters
|
74
74
|
# @option opts [BOOLEAN] :admin Grant admin privileges to this Reportage session (default to false)
|
@@ -78,8 +78,8 @@ module RusticiSoftwareCloudV2
|
|
78
78
|
data
|
79
79
|
end
|
80
80
|
|
81
|
-
# Get a session authentication token
|
82
|
-
#
|
81
|
+
# Get a Reportage session authentication token
|
82
|
+
# Returns a session authentication token to use when launching Reportage.
|
83
83
|
# @param nav_permission The navigation permissions for this Reportage session
|
84
84
|
# @param [Hash] opts the optional parameters
|
85
85
|
# @option opts [BOOLEAN] :admin Grant admin privileges to this Reportage session
|
@@ -89,13 +89,9 @@ module RusticiSoftwareCloudV2
|
|
89
89
|
@api_client.config.logger.debug 'Calling API: ReportingApi.get_reportage_auth_token ...'
|
90
90
|
end
|
91
91
|
# verify the required parameter 'nav_permission' is set
|
92
|
-
if
|
92
|
+
if nav_permission.nil?
|
93
93
|
fail ArgumentError, "Missing the required parameter 'nav_permission' when calling ReportingApi.get_reportage_auth_token"
|
94
94
|
end
|
95
|
-
# verify enum value
|
96
|
-
if @api_client.config.client_side_validation && !['NONAV', 'DOWNONLY', 'FREENAV'].include?(nav_permission)
|
97
|
-
fail ArgumentError, "invalid value for 'nav_permission', must be one of NONAV, DOWNONLY, FREENAV"
|
98
|
-
end
|
99
95
|
# resource path
|
100
96
|
local_var_path = '/reporting/reportageAuth'
|
101
97
|
|
@@ -129,10 +125,10 @@ module RusticiSoftwareCloudV2
|
|
129
125
|
end
|
130
126
|
return data, status_code, headers
|
131
127
|
end
|
132
|
-
# Get
|
133
|
-
#
|
134
|
-
# @param auth The
|
135
|
-
# @param report_url The Reportage URL to try and access
|
128
|
+
# Get a link to a page in Reportage with the given permissions
|
129
|
+
# Returns the link to use for viewing Reportage. In order to generate a link, GetReportageAuthToken will need to be called to generate an auth token with the necessary permissions.
|
130
|
+
# @param auth The Reportage authentication token retrieved from a previous call to `GET reportageAuth`
|
131
|
+
# @param report_url The Reportage URL to try and access. Common values are the Reportage homepage `https://cloud.scorm.com/Reportage/reportage.php?appId={{your appId}}` or a URL pointing to a specific report within Reportage. The latter type of URL includes lots of parameters of the report, such as the date range, demographic (via tags), specific course or learner, and so on.
|
136
132
|
# @param [Hash] opts the optional parameters
|
137
133
|
# @return [ReportageLinkSchema]
|
138
134
|
def get_reportage_link(auth, report_url, opts = {})
|
@@ -140,10 +136,10 @@ module RusticiSoftwareCloudV2
|
|
140
136
|
data
|
141
137
|
end
|
142
138
|
|
143
|
-
# Get
|
144
|
-
#
|
145
|
-
# @param auth The
|
146
|
-
# @param report_url The Reportage URL to try and access
|
139
|
+
# Get a link to a page in Reportage with the given permissions
|
140
|
+
# Returns the link to use for viewing Reportage. In order to generate a link, GetReportageAuthToken will need to be called to generate an auth token with the necessary permissions.
|
141
|
+
# @param auth The Reportage authentication token retrieved from a previous call to `GET reportageAuth`
|
142
|
+
# @param report_url The Reportage URL to try and access. Common values are the Reportage homepage `https://cloud.scorm.com/Reportage/reportage.php?appId={{your appId}}` or a URL pointing to a specific report within Reportage. The latter type of URL includes lots of parameters of the report, such as the date range, demographic (via tags), specific course or learner, and so on.
|
147
143
|
# @param [Hash] opts the optional parameters
|
148
144
|
# @return [Array<(ReportageLinkSchema, Fixnum, Hash)>] ReportageLinkSchema data, response status code and response headers
|
149
145
|
def get_reportage_link_with_http_info(auth, report_url, opts = {})
|
@@ -151,11 +147,11 @@ module RusticiSoftwareCloudV2
|
|
151
147
|
@api_client.config.logger.debug 'Calling API: ReportingApi.get_reportage_link ...'
|
152
148
|
end
|
153
149
|
# verify the required parameter 'auth' is set
|
154
|
-
if
|
150
|
+
if auth.nil?
|
155
151
|
fail ArgumentError, "Missing the required parameter 'auth' when calling ReportingApi.get_reportage_link"
|
156
152
|
end
|
157
153
|
# verify the required parameter 'report_url' is set
|
158
|
-
if
|
154
|
+
if report_url.nil?
|
159
155
|
fail ArgumentError, "Missing the required parameter 'report_url' when calling ReportingApi.get_reportage_link"
|
160
156
|
end
|
161
157
|
# resource path
|
@@ -19,8 +19,8 @@ module RusticiSoftwareCloudV2
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Create an xAPI
|
23
|
-
#
|
22
|
+
# Create an xAPI Statement Pipe
|
23
|
+
# Creates an xAPI statement pipe. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the creation of the xAPI statement pipe takes place.
|
24
24
|
# @param xapi_statement_pipe
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [StringResultSchema]
|
@@ -29,8 +29,8 @@ module RusticiSoftwareCloudV2
|
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
|
-
# Create an xAPI
|
33
|
-
#
|
32
|
+
# Create an xAPI Statement Pipe
|
33
|
+
# Creates an xAPI statement pipe. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the creation of the xAPI statement pipe takes place.
|
34
34
|
# @param xapi_statement_pipe
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
|
@@ -39,7 +39,7 @@ module RusticiSoftwareCloudV2
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: XapiApi.create_statement_pipe ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'xapi_statement_pipe' is set
|
42
|
-
if
|
42
|
+
if xapi_statement_pipe.nil?
|
43
43
|
fail ArgumentError, "Missing the required parameter 'xapi_statement_pipe' when calling XapiApi.create_statement_pipe"
|
44
44
|
end
|
45
45
|
# resource path
|
@@ -73,8 +73,8 @@ module RusticiSoftwareCloudV2
|
|
73
73
|
end
|
74
74
|
return data, status_code, headers
|
75
75
|
end
|
76
|
-
# Create
|
77
|
-
#
|
76
|
+
# Create xAPI Credentials
|
77
|
+
# Creates an xAPI credential combination from the provided secret and a generated ID.
|
78
78
|
# @param xapi_credential
|
79
79
|
# @param [Hash] opts the optional parameters
|
80
80
|
# @return [StringResultSchema]
|
@@ -83,8 +83,8 @@ module RusticiSoftwareCloudV2
|
|
83
83
|
data
|
84
84
|
end
|
85
85
|
|
86
|
-
# Create
|
87
|
-
#
|
86
|
+
# Create xAPI Credentials
|
87
|
+
# Creates an xAPI credential combination from the provided secret and a generated ID.
|
88
88
|
# @param xapi_credential
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
90
|
# @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
|
@@ -93,7 +93,7 @@ module RusticiSoftwareCloudV2
|
|
93
93
|
@api_client.config.logger.debug 'Calling API: XapiApi.create_xapi_credential ...'
|
94
94
|
end
|
95
95
|
# verify the required parameter 'xapi_credential' is set
|
96
|
-
if
|
96
|
+
if xapi_credential.nil?
|
97
97
|
fail ArgumentError, "Missing the required parameter 'xapi_credential' when calling XapiApi.create_xapi_credential"
|
98
98
|
end
|
99
99
|
# resource path
|
@@ -127,9 +127,9 @@ module RusticiSoftwareCloudV2
|
|
127
127
|
end
|
128
128
|
return data, status_code, headers
|
129
129
|
end
|
130
|
-
#
|
131
|
-
#
|
132
|
-
# @param statement_pipe_id
|
130
|
+
# Delete an xAPI Statement Pipe
|
131
|
+
# Deletes the specified xAPI statement pipe >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the deletion takes place. Recreating a statement pipe with the same ID too quickly could cause the statement pipe to end up in a faulty state.
|
132
|
+
# @param statement_pipe_id
|
133
133
|
# @param [Hash] opts the optional parameters
|
134
134
|
# @return [nil]
|
135
135
|
def delete_statement_pipe(statement_pipe_id, opts = {})
|
@@ -137,9 +137,9 @@ module RusticiSoftwareCloudV2
|
|
137
137
|
nil
|
138
138
|
end
|
139
139
|
|
140
|
-
#
|
141
|
-
#
|
142
|
-
# @param statement_pipe_id
|
140
|
+
# Delete an xAPI Statement Pipe
|
141
|
+
# Deletes the specified xAPI statement pipe >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the deletion takes place. Recreating a statement pipe with the same ID too quickly could cause the statement pipe to end up in a faulty state.
|
142
|
+
# @param statement_pipe_id
|
143
143
|
# @param [Hash] opts the optional parameters
|
144
144
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
145
145
|
def delete_statement_pipe_with_http_info(statement_pipe_id, opts = {})
|
@@ -147,7 +147,7 @@ module RusticiSoftwareCloudV2
|
|
147
147
|
@api_client.config.logger.debug 'Calling API: XapiApi.delete_statement_pipe ...'
|
148
148
|
end
|
149
149
|
# verify the required parameter 'statement_pipe_id' is set
|
150
|
-
if
|
150
|
+
if statement_pipe_id.nil?
|
151
151
|
fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.delete_statement_pipe"
|
152
152
|
end
|
153
153
|
# resource path
|
@@ -180,9 +180,9 @@ module RusticiSoftwareCloudV2
|
|
180
180
|
end
|
181
181
|
return data, status_code, headers
|
182
182
|
end
|
183
|
-
#
|
184
|
-
# Deletes the
|
185
|
-
# @param xapi_credential_id
|
183
|
+
# Delete xAPI Credentials
|
184
|
+
# Deletes the specified xAPI credentials.
|
185
|
+
# @param xapi_credential_id
|
186
186
|
# @param [Hash] opts the optional parameters
|
187
187
|
# @return [nil]
|
188
188
|
def delete_xapi_credential(xapi_credential_id, opts = {})
|
@@ -190,9 +190,9 @@ module RusticiSoftwareCloudV2
|
|
190
190
|
nil
|
191
191
|
end
|
192
192
|
|
193
|
-
#
|
194
|
-
# Deletes the
|
195
|
-
# @param xapi_credential_id
|
193
|
+
# Delete xAPI Credentials
|
194
|
+
# Deletes the specified xAPI credentials.
|
195
|
+
# @param xapi_credential_id
|
196
196
|
# @param [Hash] opts the optional parameters
|
197
197
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
198
198
|
def delete_xapi_credential_with_http_info(xapi_credential_id, opts = {})
|
@@ -200,7 +200,7 @@ module RusticiSoftwareCloudV2
|
|
200
200
|
@api_client.config.logger.debug 'Calling API: XapiApi.delete_xapi_credential ...'
|
201
201
|
end
|
202
202
|
# verify the required parameter 'xapi_credential_id' is set
|
203
|
-
if
|
203
|
+
if xapi_credential_id.nil?
|
204
204
|
fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.delete_xapi_credential"
|
205
205
|
end
|
206
206
|
# resource path
|
@@ -233,9 +233,9 @@ module RusticiSoftwareCloudV2
|
|
233
233
|
end
|
234
234
|
return data, status_code, headers
|
235
235
|
end
|
236
|
-
#
|
237
|
-
#
|
238
|
-
# @param statement_pipe_id
|
236
|
+
# Get detailed information about an xAPI Statement Pipe
|
237
|
+
# Returns detailed information about the xAPI pipe. This includes source and target urls, the last time a statement was successfully forwarded, and how many attempts have been made to send data to the target url.
|
238
|
+
# @param statement_pipe_id
|
239
239
|
# @param [Hash] opts the optional parameters
|
240
240
|
# @return [XapiStatementPipeSchema]
|
241
241
|
def get_statement_pipe(statement_pipe_id, opts = {})
|
@@ -243,9 +243,9 @@ module RusticiSoftwareCloudV2
|
|
243
243
|
data
|
244
244
|
end
|
245
245
|
|
246
|
-
#
|
247
|
-
#
|
248
|
-
# @param statement_pipe_id
|
246
|
+
# Get detailed information about an xAPI Statement Pipe
|
247
|
+
# Returns detailed information about the xAPI pipe. This includes source and target urls, the last time a statement was successfully forwarded, and how many attempts have been made to send data to the target url.
|
248
|
+
# @param statement_pipe_id
|
249
249
|
# @param [Hash] opts the optional parameters
|
250
250
|
# @return [Array<(XapiStatementPipeSchema, Fixnum, Hash)>] XapiStatementPipeSchema data, response status code and response headers
|
251
251
|
def get_statement_pipe_with_http_info(statement_pipe_id, opts = {})
|
@@ -253,7 +253,7 @@ module RusticiSoftwareCloudV2
|
|
253
253
|
@api_client.config.logger.debug 'Calling API: XapiApi.get_statement_pipe ...'
|
254
254
|
end
|
255
255
|
# verify the required parameter 'statement_pipe_id' is set
|
256
|
-
if
|
256
|
+
if statement_pipe_id.nil?
|
257
257
|
fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.get_statement_pipe"
|
258
258
|
end
|
259
259
|
# resource path
|
@@ -287,8 +287,8 @@ module RusticiSoftwareCloudV2
|
|
287
287
|
end
|
288
288
|
return data, status_code, headers
|
289
289
|
end
|
290
|
-
# Get
|
291
|
-
#
|
290
|
+
# Get a list of xAPI Statement Pipes
|
291
|
+
# Returns a list of all xAPI statement pipes.
|
292
292
|
# @param [Hash] opts the optional parameters
|
293
293
|
# @return [XapiStatementPipeListSchema]
|
294
294
|
def get_statement_pipes(opts = {})
|
@@ -296,8 +296,8 @@ module RusticiSoftwareCloudV2
|
|
296
296
|
data
|
297
297
|
end
|
298
298
|
|
299
|
-
# Get
|
300
|
-
#
|
299
|
+
# Get a list of xAPI Statement Pipes
|
300
|
+
# Returns a list of all xAPI statement pipes.
|
301
301
|
# @param [Hash] opts the optional parameters
|
302
302
|
# @return [Array<(XapiStatementPipeListSchema, Fixnum, Hash)>] XapiStatementPipeListSchema data, response status code and response headers
|
303
303
|
def get_statement_pipes_with_http_info(opts = {})
|
@@ -335,9 +335,9 @@ module RusticiSoftwareCloudV2
|
|
335
335
|
end
|
336
336
|
return data, status_code, headers
|
337
337
|
end
|
338
|
-
#
|
339
|
-
#
|
340
|
-
# @param xapi_credential_id
|
338
|
+
# Get detailed information about the xAPI Credentials
|
339
|
+
# Returns detailed information about the xAPI credentials. This includes the id (username), secret (password), permissions, and whether or not the credentials are enabled.
|
340
|
+
# @param xapi_credential_id
|
341
341
|
# @param [Hash] opts the optional parameters
|
342
342
|
# @return [XapiCredentialSchema]
|
343
343
|
def get_xapi_credential(xapi_credential_id, opts = {})
|
@@ -345,9 +345,9 @@ module RusticiSoftwareCloudV2
|
|
345
345
|
data
|
346
346
|
end
|
347
347
|
|
348
|
-
#
|
349
|
-
#
|
350
|
-
# @param xapi_credential_id
|
348
|
+
# Get detailed information about the xAPI Credentials
|
349
|
+
# Returns detailed information about the xAPI credentials. This includes the id (username), secret (password), permissions, and whether or not the credentials are enabled.
|
350
|
+
# @param xapi_credential_id
|
351
351
|
# @param [Hash] opts the optional parameters
|
352
352
|
# @return [Array<(XapiCredentialSchema, Fixnum, Hash)>] XapiCredentialSchema data, response status code and response headers
|
353
353
|
def get_xapi_credential_with_http_info(xapi_credential_id, opts = {})
|
@@ -355,7 +355,7 @@ module RusticiSoftwareCloudV2
|
|
355
355
|
@api_client.config.logger.debug 'Calling API: XapiApi.get_xapi_credential ...'
|
356
356
|
end
|
357
357
|
# verify the required parameter 'xapi_credential_id' is set
|
358
|
-
if
|
358
|
+
if xapi_credential_id.nil?
|
359
359
|
fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.get_xapi_credential"
|
360
360
|
end
|
361
361
|
# resource path
|
@@ -389,22 +389,32 @@ module RusticiSoftwareCloudV2
|
|
389
389
|
end
|
390
390
|
return data, status_code, headers
|
391
391
|
end
|
392
|
-
# Get
|
393
|
-
#
|
392
|
+
# Get a list of xAPI Credentials
|
393
|
+
# Returns a list of xAPI credentials. 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.
|
394
394
|
# @param [Hash] opts the optional parameters
|
395
|
-
# @option opts [DateTime] :since
|
396
|
-
# @option opts [
|
395
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
396
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
397
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
398
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
399
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to credential_id)
|
400
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
401
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
397
402
|
# @return [XapiCredentialsListSchema]
|
398
403
|
def get_xapi_credentials(opts = {})
|
399
404
|
data, _status_code, _headers = get_xapi_credentials_with_http_info(opts)
|
400
405
|
data
|
401
406
|
end
|
402
407
|
|
403
|
-
# Get
|
404
|
-
#
|
408
|
+
# Get a list of xAPI Credentials
|
409
|
+
# Returns a list of xAPI credentials. 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.
|
405
410
|
# @param [Hash] opts the optional parameters
|
406
|
-
# @option opts [DateTime] :since
|
407
|
-
# @option opts [
|
411
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
412
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
413
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
414
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
415
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
416
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
417
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
408
418
|
# @return [Array<(XapiCredentialsListSchema, Fixnum, Hash)>] XapiCredentialsListSchema data, response status code and response headers
|
409
419
|
def get_xapi_credentials_with_http_info(opts = {})
|
410
420
|
if @api_client.config.debugging
|
@@ -416,6 +426,11 @@ module RusticiSoftwareCloudV2
|
|
416
426
|
# query parameters
|
417
427
|
query_params = {}
|
418
428
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
429
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
430
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
431
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
432
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
433
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
419
434
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
420
435
|
|
421
436
|
# header parameters
|
@@ -443,9 +458,9 @@ module RusticiSoftwareCloudV2
|
|
443
458
|
end
|
444
459
|
return data, status_code, headers
|
445
460
|
end
|
446
|
-
#
|
447
|
-
#
|
448
|
-
# @param statement_pipe_id
|
461
|
+
# Create or update an xAPI Statement Pipe
|
462
|
+
# Creates or updates information about the xAPI statement pipe. - If the xAPI statement pipe is instead being updated, the pipe will start over and forward any statements it finds, even if it had already forwarded those statements. If the pipe being edited is currently being processed, then this request will fail with a status code of 409. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the creation of the xAPI statement pipe takes place.
|
463
|
+
# @param statement_pipe_id
|
449
464
|
# @param xapi_statement_pipe
|
450
465
|
# @param [Hash] opts the optional parameters
|
451
466
|
# @return [StringResultSchema]
|
@@ -454,9 +469,9 @@ module RusticiSoftwareCloudV2
|
|
454
469
|
data
|
455
470
|
end
|
456
471
|
|
457
|
-
#
|
458
|
-
#
|
459
|
-
# @param statement_pipe_id
|
472
|
+
# Create or update an xAPI Statement Pipe
|
473
|
+
# Creates or updates information about the xAPI statement pipe. - If the xAPI statement pipe is instead being updated, the pipe will start over and forward any statements it finds, even if it had already forwarded those statements. If the pipe being edited is currently being processed, then this request will fail with a status code of 409. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the creation of the xAPI statement pipe takes place.
|
474
|
+
# @param statement_pipe_id
|
460
475
|
# @param xapi_statement_pipe
|
461
476
|
# @param [Hash] opts the optional parameters
|
462
477
|
# @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
|
@@ -465,11 +480,11 @@ module RusticiSoftwareCloudV2
|
|
465
480
|
@api_client.config.logger.debug 'Calling API: XapiApi.set_statement_pipe ...'
|
466
481
|
end
|
467
482
|
# verify the required parameter 'statement_pipe_id' is set
|
468
|
-
if
|
483
|
+
if statement_pipe_id.nil?
|
469
484
|
fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.set_statement_pipe"
|
470
485
|
end
|
471
486
|
# verify the required parameter 'xapi_statement_pipe' is set
|
472
|
-
if
|
487
|
+
if xapi_statement_pipe.nil?
|
473
488
|
fail ArgumentError, "Missing the required parameter 'xapi_statement_pipe' when calling XapiApi.set_statement_pipe"
|
474
489
|
end
|
475
490
|
# resource path
|
@@ -503,9 +518,9 @@ module RusticiSoftwareCloudV2
|
|
503
518
|
end
|
504
519
|
return data, status_code, headers
|
505
520
|
end
|
506
|
-
#
|
507
|
-
#
|
508
|
-
# @param xapi_credential_id
|
521
|
+
# Create or update xAPI Credentials
|
522
|
+
# Creates or updates information about the xAPI credentials.
|
523
|
+
# @param xapi_credential_id
|
509
524
|
# @param xapi_credential
|
510
525
|
# @param [Hash] opts the optional parameters
|
511
526
|
# @return [nil]
|
@@ -514,9 +529,9 @@ module RusticiSoftwareCloudV2
|
|
514
529
|
nil
|
515
530
|
end
|
516
531
|
|
517
|
-
#
|
518
|
-
#
|
519
|
-
# @param xapi_credential_id
|
532
|
+
# Create or update xAPI Credentials
|
533
|
+
# Creates or updates information about the xAPI credentials.
|
534
|
+
# @param xapi_credential_id
|
520
535
|
# @param xapi_credential
|
521
536
|
# @param [Hash] opts the optional parameters
|
522
537
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -525,11 +540,11 @@ module RusticiSoftwareCloudV2
|
|
525
540
|
@api_client.config.logger.debug 'Calling API: XapiApi.set_xapi_credential ...'
|
526
541
|
end
|
527
542
|
# verify the required parameter 'xapi_credential_id' is set
|
528
|
-
if
|
543
|
+
if xapi_credential_id.nil?
|
529
544
|
fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.set_xapi_credential"
|
530
545
|
end
|
531
546
|
# verify the required parameter 'xapi_credential' is set
|
532
|
-
if
|
547
|
+
if xapi_credential.nil?
|
533
548
|
fail ArgumentError, "Missing the required parameter 'xapi_credential' when calling XapiApi.set_xapi_credential"
|
534
549
|
end
|
535
550
|
# resource path
|