rustici_software_cloud_v2 2.1.0 → 4.0.0

data/lib/rustici_software_cloud_v2/api/xapi_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
+
     # Create an xAPI Statement Pipe 
     # Creates an xAPI statement pipe.  >**Note:** >This method is asynchronous.  A returned success status indicates a background process has been started, but there will still be a delay before the creation of the xAPI statement pipe takes place. 
     # @param xapi_statement_pipe 
@@ -73,6 +75,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create xAPI Credentials 
     # Creates an xAPI credential combination from the provided secret and a generated ID. 
     # @param xapi_credential 
@@ -127,6 +130,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete an xAPI Statement Pipe 
     # Deletes the specified xAPI statement pipe  >**Note:** >This method is asynchronous.  A returned success status indicates a background process has been started, but there will still be a delay before the deletion takes place.  Recreating a statement pipe with the same ID too quickly could cause the statement pipe to end up in a faulty state. 
     # @param statement_pipe_id 
@@ -180,6 +184,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete xAPI Credentials 
     # Deletes the specified xAPI credentials. 
     # @param xapi_credential_id 
@@ -233,6 +238,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get detailed information about an xAPI Statement Pipe 
     # Returns detailed information about the xAPI pipe.  This includes source and target urls, the last time a statement was successfully forwarded, and how many attempts have been made to send data to the target url. 
     # @param statement_pipe_id 
@@ -287,6 +293,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of xAPI Statement Pipes 
     # Returns a list of all xAPI statement pipes. 
     # @param [Hash] opts the optional parameters
@@ -335,6 +342,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get detailed information about the xAPI Credentials 
     # Returns detailed information about the xAPI credentials.  This includes the id (username), secret (password), permissions, and whether or not the credentials are enabled. 
     # @param xapi_credential_id 
@@ -389,6 +397,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of xAPI Credentials 
     # Returns a list of xAPI credentials.  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. 
     # @param [Hash] opts the optional parameters
@@ -399,6 +408,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to credential_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 `more` property of multi page list requests
+    # @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)
     # @return [XapiCredentialsListSchema]
     def get_xapi_credentials(opts = {})
       data, _status_code, _headers = get_xapi_credentials_with_http_info(opts)
@@ -415,6 +425,7 @@ module RusticiSoftwareCloudV2
     # @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 `more` property of multi page list requests
+    # @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. 
     # @return [Array<(XapiCredentialsListSchema, Fixnum, Hash)>] XapiCredentialsListSchema data, response status code and response headers
     def get_xapi_credentials_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -432,6 +443,7 @@ module RusticiSoftwareCloudV2
       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[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
 
       # header parameters
       header_params = {}
@@ -458,6 +470,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create or update an xAPI Statement Pipe 
     # Creates or updates information about the xAPI statement pipe.  - If the xAPI statement pipe is instead being updated, the pipe will start over and forward any statements it finds, even if it had already forwarded those statements.  If the pipe being edited is currently being processed, then this request will fail with a status code of 409.  >**Note:** >This method is asynchronous.  A returned success status indicates a background process has been started, but there will still be a delay before the creation of the xAPI statement pipe takes place. 
     # @param statement_pipe_id 
@@ -518,6 +531,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create or update xAPI Credentials 
     # Creates or updates information about the xAPI credentials. 
     # @param xapi_credential_id 

data/lib/rustici_software_cloud_v2/api/zoomi_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
+
     # Delete the Zoomi keys for an Application 
     # Deletes the Zoomi keys for an application. 
     # @param [Hash] opts the optional parameters
@@ -66,6 +68,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete the Course from Zoomi 
     # Deletes the course from Zoomi, but the course will remain in SCORM Cloud. 
     # @param course_id 
@@ -125,6 +128,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the Zoomi company ID of an Application 
     # Returns the Zoomi company ID of an application. 
     # @param [Hash] opts the optional parameters
@@ -173,6 +177,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the Zoomi public key for an Application 
     # Returns the Zoomi public key for an application. 
     # @param [Hash] opts the optional parameters
@@ -221,6 +226,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the Zoomi enabled value of a Course Version 
     # Returns the Zoomi enabled value of a course version. 
     # @param course_id 
@@ -281,6 +287,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the status for a Course from Zoomi 
     # Returns the status for a course and starts the upload process to Zoomi if not started. 
     # @param course_id 
@@ -341,6 +348,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Begin the import process with Zoomi 
     # Begins the import process with Zoomi.  Must be followed up by a status call. 
     # @param course_id 
@@ -406,6 +414,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Set the Zoomi company ID of an Application 
     # Sets the Zoomi company ID value of an application. 
     # @param zoomi_company_id 
@@ -459,6 +468,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Set the Zoomi enabled value of a Course Version 
     # Sets the Zoomi enabled value of a course version. 
     # @param course_id 

data/lib/rustici_software_cloud_v2/api_client.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
 
@@ -31,7 +30,7 @@ module RusticiSoftwareCloudV2
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+      @user_agent = "Swagger-Codegen/4.0.0/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -112,6 +111,8 @@ module RusticiSoftwareCloudV2
         :verbose => @config.debugging
       }
 
