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

data/lib/lingara/models/canvas_definition.rb

@@ -0,0 +1,323 @@
+=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
+  # A canvas: its nodes and the edges between them. `fields` is the editor's own state; the dry-run, not this schema, judges content.
+  class CanvasDefinition
+    attr_accessor :schema
+
+    attr_accessor :nodes
+
+    attr_accessor :edges
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'schema' => :'schema',
+        :'nodes' => :'nodes',
+        :'edges' => :'edges'
+      }
+    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
+      {
+        :'schema' => :'Integer',
+        :'nodes' => :'Array<CanvasNode>',
+        :'edges' => :'Array<CanvasEdge>'
+      }
+    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::CanvasDefinition` 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::CanvasDefinition`. 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?(:'schema')
+        self.schema = attributes[:'schema']
+      else
+        self.schema = nil
+      end
+
+      if attributes.key?(:'nodes')
+        if (value = attributes[:'nodes']).is_a?(Array)
+          self.nodes = value
+        end
+      else
+        self.nodes = nil
+      end
+
+      if attributes.key?(:'edges')
+        if (value = attributes[:'edges']).is_a?(Array)
+          self.edges = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @schema.nil?
+        invalid_properties.push('invalid value for "schema", schema cannot be nil.')
+      end
+
+      if @schema > 32767
+        invalid_properties.push('invalid value for "schema", must be smaller than or equal to 32767.')
+      end
+
+      if @schema < 1
+        invalid_properties.push('invalid value for "schema", must be greater than or equal to 1.')
+      end
+
+      if @nodes.nil?
+        invalid_properties.push('invalid value for "nodes", nodes cannot be nil.')
+      end
+
+      if @nodes.length > 32
+        invalid_properties.push('invalid value for "nodes", number of items must be less than or equal to 32.')
+      end
+
+      if !@edges.nil? && @edges.length > 64
+        invalid_properties.push('invalid value for "edges", number of items must be less than or equal to 64.')
+      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 @schema.nil?
+      return false if @schema > 32767
+      return false if @schema < 1
+      return false if @nodes.nil?
+      return false if @nodes.length > 32
+      return false if !@edges.nil? && @edges.length > 64
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] schema Value to be assigned
+    def schema=(schema)
+      if schema.nil?
+        fail ArgumentError, 'schema cannot be nil'
+      end
+
+      if schema > 32767
+        fail ArgumentError, 'invalid value for "schema", must be smaller than or equal to 32767.'
+      end
+
+      if schema < 1
+        fail ArgumentError, 'invalid value for "schema", must be greater than or equal to 1.'
+      end
+
+      @schema = schema
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] nodes Value to be assigned
+    def nodes=(nodes)
+      if nodes.nil?
+        fail ArgumentError, 'nodes cannot be nil'
+      end
+
+      if nodes.length > 32
+        fail ArgumentError, 'invalid value for "nodes", number of items must be less than or equal to 32.'
+      end
+
+      @nodes = nodes
+    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 > 64
+        fail ArgumentError, 'invalid value for "edges", number of items must be less than or equal to 64.'
+      end
+
+      @edges = edges
+    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 &&
+          schema == o.schema &&
+          nodes == o.nodes &&
+          edges == o.edges
+    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
+      [schema, nodes, edges].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/canvas_draft.rb

@@ -0,0 +1,317 @@
+=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 CanvasDraft
+    attr_accessor :revision
+
+    attr_accessor :draft_version
+
+    attr_accessor :definition
+
+    attr_accessor :objects
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'revision' => :'revision',
+        :'draft_version' => :'draft_version',
+        :'definition' => :'definition',
+        :'objects' => :'objects'
+      }
+    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
+      {
+        :'revision' => :'Integer',
+        :'draft_version' => :'Integer',
+        :'definition' => :'CanvasDefinition',
+        :'objects' => :'Hash<String, CanvasObjectRef>'
+      }
+    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::CanvasDraft` 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::CanvasDraft`. 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?(:'revision')
+        self.revision = attributes[:'revision']
+      else
+        self.revision = nil
+      end
+
+      if attributes.key?(:'draft_version')
+        self.draft_version = attributes[:'draft_version']
+      else
+        self.draft_version = nil
+      end
+
+      if attributes.key?(:'definition')
+        self.definition = attributes[:'definition']
+      else
+        self.definition = nil
+      end
+
+      if attributes.key?(:'objects')
+        if (value = attributes[:'objects']).is_a?(Hash)
+          self.objects = value
+        end
+      else
+        self.objects = 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 @revision.nil?
+        invalid_properties.push('invalid value for "revision", revision cannot be nil.')
+      end
+
+      if @draft_version.nil?
+        invalid_properties.push('invalid value for "draft_version", draft_version cannot be nil.')
+      end
+
+      if @definition.nil?
+        invalid_properties.push('invalid value for "definition", definition cannot be nil.')
+      end
+
+      if @objects.nil?
+        invalid_properties.push('invalid value for "objects", objects 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 @revision.nil?
+      return false if @draft_version.nil?
+      return false if @definition.nil?
+      return false if @objects.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] revision Value to be assigned
+    def revision=(revision)
+      if revision.nil?
+        fail ArgumentError, 'revision cannot be nil'
+      end
+
+      @revision = revision
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] draft_version Value to be assigned
+    def draft_version=(draft_version)
+      if draft_version.nil?
+        fail ArgumentError, 'draft_version cannot be nil'
+      end
+
+      @draft_version = draft_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] definition Value to be assigned
+    def definition=(definition)
+      if definition.nil?
+        fail ArgumentError, 'definition cannot be nil'
+      end
+
+      @definition = definition
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] objects Value to be assigned
+    def objects=(objects)
+      if objects.nil?
+        fail ArgumentError, 'objects cannot be nil'
+      end
+
+      @objects = objects
+    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 &&
+          revision == o.revision &&
+          draft_version == o.draft_version &&
+          definition == o.definition &&
+          objects == o.objects
+    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
+      [revision, draft_version, definition, objects].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