ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/models/api_v3_cs_remote_achievements_detail.rb

@@ -0,0 +1,524 @@
+=begin
+#FTC Scoring Data API
+
+#THIS API IS CURRENTLY IN EARLY DEVELOPMENT AND MAY CHANGE WITHOUT WARNING. THIS PAGE WILL BE UPDATED ONCE THE API IS OFFICIALLY RELEASED.  This API provides event and scoring data for FIRST Tech Challenge. Applications that present result data directly are encouraged to directly call this API rather than maintaining their own copies of the data. All endpoints are cached by our CDN and may return data up to one hour old for data that changes infrequently. During an event, data that changes frequently (e.g. match results and rankings) should not be more than 30 seconds old.  NOTE: For developers who have integrated with the v2 API in the past, this is a policy shift, as previously developers were encouraged to maintain their own copy of relevant data. In the interest of providing the community with the most up-to-date data and reducing the burden for applications that are not performing their own analytics on event data, we are now encouraging directly integrating our API into websites and apps.  Also note that all endpoints that accept a year argument now expect the year in which the FIRST Championship for that season is held. This is a change from the previous API and FTC-events website, which used the kickoff year.  To report any issues, please report an issue here: https://github.com/FIRST-Tech-Challenge/scorekeeper/issues/new?template=api-bug-report.md To request additional data, please submit a feature request here: https://github.com/FIRST-Tech-Challenge/scorekeeper/issues/new?template=api-feature-request.md 
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.20.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FtcApiV3Client
+  class ApiV3CsRemoteAchievementsDetail < ApiModelBase
+    attr_accessor :init_team_prop
+
+    attr_accessor :robot_auto
+
+    attr_accessor :spike_mark_pixel
+
+    attr_accessor :target_backdrop_pixel
+
+    attr_accessor :auto_backdrop
+
+    attr_accessor :auto_backstage
+
+    attr_accessor :dc_backdrop
+
+    attr_accessor :dc_backstage
+
+    attr_accessor :mosaics
+
+    attr_accessor :max_set_line
+
+    attr_accessor :eg_robot
+
+    attr_accessor :drone
+
+    attr_accessor :minor_penalties
+
+    attr_accessor :major_penalties
+
+    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
+      {
+        :'init_team_prop' => :'initTeamProp',
+        :'robot_auto' => :'robotAuto',
+        :'spike_mark_pixel' => :'spikeMarkPixel',
+        :'target_backdrop_pixel' => :'targetBackdropPixel',
+        :'auto_backdrop' => :'autoBackdrop',
+        :'auto_backstage' => :'autoBackstage',
+        :'dc_backdrop' => :'dcBackdrop',
+        :'dc_backstage' => :'dcBackstage',
+        :'mosaics' => :'mosaics',
+        :'max_set_line' => :'maxSetLine',
+        :'eg_robot' => :'egRobot',
+        :'drone' => :'drone',
+        :'minor_penalties' => :'minorPenalties',
+        :'major_penalties' => :'majorPenalties'
+      }
+    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
+      {
+        :'init_team_prop' => :'Boolean',
+        :'robot_auto' => :'Boolean',
+        :'spike_mark_pixel' => :'Boolean',
+        :'target_backdrop_pixel' => :'Boolean',
+        :'auto_backdrop' => :'Integer',
+        :'auto_backstage' => :'Integer',
+        :'dc_backdrop' => :'Integer',
+        :'dc_backstage' => :'Integer',
+        :'mosaics' => :'Integer',
+        :'max_set_line' => :'Integer',
+        :'eg_robot' => :'ApiV3CsEndLocation',
+        :'drone' => :'Integer',
+        :'minor_penalties' => :'Integer',
+        :'major_penalties' => :'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 `FtcApiV3Client::ApiV3CsRemoteAchievementsDetail` 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 `FtcApiV3Client::ApiV3CsRemoteAchievementsDetail`. 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?(:'init_team_prop')
+        self.init_team_prop = attributes[:'init_team_prop']
+      else
+        self.init_team_prop = nil
+      end
+
+      if attributes.key?(:'robot_auto')
+        self.robot_auto = attributes[:'robot_auto']
+      else
+        self.robot_auto = nil
+      end
+
+      if attributes.key?(:'spike_mark_pixel')
+        self.spike_mark_pixel = attributes[:'spike_mark_pixel']
+      else
+        self.spike_mark_pixel = nil
+      end
+
+      if attributes.key?(:'target_backdrop_pixel')
+        self.target_backdrop_pixel = attributes[:'target_backdrop_pixel']
+      else
+        self.target_backdrop_pixel = nil
+      end
+
+      if attributes.key?(:'auto_backdrop')
+        self.auto_backdrop = attributes[:'auto_backdrop']
+      else
+        self.auto_backdrop = nil
+      end
+
+      if attributes.key?(:'auto_backstage')
+        self.auto_backstage = attributes[:'auto_backstage']
+      else
+        self.auto_backstage = nil
+      end
+
+      if attributes.key?(:'dc_backdrop')
+        self.dc_backdrop = attributes[:'dc_backdrop']
+      else
+        self.dc_backdrop = nil
+      end
+
+      if attributes.key?(:'dc_backstage')
+        self.dc_backstage = attributes[:'dc_backstage']
+      else
+        self.dc_backstage = nil
+      end
+
+      if attributes.key?(:'mosaics')
+        self.mosaics = attributes[:'mosaics']
+      else
+        self.mosaics = nil
+      end
+
+      if attributes.key?(:'max_set_line')
+        self.max_set_line = attributes[:'max_set_line']
+      else
+        self.max_set_line = nil
+      end
+
+      if attributes.key?(:'eg_robot')
+        self.eg_robot = attributes[:'eg_robot']
+      else
+        self.eg_robot = nil
+      end
+
+      if attributes.key?(:'drone')
+        self.drone = attributes[:'drone']
+      else
+        self.drone = nil
+      end
+
+      if attributes.key?(:'minor_penalties')
+        self.minor_penalties = attributes[:'minor_penalties']
+      else
+        self.minor_penalties = nil
+      end
+
+      if attributes.key?(:'major_penalties')
+        self.major_penalties = attributes[:'major_penalties']
+      else
+        self.major_penalties = 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 @init_team_prop.nil?
+        invalid_properties.push('invalid value for "init_team_prop", init_team_prop cannot be nil.')
+      end
+
+      if @robot_auto.nil?
+        invalid_properties.push('invalid value for "robot_auto", robot_auto cannot be nil.')
+      end
+
+      if @spike_mark_pixel.nil?
+        invalid_properties.push('invalid value for "spike_mark_pixel", spike_mark_pixel cannot be nil.')
+      end
+
+      if @target_backdrop_pixel.nil?
+        invalid_properties.push('invalid value for "target_backdrop_pixel", target_backdrop_pixel cannot be nil.')
+      end
+
+      if @auto_backdrop.nil?
+        invalid_properties.push('invalid value for "auto_backdrop", auto_backdrop cannot be nil.')
+      end
+
+      if @auto_backstage.nil?
+        invalid_properties.push('invalid value for "auto_backstage", auto_backstage cannot be nil.')
+      end
+
+      if @dc_backdrop.nil?
+        invalid_properties.push('invalid value for "dc_backdrop", dc_backdrop cannot be nil.')
+      end
+
+      if @dc_backstage.nil?
+        invalid_properties.push('invalid value for "dc_backstage", dc_backstage cannot be nil.')
+      end
+
+      if @mosaics.nil?
+        invalid_properties.push('invalid value for "mosaics", mosaics cannot be nil.')
+      end
+
+      if @max_set_line.nil?
+        invalid_properties.push('invalid value for "max_set_line", max_set_line cannot be nil.')
+      end
+
+      if @eg_robot.nil?
+        invalid_properties.push('invalid value for "eg_robot", eg_robot cannot be nil.')
+      end
+
+      if @drone.nil?
+        invalid_properties.push('invalid value for "drone", drone cannot be nil.')
+      end
+
+      if @minor_penalties.nil?
+        invalid_properties.push('invalid value for "minor_penalties", minor_penalties cannot be nil.')
+      end
+
+      if @major_penalties.nil?
+        invalid_properties.push('invalid value for "major_penalties", major_penalties 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 @init_team_prop.nil?
+      return false if @robot_auto.nil?
+      return false if @spike_mark_pixel.nil?
+      return false if @target_backdrop_pixel.nil?
+      return false if @auto_backdrop.nil?
+      return false if @auto_backstage.nil?
+      return false if @dc_backdrop.nil?
+      return false if @dc_backstage.nil?
+      return false if @mosaics.nil?
+      return false if @max_set_line.nil?
+      return false if @eg_robot.nil?
+      return false if @drone.nil?
+      return false if @minor_penalties.nil?
+      return false if @major_penalties.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] init_team_prop Value to be assigned
+    def init_team_prop=(init_team_prop)
+      if init_team_prop.nil?
+        fail ArgumentError, 'init_team_prop cannot be nil'
+      end
+
+      @init_team_prop = init_team_prop
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot_auto Value to be assigned
+    def robot_auto=(robot_auto)
+      if robot_auto.nil?
+        fail ArgumentError, 'robot_auto cannot be nil'
+      end
+
+      @robot_auto = robot_auto
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] spike_mark_pixel Value to be assigned
+    def spike_mark_pixel=(spike_mark_pixel)
+      if spike_mark_pixel.nil?
+        fail ArgumentError, 'spike_mark_pixel cannot be nil'
+      end
+
+      @spike_mark_pixel = spike_mark_pixel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_backdrop_pixel Value to be assigned
+    def target_backdrop_pixel=(target_backdrop_pixel)
+      if target_backdrop_pixel.nil?
+        fail ArgumentError, 'target_backdrop_pixel cannot be nil'
+      end
+
+      @target_backdrop_pixel = target_backdrop_pixel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_backdrop Value to be assigned
+    def auto_backdrop=(auto_backdrop)
+      if auto_backdrop.nil?
+        fail ArgumentError, 'auto_backdrop cannot be nil'
+      end
+
+      @auto_backdrop = auto_backdrop
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_backstage Value to be assigned
+    def auto_backstage=(auto_backstage)
+      if auto_backstage.nil?
+        fail ArgumentError, 'auto_backstage cannot be nil'
+      end
+
+      @auto_backstage = auto_backstage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_backdrop Value to be assigned
+    def dc_backdrop=(dc_backdrop)
+      if dc_backdrop.nil?
+        fail ArgumentError, 'dc_backdrop cannot be nil'
+      end
+
+      @dc_backdrop = dc_backdrop
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_backstage Value to be assigned
+    def dc_backstage=(dc_backstage)
+      if dc_backstage.nil?
+        fail ArgumentError, 'dc_backstage cannot be nil'
+      end
+
+      @dc_backstage = dc_backstage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mosaics Value to be assigned
+    def mosaics=(mosaics)
+      if mosaics.nil?
+        fail ArgumentError, 'mosaics cannot be nil'
+      end
+
+      @mosaics = mosaics
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_set_line Value to be assigned
+    def max_set_line=(max_set_line)
+      if max_set_line.nil?
+        fail ArgumentError, 'max_set_line cannot be nil'
+      end
+
+      @max_set_line = max_set_line
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] eg_robot Value to be assigned
+    def eg_robot=(eg_robot)
+      if eg_robot.nil?
+        fail ArgumentError, 'eg_robot cannot be nil'
+      end
+
+      @eg_robot = eg_robot
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] drone Value to be assigned
+    def drone=(drone)
+      if drone.nil?
+        fail ArgumentError, 'drone cannot be nil'
+      end
+
+      @drone = drone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] minor_penalties Value to be assigned
+    def minor_penalties=(minor_penalties)
+      if minor_penalties.nil?
+        fail ArgumentError, 'minor_penalties cannot be nil'
+      end
+
+      @minor_penalties = minor_penalties
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] major_penalties Value to be assigned
+    def major_penalties=(major_penalties)
+      if major_penalties.nil?
+        fail ArgumentError, 'major_penalties cannot be nil'
+      end
+
+      @major_penalties = major_penalties
+    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 &&
+          init_team_prop == o.init_team_prop &&
+          robot_auto == o.robot_auto &&
+          spike_mark_pixel == o.spike_mark_pixel &&
+          target_backdrop_pixel == o.target_backdrop_pixel &&
+          auto_backdrop == o.auto_backdrop &&
+          auto_backstage == o.auto_backstage &&
+          dc_backdrop == o.dc_backdrop &&
+          dc_backstage == o.dc_backstage &&
+          mosaics == o.mosaics &&
+          max_set_line == o.max_set_line &&
+          eg_robot == o.eg_robot &&
+          drone == o.drone &&
+          minor_penalties == o.minor_penalties &&
+          major_penalties == o.major_penalties
+    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
+      [init_team_prop, robot_auto, spike_mark_pixel, target_backdrop_pixel, auto_backdrop, auto_backstage, dc_backdrop, dc_backstage, mosaics, max_set_line, eg_robot, drone, minor_penalties, major_penalties].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
+
+    # 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
+
+  end
+
+end