rustici_software_cloud_v2 1.1.0 → 2.0.0

data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb

@@ -0,0 +1,228 @@
+=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.12
+
+=end
+
+require 'date'
+
+module RusticiSoftwareCloudV2
+  class PublicInvitationUpdateSchema
+    # If true, then new registrations can be created for this invitation.
+    attr_accessor :allow_launch
+
+    # If true, then new registrations can be created for this invitation.
+    attr_accessor :allow_new_registrations
+
+    # Specifies a URL for which to post activity and status data in real time as the course is completed
+    attr_accessor :post_back
+
+    # The ISO 8601 TimeStamp (defaults to UTC) after which this invitation will expire and can no longer be launched. An empty value will represent no expiration date. 
+    attr_accessor :expiration_date
+
+    # Integer value that limits the amount of registrations a public invitation can generate.
+    attr_accessor :registration_cap
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allow_launch' => :'allowLaunch',
+        :'allow_new_registrations' => :'allowNewRegistrations',
+        :'post_back' => :'postBack',
+        :'expiration_date' => :'expirationDate',
+        :'registration_cap' => :'registrationCap'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'allow_launch' => :'BOOLEAN',
+        :'allow_new_registrations' => :'BOOLEAN',
+        :'post_back' => :'PostBackSchema',
+        :'expiration_date' => :'DateTime',
+        :'registration_cap' => :'Integer'
+      }
+    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?(:'allowLaunch')
+        self.allow_launch = attributes[:'allowLaunch']
+      end
+
+      if attributes.has_key?(:'allowNewRegistrations')
+        self.allow_new_registrations = attributes[:'allowNewRegistrations']
+      end
+
+      if attributes.has_key?(:'postBack')
+        self.post_back = attributes[:'postBack']
+      end
+
+      if attributes.has_key?(:'expirationDate')
+        self.expiration_date = attributes[:'expirationDate']
+      end
+
+      if attributes.has_key?(:'registrationCap')
+        self.registration_cap = attributes[:'registrationCap']
+      else
+        self.registration_cap = 0
+      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 &&
+          allow_launch == o.allow_launch &&
+          allow_new_registrations == o.allow_new_registrations &&
+          post_back == o.post_back &&
+          expiration_date == o.expiration_date &&
+          registration_cap == o.registration_cap
+    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
+      [allow_launch, allow_new_registrations, post_back, expiration_date, registration_cap].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/registration_list_schema.rb

@@ -16,6 +16,7 @@ module RusticiSoftwareCloudV2
   class RegistrationListSchema
     attr_accessor :registrations
 
+    # 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.
@@ -71,6 +72,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -99,7 +101,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) })
@@ -195,5 +197,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/registration_schema.rb

@@ -224,6 +224,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -271,7 +272,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) })
@@ -367,5 +368,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb

@@ -120,6 +120,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -155,7 +156,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) })
@@ -251,5 +252,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb

@@ -80,6 +80,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -110,7 +111,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) })
@@ -206,5 +207,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb

@@ -64,6 +64,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -92,7 +93,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) })
@@ -188,5 +189,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb

@@ -56,6 +56,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -83,7 +84,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) })
@@ -179,5 +180,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/response_error.rb

@@ -61,6 +61,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -88,7 +89,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) })
@@ -184,5 +185,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb

@@ -36,28 +36,6 @@ module RusticiSoftwareCloudV2
 
     attr_accessor :description
 
-    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
       {
@@ -159,18 +137,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?
-      type_validator = EnumAttributeValidator.new('String', ['TrueFalse', 'Choice', 'FillIn', 'LongFillIn', 'Likert', 'Matching', 'Performance', 'Sequencing', 'Numeric', 'Other'])
-      return false unless type_validator.valid?(@type)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['TrueFalse', 'Choice', 'FillIn', 'LongFillIn', 'Likert', 'Matching', 'Performance', 'Sequencing', 'Numeric', 'Other']
+    #
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ['TrueFalse', 'Choice', 'FillIn', 'LongFillIn', 'Likert', 'Matching', 'Performance', 'Sequencing', 'Numeric', 'Other'])
-      unless validator.valid?(type)
-        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
-      end
       @type = type
     end
 
@@ -211,7 +186,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) })
@@ -307,5 +282,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb

@@ -32,28 +32,6 @@ module RusticiSoftwareCloudV2
 
     attr_accessor :description
 
-    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
       {
@@ -143,30 +121,23 @@ module RusticiSoftwareCloudV2
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      runtime_objective_success_status_validator = EnumAttributeValidator.new('String', ['UNKNOWN', 'PASSED', 'FAILED'])
-      return false unless runtime_objective_success_status_validator.valid?(@runtime_objective_success_status)
-      runtime_objective_completion_status_validator = EnumAttributeValidator.new('String', ['UNKNOWN', 'COMPLETED', 'INCOMPLETE', 'NOT_ATTEMPTED', 'BROWSED'])
-      return false unless runtime_objective_completion_status_validator.valid?(@runtime_objective_completion_status)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['UNKNOWN', 'PASSED', 'FAILED']
+    #
     # @param [Object] runtime_objective_success_status Object to be assigned
     def runtime_objective_success_status=(runtime_objective_success_status)
-      validator = EnumAttributeValidator.new('String', ['UNKNOWN', 'PASSED', 'FAILED'])
-      unless validator.valid?(runtime_objective_success_status)
-        fail ArgumentError, 'invalid value for "runtime_objective_success_status", must be one of #{validator.allowable_values}.'
-      end
       @runtime_objective_success_status = runtime_objective_success_status
     end
-
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['UNKNOWN', 'COMPLETED', 'INCOMPLETE', 'NOT_ATTEMPTED', 'BROWSED']
+    #
     # @param [Object] runtime_objective_completion_status Object to be assigned
     def runtime_objective_completion_status=(runtime_objective_completion_status)
-      validator = EnumAttributeValidator.new('String', ['UNKNOWN', 'COMPLETED', 'INCOMPLETE', 'NOT_ATTEMPTED', 'BROWSED'])
-      unless validator.valid?(runtime_objective_completion_status)
-        fail ArgumentError, 'invalid value for "runtime_objective_completion_status", must be one of #{validator.allowable_values}.'
-      end
       @runtime_objective_completion_status = runtime_objective_completion_status
     end
 
@@ -205,7 +176,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) })
@@ -301,5 +272,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/runtime_schema.rb

@@ -54,28 +54,6 @@ module RusticiSoftwareCloudV2
 
     attr_accessor :runtime_objectives
 
-    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
       {
@@ -237,18 +215,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?
-      runtime_success_status_validator = EnumAttributeValidator.new('String', ['UNKNOWN', 'PASSED', 'FAILED'])
-      return false unless runtime_success_status_validator.valid?(@runtime_success_status)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['UNKNOWN', 'PASSED', 'FAILED']
+    #
     # @param [Object] runtime_success_status Object to be assigned
     def runtime_success_status=(runtime_success_status)
-      validator = EnumAttributeValidator.new('String', ['UNKNOWN', 'PASSED', 'FAILED'])
-      unless validator.valid?(runtime_success_status)
-        fail ArgumentError, 'invalid value for "runtime_success_status", must be one of #{validator.allowable_values}.'
-      end
       @runtime_success_status = runtime_success_status
     end
 
@@ -298,7 +273,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) })
@@ -394,5 +369,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/score_schema.rb

@@ -57,6 +57,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -84,7 +85,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) })
@@ -180,5 +181,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end