ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/models/api_v3_skystone_achievements_detail.rb

@@ -0,0 +1,634 @@
+=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 ApiV3SkystoneAchievementsDetail < ApiModelBase
+    attr_accessor :robot1_navigated
+
+    attr_accessor :robot2_navigated
+
+    attr_accessor :auto_stones
+
+    attr_accessor :auto_delivered
+
+    attr_accessor :auto_returned
+
+    attr_accessor :auto_placed
+
+    attr_accessor :first_returned_is_skystone
+
+    attr_accessor :foundation_repositioned
+
+    attr_accessor :driver_controlled_delivered
+
+    attr_accessor :driver_controlled_returned
+
+    attr_accessor :driver_controlled_placed
+
+    attr_accessor :tallest_skyscraper
+
+    attr_accessor :robot1_parked
+
+    attr_accessor :robot2_parked
+
+    attr_accessor :robot1_capstone_level
+
+    attr_accessor :robot2_capstone_level
+
+    attr_accessor :foundation_moved
+
+    attr_accessor :minor_penalties
+
+    attr_accessor :major_penalties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'robot1_navigated' => :'robot1Navigated',
+        :'robot2_navigated' => :'robot2Navigated',
+        :'auto_stones' => :'autoStones',
+        :'auto_delivered' => :'autoDelivered',
+        :'auto_returned' => :'autoReturned',
+        :'auto_placed' => :'autoPlaced',
+        :'first_returned_is_skystone' => :'firstReturnedIsSkystone',
+        :'foundation_repositioned' => :'foundationRepositioned',
+        :'driver_controlled_delivered' => :'driverControlledDelivered',
+        :'driver_controlled_returned' => :'driverControlledReturned',
+        :'driver_controlled_placed' => :'driverControlledPlaced',
+        :'tallest_skyscraper' => :'tallestSkyscraper',
+        :'robot1_parked' => :'robot1Parked',
+        :'robot2_parked' => :'robot2Parked',
+        :'robot1_capstone_level' => :'robot1CapstoneLevel',
+        :'robot2_capstone_level' => :'robot2CapstoneLevel',
+        :'foundation_moved' => :'foundationMoved',
+        :'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
+      {
+        :'robot1_navigated' => :'Boolean',
+        :'robot2_navigated' => :'Boolean',
+        :'auto_stones' => :'Array<ApiV3Stone>',
+        :'auto_delivered' => :'Integer',
+        :'auto_returned' => :'Integer',
+        :'auto_placed' => :'Integer',
+        :'first_returned_is_skystone' => :'Boolean',
+        :'foundation_repositioned' => :'Boolean',
+        :'driver_controlled_delivered' => :'Integer',
+        :'driver_controlled_returned' => :'Integer',
+        :'driver_controlled_placed' => :'Integer',
+        :'tallest_skyscraper' => :'Integer',
+        :'robot1_parked' => :'Boolean',
+        :'robot2_parked' => :'Boolean',
+        :'robot1_capstone_level' => :'Integer',
+        :'robot2_capstone_level' => :'Integer',
+        :'foundation_moved' => :'Boolean',
+        :'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::ApiV3SkystoneAchievementsDetail` 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::ApiV3SkystoneAchievementsDetail`. 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?(:'robot1_navigated')
+        self.robot1_navigated = attributes[:'robot1_navigated']
+      else
+        self.robot1_navigated = nil
+      end
+
+      if attributes.key?(:'robot2_navigated')
+        self.robot2_navigated = attributes[:'robot2_navigated']
+      else
+        self.robot2_navigated = nil
+      end
+
+      if attributes.key?(:'auto_stones')
+        if (value = attributes[:'auto_stones']).is_a?(Array)
+          self.auto_stones = value
+        end
+      else
+        self.auto_stones = nil
+      end
+
+      if attributes.key?(:'auto_delivered')
+        self.auto_delivered = attributes[:'auto_delivered']
+      else
+        self.auto_delivered = nil
+      end
+
+      if attributes.key?(:'auto_returned')
+        self.auto_returned = attributes[:'auto_returned']
+      else
+        self.auto_returned = nil
+      end
+
+      if attributes.key?(:'auto_placed')
+        self.auto_placed = attributes[:'auto_placed']
+      else
+        self.auto_placed = nil
+      end
+
+      if attributes.key?(:'first_returned_is_skystone')
+        self.first_returned_is_skystone = attributes[:'first_returned_is_skystone']
+      else
+        self.first_returned_is_skystone = nil
+      end
+
+      if attributes.key?(:'foundation_repositioned')
+        self.foundation_repositioned = attributes[:'foundation_repositioned']
+      else
+        self.foundation_repositioned = nil
+      end
+
+      if attributes.key?(:'driver_controlled_delivered')
+        self.driver_controlled_delivered = attributes[:'driver_controlled_delivered']
+      else
+        self.driver_controlled_delivered = nil
+      end
+
+      if attributes.key?(:'driver_controlled_returned')
+        self.driver_controlled_returned = attributes[:'driver_controlled_returned']
+      else
+        self.driver_controlled_returned = nil
+      end
+
+      if attributes.key?(:'driver_controlled_placed')
+        self.driver_controlled_placed = attributes[:'driver_controlled_placed']
+      else
+        self.driver_controlled_placed = nil
+      end
+
+      if attributes.key?(:'tallest_skyscraper')
+        self.tallest_skyscraper = attributes[:'tallest_skyscraper']
+      else
+        self.tallest_skyscraper = nil
+      end
+
+      if attributes.key?(:'robot1_parked')
+        self.robot1_parked = attributes[:'robot1_parked']
+      else
+        self.robot1_parked = nil
+      end
+
+      if attributes.key?(:'robot2_parked')
+        self.robot2_parked = attributes[:'robot2_parked']
+      else
+        self.robot2_parked = nil
+      end
+
+      if attributes.key?(:'robot1_capstone_level')
+        self.robot1_capstone_level = attributes[:'robot1_capstone_level']
+      else
+        self.robot1_capstone_level = nil
+      end
+
+      if attributes.key?(:'robot2_capstone_level')
+        self.robot2_capstone_level = attributes[:'robot2_capstone_level']
+      else
+        self.robot2_capstone_level = nil
+      end
+
+      if attributes.key?(:'foundation_moved')
+        self.foundation_moved = attributes[:'foundation_moved']
+      else
+        self.foundation_moved = 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 @robot1_navigated.nil?
+        invalid_properties.push('invalid value for "robot1_navigated", robot1_navigated cannot be nil.')
+      end
+
+      if @robot2_navigated.nil?
+        invalid_properties.push('invalid value for "robot2_navigated", robot2_navigated cannot be nil.')
+      end
+
+      if @auto_stones.nil?
+        invalid_properties.push('invalid value for "auto_stones", auto_stones cannot be nil.')
+      end
+
+      if @auto_delivered.nil?
+        invalid_properties.push('invalid value for "auto_delivered", auto_delivered cannot be nil.')
+      end
+
+      if @auto_returned.nil?
+        invalid_properties.push('invalid value for "auto_returned", auto_returned cannot be nil.')
+      end
+
+      if @auto_placed.nil?
+        invalid_properties.push('invalid value for "auto_placed", auto_placed cannot be nil.')
+      end
+
+      if @first_returned_is_skystone.nil?
+        invalid_properties.push('invalid value for "first_returned_is_skystone", first_returned_is_skystone cannot be nil.')
+      end
+
+      if @foundation_repositioned.nil?
+        invalid_properties.push('invalid value for "foundation_repositioned", foundation_repositioned cannot be nil.')
+      end
+
+      if @driver_controlled_delivered.nil?
+        invalid_properties.push('invalid value for "driver_controlled_delivered", driver_controlled_delivered cannot be nil.')
+      end
+
+      if @driver_controlled_returned.nil?
+        invalid_properties.push('invalid value for "driver_controlled_returned", driver_controlled_returned cannot be nil.')
+      end
+
+      if @driver_controlled_placed.nil?
+        invalid_properties.push('invalid value for "driver_controlled_placed", driver_controlled_placed cannot be nil.')
+      end
+
+      if @tallest_skyscraper.nil?
+        invalid_properties.push('invalid value for "tallest_skyscraper", tallest_skyscraper cannot be nil.')
+      end
+
+      if @robot1_parked.nil?
+        invalid_properties.push('invalid value for "robot1_parked", robot1_parked cannot be nil.')
+      end
+
+      if @robot2_parked.nil?
+        invalid_properties.push('invalid value for "robot2_parked", robot2_parked cannot be nil.')
+      end
+
+      if @robot1_capstone_level.nil?
+        invalid_properties.push('invalid value for "robot1_capstone_level", robot1_capstone_level cannot be nil.')
+      end
+
+      if @robot2_capstone_level.nil?
+        invalid_properties.push('invalid value for "robot2_capstone_level", robot2_capstone_level cannot be nil.')
+      end
+
+      if @foundation_moved.nil?
+        invalid_properties.push('invalid value for "foundation_moved", foundation_moved 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 @robot1_navigated.nil?
+      return false if @robot2_navigated.nil?
+      return false if @auto_stones.nil?
+      return false if @auto_delivered.nil?
+      return false if @auto_returned.nil?
+      return false if @auto_placed.nil?
+      return false if @first_returned_is_skystone.nil?
+      return false if @foundation_repositioned.nil?
+      return false if @driver_controlled_delivered.nil?
+      return false if @driver_controlled_returned.nil?
+      return false if @driver_controlled_placed.nil?
+      return false if @tallest_skyscraper.nil?
+      return false if @robot1_parked.nil?
+      return false if @robot2_parked.nil?
+      return false if @robot1_capstone_level.nil?
+      return false if @robot2_capstone_level.nil?
+      return false if @foundation_moved.nil?
+      return false if @minor_penalties.nil?
+      return false if @major_penalties.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot1_navigated Value to be assigned
+    def robot1_navigated=(robot1_navigated)
+      if robot1_navigated.nil?
+        fail ArgumentError, 'robot1_navigated cannot be nil'
+      end
+
+      @robot1_navigated = robot1_navigated
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot2_navigated Value to be assigned
+    def robot2_navigated=(robot2_navigated)
+      if robot2_navigated.nil?
+        fail ArgumentError, 'robot2_navigated cannot be nil'
+      end
+
+      @robot2_navigated = robot2_navigated
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_stones Value to be assigned
+    def auto_stones=(auto_stones)
+      if auto_stones.nil?
+        fail ArgumentError, 'auto_stones cannot be nil'
+      end
+
+      @auto_stones = auto_stones
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_delivered Value to be assigned
+    def auto_delivered=(auto_delivered)
+      if auto_delivered.nil?
+        fail ArgumentError, 'auto_delivered cannot be nil'
+      end
+
+      @auto_delivered = auto_delivered
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_returned Value to be assigned
+    def auto_returned=(auto_returned)
+      if auto_returned.nil?
+        fail ArgumentError, 'auto_returned cannot be nil'
+      end
+
+      @auto_returned = auto_returned
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_placed Value to be assigned
+    def auto_placed=(auto_placed)
+      if auto_placed.nil?
+        fail ArgumentError, 'auto_placed cannot be nil'
+      end
+
+      @auto_placed = auto_placed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_returned_is_skystone Value to be assigned
+    def first_returned_is_skystone=(first_returned_is_skystone)
+      if first_returned_is_skystone.nil?
+        fail ArgumentError, 'first_returned_is_skystone cannot be nil'
+      end
+
+      @first_returned_is_skystone = first_returned_is_skystone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] foundation_repositioned Value to be assigned
+    def foundation_repositioned=(foundation_repositioned)
+      if foundation_repositioned.nil?
+        fail ArgumentError, 'foundation_repositioned cannot be nil'
+      end
+
+      @foundation_repositioned = foundation_repositioned
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] driver_controlled_delivered Value to be assigned
+    def driver_controlled_delivered=(driver_controlled_delivered)
+      if driver_controlled_delivered.nil?
+        fail ArgumentError, 'driver_controlled_delivered cannot be nil'
+      end
+
+      @driver_controlled_delivered = driver_controlled_delivered
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] driver_controlled_returned Value to be assigned
+    def driver_controlled_returned=(driver_controlled_returned)
+      if driver_controlled_returned.nil?
+        fail ArgumentError, 'driver_controlled_returned cannot be nil'
+      end
+
+      @driver_controlled_returned = driver_controlled_returned
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] driver_controlled_placed Value to be assigned
+    def driver_controlled_placed=(driver_controlled_placed)
+      if driver_controlled_placed.nil?
+        fail ArgumentError, 'driver_controlled_placed cannot be nil'
+      end
+
+      @driver_controlled_placed = driver_controlled_placed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tallest_skyscraper Value to be assigned
+    def tallest_skyscraper=(tallest_skyscraper)
+      if tallest_skyscraper.nil?
+        fail ArgumentError, 'tallest_skyscraper cannot be nil'
+      end
+
+      @tallest_skyscraper = tallest_skyscraper
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot1_parked Value to be assigned
+    def robot1_parked=(robot1_parked)
+      if robot1_parked.nil?
+        fail ArgumentError, 'robot1_parked cannot be nil'
+      end
+
+      @robot1_parked = robot1_parked
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot2_parked Value to be assigned
+    def robot2_parked=(robot2_parked)
+      if robot2_parked.nil?
+        fail ArgumentError, 'robot2_parked cannot be nil'
+      end
+
+      @robot2_parked = robot2_parked
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot1_capstone_level Value to be assigned
+    def robot1_capstone_level=(robot1_capstone_level)
+      if robot1_capstone_level.nil?
+        fail ArgumentError, 'robot1_capstone_level cannot be nil'
+      end
+
+      @robot1_capstone_level = robot1_capstone_level
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] robot2_capstone_level Value to be assigned
+    def robot2_capstone_level=(robot2_capstone_level)
+      if robot2_capstone_level.nil?
+        fail ArgumentError, 'robot2_capstone_level cannot be nil'
+      end
+
+      @robot2_capstone_level = robot2_capstone_level
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] foundation_moved Value to be assigned
+    def foundation_moved=(foundation_moved)
+      if foundation_moved.nil?
+        fail ArgumentError, 'foundation_moved cannot be nil'
+      end
+
+      @foundation_moved = foundation_moved
+    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 &&
+          robot1_navigated == o.robot1_navigated &&
+          robot2_navigated == o.robot2_navigated &&
+          auto_stones == o.auto_stones &&
+          auto_delivered == o.auto_delivered &&
+          auto_returned == o.auto_returned &&
+          auto_placed == o.auto_placed &&
+          first_returned_is_skystone == o.first_returned_is_skystone &&
+          foundation_repositioned == o.foundation_repositioned &&
+          driver_controlled_delivered == o.driver_controlled_delivered &&
+          driver_controlled_returned == o.driver_controlled_returned &&
+          driver_controlled_placed == o.driver_controlled_placed &&
+          tallest_skyscraper == o.tallest_skyscraper &&
+          robot1_parked == o.robot1_parked &&
+          robot2_parked == o.robot2_parked &&
+          robot1_capstone_level == o.robot1_capstone_level &&
+          robot2_capstone_level == o.robot2_capstone_level &&
+          foundation_moved == o.foundation_moved &&
+          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
+      [robot1_navigated, robot2_navigated, auto_stones, auto_delivered, auto_returned, auto_placed, first_returned_is_skystone, foundation_repositioned, driver_controlled_delivered, driver_controlled_returned, driver_controlled_placed, tallest_skyscraper, robot1_parked, robot2_parked, robot1_capstone_level, robot2_capstone_level, foundation_moved, 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