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

data/lib/lingara/models/dialogue_turn_request.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
@@ -17,6 +17,9 @@ module Lingara
   class DialogueTurnRequest
     attr_accessor :npc
 
+    # `subtle` (the default) keeps the character's `target_lang` at or below the learner's `level`. `none` lets the character speak at its own level, as a native speaker when it has no `languages`, and ignores `level`.
+    attr_accessor :pedagogy
+
     attr_accessor :scene
 
     attr_accessor :source_lang
@@ -30,16 +33,50 @@ module Lingara
     # The conversation so far, oldest first, at most 12 lines. You keep the window: Lingara stores nothing between turns. Send each NPC reply back cut to its first 500 characters.
     attr_accessor :history
 
+    # Where the story stands: a goal the character steers toward, and the facts it may reveal. Needs `enable_npc_dialogue_graphs`.
+    attr_accessor :checkpoint
+
+    # The ways out of this checkpoint whose game conditions already hold, each with a plain-language condition. After the reply, at most one is chosen and sent as a `transition` event before `done`. Edges your game decides on its own are never sent.
+    attr_accessor :edges
+
+    attr_accessor :facts
+
+    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
       {
         :'npc' => :'npc',
+        :'pedagogy' => :'pedagogy',
         :'scene' => :'scene',
         :'source_lang' => :'source_lang',
         :'target_lang' => :'target_lang',
         :'level' => :'level',
         :'line' => :'line',
-        :'history' => :'history'
+        :'history' => :'history',
+        :'checkpoint' => :'checkpoint',
+        :'edges' => :'edges',
+        :'facts' => :'facts'
       }
     end
 
@@ -56,13 +93,17 @@ module Lingara
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'npc' => :'Npc',
+        :'npc' => :'DialogueNpc',
+        :'pedagogy' => :'Pedagogy',
         :'scene' => :'String',
         :'source_lang' => :'String',
         :'target_lang' => :'String',
         :'level' => :'Integer',
         :'line' => :'String',
-        :'history' => :'Array<DialogueEntry>'
+        :'history' => :'Array<DialogueEntry>',
+        :'checkpoint' => :'GraphCheckpoint',
+        :'edges' => :'Array<GraphEdge>',
+        :'facts' => :'Hash<String, FactValue>'
       }
     end
 
@@ -70,6 +111,7 @@ module Lingara
     def self.openapi_nullable
       Set.new([
         :'scene',
+        :'checkpoint',
       ])
     end
 
@@ -95,6 +137,10 @@ module Lingara
         self.npc = nil
       end
 
+      if attributes.key?(:'pedagogy')
+        self.pedagogy = attributes[:'pedagogy']
+      end
+
       if attributes.key?(:'scene')
         self.scene = attributes[:'scene']
       end
@@ -128,6 +174,22 @@ module Lingara
           self.history = value
         end
       end
+
+      if attributes.key?(:'checkpoint')
+        self.checkpoint = attributes[:'checkpoint']
+      end
+
+      if attributes.key?(:'edges')
+        if (value = attributes[:'edges']).is_a?(Array)
+          self.edges = value
+        end
+      end
+
+      if attributes.key?(:'facts')
+        if (value = attributes[:'facts']).is_a?(Hash)
+          self.facts = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -183,6 +245,14 @@ module Lingara
         invalid_properties.push('invalid value for "history", number of items must be less than or equal to 12.')
       end
 
+      if !@edges.nil? && @edges.length > 8
+        invalid_properties.push('invalid value for "edges", number of items must be less than or equal to 8.')
+      end
+
+      if !@facts.nil? && @facts.length > 16
+        invalid_properties.push('invalid value for "facts", number of items must be less than or equal to 16.')
+      end
+
       invalid_properties
     end
 
@@ -202,6 +272,8 @@ module Lingara
       return false if @line.to_s.length > 500
       return false if @line.to_s.length < 1
       return false if !@history.nil? && @history.length > 12
