rustici_software_cloud_v2 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8f00a3b60d7d5cfd39d2e4870805a905568fdf6be5c29874f2d2b38a4ea949d
-  data.tar.gz: f65fee83e94e509c1b7685687b91c78683e1c54ce4ec78e63351e9299f46f4c8
+  metadata.gz: e54abadc8d428825fea19cca6020566f076d415303e1783d592013c159c814f1
+  data.tar.gz: 4c357263f6286f4a564214da5c4c0118c4d994d0696985dfb132051a15ea35df
 SHA512:
-  metadata.gz: c5179ce45e2b7fec5690dfa9da23d01993905fe1e7df29ae12303d08464923f23ea889dca2b44131fca83ad30ed4690b0da0bbc69108392fd494c96de6a57d63
-  data.tar.gz: 62667d1c7740e64361a88f7e3b91fde6d96bd482a9e9bc10a56a4cb1cf4df0821129afe013aa994d52f18c1584296a89a401d04a07bd2ed194d2c95fdbd80e82
+  metadata.gz: 622a619afa9ba64bdf1f810d1661426b66e3c3418a44558b376412692fc3ab17e5839f28dfd51cd6d96fe847dbc094e0da3561e254fd4598bdef890f1d9c9221
+  data.tar.gz: 4f5eea88d9e6cdd2baba6087b6505abb1412b99a0e6028b1f9575a4c7a5f6bd783fbc38d77210db2a764df9af96d36088bc5a7f915b11a0fa93602f8bc3b363a

data/README.md

