rustici_software_cloud_v2 2.1.0 → 4.0.0

data/lib/rustici_software_cloud_v2/models/preview_launch_link_request_schema.rb

@@ -0,0 +1,239 @@
+=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 PreviewLaunchLinkRequestSchema
+    # Number of seconds from now this link will expire in. Defaults to 120s. Range 10s:300s
+    attr_accessor :expiry
+
+    # The URL the application should redirect to when the learner exits a course.  Alternatively one of the following keywords can be used to redirect to: - `closer` - A page that automatically tries to close the browser tab/window - `blank` - A blank page - `message` - A page with a message about the course being complete  If an empty string is specified, the configured setting will be used (default www.scorm.com). If an invalid url is specified, the Message.html page will be loaded. 
+    attr_accessor :redirect_on_exit_url
+
+    # For SCORM, SCO identifier to override launch, overriding the normal sequencing.
+    attr_accessor :start_sco
+
+    # This parameter should specify a culture code. If specified, and supported, the navigation and alerts in the player will be displayed in the associated language. If not specified, the locale of the user’s browser will be used.
+    attr_accessor :culture
+
+    # A url pointing to custom CSS for the player to use.
+    attr_accessor :css_url
+
+    attr_accessor :additionalvalues
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expiry' => :'expiry',
+        :'redirect_on_exit_url' => :'redirectOnExitUrl',
+        :'start_sco' => :'startSco',
+        :'culture' => :'culture',
+        :'css_url' => :'cssUrl',
+        :'additionalvalues' => :'additionalvalues'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'expiry' => :'Integer',
+        :'redirect_on_exit_url' => :'String',
+        :'start_sco' => :'String',
+        :'culture' => :'String',
+        :'css_url' => :'String',
+        :'additionalvalues' => :'Array<ItemValuePairSchema>'
+      }
+    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?(:'expiry')
+        self.expiry = attributes[:'expiry']
+      else
+        self.expiry = 120
+      end
+
+      if attributes.has_key?(:'redirectOnExitUrl')
+        self.redirect_on_exit_url = attributes[:'redirectOnExitUrl']
+      end
+
+      if attributes.has_key?(:'startSco')
+        self.start_sco = attributes[:'startSco']
+      end
+
+      if attributes.has_key?(:'culture')
+        self.culture = attributes[:'culture']
+      end
+
+      if attributes.has_key?(:'cssUrl')
+        self.css_url = attributes[:'cssUrl']
+      end
+
+      if attributes.has_key?(:'additionalvalues')
+        if (value = attributes[:'additionalvalues']).is_a?(Array)
+          self.additionalvalues = value
+        end
+      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 &&
+          expiry == o.expiry &&
+          redirect_on_exit_url == o.redirect_on_exit_url &&
+          start_sco == o.start_sco &&
+          culture == o.culture &&
+          css_url == o.css_url &&
+          additionalvalues == o.additionalvalues
+    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
+      [expiry, redirect_on_exit_url, start_sco, culture, css_url, additionalvalues].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/private_invitation_list.rb

@@ -6,33 +6,31 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
+require_relative 'paginated_list'
+
 
 module RusticiSoftwareCloudV2
-  class PrivateInvitationList
+  class PrivateInvitationList < PaginatedList
     # 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.
     def self.attribute_map
       {
-        :'invitations' => :'invitations',
-        :'more' => :'more'
+        :'more' => :'more',
+        :'invitations' => :'invitations'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'invitations' => :'Array<PrivateInvitationSchema>',
-        :'more' => :'String'
+        :'more' => :'String',
+        :'invitations' => :'Array<PrivateInvitationSchema>'
       }
     end
 
@@ -44,21 +42,20 @@ module RusticiSoftwareCloudV2
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      # call parent's initialize
+      super(attributes)
+
       if attributes.has_key?(:'invitations')
         if (value = attributes[:'invitations']).is_a?(Array)
           self.invitations = 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 = super
       invalid_properties
     end
 
@@ -74,8 +71,7 @@ module RusticiSoftwareCloudV2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          invitations == o.invitations &&
-          more == o.more
+          invitations == o.invitations && super(o)
     end
 
     # @see the `==` method
@@ -87,7 +83,7 @@ module RusticiSoftwareCloudV2
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [invitations, more].hash
+      [invitations].hash
     end
 
     # Builds the object from hash
@@ -95,6 +91,7 @@ module RusticiSoftwareCloudV2
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      super(attributes)
       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
@@ -167,7 +164,7 @@ module RusticiSoftwareCloudV2
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
-      hash = {}
+      hash = super
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?

data/lib/rustici_software_cloud_v2/models/private_invitation_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 PrivateInvitationSchema
     # The invitationId for this invitation.
@@ -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 invitation.
+    # Determines if learners are allowed to launch the invitation. If false, the invitation is disabled and no new or existing learners are allowed to launch it. 
     attr_accessor :allow_launch
 
     attr_accessor :invitation_email

