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 back the API version and
|
23
|
-
# Get back the API version and application name.
|
22
|
+
# Get back the API version and Application name
|
23
|
+
# Get back the API version and application name. The return value for this method will never change. This method largely exists for API parity with our on-premise or Managed Hosting products, which may return different release numbers from this endpoint. For SCORM Cloud, this is effectively equal to the `/ping` resource.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [AboutSchema]
|
26
26
|
def get_about(opts = {})
|
@@ -28,8 +28,8 @@ module RusticiSoftwareCloudV2
|
|
28
28
|
data
|
29
29
|
end
|
30
30
|
|
31
|
-
# Get back the API version and
|
32
|
-
# Get back the API version and application name.
|
31
|
+
# Get back the API version and Application name
|
32
|
+
# Get back the API version and application name. The return value for this method will never change. This method largely exists for API parity with our on-premise or Managed Hosting products, which may return different release numbers from this endpoint. For SCORM Cloud, this is effectively equal to the `/ping` resource.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(AboutSchema, Fixnum, Hash)>] AboutSchema data, response status code and response headers
|
35
35
|
def get_about_with_http_info(opts = {})
|
@@ -19,26 +19,28 @@ module RusticiSoftwareCloudV2
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Use the Application Management App to create a new Application
|
23
|
+
# Creates an application. Applications are how resources are grouped together in SCORM Cloud. Any courses, registrations, etc. will only be accessible via the credentials for the application they belong to. >**Note:** >Application IDs are unique in that we do not allow the user to supply a custom value for this field. The ID of the newly created application will be specified in the response from this method. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
24
|
+
# @param application_request
|
24
25
|
# @param [Hash] opts the optional parameters
|
25
26
|
# @return [ApplicationSchema]
|
26
|
-
def create_application(
|
27
|
-
data, _status_code, _headers = create_application_with_http_info(
|
27
|
+
def create_application(application_request, opts = {})
|
28
|
+
data, _status_code, _headers = create_application_with_http_info(application_request, opts)
|
28
29
|
data
|
29
30
|
end
|
30
31
|
|
31
|
-
#
|
32
|
-
#
|
32
|
+
# Use the Application Management App to create a new Application
|
33
|
+
# Creates an application. Applications are how resources are grouped together in SCORM Cloud. Any courses, registrations, etc. will only be accessible via the credentials for the application they belong to. >**Note:** >Application IDs are unique in that we do not allow the user to supply a custom value for this field. The ID of the newly created application will be specified in the response from this method. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
34
|
+
# @param application_request
|
33
35
|
# @param [Hash] opts the optional parameters
|
34
36
|
# @return [Array<(ApplicationSchema, Fixnum, Hash)>] ApplicationSchema data, response status code and response headers
|
35
|
-
def create_application_with_http_info(
|
37
|
+
def create_application_with_http_info(application_request, opts = {})
|
36
38
|
if @api_client.config.debugging
|
37
39
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_application ...'
|
38
40
|
end
|
39
|
-
# verify the required parameter '
|
40
|
-
if
|
41
|
-
fail ArgumentError, "Missing the required parameter '
|
41
|
+
# verify the required parameter 'application_request' is set
|
42
|
+
if application_request.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'application_request' when calling ApplicationManagementApi.create_application"
|
42
44
|
end
|
43
45
|
# resource path
|
44
46
|
local_var_path = '/appManagement/applications'
|
@@ -57,7 +59,7 @@ module RusticiSoftwareCloudV2
|
|
57
59
|
form_params = {}
|
58
60
|
|
59
61
|
# http body (model)
|
60
|
-
post_body = @api_client.object_to_http_body(
|
62
|
+
post_body = @api_client.object_to_http_body(application_request)
|
61
63
|
auth_names = ['APP_MANAGEMENT', 'OAUTH']
|
62
64
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
63
65
|
:header_params => header_params,
|
@@ -71,7 +73,8 @@ module RusticiSoftwareCloudV2
|
|
71
73
|
end
|
72
74
|
return data, status_code, headers
|
73
75
|
end
|
74
|
-
#
|
76
|
+
# Use the Application Manager App to create a new secret key for an Application
|
77
|
+
# Creates a new credential (aka secret key) for use with the child application. The credential will be used alongside the `childAppId` for basic auth requests. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
75
78
|
# @param child_app_id
|
76
79
|
# @param credential_request
|
77
80
|
# @param [Hash] opts the optional parameters
|
@@ -81,7 +84,8 @@ module RusticiSoftwareCloudV2
|
|
81
84
|
data
|
82
85
|
end
|
83
86
|
|
84
|
-
#
|
87
|
+
# Use the Application Manager App to create a new secret key for an Application
|
88
|
+
# Creates a new credential (aka secret key) for use with the child application. The credential will be used alongside the `childAppId` for basic auth requests. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
85
89
|
# @param child_app_id
|
86
90
|
# @param credential_request
|
87
91
|
# @param [Hash] opts the optional parameters
|
@@ -91,11 +95,11 @@ module RusticiSoftwareCloudV2
|
|
91
95
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
|
92
96
|
end
|
93
97
|
# verify the required parameter 'child_app_id' is set
|
94
|
-
if
|
98
|
+
if child_app_id.nil?
|
95
99
|
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.create_credential"
|
96
100
|
end
|
97
101
|
# verify the required parameter 'credential_request' is set
|
98
|
-
if
|
102
|
+
if credential_request.nil?
|
99
103
|
fail ArgumentError, "Missing the required parameter 'credential_request' when calling ApplicationManagementApi.create_credential"
|
100
104
|
end
|
101
105
|
# resource path
|
@@ -129,7 +133,8 @@ module RusticiSoftwareCloudV2
|
|
129
133
|
end
|
130
134
|
return data, status_code, headers
|
131
135
|
end
|
132
|
-
#
|
136
|
+
# Obtain an OAuth token for scoped access to an Application
|
137
|
+
# 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.
|
133
138
|
# @param token_request
|
134
139
|
# @param [Hash] opts the optional parameters
|
135
140
|
# @return [StringResultSchema]
|
@@ -138,7 +143,8 @@ module RusticiSoftwareCloudV2
|
|
138
143
|
data
|
139
144
|
end
|
140
145
|
|
141
|
-
#
|
146
|
+
# Obtain an OAuth token for scoped access to an Application
|
147
|
+
# 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.
|
142
148
|
# @param token_request
|
143
149
|
# @param [Hash] opts the optional parameters
|
144
150
|
# @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
|
@@ -147,7 +153,7 @@ module RusticiSoftwareCloudV2
|
|
147
153
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_token ...'
|
148
154
|
end
|
149
155
|
# verify the required parameter 'token_request' is set
|
150
|
-
if
|
156
|
+
if token_request.nil?
|
151
157
|
fail ArgumentError, "Missing the required parameter 'token_request' when calling ApplicationManagementApi.create_token"
|
152
158
|
end
|
153
159
|
# resource path
|
@@ -181,7 +187,8 @@ module RusticiSoftwareCloudV2
|
|
181
187
|
end
|
182
188
|
return data, status_code, headers
|
183
189
|
end
|
184
|
-
#
|
190
|
+
# Use the Application Management App to delete an Application
|
191
|
+
# Deletes the specified application. All content within an application must be removed in order to allow deletion. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
185
192
|
# @param child_app_id
|
186
193
|
# @param [Hash] opts the optional parameters
|
187
194
|
# @return [nil]
|
@@ -190,7 +197,8 @@ module RusticiSoftwareCloudV2
|
|
190
197
|
nil
|
191
198
|
end
|
192
199
|
|
193
|
-
#
|
200
|
+
# Use the Application Management App to delete an Application
|
201
|
+
# Deletes the specified application. All content within an application must be removed in order to allow deletion. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
194
202
|
# @param child_app_id
|
195
203
|
# @param [Hash] opts the optional parameters
|
196
204
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -199,7 +207,7 @@ module RusticiSoftwareCloudV2
|
|
199
207
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application ...'
|
200
208
|
end
|
201
209
|
# verify the required parameter 'child_app_id' is set
|
202
|
-
if
|
210
|
+
if child_app_id.nil?
|
203
211
|
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_application"
|
204
212
|
end
|
205
213
|
# resource path
|
@@ -232,36 +240,33 @@ module RusticiSoftwareCloudV2
|
|
232
240
|
end
|
233
241
|
return data, status_code, headers
|
234
242
|
end
|
235
|
-
#
|
236
|
-
# Clears the setting value
|
243
|
+
# Delete a configuration setting explicitly set for an Application
|
244
|
+
# Clears the specified setting from the application. This causes the setting to inherit a value from a higher level (e.g. system default if deleting from application, application level if deleting from learning standard). If the configuration setting was not set at the application level it will continue to persist and will require deletion from the level it was set.
|
237
245
|
# @param setting_id
|
238
246
|
# @param [Hash] opts the optional parameters
|
239
247
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
240
|
-
# @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to
|
248
|
+
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
241
249
|
# @return [nil]
|
242
250
|
def delete_application_configuration_setting(setting_id, opts = {})
|
243
251
|
delete_application_configuration_setting_with_http_info(setting_id, opts)
|
244
252
|
nil
|
245
253
|
end
|
246
254
|
|
247
|
-
#
|
248
|
-
# Clears the setting value
|
255
|
+
# Delete a configuration setting explicitly set for an Application
|
256
|
+
# Clears the specified setting from the application. This causes the setting to inherit a value from a higher level (e.g. system default if deleting from application, application level if deleting from learning standard). If the configuration setting was not set at the application level it will continue to persist and will require deletion from the level it was set.
|
249
257
|
# @param setting_id
|
250
258
|
# @param [Hash] opts the optional parameters
|
251
259
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
252
|
-
# @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to
|
260
|
+
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
253
261
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
254
262
|
def delete_application_configuration_setting_with_http_info(setting_id, opts = {})
|
255
263
|
if @api_client.config.debugging
|
256
264
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application_configuration_setting ...'
|
257
265
|
end
|
258
266
|
# verify the required parameter 'setting_id' is set
|
259
|
-
if
|
267
|
+
if setting_id.nil?
|
260
268
|
fail ArgumentError, "Missing the required parameter 'setting_id' when calling ApplicationManagementApi.delete_application_configuration_setting"
|
261
269
|
end
|
262
|
-
if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
|
263
|
-
fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
|
264
|
-
end
|
265
270
|
# resource path
|
266
271
|
local_var_path = '/appManagement/configuration/{settingId}'.sub('{' + 'settingId' + '}', setting_id.to_s)
|
267
272
|
|
@@ -294,7 +299,8 @@ module RusticiSoftwareCloudV2
|
|
294
299
|
end
|
295
300
|
return data, status_code, headers
|
296
301
|
end
|
297
|
-
#
|
302
|
+
# Use the Application Management App to delete a secret key from an Application
|
303
|
+
# Deletes a credential belonging to the child application. >**Caution:** >If the last secret key for an application is deleted it will not be able to use the SCORM Cloud API until another key is granted to it via `CreateCredential`. It may also disable some website privileges. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
298
304
|
# @param child_app_id
|
299
305
|
# @param credential_id
|
300
306
|
# @param [Hash] opts the optional parameters
|
@@ -304,7 +310,8 @@ module RusticiSoftwareCloudV2
|
|
304
310
|
nil
|
305
311
|
end
|
306
312
|
|
307
|
-
#
|
313
|
+
# Use the Application Management App to delete a secret key from an Application
|
314
|
+
# Deletes a credential belonging to the child application. >**Caution:** >If the last secret key for an application is deleted it will not be able to use the SCORM Cloud API until another key is granted to it via `CreateCredential`. It may also disable some website privileges. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
308
315
|
# @param child_app_id
|
309
316
|
# @param credential_id
|
310
317
|
# @param [Hash] opts the optional parameters
|
@@ -314,11 +321,11 @@ module RusticiSoftwareCloudV2
|
|
314
321
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_credential ...'
|
315
322
|
end
|
316
323
|
# verify the required parameter 'child_app_id' is set
|
317
|
-
if
|
324
|
+
if child_app_id.nil?
|
318
325
|
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_credential"
|
319
326
|
end
|
320
327
|
# verify the required parameter 'credential_id' is set
|
321
|
-
if
|
328
|
+
if credential_id.nil?
|
322
329
|
fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.delete_credential"
|
323
330
|
end
|
324
331
|
# resource path
|
@@ -351,10 +358,11 @@ module RusticiSoftwareCloudV2
|
|
351
358
|
end
|
352
359
|
return data, status_code, headers
|
353
360
|
end
|
354
|
-
#
|
361
|
+
# Get effective configuration settings for an Application
|
362
|
+
# Returns the effective configuration settings for the application. Configuration settings at the application level will apply to all items within that application (courses, registrations, etc.). If there is a configuration setting present at a more specific level (course, registration, etc.), that setting will override the one set at the application level. >**Note:** >This resource lists configuration for two groupings of content: >- ALL content in an application. This is achieved by leaving `learningStandard` and `singleSco` as `null`. Anything set at the learningStandard/singleSco level will take precedence over these settings. >- Content falling into a learningStandard/singleSco category. This allows setting more specific defaults for a particular learningStandard/singleSco combination. _Note: both `learningStandard` and `singleSco` must be provided, as this level is considered to be identified by those items joined._
|
355
363
|
# @param [Hash] opts the optional parameters
|
356
364
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
357
|
-
# @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to
|
365
|
+
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
358
366
|
# @option opts [BOOLEAN] :include_metadata (default to false)
|
359
367
|
# @return [SettingListSchema]
|
360
368
|
def get_application_configuration(opts = {})
|
@@ -362,19 +370,17 @@ module RusticiSoftwareCloudV2
|
|
362
370
|
data
|
363
371
|
end
|
364
372
|
|
365
|
-
#
|
373
|
+
# Get effective configuration settings for an Application
|
374
|
+
# Returns the effective configuration settings for the application. Configuration settings at the application level will apply to all items within that application (courses, registrations, etc.). If there is a configuration setting present at a more specific level (course, registration, etc.), that setting will override the one set at the application level. >**Note:** >This resource lists configuration for two groupings of content: >- ALL content in an application. This is achieved by leaving `learningStandard` and `singleSco` as `null`. Anything set at the learningStandard/singleSco level will take precedence over these settings. >- Content falling into a learningStandard/singleSco category. This allows setting more specific defaults for a particular learningStandard/singleSco combination. _Note: both `learningStandard` and `singleSco` must be provided, as this level is considered to be identified by those items joined._
|
366
375
|
# @param [Hash] opts the optional parameters
|
367
376
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
368
|
-
# @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to
|
377
|
+
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
369
378
|
# @option opts [BOOLEAN] :include_metadata
|
370
379
|
# @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
|
371
380
|
def get_application_configuration_with_http_info(opts = {})
|
372
381
|
if @api_client.config.debugging
|
373
382
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_configuration ...'
|
374
383
|
end
|
375
|
-
if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
|
376
|
-
fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
|
377
|
-
end
|
378
384
|
# resource path
|
379
385
|
local_var_path = '/appManagement/configuration'
|
380
386
|
|
@@ -409,8 +415,68 @@ module RusticiSoftwareCloudV2
|
|
409
415
|
end
|
410
416
|
return data, status_code, headers
|
411
417
|
end
|
412
|
-
#
|
413
|
-
#
|
418
|
+
# Use the Application Management App to get detailed information about an Application
|
419
|
+
# Returns detailed information about the application. This includes name, create date, and delete permissions. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
420
|
+
# @param child_app_id
|
421
|
+
# @param [Hash] opts the optional parameters
|
422
|
+
# @option opts [BOOLEAN] :include_course_count Include a count of courses for the application. (default to false)
|
423
|
+
# @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period. (default to false)
|
424
|
+
# @return [ApplicationInfoSchema]
|
425
|
+
def get_application_info(child_app_id, opts = {})
|
426
|
+
data, _status_code, _headers = get_application_info_with_http_info(child_app_id, opts)
|
427
|
+
data
|
428
|
+
end
|
429
|
+
|
430
|
+
# Use the Application Management App to get detailed information about an Application
|
431
|
+
# Returns detailed information about the application. This includes name, create date, and delete permissions. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
432
|
+
# @param child_app_id
|
433
|
+
# @param [Hash] opts the optional parameters
|
434
|
+
# @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
|
435
|
+
# @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
|
436
|
+
# @return [Array<(ApplicationInfoSchema, Fixnum, Hash)>] ApplicationInfoSchema data, response status code and response headers
|
437
|
+
def get_application_info_with_http_info(child_app_id, opts = {})
|
438
|
+
if @api_client.config.debugging
|
439
|
+
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_info ...'
|
440
|
+
end
|
441
|
+
# verify the required parameter 'child_app_id' is set
|
442
|
+
if child_app_id.nil?
|
443
|
+
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_application_info"
|
444
|
+
end
|
445
|
+
# resource path
|
446
|
+
local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
|
447
|
+
|
448
|
+
# query parameters
|
449
|
+
query_params = {}
|
450
|
+
query_params[:'includeCourseCount'] = opts[:'include_course_count'] if !opts[:'include_course_count'].nil?
|
451
|
+
query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
|
452
|
+
|
453
|
+
# header parameters
|
454
|
+
header_params = {}
|
455
|
+
# HTTP header 'Accept' (if needed)
|
456
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
457
|
+
# HTTP header 'Content-Type'
|
458
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
459
|
+
|
460
|
+
# form parameters
|
461
|
+
form_params = {}
|
462
|
+
|
463
|
+
# http body (model)
|
464
|
+
post_body = nil
|
465
|
+
auth_names = ['APP_MANAGEMENT', 'OAUTH']
|
466
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
467
|
+
:header_params => header_params,
|
468
|
+
:query_params => query_params,
|
469
|
+
:form_params => form_params,
|
470
|
+
:body => post_body,
|
471
|
+
:auth_names => auth_names,
|
472
|
+
:return_type => 'ApplicationInfoSchema')
|
473
|
+
if @api_client.config.debugging
|
474
|
+
@api_client.config.logger.debug "API called: ApplicationManagementApi#get_application_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
475
|
+
end
|
476
|
+
return data, status_code, headers
|
477
|
+
end
|
478
|
+
# Use the Application Management App to get a list of Applications
|
479
|
+
# Returns a list of all applications which are in this Realm. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
414
480
|
# @param [Hash] opts the optional parameters
|
415
481
|
# @return [ApplicationListSchema]
|
416
482
|
def get_application_list(opts = {})
|
@@ -418,8 +484,8 @@ module RusticiSoftwareCloudV2
|
|
418
484
|
data
|
419
485
|
end
|
420
486
|
|
421
|
-
#
|
422
|
-
#
|
487
|
+
# Use the Application Management App to get a list of Applications
|
488
|
+
# Returns a list of all applications which are in this Realm. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
423
489
|
# @param [Hash] opts the optional parameters
|
424
490
|
# @return [Array<(ApplicationListSchema, Fixnum, Hash)>] ApplicationListSchema data, response status code and response headers
|
425
491
|
def get_application_list_with_http_info(opts = {})
|
@@ -457,7 +523,8 @@ module RusticiSoftwareCloudV2
|
|
457
523
|
end
|
458
524
|
return data, status_code, headers
|
459
525
|
end
|
460
|
-
#
|
526
|
+
# Use the Application Manager App to get a list of secret keys for an Application
|
527
|
+
# Returns a list of all the credentials (aka secret keys) belonging to the child application. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
461
528
|
# @param child_app_id
|
462
529
|
# @param [Hash] opts the optional parameters
|
463
530
|
# @return [CredentialListSchema]
|
@@ -466,7 +533,8 @@ module RusticiSoftwareCloudV2
|
|
466
533
|
data
|
467
534
|
end
|
468
535
|
|
469
|
-
#
|
536
|
+
# Use the Application Manager App to get a list of secret keys for an Application
|
537
|
+
# Returns a list of all the credentials (aka secret keys) belonging to the child application. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
470
538
|
# @param child_app_id
|
471
539
|
# @param [Hash] opts the optional parameters
|
472
540
|
# @return [Array<(CredentialListSchema, Fixnum, Hash)>] CredentialListSchema data, response status code and response headers
|
@@ -475,7 +543,7 @@ module RusticiSoftwareCloudV2
|
|
475
543
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_credentials ...'
|
476
544
|
end
|
477
545
|
# verify the required parameter 'child_app_id' is set
|
478
|
-
if
|
546
|
+
if child_app_id.nil?
|
479
547
|
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_credentials"
|
480
548
|
end
|
481
549
|
# resource path
|
@@ -509,34 +577,33 @@ module RusticiSoftwareCloudV2
|
|
509
577
|
end
|
510
578
|
return data, status_code, headers
|
511
579
|
end
|
512
|
-
#
|
580
|
+
# Update configuration settings for an Application
|
581
|
+
# Updates configuration settings at the application level. This will explicitly set a value at the applicaiton level. These settings will affect all items within the application which do not have their own explicit configuration set. This can effectively be used to set application level defaults.
|
513
582
|
# @param configuration_settings
|
514
583
|
# @param [Hash] opts the optional parameters
|
515
584
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
516
|
-
# @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to
|
585
|
+
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
517
586
|
# @return [nil]
|
518
587
|
def set_application_configuration(configuration_settings, opts = {})
|
519
588
|
set_application_configuration_with_http_info(configuration_settings, opts)
|
520
589
|
nil
|
521
590
|
end
|
522
591
|
|
523
|
-
#
|
592
|
+
# Update configuration settings for an Application
|
593
|
+
# Updates configuration settings at the application level. This will explicitly set a value at the applicaiton level. These settings will affect all items within the application which do not have their own explicit configuration set. This can effectively be used to set application level defaults.
|
524
594
|
# @param configuration_settings
|
525
595
|
# @param [Hash] opts the optional parameters
|
526
596
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
527
|
-
# @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to
|
597
|
+
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
528
598
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
529
599
|
def set_application_configuration_with_http_info(configuration_settings, opts = {})
|
530
600
|
if @api_client.config.debugging
|
531
601
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.set_application_configuration ...'
|
532
602
|
end
|
533
603
|
# verify the required parameter 'configuration_settings' is set
|
534
|
-
if
|
604
|
+
if configuration_settings.nil?
|
535
605
|
fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling ApplicationManagementApi.set_application_configuration"
|
536
606
|
end
|
537
|
-
if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
|
538
|
-
fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
|
539
|
-
end
|
540
607
|
# resource path
|
541
608
|
local_var_path = '/appManagement/configuration'
|
542
609
|
|
@@ -569,7 +636,67 @@ module RusticiSoftwareCloudV2
|
|
569
636
|
end
|
570
637
|
return data, status_code, headers
|
571
638
|
end
|
572
|
-
#
|
639
|
+
# Use the Application Management App to update information about an Application
|
640
|
+
# Updates information about the application, such as the name and enabling/ disabling deletion operations for the application. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
641
|
+
# @param child_app_id
|
642
|
+
# @param application_properties
|
643
|
+
# @param [Hash] opts the optional parameters
|
644
|
+
# @return [nil]
|
645
|
+
def update_application(child_app_id, application_properties, opts = {})
|
646
|
+
update_application_with_http_info(child_app_id, application_properties, opts)
|
647
|
+
nil
|
648
|
+
end
|
649
|
+
|
650
|
+
# Use the Application Management App to update information about an Application
|
651
|
+
# Updates information about the application, such as the name and enabling/ disabling deletion operations for the application. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
652
|
+
# @param child_app_id
|
653
|
+
# @param application_properties
|
654
|
+
# @param [Hash] opts the optional parameters
|
655
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
656
|
+
def update_application_with_http_info(child_app_id, application_properties, opts = {})
|
657
|
+
if @api_client.config.debugging
|
658
|
+
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_application ...'
|
659
|
+
end
|
660
|
+
# verify the required parameter 'child_app_id' is set
|
661
|
+
if child_app_id.nil?
|
662
|
+
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_application"
|
663
|
+
end
|
664
|
+
# verify the required parameter 'application_properties' is set
|
665
|
+
if application_properties.nil?
|
666
|
+
fail ArgumentError, "Missing the required parameter 'application_properties' when calling ApplicationManagementApi.update_application"
|
667
|
+
end
|
668
|
+
# resource path
|
669
|
+
local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
|
670
|
+
|
671
|
+
# query parameters
|
672
|
+
query_params = {}
|
673
|
+
|
674
|
+
# header parameters
|
675
|
+
header_params = {}
|
676
|
+
# HTTP header 'Accept' (if needed)
|
677
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
678
|
+
# HTTP header 'Content-Type'
|
679
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
680
|
+
|
681
|
+
# form parameters
|
682
|
+
form_params = {}
|
683
|
+
|
684
|
+
# http body (model)
|
685
|
+
post_body = @api_client.object_to_http_body(application_properties)
|
686
|
+
auth_names = ['APP_MANAGEMENT', 'OAUTH']
|
687
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
688
|
+
:header_params => header_params,
|
689
|
+
:query_params => query_params,
|
690
|
+
:form_params => form_params,
|
691
|
+
:body => post_body,
|
692
|
+
:auth_names => auth_names)
|
693
|
+
if @api_client.config.debugging
|
694
|
+
@api_client.config.logger.debug "API called: ApplicationManagementApi#update_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
695
|
+
end
|
696
|
+
return data, status_code, headers
|
697
|
+
end
|
698
|
+
# Use the Application Manager App to update an existing secret key for an Application
|
699
|
+
# Updates the name or status associated with the credential. Disabling a credential will cause it to no longer be valid for authorization through the API. >**Caution:** >If the last (or only) key for an application is disabled it may affect some website privileges. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
573
700
|
# @param child_app_id
|
574
701
|
# @param credential_id
|
575
702
|
# @param credential_update
|
@@ -580,7 +707,8 @@ module RusticiSoftwareCloudV2
|
|
580
707
|
nil
|
581
708
|
end
|
582
709
|
|
583
|
-
#
|
710
|
+
# Use the Application Manager App to update an existing secret key for an Application
|
711
|
+
# Updates the name or status associated with the credential. Disabling a credential will cause it to no longer be valid for authorization through the API. >**Caution:** >If the last (or only) key for an application is disabled it may affect some website privileges. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
|
584
712
|
# @param child_app_id
|
585
713
|
# @param credential_id
|
586
714
|
# @param credential_update
|
@@ -591,15 +719,15 @@ module RusticiSoftwareCloudV2
|
|
591
719
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_credential ...'
|
592
720
|
end
|
593
721
|
# verify the required parameter 'child_app_id' is set
|
594
|
-
if
|
722
|
+
if child_app_id.nil?
|
595
723
|
fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_credential"
|
596
724
|
end
|
597
725
|
# verify the required parameter 'credential_id' is set
|
598
|
-
if
|
726
|
+
if credential_id.nil?
|
599
727
|
fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.update_credential"
|
600
728
|
end
|
601
729
|
# verify the required parameter 'credential_update' is set
|
602
|
-
if
|
730
|
+
if credential_update.nil?
|
603
731
|
fail ArgumentError, "Missing the required parameter 'credential_update' when calling ApplicationManagementApi.update_credential"
|
604
732
|
end
|
605
733
|
# resource path
|
@@ -19,39 +19,31 @@ module RusticiSoftwareCloudV2
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
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.
|
24
|
-
# @param scope
|
22
|
+
# Obtain an OAuth token for scoped access to an Application
|
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.
|
24
|
+
# @param scope Space separated string of OAuth scopes, e.g. \"write:course read:registration\".
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Integer] :expiration (default to 300)
|
26
|
+
# @option opts [Integer] :expiration Amount of seconds until the OAuth token expires. (default to 300)
|
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
|
-
#
|
34
|
-
# 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. >
|
35
|
-
# @param scope
|
33
|
+
# Obtain an OAuth token for scoped access to an Application
|
34
|
+
# 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.
|
35
|
+
# @param scope Space separated string of OAuth scopes, e.g. \"write:course read:registration\".
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [Integer] :expiration
|
37
|
+
# @option opts [Integer] :expiration Amount of seconds until the OAuth token expires.
|
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
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
|
-
if
|
44
|
+
if scope.nil?
|
45
45
|
fail ArgumentError, "Missing the required parameter 'scope' when calling AuthenticationApi.get_app_token"
|
46
46
|
end
|
47
|
-
if @api_client.config.client_side_validation && !opts[:'expiration'].nil? && opts[:'expiration'] > 43200
|
48
|
-
fail ArgumentError, 'invalid value for "opts[:"expiration"]" when calling AuthenticationApi.get_app_token, must be smaller than or equal to 43200.'
|
49
|
-
end
|
50
|
-
|
51
|
-
if @api_client.config.client_side_validation && !opts[:'expiration'].nil? && opts[:'expiration'] < 60
|
52
|
-
fail ArgumentError, 'invalid value for "opts[:"expiration"]" when calling AuthenticationApi.get_app_token, must be greater than or equal to 60.'
|
53
|
-
end
|
54
|
-
|
55
47
|
# resource path
|
56
48
|
local_var_path = '/oauth/authenticate/application/token'
|
57
49
|
|