@@ -7,9 +7,12 @@ REST API used for SCORM Cloud integrations.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 4.0.0
+- Package version: 5.0.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
+## Requirements
+Ruby 3.3 or later.
+
 ## Installation
 ### Gem
 [rustici_software_cloud_v2](https://rubygems.org/gems/rustici_software_cloud_v2)
@@ -22,13 +25,13 @@ gem build rustici_software_cloud_v2.gemspec
 ```
 
 ```shell
-gem install ./rustici_software_cloud_v2-4.0.0.gem
+gem install ./rustici_software_cloud_v2-5.0.0.gem
 ```
-For development, run `gem install --dev ./rustici_software_cloud_v2-4.0.0.gem` to install the development dependencies
+For development, run `gem install --dev ./rustici_software_cloud_v2-5.0.0.gem` to install the development dependencies.
 
 Finally add this to the Gemfile:
 
-    gem 'rustici_software_cloud_v2', '~> 4.0.0'
+    gem 'rustici_software_cloud_v2', '~> 5.0.0'
 
 ## Tips and Tricks
 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()
 
         # Show the launch link
         puts OUTPUT_BORDER
-        puts "Launck Link: #{launch_link}"
+        puts "Launch Link: #{launch_link}"
         puts 'Navigate to the url above to take the course. Hit enter once complete.'
         gets
 

data/lib/rustici_software_cloud_v2/api/about_api.rb

@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
     # Get back the API version and Application name 
     # 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. 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AboutSchema, Fixnum, Hash)>] AboutSchema data, response status code and response headers
+    # @return [Array<(AboutSchema, Integer, Hash)>] AboutSchema data, response status code and response headers
     def get_about_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AboutApi.get_about ...'

data/lib/rustici_software_cloud_v2/api/application_management_api.rb

@@ -35,7 +35,7 @@ module RusticiSoftwareCloudV2
     # 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. 
     # @param application_request 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ApplicationSchema, Fixnum, Hash)>] ApplicationSchema data, response status code and response headers
+    # @return [Array<(ApplicationSchema, Integer, Hash)>] ApplicationSchema data, response status code and response headers
     def create_application_with_http_info(application_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_application ...'
@@ -92,7 +92,7 @@ module RusticiSoftwareCloudV2
     # @param child_app_id 
     # @param credential_request 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CredentialSchema, Fixnum, Hash)>] CredentialSchema data, response status code and response headers
+    # @return [Array<(CredentialSchema, Integer, Hash)>] CredentialSchema data, response status code and response headers
     def create_credential_with_http_info(child_app_id, credential_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
@@ -151,7 +151,7 @@ module RusticiSoftwareCloudV2
     # 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.  &gt;**Note:** &gt;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. 
     # @param token_request 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
+    # @return [Array<(StringResultSchema, Integer, Hash)>] StringResultSchema data, response status code and response headers
     def create_token_with_http_info(token_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_token ...'
@@ -178,7 +178,7 @@ module RusticiSoftwareCloudV2
 
       # http body (model)
       post_body = @api_client.object_to_http_body(token_request)
-      auth_names = ['APP_NORMAL']
+      auth_names = ['APP_MANAGEMENT', 'APP_NORMAL']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -206,7 +206,7 @@ module RusticiSoftwareCloudV2
     # Deletes the specified application.  All content within an application must be removed in order to allow deletion.  &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**.  When using this special application&#39;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&#39;t a general purpose credential).  You can list, add, update, and delete both applications and credentials with this API resource. 
     # @param child_app_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_application_with_http_info(child_app_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application ...'
@@ -264,7 +264,7 @@ module RusticiSoftwareCloudV2
     # @param [Hash] opts the optional parameters
     # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
     # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content. 
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_application_configuration_setting_with_http_info(setting_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application_configuration_setting ...'
@@ -322,7 +322,7 @@ module RusticiSoftwareCloudV2
     # @param child_app_id 
     # @param credential_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_credential_with_http_info(child_app_id, credential_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_credential ...'
@@ -384,7 +384,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
     # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content. 
     # @option opts [BOOLEAN] :include_metadata 
-    # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
+    # @return [Array<(SettingListSchema, Integer, Hash)>] SettingListSchema data, response status code and response headers
     def get_application_configuration_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_configuration ...'
@@ -442,7 +442,7 @@ module RusticiSoftwareCloudV2
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
     # @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
-    # @return [Array<(ApplicationInfoSchema, Fixnum, Hash)>] ApplicationInfoSchema data, response status code and response headers
+    # @return [Array<(ApplicationInfoSchema, Integer, Hash)>] ApplicationInfoSchema data, response status code and response headers
     def get_application_info_with_http_info(child_app_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_info ...'
@@ -498,7 +498,7 @@ module RusticiSoftwareCloudV2
     # (Deprecated) Use the Application Management App to get basic data about all Applications in a Realm 
     # Returns a list of all applications which are in this Realm.  &gt;**Deprecated:** &gt;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.  &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**.  When using this special application&#39;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&#39;t a general purpose credential).  You can list, add, update, and delete both applications and credentials with this API resource. 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ApplicationListSchema, Fixnum, Hash)>] ApplicationListSchema data, response status code and response headers
+    # @return [Array<(ApplicationListSchema, Integer, Hash)>] ApplicationListSchema data, response status code and response headers
     def get_application_list_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_list ...'
@@ -568,7 +568,7 @@ module RusticiSoftwareCloudV2
     # @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
     # @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
     # @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 &#x60;more&#x60; token. 
-    # @return [Array<(ApplicationInfoListSchema, Fixnum, Hash)>] ApplicationInfoListSchema data, response status code and response headers
+    # @return [Array<(ApplicationInfoListSchema, Integer, Hash)>] ApplicationInfoListSchema data, response status code and response headers
     def get_applications_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_applications ...'
@@ -629,7 +629,7 @@ module RusticiSoftwareCloudV2
     # Returns a list of all the credentials (aka secret keys) belonging to the child application.  &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**.  When using this special application&#39;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&#39;t a general purpose credential).  You can list, add, update, and delete both applications and credentials with this API resource. 
     # @param child_app_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CredentialListSchema, Fixnum, Hash)>] CredentialListSchema data, response status code and response headers
+    # @return [Array<(CredentialListSchema, Integer, Hash)>] CredentialListSchema data, response status code and response headers
     def get_credentials_with_http_info(child_app_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_credentials ...'
@@ -688,7 +688,7 @@ module RusticiSoftwareCloudV2
     # @param [Hash] opts the optional parameters
     # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
     # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content. 
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def set_application_configuration_with_http_info(configuration_settings, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.set_application_configuration ...'
@@ -746,7 +746,7 @@ module RusticiSoftwareCloudV2
     # @param child_app_id 
     # @param application_properties 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def update_application_with_http_info(child_app_id, application_properties, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_application ...'
@@ -808,7 +808,7 @@ module RusticiSoftwareCloudV2
     # @param credential_id 
     # @param credential_update 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def update_credential_with_http_info(child_app_id, credential_id, credential_update, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_credential ...'

data/lib/rustici_software_cloud_v2/api/authentication_api.rb

@@ -37,7 +37,7 @@ module RusticiSoftwareCloudV2
     # @param scope Space separated string of OAuth scopes, e.g. \"write:course read:registration\". 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :expiration Amount of seconds until the OAuth token expires. 
-    # @return [Array<(ApplicationToken, Fixnum, Hash)>] ApplicationToken data, response status code and response headers
+    # @return [Array<(ApplicationToken, Integer, Hash)>] ApplicationToken data, response status code and response headers
     def get_app_token_with_http_info(scope, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_app_token ...'
@@ -66,7 +66,7 @@ module RusticiSoftwareCloudV2
 
       # http body (model)
       post_body = nil
-      auth_names = ['APP_NORMAL']
+      auth_names = ['APP_MANAGEMENT', 'APP_NORMAL']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb

@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
     # A call to this method will create a new content connector and return a newly created Id for it. 
     # @param connector 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
+    # @return [Array<(StringResultSchema, Integer, Hash)>] StringResultSchema data, response status code and response headers
     def create_connector_with_http_info(connector, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.create_connector ...'
@@ -88,7 +88,7 @@ module RusticiSoftwareCloudV2
     # Delete the specified connector. 
     # @param connector_id the connector id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_connector_with_http_info(connector_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.delete_connector ...'
@@ -142,7 +142,7 @@ module RusticiSoftwareCloudV2
     # Get list of all Content Connectors in this application. 
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :include_additional_instance_information 
-    # @return [Array<(ConnectorListSchema, Fixnum, Hash)>] ConnectorListSchema data, response status code and response headers
+    # @return [Array<(ConnectorListSchema, Integer, Hash)>] ConnectorListSchema data, response status code and response headers
     def get_connectors_list_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.get_connectors_list ...'
@@ -194,7 +194,7 @@ module RusticiSoftwareCloudV2
     # @param connector_id the connector id
     # @param connector 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def update_connector_with_http_info(connector_id, connector, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.update_connector ...'