rustici_software_cloud_v2 2.0.0 → 2.1.0

data/lib/rustici_software_cloud_v2/api/dispatch_api.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
 
@@ -1422,7 +1422,181 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+    # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. 
+    # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step. 
+    # @param dispatch_id Identifier for the dispatch
+    # @param [Hash] opts the optional parameters
+    # @return [DispatchLti13InfoSchema]
+    def get_lti13_dispatch(dispatch_id, opts = {})
+      data, _status_code, _headers = get_lti13_dispatch_with_http_info(dispatch_id, opts)
+      data
+    end
+
+    # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. 
+    # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step. 
+    # @param dispatch_id Identifier for the dispatch
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DispatchLti13InfoSchema, Fixnum, Hash)>] DispatchLti13InfoSchema data, response status code and response headers
+    def get_lti13_dispatch_with_http_info(dispatch_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch ...'
+      end
+      # verify the required parameter 'dispatch_id' is set
+      if dispatch_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti13_dispatch"
+      end
+      # resource path
+      local_var_path = '/dispatch/dispatches/{dispatchId}/lti13'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['APP_NORMAL', 'OAUTH']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DispatchLti13InfoSchema')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DispatchApi#get_lti13_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Launch this dispatch using the IMS LTI 1.3 specification. 
+    # Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course). 
+    # @param dispatch_id Identifier for the dispatch
+    # @param external_config External configuration object
+    # @param jwt 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_lti13_dispatch_launch(dispatch_id, external_config, jwt, opts = {})
+      get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts)
+      nil
+    end
+
+    # Launch this dispatch using the IMS LTI 1.3 specification. 
+    # Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course). 
+    # @param dispatch_id Identifier for the dispatch
+    # @param external_config External configuration object
+    # @param jwt 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch_launch ...'
+      end
+      # verify the required parameter 'dispatch_id' is set
+      if dispatch_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti13_dispatch_launch"
+      end
+      # verify the required parameter 'external_config' is set
+      if external_config.nil?
+        fail ArgumentError, "Missing the required parameter 'external_config' when calling DispatchApi.get_lti13_dispatch_launch"
+      end
+      # verify the required parameter 'jwt' is set
+      if jwt.nil?
+        fail ArgumentError, "Missing the required parameter 'jwt' when calling DispatchApi.get_lti13_dispatch_launch"
+      end
+      # resource path
+      local_var_path = '/dispatch/dispatches/{dispatchId}/launches'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'externalConfig'] = external_config
+      query_params[:'jwt'] = jwt
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['UNSECURED']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DispatchApi#get_lti13_dispatch_launch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId` 
+    # @param destination_id Identifier for the destination
+    # @param [Hash] opts the optional parameters
+    # @return [Lti13ToolConfigurationSchema]
+    def get_lti13_tool_configuration_schema(destination_id, opts = {})
+      data, _status_code, _headers = get_lti13_tool_configuration_schema_with_http_info(destination_id, opts)
+      data
+    end
+
+    # Get the information needed to configure a LTI 1.3 platform with the destination id &#x60;destinationId&#x60; 
+    # @param destination_id Identifier for the destination
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Lti13ToolConfigurationSchema, Fixnum, Hash)>] Lti13ToolConfigurationSchema data, response status code and response headers
+    def get_lti13_tool_configuration_schema_with_http_info(destination_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_tool_configuration_schema ...'
+      end
+      # verify the required parameter 'destination_id' is set
+      if destination_id.nil?
+        fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_lti13_tool_configuration_schema"
+      end
+      # resource path
+      local_var_path = '/dispatch/destinations/{destinationId}/lti13'.sub('{' + 'destinationId' + '}', destination_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['APP_NORMAL', 'OAUTH']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Lti13ToolConfigurationSchema')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DispatchApi#get_lti13_tool_configuration_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification. 
+    # Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch. 
     # @param dispatch_id Identifier for the dispatch
     # @param [Hash] opts the optional parameters
     # @return [DispatchLtiInfoSchema]
@@ -1432,6 +1606,7 @@ module RusticiSoftwareCloudV2
     end
 
     # Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification. 
+    # Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch. 
     # @param dispatch_id Identifier for the dispatch
     # @param [Hash] opts the optional parameters
     # @return [Array<(DispatchLtiInfoSchema, Fixnum, Hash)>] DispatchLtiInfoSchema data, response status code and response headers
@@ -1805,7 +1980,7 @@ module RusticiSoftwareCloudV2
       return data, status_code, headers
     end
     # Create or update a Destination 
-    # Creates or updates information about the destination.  -If the destination is being created, a name should be provided in the DestinationSchema.  If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated.  You may also optionally supply the e-mail address of the user to be associated with this destination.  This e-mail address should correspond to a SCORM Cloud user account. 
+    # Creates or updates information about the destination.  -If the destination is being created, a name should be provided in the DestinationSchema.  If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated.  You may also optionally supply the e-mail address of the user to be associated with this destination.  This e-mail address should correspond to a SCORM Cloud user account.  >**Note:** >While the \"updated\" and \"created\" values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored. 
     # @param destination_id Identifier for the destination
     # @param destination 
     # @param [Hash] opts the optional parameters
@@ -1816,7 +1991,7 @@ module RusticiSoftwareCloudV2
     end
 
     # Create or update a Destination 
-    # Creates or updates information about the destination.  -If the destination is being created, a name should be provided in the DestinationSchema.  If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated.  You may also optionally supply the e-mail address of the user to be associated with this destination.  This e-mail address should correspond to a SCORM Cloud user account. 
+    # Creates or updates information about the destination.  -If the destination is being created, a name should be provided in the DestinationSchema.  If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated.  You may also optionally supply the e-mail address of the user to be associated with this destination.  This e-mail address should correspond to a SCORM Cloud user account.  &gt;**Note:** &gt;While the \&quot;updated\&quot; and \&quot;created\&quot; values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored. 
     # @param destination_id Identifier for the destination
     # @param destination 
     # @param [Hash] opts the optional parameters

data/lib/rustici_software_cloud_v2/api/invitations_api.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
 

data/lib/rustici_software_cloud_v2/api/learner_api.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
 

data/lib/rustici_software_cloud_v2/api/ping_api.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
 

data/lib/rustici_software_cloud_v2/api/registration_api.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
 

data/lib/rustici_software_cloud_v2/api/reporting_api.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
 

data/lib/rustici_software_cloud_v2/api/xapi_api.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
 

data/lib/rustici_software_cloud_v2/api/zoomi_api.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
 

data/lib/rustici_software_cloud_v2/api_client.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
 

data/lib/rustici_software_cloud_v2/api_error.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
 

data/lib/rustici_software_cloud_v2/configuration.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
 
@@ -222,6 +222,13 @@ module RusticiSoftwareCloudV2
             key: 'Authorization',
             value: oauth2_token
           },
+        'UNSECURED' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
       }
     end
   end

data/lib/rustici_software_cloud_v2/models/about_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
 

data/lib/rustici_software_cloud_v2/models/activity_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
 

data/lib/rustici_software_cloud_v2/models/application_info_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
 

data/lib/rustici_software_cloud_v2/models/application_list_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
 

data/lib/rustici_software_cloud_v2/models/application_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
 

data/lib/rustici_software_cloud_v2/models/application_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
 

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

data/lib/rustici_software_cloud_v2/models/asset_file_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
 

data/lib/rustici_software_cloud_v2/models/batch_tags_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
 

data/lib/rustici_software_cloud_v2/models/comment_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
 

data/lib/rustici_software_cloud_v2/models/completion_amount_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
 

data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb

@@ -0,0 +1,188 @@
+=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
+  # List of content connectors.
+  class ConnectorListSchema
+    attr_accessor :connector_entries
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'connector_entries' => :'connectorEntries'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'connector_entries' => :'Array<ConnectorSchema>'
+      }
+    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?(:'connectorEntries')
+        if (value = attributes[:'connectorEntries']).is_a?(Array)
+          self.connector_entries = 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 &&
+          connector_entries == o.connector_entries
+    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_entries].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