+      return false if !@edges.nil? && @edges.length > 8
+      return false if !@facts.nil? && @facts.length > 16
       true
     end
 
@@ -299,18 +371,50 @@ module Lingara
       @history = history
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] edges Value to be assigned
+    def edges=(edges)
+      if edges.nil?
+        fail ArgumentError, 'edges cannot be nil'
+      end
+
+      if edges.length > 8
+        fail ArgumentError, 'invalid value for "edges", number of items must be less than or equal to 8.'
+      end
+
+      @edges = edges
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] facts Value to be assigned
+    def facts=(facts)
+      if facts.nil?
+        fail ArgumentError, 'facts cannot be nil'
+      end
+
+      if facts.length > 16
+        fail ArgumentError, 'invalid value for "facts", number of items must be less than or equal to 16.'
+      end
+
+      @facts = facts
+    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 &&
           npc == o.npc &&
+          pedagogy == o.pedagogy &&
           scene == o.scene &&
           source_lang == o.source_lang &&
           target_lang == o.target_lang &&
           level == o.level &&
           line == o.line &&
-          history == o.history
+          history == o.history &&
+          checkpoint == o.checkpoint &&
+          edges == o.edges &&
+          facts == o.facts
     end
 
     # @see the `==` method
@@ -322,7 +426,7 @@ module Lingara
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [npc, scene, source_lang, target_lang, level, line, history].hash
+      [npc, pedagogy, scene, source_lang, target_lang, level, line, history, checkpoint, edges, facts].hash
     end
 
     # Builds the object from hash

data/lib/lingara/models/dialogue_warning.rb

@@ -0,0 +1,285 @@
+=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 DialogueWarning
+    attr_accessor :code
+
+    attr_accessor :path
+
+    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
+      {
+        :'code' => :'code',
+        :'path' => :'path'
+      }
+    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' => :'DialogueWarningCode',
+        :'path' => :'String'
+      }
+    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::DialogueWarning` 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::DialogueWarning`. 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?(:'path')
+        self.path = attributes[:'path']
+      else
+        self.path = 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 @path.nil?
+        invalid_properties.push('invalid value for "path", path cannot be nil.')
+      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 @path.nil?
+      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
+
+      @code = code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] path Value to be assigned
+    def path=(path)
+      if path.nil?
+        fail ArgumentError, 'path cannot be nil'
+      end
+
+      @path = path
+    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 &&
+          path == o.path
+    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, path].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/dialogue_warning_code.rb

@@ -0,0 +1,42 @@
+=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 DialogueWarningCode
+    CHECKPOINT_UNREACHABLE = "checkpoint_unreachable".freeze
+    OUTCOME_UNREACHABLE = "outcome_unreachable".freeze
+    PREDICATE_UNCHECKED = "predicate_unchecked".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [CHECKPOINT_UNREACHABLE, OUTCOME_UNREACHABLE, PREDICATE_UNCHECKED, 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 DialogueWarningCode.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #DialogueWarningCode"
+    end
+  end
+end

data/lib/lingara/models/embed_player_link.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/embed_token.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/embed_token_request.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/error_envelope.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
@@ -15,7 +15,7 @@ require 'time'
 
 module Lingara
   class ErrorEnvelope
-    # Why the request was refused, as a stable code to branch on: for example `insufficient_scope` (`403`), `rate_limited` (`429`) and, for a metered client, `spend_cap_reached` (`402`) and `metered_billing_inactive` (`402`).
+    # Why the request was refused, as a stable code to branch on: for example `insufficient_scope` (`403`), `rate_limited` (`429`), `api_allowance_exhausted` (`429`) and, for a metered client, `spend_cap_reached` (`402`) and `metered_billing_inactive` (`402`).
     attr_accessor :code
 
     attr_accessor :error

data/lib/lingara/models/event_envelope.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/event_page.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