lingara 0.2.0.pre.alpha.4 → 0.2.0.pre.alpha.6

data/lib/lingara/models/npc_language.rb

@@ -0,0 +1,345 @@
+=begin
+#Lingara API
+
+#Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
+
+The version of the OpenAPI document: 2026-10-simple-tarpon
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lingara
+  class NpcLanguage
+    attr_accessor :code
+
+    attr_accessor :speaking
+
+    attr_accessor :comprehension
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'speaking' => :'speaking',
+        :'comprehension' => :'comprehension'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'code' => :'String',
+        :'speaking' => :'Integer',
+        :'comprehension' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lingara::NpcLanguage` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lingara::NpcLanguage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      else
+        self.code = nil
+      end
+
+      if attributes.key?(:'speaking')
+        self.speaking = attributes[:'speaking']
+      else
+        self.speaking = nil
+      end
+
+      if attributes.key?(:'comprehension')
+        self.comprehension = attributes[:'comprehension']
+      else
+        self.comprehension = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @code.to_s.length > 16
+        invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 16.')
+      end
+
+      pattern = Regexp.new(/^[a-z]{2,3}(-[A-Za-z0-9]{2,8}){0,2}$/)
+      if @code !~ pattern
+        invalid_properties.push("invalid value for \"code\", must conform to the pattern #{pattern}.")
+      end
+
+      if @speaking.nil?
+        invalid_properties.push('invalid value for "speaking", speaking cannot be nil.')
+      end
+
+      if @speaking > 9
+        invalid_properties.push('invalid value for "speaking", must be smaller than or equal to 9.')
+      end
+
+      if @speaking < 1
+        invalid_properties.push('invalid value for "speaking", must be greater than or equal to 1.')
+      end
+
+      if @comprehension.nil?
+        invalid_properties.push('invalid value for "comprehension", comprehension cannot be nil.')
+      end
+
+      if @comprehension > 9
+        invalid_properties.push('invalid value for "comprehension", must be smaller than or equal to 9.')
+      end
+
+      if @comprehension < 1
+        invalid_properties.push('invalid value for "comprehension", must be greater than or equal to 1.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @code.nil?
+      return false if @code.to_s.length > 16
+      return false if @code !~ Regexp.new(/^[a-z]{2,3}(-[A-Za-z0-9]{2,8}){0,2}$/)
+      return false if @speaking.nil?
+      return false if @speaking > 9
+      return false if @speaking < 1
+      return false if @comprehension.nil?
+      return false if @comprehension > 9
+      return false if @comprehension < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if code.nil?
+        fail ArgumentError, 'code cannot be nil'
+      end
+
+      if code.to_s.length > 16
+        fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 16.'
+      end
+
+      pattern = Regexp.new(/^[a-z]{2,3}(-[A-Za-z0-9]{2,8}){0,2}$/)
+      if code !~ pattern
+        fail ArgumentError, "invalid value for \"code\", must conform to the pattern #{pattern}."
+      end
+
+      @code = code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] speaking Value to be assigned
+    def speaking=(speaking)
+      if speaking.nil?
+        fail ArgumentError, 'speaking cannot be nil'
+      end
+
+      if speaking > 9
+        fail ArgumentError, 'invalid value for "speaking", must be smaller than or equal to 9.'
+      end
+
+      if speaking < 1
+        fail ArgumentError, 'invalid value for "speaking", must be greater than or equal to 1.'
+      end
+
+      @speaking = speaking
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comprehension Value to be assigned
+    def comprehension=(comprehension)
+      if comprehension.nil?
+        fail ArgumentError, 'comprehension cannot be nil'
+      end
+
+      if comprehension > 9
+        fail ArgumentError, 'invalid value for "comprehension", must be smaller than or equal to 9.'
+      end
+
+      if comprehension < 1
+        fail ArgumentError, 'invalid value for "comprehension", must be greater than or equal to 1.'
+      end
+
+      @comprehension = comprehension
+    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 &&
+          code == o.code &&
+          speaking == o.speaking &&
+          comprehension == o.comprehension
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [code, speaking, comprehension].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Lingara.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/lingara/models/pedagogy.rb

@@ -0,0 +1,41 @@
+=begin
+#Lingara API
+
+#Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
+
+The version of the OpenAPI document: 2026-10-simple-tarpon
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lingara
+  class Pedagogy
+    SUBTLE = "subtle".freeze
+    NONE = "none".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [SUBTLE, NONE, UNKNOWN_DEFAULT_OPEN_API].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if Pedagogy.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #Pedagogy"
+    end
+  end
+end

data/lib/lingara/models/plan_fail_reason.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_pending.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_phase.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_question.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_ready_status.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_result.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_set.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_started.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_status.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/plan_word.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/practice_completed_data.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/practice_item.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/practice_outcome.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/reaction_report.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/lingara/models/reaction_status.rb

@@ -3,7 +3,7 @@
 
 #Generate vocabulary lists and lesson plans, and hold tutor conversations, in the languages Lingara teaches. Each call is paid for by the client that makes it: an `allowance` client spends its owner's allowance, and a `metered` client is billed for its usage.
 
-The version of the OpenAPI document: 2026-10-virile-dragon
+The version of the OpenAPI document: 2026-10-simple-tarpon
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0