rustici_software_cloud_v2 1.1.0 → 2.1.0

data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb

@@ -0,0 +1,207 @@
+=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
+Swagger Codegen version: 2.4.27
+
+=end
+
+require 'date'
+
+module RusticiSoftwareCloudV2
+  # Request schema to import a course asset file by fetching it from a url 
+  class ImportAssetRequestSchema
+    # URL path to the asset file to import.
+    attr_accessor :fetch_url
+
+    # Relative path from the course's base directory where the asset file will be imported. `/Etiquette/Course.html` will upload the file into the Etiquette folder of the course. 
+    attr_accessor :destination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'fetch_url' => :'fetchUrl',
+        :'destination' => :'destination'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'fetch_url' => :'String',
+        :'destination' => :'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?(:'fetchUrl')
+        self.fetch_url = attributes[:'fetchUrl']
+      end
+
+      if attributes.has_key?(:'destination')
+        self.destination = attributes[:'destination']
+      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
+      if @fetch_url.nil?
+        invalid_properties.push('invalid value for "fetch_url", fetch_url cannot be nil.')
+      end
+
+      if @destination.nil?
+        invalid_properties.push('invalid value for "destination", destination cannot be nil.')
+      end
+
+      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?
+      return false if @fetch_url.nil?
+      return false if @destination.nil?
+      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 &&
+          fetch_url == o.fetch_url &&
+          destination == o.destination
+    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
+      [fetch_url, destination].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/import_connector_request_schema.rb

@@ -0,0 +1,207 @@
+=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
+Swagger Codegen version: 2.4.27
+
+=end
+
+require 'date'
+
+module RusticiSoftwareCloudV2
+  # Used to create a course from a content connector. Before creating a course using this schema, a content connector must be created using the `/contentConnectors` API endpoints. Once a content connector has been created, this schema can be used to create a course that can be launched using that connector.  For example, this schema is used to import an LTI 1.3 Tool to be consumed by SCORM Cloud acting as the LTI Platform. 
+  class ImportConnectorRequestSchema
+    # The connector to use for this course
+    attr_accessor :connector_id
+
+    # The id the connector provides to identify this content
+    attr_accessor :connector_id_for_content
+
+    # The metadata for this connector, format is implementation specific
+    attr_accessor :metadata_for_connector
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'connector_id' => :'connectorId',
+        :'connector_id_for_content' => :'connectorIdForContent',
+        :'metadata_for_connector' => :'metadataForConnector'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'connector_id' => :'String',
+        :'connector_id_for_content' => :'String',
+        :'metadata_for_connector' => :'Object'
+      }
+    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?(:'connectorId')
+        self.connector_id = attributes[:'connectorId']
+      end
+
+      if attributes.has_key?(:'connectorIdForContent')
+        self.connector_id_for_content = attributes[:'connectorIdForContent']
+      end
+
+      if attributes.has_key?(:'metadataForConnector')
+        self.metadata_for_connector = attributes[:'metadataForConnector']
+      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 &&
+          connector_id == o.connector_id &&
+          connector_id_for_content == o.connector_id_for_content &&
+          metadata_for_connector == o.metadata_for_connector
+    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
+      [connector_id, connector_id_for_content, metadata_for_connector].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/import_fetch_request_schema.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.12
+Swagger Codegen version: 2.4.27
 
 =end
 
@@ -15,20 +15,29 @@ require 'date'
 module RusticiSoftwareCloudV2
   # Request to import a course by downloading it from a url
   class ImportFetchRequestSchema
-    # URL path to the .zip package to download to import this course
+    # URL path to the .zip package or media file to download to import this course
     attr_accessor :url
 
+    # MIME type of the content to be fetched
+    attr_accessor :content_type
+
+    attr_accessor :media_file_metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'url' => :'url'
+        :'url' => :'url',
+        :'content_type' => :'contentType',
+        :'media_file_metadata' => :'mediaFileMetadata'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'url' => :'String'
+        :'url' => :'String',
+        :'content_type' => :'String',
+        :'media_file_metadata' => :'MediaFileMetadataSchema'
       }
     end
 
@@ -43,6 +52,16 @@ module RusticiSoftwareCloudV2
       if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       end
+
+      if attributes.has_key?(:'contentType')
+        self.content_type = attributes[:'contentType']
+      else
+        self.content_type = 'application/zip'
+      end
+
+      if attributes.has_key?(:'mediaFileMetadata')
+        self.media_file_metadata = attributes[:'mediaFileMetadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -63,12 +82,15 @@ module RusticiSoftwareCloudV2
       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 &&
-          url == o.url
+          url == o.url &&
+          content_type == o.content_type &&
+          media_file_metadata == o.media_file_metadata
     end
 
     # @see the `==` method
@@ -80,7 +102,7 @@ module RusticiSoftwareCloudV2
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [url].hash
+      [url, content_type, media_file_metadata].hash
     end
 
     # Builds the object from hash
@@ -90,7 +112,7 @@ module RusticiSoftwareCloudV2
       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 the attribute
+          # 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) })
@@ -186,5 +208,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.12
+Swagger Codegen version: 2.4.27
 
 =end
 
@@ -22,28 +22,6 @@ module RusticiSoftwareCloudV2
 
     attr_accessor :import_result
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -99,18 +77,15 @@ module RusticiSoftwareCloudV2
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ['RUNNING', 'COMPLETE', 'ERROR'])
-      return false unless status_validator.valid?(@status)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['RUNNING', 'COMPLETE', 'ERROR']
+    #
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ['RUNNING', 'COMPLETE', 'ERROR'])
-      unless validator.valid?(status)
-        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
-      end
       @status = status
     end
 
@@ -144,7 +119,7 @@ module RusticiSoftwareCloudV2
       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 the attribute
+          # 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) })
@@ -240,5 +215,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end