rustici_software_cloud_v2 2.1.0 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/lib/rustici_software_cloud_v2/api/about_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +103 -8
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +6 -1
- data/lib/rustici_software_cloud_v2/api/course_api.rb +42 -1
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +67 -10
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +35 -3
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +8 -1
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +32 -1
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +5 -1
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +15 -1
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +11 -1
- data/lib/rustici_software_cloud_v2/api_client.rb +3 -2
- data/lib/rustici_software_cloud_v2/api_error.rb +0 -1
- data/lib/rustici_software_cloud_v2/configuration.rb +0 -8
- 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 +197 -0
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +12 -2
- 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/{credential_created_schema.rb → destination_info_id_schema.rb} +10 -40
- data/lib/rustici_software_cloud_v2/models/destination_info_list_schema.rb +198 -0
- 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 +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +1 -1
- 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/invitation_job_status_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +15 -18
- 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 +186 -0
- 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 +15 -18
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +4 -4
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +4 -4
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
- 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/registration_success.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 +15 -18
- 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/models/zoomi_company_id.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -2
- data/lib/rustici_software_cloud_v2.rb +6 -2
- data/rustici_software_cloud_v2.gemspec +0 -1
- data/spec/api_client_spec.rb +0 -1
- data/spec/configuration_spec.rb +0 -1
- data/spec/spec_helper.rb +0 -1
- metadata +8 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f8f00a3b60d7d5cfd39d2e4870805a905568fdf6be5c29874f2d2b38a4ea949d
|
4
|
+
data.tar.gz: f65fee83e94e509c1b7685687b91c78683e1c54ce4ec78e63351e9299f46f4c8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c5179ce45e2b7fec5690dfa9da23d01993905fe1e7df29ae12303d08464923f23ea889dca2b44131fca83ad30ed4690b0da0bbc69108392fd494c96de6a57d63
|
7
|
+
data.tar.gz: 62667d1c7740e64361a88f7e3b91fde6d96bd482a9e9bc10a56a4cb1cf4df0821129afe013aa994d52f18c1584296a89a401d04a07bd2ed194d2c95fdbd80e82
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ 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: 4.0.0
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -22,13 +22,13 @@ gem build rustici_software_cloud_v2.gemspec
|
|
22
22
|
```
|
23
23
|
|
24
24
|
```shell
|
25
|
-
gem install ./rustici_software_cloud_v2-
|
25
|
+
gem install ./rustici_software_cloud_v2-4.0.0.gem
|
26
26
|
```
|
27
|
-
For development, run `gem install --dev ./rustici_software_cloud_v2-
|
27
|
+
For development, run `gem install --dev ./rustici_software_cloud_v2-4.0.0.gem` to install the development dependencies
|
28
28
|
|
29
29
|
Finally add this to the Gemfile:
|
30
30
|
|
31
|
-
gem 'rustici_software_cloud_v2', '~>
|
31
|
+
gem 'rustici_software_cloud_v2', '~> 4.0.0'
|
32
32
|
|
33
33
|
## Tips and Tricks
|
34
34
|
Working with headers will require calling the `WithHttpInfo` version of the function. This allows for grabbing the header directly from the response object:
|
@@ -6,7 +6,6 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.27
|
10
9
|
|
11
10
|
=end
|
12
11
|
|
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
|
|
19
18
|
def initialize(api_client = ApiClient.default)
|
20
19
|
@api_client = api_client
|
21
20
|
end
|
21
|
+
|
22
|
+
extend Gem::Deprecate
|
23
|
+
|
22
24
|
# Get back the API version and Application name
|
23
25
|
# 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
26
|
# @param [Hash] opts the optional parameters
|
@@ -6,7 +6,6 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.27
|
10
9
|
|
11
10
|
=end
|
12
11
|
|
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
|
|
19
18
|
def initialize(api_client = ApiClient.default)
|
20
19
|
@api_client = api_client
|
21
20
|
end
|
21
|
+
|
22
|
+
extend Gem::Deprecate
|
23
|
+
|
22
24
|
# Use the Application Management App to create a new Application
|
23
25
|
# 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
26
|
# @param application_request
|
@@ -73,12 +75,13 @@ module RusticiSoftwareCloudV2
|
|
73
75
|
end
|
74
76
|
return data, status_code, headers
|
75
77
|
end
|
78
|
+
|
76
79
|
# Use the Application Manager App to create a new secret key for an Application
|
77
80
|
# 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.
|
78
81
|
# @param child_app_id
|
79
82
|
# @param credential_request
|
80
83
|
# @param [Hash] opts the optional parameters
|
81
|
-
# @return [
|
84
|
+
# @return [CredentialSchema]
|
82
85
|
def create_credential(child_app_id, credential_request, opts = {})
|
83
86
|
data, _status_code, _headers = create_credential_with_http_info(child_app_id, credential_request, opts)
|
84
87
|
data
|
@@ -89,7 +92,7 @@ module RusticiSoftwareCloudV2
|
|
89
92
|
# @param child_app_id
|
90
93
|
# @param credential_request
|
91
94
|
# @param [Hash] opts the optional parameters
|
92
|
-
# @return [Array<(
|
95
|
+
# @return [Array<(CredentialSchema, Fixnum, Hash)>] CredentialSchema data, response status code and response headers
|
93
96
|
def create_credential_with_http_info(child_app_id, credential_request, opts = {})
|
94
97
|
if @api_client.config.debugging
|
95
98
|
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
|
@@ -127,12 +130,13 @@ module RusticiSoftwareCloudV2
|
|
127
130
|
:form_params => form_params,
|
128
131
|
:body => post_body,
|
129
132
|
:auth_names => auth_names,
|
130
|
-
:return_type => '
|
133
|
+
:return_type => 'CredentialSchema')
|
131
134
|
if @api_client.config.debugging
|
132
135
|
@api_client.config.logger.debug "API called: ApplicationManagementApi#create_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
133
136
|
end
|
134
137
|
return data, status_code, headers
|
135
138
|
end
|
139
|
+
|
136
140
|
# Obtain an OAuth token for scoped access to an Application
|
137
141
|
# 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.
|
138
142
|
# @param token_request
|
@@ -187,6 +191,7 @@ module RusticiSoftwareCloudV2
|
|
187
191
|
end
|
188
192
|
return data, status_code, headers
|
189
193
|
end
|
194
|
+
|
190
195
|
# Use the Application Management App to delete an Application
|
191
196
|
# 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.
|
192
197
|
# @param child_app_id
|
@@ -240,6 +245,7 @@ module RusticiSoftwareCloudV2
|
|
240
245
|
end
|
241
246
|
return data, status_code, headers
|
242
247
|
end
|
248
|
+
|
243
249
|
# Delete a configuration setting explicitly set for an Application
|
244
250
|
# 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.
|
245
251
|
# @param setting_id
|
@@ -299,6 +305,7 @@ module RusticiSoftwareCloudV2
|
|
299
305
|
end
|
300
306
|
return data, status_code, headers
|
301
307
|
end
|
308
|
+
|
302
309
|
# Use the Application Management App to delete a secret key from an Application
|
303
310
|
# 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.
|
304
311
|
# @param child_app_id
|
@@ -358,6 +365,7 @@ module RusticiSoftwareCloudV2
|
|
358
365
|
end
|
359
366
|
return data, status_code, headers
|
360
367
|
end
|
368
|
+
|
361
369
|
# Get effective configuration settings for an Application
|
362
370
|
# 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._
|
363
371
|
# @param [Hash] opts the optional parameters
|
@@ -415,6 +423,7 @@ module RusticiSoftwareCloudV2
|
|
415
423
|
end
|
416
424
|
return data, status_code, headers
|
417
425
|
end
|
426
|
+
|
418
427
|
# Use the Application Management App to get detailed information about an Application
|
419
428
|
# 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
429
|
# @param child_app_id
|
@@ -475,17 +484,19 @@ module RusticiSoftwareCloudV2
|
|
475
484
|
end
|
476
485
|
return data, status_code, headers
|
477
486
|
end
|
478
|
-
|
479
|
-
#
|
487
|
+
|
488
|
+
# (Deprecated) Use the Application Management App to get basic data about all Applications in a Realm
|
489
|
+
# 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.
|
480
490
|
# @param [Hash] opts the optional parameters
|
481
491
|
# @return [ApplicationListSchema]
|
482
492
|
def get_application_list(opts = {})
|
483
493
|
data, _status_code, _headers = get_application_list_with_http_info(opts)
|
484
494
|
data
|
485
495
|
end
|
496
|
+
deprecate :get_application_list, 'GetApplications', 0, 0
|
486
497
|
|
487
|
-
# Use the Application Management App to get
|
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.
|
498
|
+
# (Deprecated) Use the Application Management App to get basic data about all Applications in a Realm
|
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.
|
489
500
|
# @param [Hash] opts the optional parameters
|
490
501
|
# @return [Array<(ApplicationListSchema, Fixnum, Hash)>] ApplicationListSchema data, response status code and response headers
|
491
502
|
def get_application_list_with_http_info(opts = {})
|
@@ -523,6 +534,87 @@ module RusticiSoftwareCloudV2
|
|
523
534
|
end
|
524
535
|
return data, status_code, headers
|
525
536
|
end
|
537
|
+
deprecate :get_application_list_with_http_info, 'GetApplicationsWithHttpInfo', 0, 0
|
538
|
+
|
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. >**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
|
+
# @param [Hash] opts the optional parameters
|
542
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
543
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
544
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
545
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
546
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to app_id)
|
547
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
548
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
549
|
+
# @option opts [BOOLEAN] :include_course_count Include a count of courses for the application. (default to false)
|
550
|
+
# @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period. (default to false)
|
551
|
+
# @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. (default to false)
|
552
|
+
# @return [ApplicationInfoListSchema]
|
553
|
+
def get_applications(opts = {})
|
554
|
+
data, _status_code, _headers = get_applications_with_http_info(opts)
|
555
|
+
data
|
556
|
+
end
|
557
|
+
|
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. >**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
|
+
# @param [Hash] opts the optional parameters
|
561
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
562
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
563
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
564
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
565
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
566
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
567
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
568
|
+
# @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
|
569
|
+
# @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
|
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, Fixnum, Hash)>] ApplicationInfoListSchema data, response status code and response headers
|
572
|
+
def get_applications_with_http_info(opts = {})
|
573
|
+
if @api_client.config.debugging
|
574
|
+
@api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_applications ...'
|
575
|
+
end
|
576
|
+
# resource path
|
577
|
+
local_var_path = '/appManagement/applicationList'
|
578
|
+
|
579
|
+
# query parameters
|
580
|
+
query_params = {}
|
581
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
582
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
583
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
584
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
585
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
586
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
587
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
588
|
+
query_params[:'includeCourseCount'] = opts[:'include_course_count'] if !opts[:'include_course_count'].nil?
|
589
|
+
query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
|
590
|
+
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
591
|
+
|
592
|
+
# header parameters
|
593
|
+
header_params = {}
|
594
|
+
# HTTP header 'Accept' (if needed)
|
595
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
596
|
+
# HTTP header 'Content-Type'
|
597
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
598
|
+
|
599
|
+
# form parameters
|
600
|
+
form_params = {}
|
601
|
+
|
602
|
+
# http body (model)
|
603
|
+
post_body = nil
|
604
|
+
auth_names = ['APP_MANAGEMENT', 'OAUTH']
|
605
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
606
|
+
:header_params => header_params,
|
607
|
+
:query_params => query_params,
|
608
|
+
:form_params => form_params,
|
609
|
+
:body => post_body,
|
610
|
+
:auth_names => auth_names,
|
611
|
+
:return_type => 'ApplicationInfoListSchema')
|
612
|
+
if @api_client.config.debugging
|
613
|
+
@api_client.config.logger.debug "API called: ApplicationManagementApi#get_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
614
|
+
end
|
615
|
+
return data, status_code, headers
|
616
|
+
end
|
617
|
+
|
526
618
|
# Use the Application Manager App to get a list of secret keys for an Application
|
527
619
|
# 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.
|
528
620
|
# @param child_app_id
|
@@ -577,6 +669,7 @@ module RusticiSoftwareCloudV2
|
|
577
669
|
end
|
578
670
|
return data, status_code, headers
|
579
671
|
end
|
672
|
+
|
580
673
|
# Update configuration settings for an Application
|
581
674
|
# 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.
|
582
675
|
# @param configuration_settings
|
@@ -636,6 +729,7 @@ module RusticiSoftwareCloudV2
|
|
636
729
|
end
|
637
730
|
return data, status_code, headers
|
638
731
|
end
|
732
|
+
|
639
733
|
# Use the Application Management App to update information about an Application
|
640
734
|
# 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
735
|
# @param child_app_id
|
@@ -695,6 +789,7 @@ module RusticiSoftwareCloudV2
|
|
695
789
|
end
|
696
790
|
return data, status_code, headers
|
697
791
|
end
|
792
|
+
|
698
793
|
# Use the Application Manager App to update an existing secret key for an Application
|
699
794
|
# 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.
|
700
795
|
# @param child_app_id
|
@@ -6,7 +6,6 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.27
|
10
9
|
|
11
10
|
=end
|
12
11
|
|
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
|
|
19
18
|
def initialize(api_client = ApiClient.default)
|
20
19
|
@api_client = api_client
|
21
20
|
end
|
21
|
+
|
22
|
+
extend Gem::Deprecate
|
23
|
+
|
22
24
|
# Obtain an OAuth token for scoped access to an Application
|
23
25
|
# 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
26
|
# @param scope Space separated string of OAuth scopes, e.g. \"write:course read:registration\".
|
@@ -6,7 +6,6 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.27
|
10
9
|
|
11
10
|
=end
|
12
11
|
|
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
|
|
19
18
|
def initialize(api_client = ApiClient.default)
|
20
19
|
@api_client = api_client
|
21
20
|
end
|
21
|
+
|
22
|
+
extend Gem::Deprecate
|
23
|
+
|
22
24
|
# A call to this method will create a new content connector and return a newly created Id for it.
|
23
25
|
# @param connector
|
24
26
|
# @param [Hash] opts the optional parameters
|
@@ -71,6 +73,7 @@ module RusticiSoftwareCloudV2
|
|
71
73
|
end
|
72
74
|
return data, status_code, headers
|
73
75
|
end
|
76
|
+
|
74
77
|
# Delete a connector
|
75
78
|
# Delete the specified connector.
|
76
79
|
# @param connector_id the connector id
|
@@ -124,6 +127,7 @@ module RusticiSoftwareCloudV2
|
|
124
127
|
end
|
125
128
|
return data, status_code, headers
|
126
129
|
end
|
130
|
+
|
127
131
|
# Get a list of all Content Connectors for the application
|
128
132
|
# Get list of all Content Connectors in this application.
|
129
133
|
# @param [Hash] opts the optional parameters
|
@@ -175,6 +179,7 @@ module RusticiSoftwareCloudV2
|
|
175
179
|
end
|
176
180
|
return data, status_code, headers
|
177
181
|
end
|
182
|
+
|
178
183
|
# Update the configuration or enabled flag associated with `connectorId`.
|
179
184
|
# @param connector_id the connector id
|
180
185
|
# @param connector
|