rustici_software_cloud_v2 1.1.0 → 2.0.0

data/lib/rustici_software_cloud_v2/models/permissions_schema.rb

@@ -67,6 +67,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -95,7 +96,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) })
@@ -191,5 +192,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/ping_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/post_back_schema.rb

@@ -31,28 +31,6 @@ module RusticiSoftwareCloudV2
     # This paramenter is ONLY used for backwards compatibility with XML postback implementations.  You probably shouldn't need to use this unless you're currently transitioning from the V1 api to the V2 api and already have existing XML postback logic in your application, but have not yet built out JSON postback logic.  If a registration is created with the V2 api we will assume that you're expecting JSON results unless otherwise specified. 
     attr_accessor :legacy
 
-    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
       {
@@ -124,30 +102,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?
-      auth_type_validator = EnumAttributeValidator.new('String', ['UNDEFINED', 'FORM', 'HTTPBASIC'])
-      return false unless auth_type_validator.valid?(@auth_type)
-      results_format_validator = EnumAttributeValidator.new('String', ['UNDEFINED', 'COURSE', 'ACTIVITY', 'FULL'])
-      return false unless results_format_validator.valid?(@results_format)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['UNDEFINED', 'FORM', 'HTTPBASIC']
+    #
     # @param [Object] auth_type Object to be assigned
     def auth_type=(auth_type)
-      validator = EnumAttributeValidator.new('String', ['UNDEFINED', 'FORM', 'HTTPBASIC'])
-      unless validator.valid?(auth_type)
-        fail ArgumentError, 'invalid value for "auth_type", must be one of #{validator.allowable_values}.'
-      end
       @auth_type = auth_type
     end
-
     # Custom attribute writer method checking allowed values (enum).
+    #
+    # allowable_values = ['UNDEFINED', 'COURSE', 'ACTIVITY', 'FULL']
+    #
     # @param [Object] results_format Object to be assigned
     def results_format=(results_format)
-      validator = EnumAttributeValidator.new('String', ['UNDEFINED', 'COURSE', 'ACTIVITY', 'FULL'])
-      unless validator.valid?(results_format)
-        fail ArgumentError, 'invalid value for "results_format", must be one of #{validator.allowable_values}.'
-      end
       @results_format = results_format
     end
 
@@ -183,7 +154,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) })
@@ -279,5 +250,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb

@@ -17,6 +17,7 @@ module RusticiSoftwareCloudV2
     # A list of private invitation objects.
     attr_accessor :invitations
 
+    # 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.
@@ -67,6 +68,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -95,7 +97,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) })
@@ -191,5 +193,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb

@@ -20,7 +20,7 @@ module RusticiSoftwareCloudV2
     # Course Id for this Invitation.
     attr_accessor :course_id
 
-    # If true, then new registrations can be created for this dispatch.
+    # If true, then new registrations can be created for this invitation.
     attr_accessor :allow_launch
 
     attr_accessor :invitation_email
@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
     # Specifies a URL for which to post activity and status data in real time as the course is completed
     attr_accessor :post_back
 
-    # The date this invitation will expire and can not be launched (formatted yyyyMMddHHmmss in UTC time).
+    # 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
 
     # The count of registrations for this invitation
@@ -127,6 +127,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -162,7 +163,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) })
@@ -258,5 +259,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb

@@ -0,0 +1,215 @@
+=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 PrivateInvitationUpdateSchema
+    # If true, then new registrations can be created for this invitation.
+    attr_accessor :allow_launch
+
+    attr_accessor :invitation_email
+
+    # 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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allow_launch' => :'allowLaunch',
+        :'invitation_email' => :'invitationEmail',
+        :'post_back' => :'postBack',
+        :'expiration_date' => :'expirationDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'allow_launch' => :'BOOLEAN',
+        :'invitation_email' => :'InvitationEmailSchema',
+        :'post_back' => :'PostBackSchema',
+        :'expiration_date' => :'DateTime'
+      }
+    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?(:'invitationEmail')
+        self.invitation_email = attributes[:'invitationEmail']
+      end
+
+      if attributes.has_key?(:'postBack')
+        self.post_back = attributes[:'postBack']
+      end
+
+      if attributes.has_key?(:'expirationDate')
+        self.expiration_date = attributes[:'expirationDate']
+      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 &&
+          invitation_email == o.invitation_email &&
+          post_back == o.post_back &&
+          expiration_date == o.expiration_date
+    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, invitation_email, post_back, expiration_date].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/public_invitation_list.rb

@@ -17,6 +17,7 @@ module RusticiSoftwareCloudV2
     # A list of public invitation objects.
     attr_accessor :invitations
 
+    # 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.
@@ -67,6 +68,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -95,7 +97,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) })
@@ -191,5 +193,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end

data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb

@@ -20,10 +20,10 @@ module RusticiSoftwareCloudV2
     # Course Id for this Invitation.
     attr_accessor :course_id
 
-    # If true, then new registrations can be created for this dispatch.
+    # 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 dispatch.
+    # If true, then new registrations can be created for this invitation.
     attr_accessor :allow_new_registrations
 
     # The launch URL for the invitation
@@ -37,7 +37,7 @@ module RusticiSoftwareCloudV2
     # Specifies a URL for which to post activity and status data in real time as the course is completed
     attr_accessor :post_back
 
-    # The date this invitation will expire and can not be launched (formatted yyyyMMddHHmmss in UTC time).
+    # 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.
@@ -148,6 +148,7 @@ module RusticiSoftwareCloudV2
       true
     end
 
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -185,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) })
@@ -281,5 +282,6 @@ module RusticiSoftwareCloudV2
         value
       end
     end
+
   end
 end