rustici_software_cloud_v2 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247b1a7a7ea4ee91459e4651907dc34c8e01c1922b908de16df785bd6e013eba
-  data.tar.gz: 7140c78703919b71ab730564ee20aa982abeb3ab270325dcb2eeb9e680119149
+  metadata.gz: 54fecc8c26cad60fa8de9c4b72b9e18f764afe2e008f70b1a2bac4f18d3a03b4
+  data.tar.gz: 9b9f5d532fceb6529c8aaefe18b35bb624687a5f6b5506112a26defbfebf0335
 SHA512:
-  metadata.gz: ac4f6a667976b270b3b230de312167e8e8fd0731a494e1dfbb1c17a99c826e2f80bbb81c894880088c23a36a8b2eff038927831eee52dc5d45f86ad143ea317b
-  data.tar.gz: c41e7e7b66dffcdc05ab1169e531fbd88f3f8ba3b2095a6648598de86ae114e5bec6c8418d193f519d86b767e86e14bc2ea878067fb15dca3050ceb8b0588129
+  metadata.gz: '039ea224b2d8524a82cb1ed5ceb2c365be1026544d5f1c4ad18fbbbcf5cd247f7d72383ba43d721db5b52ffd35ee2517d372209e6323a65cd2b5603cf5db4a3d'
+  data.tar.gz: a066a4fc7062393edc41fa7f1758cce899881667d4070c296e6e4dd1b48b0ddbcc8944bd57596fd0bfcbcd67387602cd507fc831c00fd1b3c9d1d93f3ea7e8cb

data/README.md

@@ -7,7 +7,7 @@ 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: 2.1.0
+- Package version: 3.0.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -22,13 +22,13 @@ gem build rustici_software_cloud_v2.gemspec
 ```
 
 ```shell
-gem install ./rustici_software_cloud_v2-2.1.0.gem
+gem install ./rustici_software_cloud_v2-3.0.0.gem
 ```
-For development, run `gem install --dev ./rustici_software_cloud_v2-2.1.0.gem` to install the development dependencies
+For development, run `gem install --dev ./rustici_software_cloud_v2-3.0.0.gem` to install the development dependencies
 
 Finally add this to the Gemfile:
 
-    gem 'rustici_software_cloud_v2', '~> 2.1.0'
+    gem 'rustici_software_cloud_v2', '~> 3.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:

data/lib/rustici_software_cloud_v2/api/about_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    extend Gem::Deprecate
+
     # 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

data/lib/rustici_software_cloud_v2/api/application_management_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    extend Gem::Deprecate
+
     # Use the Application Management App to create a new Application 
     # 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 
@@ -73,6 +75,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Use the Application Manager App to create a new secret key for an Application 
     # 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. 
     # @param child_app_id 
@@ -133,6 +136,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Obtain an OAuth token for scoped access to an Application 
     # 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. 
     # @param token_request 
@@ -187,6 +191,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Use the Application Management App to delete an Application 
     # 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. 
     # @param child_app_id 
@@ -240,6 +245,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a configuration setting explicitly set for an Application 
     # 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. 
     # @param setting_id 
@@ -299,6 +305,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Use the Application Management App to delete a secret key from an Application 
     # 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. 
     # @param child_app_id 
@@ -358,6 +365,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get effective configuration settings for an Application 
     # 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._ 
     # @param [Hash] opts the optional parameters
@@ -415,6 +423,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Use the Application Management App to get detailed information about an Application 
     # 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. 
     # @param child_app_id 
@@ -475,17 +484,19 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
-    # Use the Application Management App to get a list of Applications 
-    # 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. 
+
+    # (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.  >**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. 
     # @param [Hash] opts the optional parameters
     # @return [ApplicationListSchema]
     def get_application_list(opts = {})
       data, _status_code, _headers = get_application_list_with_http_info(opts)
       data
     end
+    deprecate :get_application_list, 'GetApplications', 0, 0
 
-    # Use the Application Management App to get a list of Applications 
-    # 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. 
+    # (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.  >**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. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApplicationListSchema, Fixnum, Hash)>] ApplicationListSchema data, response status code and response headers
     def get_application_list_with_http_info(opts = {})
@@ -523,6 +534,87 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+    deprecate :get_application_list_with_http_info, 'GetApplicationsWithHttpInfo', 0, 0
+
+    # Use the Application Management App to get a detailed list of Applications 
+    # Returns a list of applications. Can be filtered using the request parameters to provide a subset of results.  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.  >**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:** >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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
+    # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
+    # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)
+    # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
+    # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to app_id)
+    # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.  (default to updated_asc)
+    # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @option opts [BOOLEAN] :include_course_count Include a count of courses for the application. (default to false)
+    # @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period. (default to false)
+    # @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.  (default to false)
+    # @return [ApplicationInfoListSchema]
+    def get_applications(opts = {})
+      data, _status_code, _headers = get_applications_with_http_info(opts)
+      data
+    end
+
+    # Use the Application Management App to get a detailed list of Applications 
+    # Returns a list of applications. Can be filtered using the request parameters to provide a subset of results.  This endpoint caches the course and registration counts of an application for 24 hours if either  &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. 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.  &gt;**Note:** &gt;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 &#x60;more&#x60; 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.  &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.  &gt;**Info:** &gt;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 &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;.  GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
+    # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
+    # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against
+    # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
+    # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. 
+    # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. 
+    # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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
+    def get_applications_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_applications ...'
+      end
+      # resource path
+      local_var_path = '/appManagement/applicationList'
+
+      # query parameters
+      query_params = {}
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
+      query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
+      query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
+      query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
+      query_params[:'includeCourseCount'] = opts[:'include_course_count'] if !opts[:'include_course_count'].nil?
+      query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['APP_MANAGEMENT', 'OAUTH']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApplicationInfoListSchema')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApplicationManagementApi#get_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Use the Application Manager App to get a list of secret keys for an Application 
     # 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. 
     # @param child_app_id 
@@ -577,6 +669,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update configuration settings for an Application 
     # 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. 
     # @param configuration_settings 
@@ -636,6 +729,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Use the Application Management App to update information about an Application 
     # 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. 
     # @param child_app_id 
@@ -695,6 +789,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Use the Application Manager App to update an existing secret key for an Application 
     # 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. 
     # @param child_app_id 

data/lib/rustici_software_cloud_v2/api/authentication_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    extend Gem::Deprecate
+
     # Obtain an OAuth token for scoped access to an Application 
     # 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. 
     # @param scope Space separated string of OAuth scopes, e.g. \"write:course read:registration\". 

data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    extend Gem::Deprecate
+
     # 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
@@ -71,6 +73,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a connector 
     # Delete the specified connector. 
     # @param connector_id the connector id
@@ -124,6 +127,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of all Content Connectors for the application 
     # Get list of all Content Connectors in this application. 
     # @param [Hash] opts the optional parameters
@@ -175,6 +179,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update the configuration or enabled flag associated with `connectorId`. 
     # @param connector_id the connector id
     # @param connector