rustici_software_cloud_v2 2.0.0 → 3.0.0

data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb

@@ -0,0 +1,186 @@
+=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 DispatchLti13InfoSchema
+    # Endpoint executed at the end of the OIDC authentication flow.
+    attr_accessor :target_link_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'target_link_uri' => :'targetLinkUri'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'target_link_uri' => :'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?(:'targetLinkUri')
+        self.target_link_uri = attributes[:'targetLinkUri']
+      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 &&
+          target_link_uri == o.target_link_uri
+    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
+      [target_link_uri].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/dispatch_lti_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class DispatchLtiInfoSchema
     # The LTI launch URL for this dispatch

data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class DispatchRegistrationCountSchema
     attr_accessor :registration_count

data/lib/rustici_software_cloud_v2/models/dispatch_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class DispatchSchema
     # Destination ID.

data/lib/rustici_software_cloud_v2/models/enabled_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class EnabledSchema
     attr_accessor :enabled

data/lib/rustici_software_cloud_v2/models/file_list_item_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class FileListItemSchema
     # Relative file path of the file. Used in asset manipulation calls

data/lib/rustici_software_cloud_v2/models/file_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class FileListSchema
     attr_accessor :files

data/lib/rustici_software_cloud_v2/models/import_asset_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   # Request schema to import a course asset file by fetching it from a url 
   class ImportAssetRequestSchema

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
+
+=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,12 +6,12 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   # Request to import a course by downloading it from a url
   class ImportFetchRequestSchema

data/lib/rustici_software_cloud_v2/models/import_job_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ImportJobResultSchema
     attr_accessor :job_id

data/lib/rustici_software_cloud_v2/models/import_media_file_reference_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   # Used to create a course that references a media file. Upon import, the actual file is not downloaded and stored on SCORM Cloud's servers. Instead, the media file wrapper will load the content from the provided URL. 
   class ImportMediaFileReferenceRequestSchema

data/lib/rustici_software_cloud_v2/models/import_request_schema.rb

@@ -6,24 +6,27 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
-  # Request to import a new course. Exactly one of fetchRequest or mediaFileReferenceRequest must be supplied, depending on the desired import behavior. 
+  # Request to import a new course. Exactly one of the schemas must be supplied, depending on the desired import behavior. 
   class ImportRequestSchema
     attr_accessor :fetch_request
 
     attr_accessor :media_file_reference_request
 
+    attr_accessor :connector_reference_request
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'fetch_request' => :'fetchRequest',
-        :'media_file_reference_request' => :'mediaFileReferenceRequest'
+        :'media_file_reference_request' => :'mediaFileReferenceRequest',
+        :'connector_reference_request' => :'connectorReferenceRequest'
       }
     end
 
@@ -31,7 +34,8 @@ module RusticiSoftwareCloudV2
     def self.swagger_types
       {
         :'fetch_request' => :'ImportFetchRequestSchema',
-        :'media_file_reference_request' => :'ImportMediaFileReferenceRequestSchema'
+        :'media_file_reference_request' => :'ImportMediaFileReferenceRequestSchema',
+        :'connector_reference_request' => :'ImportConnectorRequestSchema'
       }
     end
 
@@ -50,6 +54,10 @@ module RusticiSoftwareCloudV2
       if attributes.has_key?(:'mediaFileReferenceRequest')
         self.media_file_reference_request = attributes[:'mediaFileReferenceRequest']
       end
+
+      if attributes.has_key?(:'connectorReferenceRequest')
+        self.connector_reference_request = attributes[:'connectorReferenceRequest']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -72,7 +80,8 @@ module RusticiSoftwareCloudV2
       return true if self.equal?(o)
       self.class == o.class &&
           fetch_request == o.fetch_request &&
-          media_file_reference_request == o.media_file_reference_request
+          media_file_reference_request == o.media_file_reference_request &&
+          connector_reference_request == o.connector_reference_request
     end
 
     # @see the `==` method
@@ -84,7 +93,7 @@ module RusticiSoftwareCloudV2
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [fetch_request, media_file_reference_request].hash
+      [fetch_request, media_file_reference_request, connector_reference_request].hash
     end
 
     # Builds the object from hash

data/lib/rustici_software_cloud_v2/models/import_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class ImportResultSchema
     # web path to this course

data/lib/rustici_software_cloud_v2/models/integer_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class IntegerResultSchema
     attr_accessor :result

data/lib/rustici_software_cloud_v2/models/invitation_email_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   # Object representing an e-mail to be sent to a given list of e-mail addresses inviting them to participate in a course.
   class InvitationEmailSchema

data/lib/rustici_software_cloud_v2/models/invitation_job_status_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.12
 
 =end
 
 require 'date'
 
+
 module RusticiSoftwareCloudV2
   class InvitationJobStatusSchema
     # The status of the job.