lingara 0.1.0.pre.alpha.13 → 0.2.0.pre.alpha.3

data/lib/lingara/models/embed_player_link.rb

@@ -0,0 +1,427 @@
+=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-virile-dragon
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lingara
+  class EmbedPlayerLink
+    attr_accessor :status
+
+    # The account's `lgr_sub_`: what this player's events carry from now on.
+    attr_accessor :subject
+
+    # The guest's `lgr_sub_`: what the player's earlier events keep. Route both to the same `player_ref`.
+    attr_accessor :previous_subject
+
+    # When the link was made. On an `existing` answer, the first call's time.
+    attr_accessor :linked_at
+
+    # The most a token for this player can now hold: what the account granted, of the scopes a player's token can carry.
+    attr_accessor :scopes
+
+    # Rows this call moved to the account, per table. Only tables with a count appear.
+    attr_accessor :carried
+
+    # Rows this call left with the guest, per table: a plan still being written, or a row the account already had. Call again once `lesson_plans` here has a plan that has finished.
+    attr_accessor :kept
+
+    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
+      {
+        :'status' => :'status',
+        :'subject' => :'subject',
+        :'previous_subject' => :'previous_subject',
+        :'linked_at' => :'linked_at',
+        :'scopes' => :'scopes',
+        :'carried' => :'carried',
+        :'kept' => :'kept'
+      }
+    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
+      {
+        :'status' => :'LinkStatus',
+        :'subject' => :'String',
+        :'previous_subject' => :'String',
+        :'linked_at' => :'Time',
+        :'scopes' => :'Array<String>',
+        :'carried' => :'Hash<String, Integer>',
+        :'kept' => :'Hash<String, 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::EmbedPlayerLink` 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::EmbedPlayerLink`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      else
+        self.subject = nil
+      end
+
+      if attributes.key?(:'previous_subject')
+        self.previous_subject = attributes[:'previous_subject']
+      else
+        self.previous_subject = nil
+      end
+
+      if attributes.key?(:'linked_at')
+        self.linked_at = attributes[:'linked_at']
+      else
+        self.linked_at = nil
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = value
+        end
+      else
+        self.scopes = nil
+      end
+
+      if attributes.key?(:'carried')
+        if (value = attributes[:'carried']).is_a?(Hash)
+          self.carried = value
+        end
+      else
+        self.carried = nil
+      end
+
+      if attributes.key?(:'kept')
+        if (value = attributes[:'kept']).is_a?(Hash)
+          self.kept = value
+        end
+      else
+        self.kept = 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 @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @subject.nil?
+        invalid_properties.push('invalid value for "subject", subject cannot be nil.')
+      end
+
+      if @previous_subject.nil?
+        invalid_properties.push('invalid value for "previous_subject", previous_subject cannot be nil.')
+      end
+
+      if @linked_at.nil?
+        invalid_properties.push('invalid value for "linked_at", linked_at cannot be nil.')
+      end
+
+      if @scopes.nil?
+        invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
+      end
+
+      if @carried.nil?
+        invalid_properties.push('invalid value for "carried", carried cannot be nil.')
+      end
+
+      if @kept.nil?
+        invalid_properties.push('invalid value for "kept", kept 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 @status.nil?
+      return false if @subject.nil?
+      return false if @previous_subject.nil?
+      return false if @linked_at.nil?
+      return false if @scopes.nil?
+      return false if @carried.nil?
+      return false if @kept.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject Value to be assigned
+    def subject=(subject)
+      if subject.nil?
+        fail ArgumentError, 'subject cannot be nil'
+      end
+
+      @subject = subject
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] previous_subject Value to be assigned
+    def previous_subject=(previous_subject)
+      if previous_subject.nil?
+        fail ArgumentError, 'previous_subject cannot be nil'
+      end
+
+      @previous_subject = previous_subject
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] linked_at Value to be assigned
+    def linked_at=(linked_at)
+      if linked_at.nil?
+        fail ArgumentError, 'linked_at cannot be nil'
+      end
+
+      @linked_at = linked_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scopes Value to be assigned
+    def scopes=(scopes)
+      if scopes.nil?
+        fail ArgumentError, 'scopes cannot be nil'
+      end
+
+      @scopes = scopes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] carried Value to be assigned
+    def carried=(carried)
+      if carried.nil?
+        fail ArgumentError, 'carried cannot be nil'
+      end
+
+      @carried = carried
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kept Value to be assigned
+    def kept=(kept)
+      if kept.nil?
+        fail ArgumentError, 'kept cannot be nil'
+      end
+
+      @kept = kept
+    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 &&
+          status == o.status &&
+          subject == o.subject &&
+          previous_subject == o.previous_subject &&
+          linked_at == o.linked_at &&
+          scopes == o.scopes &&
+          carried == o.carried &&
+          kept == o.kept
+    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
+      [status, subject, previous_subject, linked_at, scopes, carried, kept].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