+      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+
       # set custom cert, if provided
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 

data/lib/rustici_software_cloud_v2/api_error.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
 

data/lib/rustici_software_cloud_v2/configuration.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
 
@@ -222,13 +221,6 @@ module RusticiSoftwareCloudV2
             key: 'Authorization',
             value: oauth2_token
           },
-        'UNSECURED' =>
-          {
-            type: 'basic',
-            in: 'header',
-            key: 'Authorization',
-            value: basic_auth_token
-          },
       }
     end
   end

data/lib/rustici_software_cloud_v2/models/about_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class AboutSchema
     attr_accessor :version

data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ActivityResultSchema
     attr_accessor :id

data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb

@@ -0,0 +1,197 @@
+=begin
+#SCORM Cloud Rest API
+
+#REST API used for SCORM Cloud integrations.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+
+module RusticiSoftwareCloudV2
+  class ApplicationInfoListSchema
+    attr_accessor :applications
+
+    # Token for getting the next set of results, from the prior set of results.
+    attr_accessor :more
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'applications' => :'applications',
+        :'more' => :'more'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'applications' => :'Array<ApplicationInfoSchema>',
+        :'more' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'applications')
+        if (value = attributes[:'applications']).is_a?(Array)
+          self.applications = value
+        end
+      end
+
+      if attributes.has_key?(:'more')
+        self.more = attributes[:'more']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          applications == o.applications &&
+          more == o.more
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [applications, more].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = RusticiSoftwareCloudV2.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/rustici_software_cloud_v2/models/application_info_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ApplicationInfoSchema
     # The application id for this application.
@@ -23,6 +23,9 @@ module RusticiSoftwareCloudV2
     # The time the application was created in UTC
     attr_accessor :create_date
 
+    # The time the application was last updated in UTC
+    attr_accessor :update_date
+
     # Whether the application is allowed to perform delete operations
     attr_accessor :allow_delete
 
@@ -36,6 +39,7 @@ module RusticiSoftwareCloudV2
         :'id' => :'id',
         :'name' => :'name',
         :'create_date' => :'createDate',
+        :'update_date' => :'updateDate',
         :'allow_delete' => :'allowDelete',
         :'course_count' => :'courseCount',
         :'registration_count' => :'registrationCount'
@@ -48,6 +52,7 @@ module RusticiSoftwareCloudV2
         :'id' => :'String',
         :'name' => :'String',
         :'create_date' => :'DateTime',
+        :'update_date' => :'DateTime',
         :'allow_delete' => :'BOOLEAN',
         :'course_count' => :'Integer',
         :'registration_count' => :'Integer'
@@ -74,6 +79,10 @@ module RusticiSoftwareCloudV2
         self.create_date = attributes[:'createDate']
       end
 
+      if attributes.has_key?(:'updateDate')
+        self.update_date = attributes[:'updateDate']
+      end
+
       if attributes.has_key?(:'allowDelete')
         self.allow_delete = attributes[:'allowDelete']
       end
@@ -109,6 +118,7 @@ module RusticiSoftwareCloudV2
           id == o.id &&
           name == o.name &&
           create_date == o.create_date &&
+          update_date == o.update_date &&
           allow_delete == o.allow_delete &&
           course_count == o.course_count &&
           registration_count == o.registration_count
@@ -123,7 +133,7 @@ module RusticiSoftwareCloudV2
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, create_date, allow_delete, course_count, registration_count].hash
+      [id, name, create_date, update_date, allow_delete, course_count, registration_count].hash
     end
 
     # Builds the object from hash

data/lib/rustici_software_cloud_v2/models/application_list_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ApplicationListSchema
     attr_accessor :applications

data/lib/rustici_software_cloud_v2/models/application_request_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ApplicationRequestSchema
     # The name of this application.

data/lib/rustici_software_cloud_v2/models/application_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ApplicationSchema
     # The application id for this application.

data/lib/rustici_software_cloud_v2/models/application_token.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ApplicationToken
     attr_accessor :access_token

data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class AssetFileSchema
     attr_accessor :filename

data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class BatchTagsSchema
     attr_accessor :ids

data/lib/rustici_software_cloud_v2/models/comment_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class CommentSchema
     attr_accessor :value

data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class CompletionAmountSchema
     # Scaled completion amount between 0 and 100

data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   # List of content connectors.
   class ConnectorListSchema

data/lib/rustici_software_cloud_v2/models/connector_schema.rb

@@ -6,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   # A content connector.
   class ConnectorSchema