ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/models/api_v3_power_play_remote_achievements_detail.rb

@@ -0,0 +1,538 @@
+=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 ApiV3PowerPlayRemoteAchievementsDetail < ApiModelBase
+    attr_accessor :robot_auto
+
+    attr_accessor :auto_terminal_near
+
+    attr_accessor :auto_terminal_far
+
+    attr_accessor :dc_terminal_near
+
+    attr_accessor :dc_terminal_far
+
+    attr_accessor :eg_navigated
+
+    attr_accessor :minor_penalties
+
+    attr_accessor :major_penalties
+
+    attr_accessor :beacons
+
+    attr_accessor :owned_junctions
+
+    attr_accessor :circuit
+
+    # Indicates if team used a team-supplied signal sleave
+    attr_accessor :init_signal_sleeve
+
+    # Two dimensional array of lists of items scored on junctions in autonomous. [0,0] is the upper-left corner of the field as viewed from the audience side of the field. The array is indexed by row, then column. (e.g [0,2] is in the upper right corner of the field.) Each junction is stored bottom up (index 0 is the bottom-most element on the field).
+    attr_accessor :auto_junctions
+
+    # Two dimensional array of lists of items scored on junctions in driver-controlled. [0,0] is the upper-left corner of the field as viewed from the audience side of the field. The array is indexed by crow, then column. (e.g [0,2] is in the upper right corner of the field.) Each junction is stored bottom up (index 0 is the bottom-most element on the field).
+    attr_accessor :dc_junctions
+
+    # Array of 4 cone counts scored by this alliance on ground, low, medium, and high junctions respectively, scored in autonomous. E.g. red.autoJunctionCones[2] is the total number of cones scored by red on medium-height junctions.
+    attr_accessor :auto_junction_cones
+
+    # Array of 4 cone counts scored by this alliance on ground, low, medium, and high junctions respectively, scored in driver-controlled. E.g. red.dcJunctionCones[2] is the total number of cones scored by red on medium-height junctions.
+    attr_accessor :dc_junction_cones
+
+    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
+      {
+        :'robot_auto' => :'robotAuto',
+        :'auto_terminal_near' => :'autoTerminalNear',
+        :'auto_terminal_far' => :'autoTerminalFar',
+        :'dc_terminal_near' => :'dcTerminalNear',
+        :'dc_terminal_far' => :'dcTerminalFar',
+        :'eg_navigated' => :'egNavigated',
+        :'minor_penalties' => :'minorPenalties',
+        :'major_penalties' => :'majorPenalties',
+        :'beacons' => :'beacons',
+        :'owned_junctions' => :'ownedJunctions',
+        :'circuit' => :'circuit',
+        :'init_signal_sleeve' => :'initSignalSleeve',
+        :'auto_junctions' => :'autoJunctions',
+        :'dc_junctions' => :'dcJunctions',
+        :'auto_junction_cones' => :'autoJunctionCones',
+        :'dc_junction_cones' => :'dcJunctionCones'
+      }
+    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
+      {
+        :'robot_auto' => :'ApiV3PowerPlayAutoLocation',
+        :'auto_terminal_near' => :'Integer',
+        :'auto_terminal_far' => :'Integer',
+        :'dc_terminal_near' => :'Integer',
+        :'dc_terminal_far' => :'Integer',
+        :'eg_navigated' => :'Boolean',
+        :'minor_penalties' => :'Integer',
+        :'major_penalties' => :'Integer',
+        :'beacons' => :'Integer',
+        :'owned_junctions' => :'Integer',
+        :'circuit' => :'Boolean',
+        :'init_signal_sleeve' => :'Boolean',
+        :'auto_junctions' => :'Array<ApiV3RemoteJunctionElement>',
+        :'dc_junctions' => :'Array<ApiV3RemoteJunctionElement>',
+        :'auto_junction_cones' => :'Array<Integer>',
+        :'dc_junction_cones' => :'Array<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::ApiV3PowerPlayRemoteAchievementsDetail` 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::ApiV3PowerPlayRemoteAchievementsDetail`. 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?(:'robot_auto')
+        self.robot_auto = attributes[:'robot_auto']
+      end
+
+      if attributes.key?(:'auto_terminal_near')
+        self.auto_terminal_near = attributes[:'auto_terminal_near']
+      else
+        self.auto_terminal_near = nil
+      end
+
+      if attributes.key?(:'auto_terminal_far')
+        self.auto_terminal_far = attributes[:'auto_terminal_far']
+      else
+        self.auto_terminal_far = nil
+      end
+
+      if attributes.key?(:'dc_terminal_near')
+        self.dc_terminal_near = attributes[:'dc_terminal_near']
+      else
+        self.dc_terminal_near = nil
+      end
+
+      if attributes.key?(:'dc_terminal_far')
+        self.dc_terminal_far = attributes[:'dc_terminal_far']
+      else
+        self.dc_terminal_far = nil
+      end
+
+      if attributes.key?(:'eg_navigated')
+        self.eg_navigated = attributes[:'eg_navigated']
+      else
+        self.eg_navigated = 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
+
+      if attributes.key?(:'beacons')
+        self.beacons = attributes[:'beacons']
+      else
+        self.beacons = nil
+      end
+
+      if attributes.key?(:'owned_junctions')
+        self.owned_junctions = attributes[:'owned_junctions']
+      else
+        self.owned_junctions = nil
+      end
+
+      if attributes.key?(:'circuit')
+        self.circuit = attributes[:'circuit']
+      else
+        self.circuit = nil
+      end
+
+      if attributes.key?(:'init_signal_sleeve')
+        self.init_signal_sleeve = attributes[:'init_signal_sleeve']
+      else
+        self.init_signal_sleeve = nil
+      end
+
+      if attributes.key?(:'auto_junctions')
+        if (value = attributes[:'auto_junctions']).is_a?(Array)
+          self.auto_junctions = value
+        end
+      else
+        self.auto_junctions = nil
+      end
+
+      if attributes.key?(:'dc_junctions')
+        if (value = attributes[:'dc_junctions']).is_a?(Array)
+          self.dc_junctions = value
+        end
+      else
+        self.dc_junctions = nil
+      end
+
+      if attributes.key?(:'auto_junction_cones')
+        if (value = attributes[:'auto_junction_cones']).is_a?(Array)
+          self.auto_junction_cones = value
+        end
+      end
+
+      if attributes.key?(:'dc_junction_cones')
+        if (value = attributes[:'dc_junction_cones']).is_a?(Array)
+          self.dc_junction_cones = 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 @auto_terminal_near.nil?
+        invalid_properties.push('invalid value for "auto_terminal_near", auto_terminal_near cannot be nil.')
+      end
+
+      if @auto_terminal_far.nil?
+        invalid_properties.push('invalid value for "auto_terminal_far", auto_terminal_far cannot be nil.')
+      end
+
+      if @dc_terminal_near.nil?
+        invalid_properties.push('invalid value for "dc_terminal_near", dc_terminal_near cannot be nil.')
+      end
+
+      if @dc_terminal_far.nil?
+        invalid_properties.push('invalid value for "dc_terminal_far", dc_terminal_far cannot be nil.')
+      end
+
+      if @eg_navigated.nil?
+        invalid_properties.push('invalid value for "eg_navigated", eg_navigated 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
+
+      if @beacons.nil?
+        invalid_properties.push('invalid value for "beacons", beacons cannot be nil.')
+      end
+
+      if @owned_junctions.nil?
+        invalid_properties.push('invalid value for "owned_junctions", owned_junctions cannot be nil.')
+      end
+
+      if @circuit.nil?
+        invalid_properties.push('invalid value for "circuit", circuit cannot be nil.')
+      end
+
+      if @init_signal_sleeve.nil?
+        invalid_properties.push('invalid value for "init_signal_sleeve", init_signal_sleeve cannot be nil.')
+      end
+
+      if @auto_junctions.nil?
+        invalid_properties.push('invalid value for "auto_junctions", auto_junctions cannot be nil.')
+      end
+
+      if @dc_junctions.nil?
+        invalid_properties.push('invalid value for "dc_junctions", dc_junctions 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 @auto_terminal_near.nil?
+      return false if @auto_terminal_far.nil?
+      return false if @dc_terminal_near.nil?
+      return false if @dc_terminal_far.nil?
+      return false if @eg_navigated.nil?
+      return false if @minor_penalties.nil?
+      return false if @major_penalties.nil?
+      return false if @beacons.nil?
+      return false if @owned_junctions.nil?
+      return false if @circuit.nil?
+      return false if @init_signal_sleeve.nil?
+      return false if @auto_junctions.nil?
+      return false if @dc_junctions.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_terminal_near Value to be assigned
+    def auto_terminal_near=(auto_terminal_near)
+      if auto_terminal_near.nil?
+        fail ArgumentError, 'auto_terminal_near cannot be nil'
+      end
+
+      @auto_terminal_near = auto_terminal_near
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_terminal_far Value to be assigned
+    def auto_terminal_far=(auto_terminal_far)
+      if auto_terminal_far.nil?
+        fail ArgumentError, 'auto_terminal_far cannot be nil'
+      end
+
+      @auto_terminal_far = auto_terminal_far
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_terminal_near Value to be assigned
+    def dc_terminal_near=(dc_terminal_near)
+      if dc_terminal_near.nil?
+        fail ArgumentError, 'dc_terminal_near cannot be nil'
+      end
+
+      @dc_terminal_near = dc_terminal_near
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_terminal_far Value to be assigned
+    def dc_terminal_far=(dc_terminal_far)
+      if dc_terminal_far.nil?
+        fail ArgumentError, 'dc_terminal_far cannot be nil'
+      end
+
+      @dc_terminal_far = dc_terminal_far
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] eg_navigated Value to be assigned
+    def eg_navigated=(eg_navigated)
+      if eg_navigated.nil?
+        fail ArgumentError, 'eg_navigated cannot be nil'
+      end
+
+      @eg_navigated = eg_navigated
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] beacons Value to be assigned
+    def beacons=(beacons)
+      if beacons.nil?
+        fail ArgumentError, 'beacons cannot be nil'
+      end
+
+      @beacons = beacons
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owned_junctions Value to be assigned
+    def owned_junctions=(owned_junctions)
+      if owned_junctions.nil?
+        fail ArgumentError, 'owned_junctions cannot be nil'
+      end
+
+      @owned_junctions = owned_junctions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] circuit Value to be assigned
+    def circuit=(circuit)
+      if circuit.nil?
+        fail ArgumentError, 'circuit cannot be nil'
+      end
+
+      @circuit = circuit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] init_signal_sleeve Value to be assigned
+    def init_signal_sleeve=(init_signal_sleeve)
+      if init_signal_sleeve.nil?
+        fail ArgumentError, 'init_signal_sleeve cannot be nil'
+      end
+
+      @init_signal_sleeve = init_signal_sleeve
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_junctions Value to be assigned
+    def auto_junctions=(auto_junctions)
+      if auto_junctions.nil?
+        fail ArgumentError, 'auto_junctions cannot be nil'
+      end
+
+      @auto_junctions = auto_junctions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_junctions Value to be assigned
+    def dc_junctions=(dc_junctions)
+      if dc_junctions.nil?
+        fail ArgumentError, 'dc_junctions cannot be nil'
+      end
+
+      @dc_junctions = dc_junctions
+    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 &&
+          robot_auto == o.robot_auto &&
+          auto_terminal_near == o.auto_terminal_near &&
+          auto_terminal_far == o.auto_terminal_far &&
+          dc_terminal_near == o.dc_terminal_near &&
+          dc_terminal_far == o.dc_terminal_far &&
+          eg_navigated == o.eg_navigated &&
+          minor_penalties == o.minor_penalties &&
+          major_penalties == o.major_penalties &&
+          beacons == o.beacons &&
+          owned_junctions == o.owned_junctions &&
+          circuit == o.circuit &&
+          init_signal_sleeve == o.init_signal_sleeve &&
+          auto_junctions == o.auto_junctions &&
+          dc_junctions == o.dc_junctions &&
+          auto_junction_cones == o.auto_junction_cones &&
+          dc_junction_cones == o.dc_junction_cones
+    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
+      [robot_auto, auto_terminal_near, auto_terminal_far, dc_terminal_near, dc_terminal_far, eg_navigated, minor_penalties, major_penalties, beacons, owned_junctions, circuit, init_signal_sleeve, auto_junctions, dc_junctions, auto_junction_cones, dc_junction_cones].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