lishogi 0.1.0

data/lib/lishogi/models/user_preferences.rb

@@ -0,0 +1,515 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lishogi
+  class UserPreferences
+    attr_accessor :dark
+
+    attr_accessor :transp
+
+    attr_accessor :bg_img
+
+    attr_accessor :theme
+
+    attr_accessor :piece_set
+
+    attr_accessor :sound_set
+
+    attr_accessor :blindfold
+
+    attr_accessor :takeback
+
+    attr_accessor :moretime
+
+    attr_accessor :clock_tenths
+
+    attr_accessor :clock_bar
+
+    attr_accessor :clock_sound
+
+    attr_accessor :premove
+
+    attr_accessor :animation
+
+    attr_accessor :captured
+
+    attr_accessor :follow
+
+    attr_accessor :highlight
+
+    attr_accessor :destination
+
+    attr_accessor :coords
+
+    attr_accessor :replay
+
+    attr_accessor :challenge
+
+    attr_accessor :message
+
+    attr_accessor :coord_color
+
+    attr_accessor :submit_move
+
+    attr_accessor :confirm_resign
+
+    attr_accessor :keyboard_move
+
+    attr_accessor :zen
+
+    attr_accessor :move_event
+
+    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
+      {
+        :'dark' => :'dark',
+        :'transp' => :'transp',
+        :'bg_img' => :'bgImg',
+        :'theme' => :'theme',
+        :'piece_set' => :'pieceSet',
+        :'sound_set' => :'soundSet',
+        :'blindfold' => :'blindfold',
+        :'takeback' => :'takeback',
+        :'moretime' => :'moretime',
+        :'clock_tenths' => :'clockTenths',
+        :'clock_bar' => :'clockBar',
+        :'clock_sound' => :'clockSound',
+        :'premove' => :'premove',
+        :'animation' => :'animation',
+        :'captured' => :'captured',
+        :'follow' => :'follow',
+        :'highlight' => :'highlight',
+        :'destination' => :'destination',
+        :'coords' => :'coords',
+        :'replay' => :'replay',
+        :'challenge' => :'challenge',
+        :'message' => :'message',
+        :'coord_color' => :'coordColor',
+        :'submit_move' => :'submitMove',
+        :'confirm_resign' => :'confirmResign',
+        :'keyboard_move' => :'keyboardMove',
+        :'zen' => :'zen',
+        :'move_event' => :'moveEvent'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'dark' => :'Boolean',
+        :'transp' => :'Boolean',
+        :'bg_img' => :'String',
+        :'theme' => :'String',
+        :'piece_set' => :'String',
+        :'sound_set' => :'String',
+        :'blindfold' => :'Integer',
+        :'takeback' => :'Integer',
+        :'moretime' => :'Integer',
+        :'clock_tenths' => :'Integer',
+        :'clock_bar' => :'Boolean',
+        :'clock_sound' => :'Boolean',
+        :'premove' => :'Boolean',
+        :'animation' => :'Integer',
+        :'captured' => :'Boolean',
+        :'follow' => :'Boolean',
+        :'highlight' => :'Boolean',
+        :'destination' => :'Boolean',
+        :'coords' => :'Integer',
+        :'replay' => :'Integer',
+        :'challenge' => :'Integer',
+        :'message' => :'Integer',
+        :'coord_color' => :'Integer',
+        :'submit_move' => :'Integer',
+        :'confirm_resign' => :'Integer',
+        :'keyboard_move' => :'Integer',
+        :'zen' => :'Integer',
+        :'move_event' => :'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 `Lishogi::UserPreferences` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lishogi::UserPreferences`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'dark')
+        self.dark = attributes[:'dark']
+      end
+
+      if attributes.key?(:'transp')
+        self.transp = attributes[:'transp']
+      end
+
+      if attributes.key?(:'bg_img')
+        self.bg_img = attributes[:'bg_img']
+      end
+
+      if attributes.key?(:'theme')
+        self.theme = attributes[:'theme']
+      end
+
+      if attributes.key?(:'piece_set')
+        self.piece_set = attributes[:'piece_set']
+      end
+
+      if attributes.key?(:'sound_set')
+        self.sound_set = attributes[:'sound_set']
+      end
+
+      if attributes.key?(:'blindfold')
+        self.blindfold = attributes[:'blindfold']
+      end
+
+      if attributes.key?(:'takeback')
+        self.takeback = attributes[:'takeback']
+      end
+
+      if attributes.key?(:'moretime')
+        self.moretime = attributes[:'moretime']
+      end
+
+      if attributes.key?(:'clock_tenths')
+        self.clock_tenths = attributes[:'clock_tenths']
+      end
+
+      if attributes.key?(:'clock_bar')
+        self.clock_bar = attributes[:'clock_bar']
+      end
+
+      if attributes.key?(:'clock_sound')
+        self.clock_sound = attributes[:'clock_sound']
+      end
+
+      if attributes.key?(:'premove')
+        self.premove = attributes[:'premove']
+      end
+
+      if attributes.key?(:'animation')
+        self.animation = attributes[:'animation']
+      end
+
+      if attributes.key?(:'captured')
+        self.captured = attributes[:'captured']
+      end
+
+      if attributes.key?(:'follow')
+        self.follow = attributes[:'follow']
+      end
+
+      if attributes.key?(:'highlight')
+        self.highlight = attributes[:'highlight']
+      end
+
+      if attributes.key?(:'destination')
+        self.destination = attributes[:'destination']
+      end
+
+      if attributes.key?(:'coords')
+        self.coords = attributes[:'coords']
+      end
+
+      if attributes.key?(:'replay')
+        self.replay = attributes[:'replay']
+      end
+
+      if attributes.key?(:'challenge')
+        self.challenge = attributes[:'challenge']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'coord_color')
+        self.coord_color = attributes[:'coord_color']
+      end
+
+      if attributes.key?(:'submit_move')
+        self.submit_move = attributes[:'submit_move']
+      end
+
+      if attributes.key?(:'confirm_resign')
+        self.confirm_resign = attributes[:'confirm_resign']
+      end
+
+      if attributes.key?(:'keyboard_move')
+        self.keyboard_move = attributes[:'keyboard_move']
+      end
+
+      if attributes.key?(:'zen')
+        self.zen = attributes[:'zen']
+      end
+
+      if attributes.key?(:'move_event')
+        self.move_event = attributes[:'move_event']
+      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
+      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'
+      theme_validator = EnumAttributeValidator.new('String', ["orange", "natural", "wood", "wood1", "kaya1", "kaya2", "oak", "blue", "grey", "painting1", "painting2", "kinkaku", "space", "dobutsu", "custom"])
+      return false unless theme_validator.valid?(@theme)
+      piece_set_validator = EnumAttributeValidator.new('String', ["kanji_light", "kanji_brown", "Ryoko_1Kanji", "orangain", "kanji_red_wood", "Portella", "Portella_2Kanji", "1Kanji_3D", "2Kanji_3D", "Shogi_cz", "Engraved_cz", "Kanji_Guide_Shadowed", "Valdivia", "Vald_opt", "pixel", "shogi_BnW", "Intl_Colored_2D", "Intl_Colored_3D", "Intl_Shadowed", "Intl_Monochrome_2D", "Intl_Wooden_3D", "Intl_Portella", "international", "simple_kanji", "doubutsu", "Logy_Games", "western"])
+      return false unless piece_set_validator.valid?(@piece_set)
+      sound_set_validator = EnumAttributeValidator.new('String', ["silent", "chess", "nes", "sfx", "futuristic", "robot", "music", "shogiAlt", "shogi", "speech"])
+      return false unless sound_set_validator.valid?(@sound_set)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] theme Object to be assigned
+    def theme=(theme)
+      validator = EnumAttributeValidator.new('String', ["orange", "natural", "wood", "wood1", "kaya1", "kaya2", "oak", "blue", "grey", "painting1", "painting2", "kinkaku", "space", "dobutsu", "custom"])
+      unless validator.valid?(theme)
+        fail ArgumentError, "invalid value for \"theme\", must be one of #{validator.allowable_values}."
+      end
+      @theme = theme
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] piece_set Object to be assigned
+    def piece_set=(piece_set)
+      validator = EnumAttributeValidator.new('String', ["kanji_light", "kanji_brown", "Ryoko_1Kanji", "orangain", "kanji_red_wood", "Portella", "Portella_2Kanji", "1Kanji_3D", "2Kanji_3D", "Shogi_cz", "Engraved_cz", "Kanji_Guide_Shadowed", "Valdivia", "Vald_opt", "pixel", "shogi_BnW", "Intl_Colored_2D", "Intl_Colored_3D", "Intl_Shadowed", "Intl_Monochrome_2D", "Intl_Wooden_3D", "Intl_Portella", "international", "simple_kanji", "doubutsu", "Logy_Games", "western"])
+      unless validator.valid?(piece_set)
+        fail ArgumentError, "invalid value for \"piece_set\", must be one of #{validator.allowable_values}."
+      end
+      @piece_set = piece_set
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sound_set Object to be assigned
+    def sound_set=(sound_set)
+      validator = EnumAttributeValidator.new('String', ["silent", "chess", "nes", "sfx", "futuristic", "robot", "music", "shogiAlt", "shogi", "speech"])
+      unless validator.valid?(sound_set)
+        fail ArgumentError, "invalid value for \"sound_set\", must be one of #{validator.allowable_values}."
+      end
+      @sound_set = sound_set
+    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 &&
+          dark == o.dark &&
+          transp == o.transp &&
+          bg_img == o.bg_img &&
+          theme == o.theme &&
+          piece_set == o.piece_set &&
+          sound_set == o.sound_set &&
+          blindfold == o.blindfold &&
+          takeback == o.takeback &&
+          moretime == o.moretime &&
+          clock_tenths == o.clock_tenths &&
+          clock_bar == o.clock_bar &&
+          clock_sound == o.clock_sound &&
+          premove == o.premove &&
+          animation == o.animation &&
+          captured == o.captured &&
+          follow == o.follow &&
+          highlight == o.highlight &&
+          destination == o.destination &&
+          coords == o.coords &&
+          replay == o.replay &&
+          challenge == o.challenge &&
+          message == o.message &&
+          coord_color == o.coord_color &&
+          submit_move == o.submit_move &&
+          confirm_resign == o.confirm_resign &&
+          keyboard_move == o.keyboard_move &&
+          zen == o.zen &&
+          move_event == o.move_event
+    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
+      [dark, transp, bg_img, theme, piece_set, sound_set, blindfold, takeback, moretime, clock_tenths, clock_bar, clock_sound, premove, animation, captured, follow, highlight, destination, coords, replay, challenge, message, coord_color, submit_move, confirm_resign, keyboard_move, zen, move_event].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 = Lishogi.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