rustici_software_cloud_v2 3.0.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -5
- data/lib/rustici_software_cloud_v2/api/about_api.rb +1 -1
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +19 -19
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +2 -2
- data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +4 -4
- data/lib/rustici_software_cloud_v2/api/course_api.rb +46 -37
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +59 -47
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +28 -22
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +6 -6
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +1 -1
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +27 -27
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +3 -3
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +10 -10
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/{zoomi_company_id.rb → destination_info_id_schema.rb} +19 -9
- data/lib/rustici_software_cloud_v2/models/{zoomi_course_options_schema.rb → destination_info_list_schema.rb} +19 -25
- data/lib/rustici_software_cloud_v2/models/destination_info_schema.rb +263 -0
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +5 -15
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +2 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +12 -2
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/{credential_created_schema.rb → invitation_email_update_schema.rb} +17 -46
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +16 -5
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/paginated_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/preview_launch_link_request_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +26 -6
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +3 -3
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +15 -16
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +4 -6
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -1
- data/lib/rustici_software_cloud_v2.rb +5 -4
- data/rustici_software_cloud_v2.gemspec +9 -13
- data/spec/api_client_spec.rb +1 -1
- metadata +33 -121
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +0 -538
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e54abadc8d428825fea19cca6020566f076d415303e1783d592013c159c814f1
|
|
4
|
+
data.tar.gz: 4c357263f6286f4a564214da5c4c0118c4d994d0696985dfb132051a15ea35df
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 622a619afa9ba64bdf1f810d1661426b66e3c3418a44558b376412692fc3ab17e5839f28dfd51cd6d96fe847dbc094e0da3561e254fd4598bdef890f1d9c9221
|
|
7
|
+
data.tar.gz: 4f5eea88d9e6cdd2baba6087b6505abb1412b99a0e6028b1f9575a4c7a5f6bd783fbc38d77210db2a764df9af96d36088bc5a7f915b11a0fa93602f8bc3b363a
|
data/README.md
CHANGED
|
@@ -7,9 +7,12 @@ REST API used for SCORM Cloud integrations.
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0
|
|
10
|
-
- Package version:
|
|
10
|
+
- Package version: 5.0.0
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
|
+
## Requirements
|
|
14
|
+
Ruby 3.3 or later.
|
|
15
|
+
|
|
13
16
|
## Installation
|
|
14
17
|
### Gem
|
|
15
18
|
[rustici_software_cloud_v2](https://rubygems.org/gems/rustici_software_cloud_v2)
|
|
@@ -22,13 +25,13 @@ gem build rustici_software_cloud_v2.gemspec
|
|
|
22
25
|
```
|
|
23
26
|
|
|
24
27
|
```shell
|
|
25
|
-
gem install ./rustici_software_cloud_v2-
|
|
28
|
+
gem install ./rustici_software_cloud_v2-5.0.0.gem
|
|
26
29
|
```
|
|
27
|
-
For development, run `gem install --dev ./rustici_software_cloud_v2-
|
|
30
|
+
For development, run `gem install --dev ./rustici_software_cloud_v2-5.0.0.gem` to install the development dependencies.
|
|
28
31
|
|
|
29
32
|
Finally add this to the Gemfile:
|
|
30
33
|
|
|
31
|
-
gem 'rustici_software_cloud_v2', '~>
|
|
34
|
+
gem 'rustici_software_cloud_v2', '~> 5.0.0'
|
|
32
35
|
|
|
33
36
|
## Tips and Tricks
|
|
34
37
|
Working with headers will require calling the `WithHttpInfo` version of the function. This allows for grabbing the header directly from the response object:
|
|
@@ -99,7 +102,7 @@ def main()
|
|
|
99
102
|
|
|
100
103
|
# Show the launch link
|
|
101
104
|
puts OUTPUT_BORDER
|
|
102
|
-
puts "
|
|
105
|
+
puts "Launch Link: #{launch_link}"
|
|
103
106
|
puts 'Navigate to the url above to take the course. Hit enter once complete.'
|
|
104
107
|
gets
|
|
105
108
|
|
|
@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
|
|
|
33
33
|
# Get back the API version and Application name
|
|
34
34
|
# 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.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @return [Array<(AboutSchema,
|
|
36
|
+
# @return [Array<(AboutSchema, Integer, Hash)>] AboutSchema data, response status code and response headers
|
|
37
37
|
def get_about_with_http_info(opts = {})
|
|
38
38
|
if @api_client.config.debugging
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: AboutApi.get_about ...'
|
|
@@ -35,7 +35,7 @@ module RusticiSoftwareCloudV2
|
|
|
35
35
|
# 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.
|
|
36
36
|
# @param application_request
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
|
-
# @return [Array<(ApplicationSchema,
|
|
38
|
+
# @return [Array<(ApplicationSchema, Integer, Hash)>] ApplicationSchema data, response status code and response headers
|
|
39
39
|
def create_application_with_http_info(application_request, opts = {})
|
|
40
40
|
if @api_client.config.debugging
|
|
41
41
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_application ...'
|
|
@@ -81,7 +81,7 @@ module RusticiSoftwareCloudV2
|
|
|
81
81
|
# @param child_app_id
|
|
82
82
|
# @param credential_request
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
|
-
# @return [
|
|
84
|
+
# @return [CredentialSchema]
|
|
85
85
|
def create_credential(child_app_id, credential_request, opts = {})
|
|
86
86
|
data, _status_code, _headers = create_credential_with_http_info(child_app_id, credential_request, opts)
|
|
87
87
|
data
|
|
@@ -92,7 +92,7 @@ module RusticiSoftwareCloudV2
|
|
|
92
92
|
# @param child_app_id
|
|
93
93
|
# @param credential_request
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
|
-
# @return [Array<(
|
|
95
|
+
# @return [Array<(CredentialSchema, Integer, Hash)>] CredentialSchema data, response status code and response headers
|
|
96
96
|
def create_credential_with_http_info(child_app_id, credential_request, opts = {})
|
|
97
97
|
if @api_client.config.debugging
|
|
98
98
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
|
|
@@ -130,7 +130,7 @@ module RusticiSoftwareCloudV2
|
|
|
130
130
|
:form_params => form_params,
|
|
131
131
|
:body => post_body,
|
|
132
132
|
:auth_names => auth_names,
|
|
133
|
-
:return_type => '
|
|
133
|
+
:return_type => 'CredentialSchema')
|
|
134
134
|
if @api_client.config.debugging
|
|
135
135
|
@api_client.config.logger.debug "API called: ApplicationManagementApi#create_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
136
136
|
end
|
|
@@ -151,7 +151,7 @@ module RusticiSoftwareCloudV2
|
|
|
151
151
|
# 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.
|
|
152
152
|
# @param token_request
|
|
153
153
|
# @param [Hash] opts the optional parameters
|
|
154
|
-
# @return [Array<(StringResultSchema,
|
|
154
|
+
# @return [Array<(StringResultSchema, Integer, Hash)>] StringResultSchema data, response status code and response headers
|
|
155
155
|
def create_token_with_http_info(token_request, opts = {})
|
|
156
156
|
if @api_client.config.debugging
|
|
157
157
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_token ...'
|
|
@@ -178,7 +178,7 @@ module RusticiSoftwareCloudV2
|
|
|
178
178
|
|
|
179
179
|
# http body (model)
|
|
180
180
|
post_body = @api_client.object_to_http_body(token_request)
|
|
181
|
-
auth_names = ['APP_NORMAL']
|
|
181
|
+
auth_names = ['APP_MANAGEMENT', 'APP_NORMAL']
|
|
182
182
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
183
183
|
:header_params => header_params,
|
|
184
184
|
:query_params => query_params,
|
|
@@ -206,7 +206,7 @@ module RusticiSoftwareCloudV2
|
|
|
206
206
|
# 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.
|
|
207
207
|
# @param child_app_id
|
|
208
208
|
# @param [Hash] opts the optional parameters
|
|
209
|
-
# @return [Array<(nil,
|
|
209
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
210
210
|
def delete_application_with_http_info(child_app_id, opts = {})
|
|
211
211
|
if @api_client.config.debugging
|
|
212
212
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application ...'
|
|
@@ -264,7 +264,7 @@ module RusticiSoftwareCloudV2
|
|
|
264
264
|
# @param [Hash] opts the optional parameters
|
|
265
265
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
|
266
266
|
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
|
267
|
-
# @return [Array<(nil,
|
|
267
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
268
268
|
def delete_application_configuration_setting_with_http_info(setting_id, opts = {})
|
|
269
269
|
if @api_client.config.debugging
|
|
270
270
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application_configuration_setting ...'
|
|
@@ -322,7 +322,7 @@ module RusticiSoftwareCloudV2
|
|
|
322
322
|
# @param child_app_id
|
|
323
323
|
# @param credential_id
|
|
324
324
|
# @param [Hash] opts the optional parameters
|
|
325
|
-
# @return [Array<(nil,
|
|
325
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
326
326
|
def delete_credential_with_http_info(child_app_id, credential_id, opts = {})
|
|
327
327
|
if @api_client.config.debugging
|
|
328
328
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_credential ...'
|
|
@@ -384,7 +384,7 @@ module RusticiSoftwareCloudV2
|
|
|
384
384
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
|
385
385
|
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
|
386
386
|
# @option opts [BOOLEAN] :include_metadata
|
|
387
|
-
# @return [Array<(SettingListSchema,
|
|
387
|
+
# @return [Array<(SettingListSchema, Integer, Hash)>] SettingListSchema data, response status code and response headers
|
|
388
388
|
def get_application_configuration_with_http_info(opts = {})
|
|
389
389
|
if @api_client.config.debugging
|
|
390
390
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_configuration ...'
|
|
@@ -442,7 +442,7 @@ module RusticiSoftwareCloudV2
|
|
|
442
442
|
# @param [Hash] opts the optional parameters
|
|
443
443
|
# @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
|
|
444
444
|
# @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
|
|
445
|
-
# @return [Array<(ApplicationInfoSchema,
|
|
445
|
+
# @return [Array<(ApplicationInfoSchema, Integer, Hash)>] ApplicationInfoSchema data, response status code and response headers
|
|
446
446
|
def get_application_info_with_http_info(child_app_id, opts = {})
|
|
447
447
|
if @api_client.config.debugging
|
|
448
448
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_info ...'
|
|
@@ -498,7 +498,7 @@ module RusticiSoftwareCloudV2
|
|
|
498
498
|
# (Deprecated) Use the Application Management App to get basic data about all Applications in a Realm
|
|
499
499
|
# Returns a list of all applications which are in this Realm. >**Deprecated:** >It is advised to use GetApplications instead of this endpoint, as this one now exists for backwards compatibility. This endpoint returns very limited data about **all** applications in a Realm and is not paginated. Because of this, this endpoint can run into issues and have very slow performance when attempting to pull data for accounts with many applications. The GetApplications endpoint alleviates this problem by using pagination to return a limited amount of applications at once, while also providing much more detail about every application present in a 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.
|
|
500
500
|
# @param [Hash] opts the optional parameters
|
|
501
|
-
# @return [Array<(ApplicationListSchema,
|
|
501
|
+
# @return [Array<(ApplicationListSchema, Integer, Hash)>] ApplicationListSchema data, response status code and response headers
|
|
502
502
|
def get_application_list_with_http_info(opts = {})
|
|
503
503
|
if @api_client.config.debugging
|
|
504
504
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_list ...'
|
|
@@ -537,7 +537,7 @@ module RusticiSoftwareCloudV2
|
|
|
537
537
|
deprecate :get_application_list_with_http_info, 'GetApplicationsWithHttpInfo', 0, 0
|
|
538
538
|
|
|
539
539
|
# Use the Application Management App to get a detailed list of Applications
|
|
540
|
-
# Returns a list of applications. Can be filtered using the request parameters to provide a subset of results.
|
|
540
|
+
# Returns a list of applications. 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. >**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. >**Info:** >This endpoint caches the course and registration counts of an application for 24 hours if either `includeCourseCount` or `includeRegistrationCount` parameters, respectively, are set to `true`. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with `includeCourseCount` and/or `includeRegistrationCount` set to `true`. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
|
|
541
541
|
# @param [Hash] opts the optional parameters
|
|
542
542
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
543
543
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -556,7 +556,7 @@ module RusticiSoftwareCloudV2
|
|
|
556
556
|
end
|
|
557
557
|
|
|
558
558
|
# Use the Application Management App to get a detailed list of Applications
|
|
559
|
-
# Returns a list of applications. Can be filtered using the request parameters to provide a subset of results.
|
|
559
|
+
# Returns a list of applications. 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. >**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. >**Info:** >This endpoint caches the course and registration counts of an application for 24 hours if either `includeCourseCount` or `includeRegistrationCount` parameters, respectively, are set to `true`. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with `includeCourseCount` and/or `includeRegistrationCount` set to `true`. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
|
|
560
560
|
# @param [Hash] opts the optional parameters
|
|
561
561
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
562
562
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -568,7 +568,7 @@ module RusticiSoftwareCloudV2
|
|
|
568
568
|
# @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
|
|
569
569
|
# @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
|
|
570
570
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
571
|
-
# @return [Array<(ApplicationInfoListSchema,
|
|
571
|
+
# @return [Array<(ApplicationInfoListSchema, Integer, Hash)>] ApplicationInfoListSchema data, response status code and response headers
|
|
572
572
|
def get_applications_with_http_info(opts = {})
|
|
573
573
|
if @api_client.config.debugging
|
|
574
574
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_applications ...'
|
|
@@ -629,7 +629,7 @@ module RusticiSoftwareCloudV2
|
|
|
629
629
|
# 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.
|
|
630
630
|
# @param child_app_id
|
|
631
631
|
# @param [Hash] opts the optional parameters
|
|
632
|
-
# @return [Array<(CredentialListSchema,
|
|
632
|
+
# @return [Array<(CredentialListSchema, Integer, Hash)>] CredentialListSchema data, response status code and response headers
|
|
633
633
|
def get_credentials_with_http_info(child_app_id, opts = {})
|
|
634
634
|
if @api_client.config.debugging
|
|
635
635
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_credentials ...'
|
|
@@ -688,7 +688,7 @@ module RusticiSoftwareCloudV2
|
|
|
688
688
|
# @param [Hash] opts the optional parameters
|
|
689
689
|
# @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
|
|
690
690
|
# @option opts [BOOLEAN] :single_sco Required if `learningStandard` is specified. Scopes settings to either single or multi-SCO content.
|
|
691
|
-
# @return [Array<(nil,
|
|
691
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
692
692
|
def set_application_configuration_with_http_info(configuration_settings, opts = {})
|
|
693
693
|
if @api_client.config.debugging
|
|
694
694
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.set_application_configuration ...'
|
|
@@ -746,7 +746,7 @@ module RusticiSoftwareCloudV2
|
|
|
746
746
|
# @param child_app_id
|
|
747
747
|
# @param application_properties
|
|
748
748
|
# @param [Hash] opts the optional parameters
|
|
749
|
-
# @return [Array<(nil,
|
|
749
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
750
750
|
def update_application_with_http_info(child_app_id, application_properties, opts = {})
|
|
751
751
|
if @api_client.config.debugging
|
|
752
752
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_application ...'
|
|
@@ -808,7 +808,7 @@ module RusticiSoftwareCloudV2
|
|
|
808
808
|
# @param credential_id
|
|
809
809
|
# @param credential_update
|
|
810
810
|
# @param [Hash] opts the optional parameters
|
|
811
|
-
# @return [Array<(nil,
|
|
811
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
812
812
|
def update_credential_with_http_info(child_app_id, credential_id, credential_update, opts = {})
|
|
813
813
|
if @api_client.config.debugging
|
|
814
814
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_credential ...'
|
|
@@ -37,7 +37,7 @@ module RusticiSoftwareCloudV2
|
|
|
37
37
|
# @param scope Space separated string of OAuth scopes, e.g. \"write:course read:registration\".
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
39
|
# @option opts [Integer] :expiration Amount of seconds until the OAuth token expires.
|
|
40
|
-
# @return [Array<(ApplicationToken,
|
|
40
|
+
# @return [Array<(ApplicationToken, Integer, Hash)>] ApplicationToken data, response status code and response headers
|
|
41
41
|
def get_app_token_with_http_info(scope, opts = {})
|
|
42
42
|
if @api_client.config.debugging
|
|
43
43
|
@api_client.config.logger.debug 'Calling API: AuthenticationApi.get_app_token ...'
|
|
@@ -66,7 +66,7 @@ module RusticiSoftwareCloudV2
|
|
|
66
66
|
|
|
67
67
|
# http body (model)
|
|
68
68
|
post_body = nil
|
|
69
|
-
auth_names = ['APP_NORMAL']
|
|
69
|
+
auth_names = ['APP_MANAGEMENT', 'APP_NORMAL']
|
|
70
70
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
71
71
|
:header_params => header_params,
|
|
72
72
|
:query_params => query_params,
|
|
@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
|
|
|
33
33
|
# A call to this method will create a new content connector and return a newly created Id for it.
|
|
34
34
|
# @param connector
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @return [Array<(StringResultSchema,
|
|
36
|
+
# @return [Array<(StringResultSchema, Integer, Hash)>] StringResultSchema data, response status code and response headers
|
|
37
37
|
def create_connector_with_http_info(connector, opts = {})
|
|
38
38
|
if @api_client.config.debugging
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: ContentConnectorsApi.create_connector ...'
|
|
@@ -88,7 +88,7 @@ module RusticiSoftwareCloudV2
|
|
|
88
88
|
# Delete the specified connector.
|
|
89
89
|
# @param connector_id the connector id
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
|
-
# @return [Array<(nil,
|
|
91
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
92
92
|
def delete_connector_with_http_info(connector_id, opts = {})
|
|
93
93
|
if @api_client.config.debugging
|
|
94
94
|
@api_client.config.logger.debug 'Calling API: ContentConnectorsApi.delete_connector ...'
|
|
@@ -142,7 +142,7 @@ module RusticiSoftwareCloudV2
|
|
|
142
142
|
# Get list of all Content Connectors in this application.
|
|
143
143
|
# @param [Hash] opts the optional parameters
|
|
144
144
|
# @option opts [BOOLEAN] :include_additional_instance_information
|
|
145
|
-
# @return [Array<(ConnectorListSchema,
|
|
145
|
+
# @return [Array<(ConnectorListSchema, Integer, Hash)>] ConnectorListSchema data, response status code and response headers
|
|
146
146
|
def get_connectors_list_with_http_info(opts = {})
|
|
147
147
|
if @api_client.config.debugging
|
|
148
148
|
@api_client.config.logger.debug 'Calling API: ContentConnectorsApi.get_connectors_list ...'
|
|
@@ -194,7 +194,7 @@ module RusticiSoftwareCloudV2
|
|
|
194
194
|
# @param connector_id the connector id
|
|
195
195
|
# @param connector
|
|
196
196
|
# @param [Hash] opts the optional parameters
|
|
197
|
-
# @return [Array<(nil,
|
|
197
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
198
198
|
def update_connector_with_http_info(connector_id, connector, opts = {})
|
|
199
199
|
if @api_client.config.debugging
|
|
200
200
|
@api_client.config.logger.debug 'Calling API: ContentConnectorsApi.update_connector ...'
|