data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb

@@ -6,15 +6,15 @@
 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 PrivateInvitationUpdateSchema
-    # If true, then new registrations can be created for this invitation.
+    # Determines if learners are allowed to launch the invitation. If false, the invitation is disabled and no new or existing learners are allowed to launch it. 
     attr_accessor :allow_launch
 
     attr_accessor :invitation_email

data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb

@@ -6,33 +6,31 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
 require 'date'
+require_relative 'paginated_list'
+
 
 module RusticiSoftwareCloudV2
-  class PublicInvitationList
+  class PublicInvitationList < PaginatedList
     # 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.
     def self.attribute_map
       {
-        :'invitations' => :'invitations',
-        :'more' => :'more'
+        :'more' => :'more',
+        :'invitations' => :'invitations'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'invitations' => :'Array<PublicInvitationSchema>',
-        :'more' => :'String'
+        :'more' => :'String',
+        :'invitations' => :'Array<PublicInvitationSchema>'
       }
     end
 
@@ -44,21 +42,20 @@ module RusticiSoftwareCloudV2
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      # call parent's initialize
+      super(attributes)
+
       if attributes.has_key?(:'invitations')
         if (value = attributes[:'invitations']).is_a?(Array)
           self.invitations = 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 = super
       invalid_properties
     end
 
@@ -74,8 +71,7 @@ module RusticiSoftwareCloudV2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          invitations == o.invitations &&
-          more == o.more
+          invitations == o.invitations && super(o)
     end
 
     # @see the `==` method
@@ -87,7 +83,7 @@ module RusticiSoftwareCloudV2
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [invitations, more].hash
+      [invitations].hash
     end
 
     # Builds the object from hash
@@ -95,6 +91,7 @@ module RusticiSoftwareCloudV2
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      super(attributes)
       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
@@ -167,7 +164,7 @@ module RusticiSoftwareCloudV2
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
-      hash = {}
+      hash = super
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?

data/lib/rustici_software_cloud_v2/models/public_invitation_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 PublicInvitationSchema
     # The invitationId for this invitation.
@@ -20,12 +20,12 @@ module RusticiSoftwareCloudV2
     # Course Id for this Invitation.
     attr_accessor :course_id
 
-    # If true, then new registrations can be created for this invitation.
+    # Determines if learners are allowed to launch the invitation. If false, the invitation is disabled and no new or existing learners are allowed to launch it. 
     attr_accessor :allow_launch
 
     attr_accessor :invitation_email
 
-    # If true, then new registrations can be created for this invitation.
+    # Determines if new registrations can be created for this public invitation. If false, no new registrations can be created for the invitation, so only learners with existing registrations can access the invitation. 
     attr_accessor :allow_new_registrations
 
     # The launch URL for the invitation
@@ -42,7 +42,7 @@ module RusticiSoftwareCloudV2
     # 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.
+    # Integer value that represents the maximum number of registrations that can be created for a public invitation. Setting this value to '0' allows an unlimited amount of registrations to be created for the invitation. 
     attr_accessor :registration_cap
 
     # The count of registrations for this invitation

data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb

@@ -6,18 +6,18 @@
 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 PublicInvitationUpdateSchema
-    # If true, then new registrations can be created for this invitation.
+    # Determines if learners are allowed to launch the invitation. If false, the invitation is disabled and no new or existing learners are allowed to launch it. 
     attr_accessor :allow_launch
 
-    # If true, then new registrations can be created for this invitation.
+    # Determines if new registrations can be created for this public invitation. If false, no new registrations can be created for the invitation, so only learners with existing registrations can access the 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
@@ -26,7 +26,7 @@ module RusticiSoftwareCloudV2
     # 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.
+    # Integer value that represents the maximum number of registrations that can be created for a public invitation. Setting this value to '0' allows an unlimited amount of registrations to be created for the invitation. 
     attr_accessor :registration_cap
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/rustici_software_cloud_v2/models/registration_completion.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 RegistrationCompletion
     

data/lib/rustici_software_cloud_v2/models/registration_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 RegistrationListSchema
     attr_accessor :registrations

data/lib/rustici_software_cloud_v2/models/registration_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 RegistrationSchema
     attr_accessor :id

data/lib/rustici_software_cloud_v2/models/registration_success.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 RegistrationSuccess
     

data/lib/rustici_software_cloud_v2/models/reportage_account_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 ReportageAccountInfoSchema
     attr_accessor :email

data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_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 ReportageAccountInfoUsageSchema
     attr_accessor :month_start

data/lib/rustici_software_cloud_v2/models/reportage_auth_token_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 ReportageAuthTokenSchema
     attr_accessor :auth_enabled

data/lib/rustici_software_cloud_v2/models/reportage_link_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 ReportageLinkSchema
     attr_accessor :reportage_link

data/lib/rustici_software_cloud_v2/models/response_error.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 ResponseError
     attr_accessor :message