ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/models/api_v3_ff_remote_achievements_detail.rb

@@ -0,0 +1,629 @@
+=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 ApiV3FFRemoteAchievementsDetail < ApiModelBase
+    attr_accessor :auto_delivered
+
+    attr_accessor :auto_robot
+
+    attr_accessor :preload
+
+    attr_accessor :auto_storage_freight
+
+    attr_accessor :auto_freight1
+
+    attr_accessor :auto_freight2
+
+    attr_accessor :auto_freight3
+
+    attr_accessor :dc_storage_freight
+
+    attr_accessor :dc_freight1
+
+    attr_accessor :dc_freight2
+
+    attr_accessor :dc_freight3
+
+    attr_accessor :eg_delivered
+
+    attr_accessor :balanced
+
+    attr_accessor :eg_robot
+
+    attr_accessor :capped
+
+    attr_accessor :minor_penalties
+
+    attr_accessor :major_penalties
+
+    # Indicates if team used a team shipping element
+    attr_accessor :init_tse
+
+    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
+      {
+        :'auto_delivered' => :'autoDelivered',
+        :'auto_robot' => :'autoRobot',
+        :'preload' => :'preload',
+        :'auto_storage_freight' => :'autoStorageFreight',
+        :'auto_freight1' => :'autoFreight1',
+        :'auto_freight2' => :'autoFreight2',
+        :'auto_freight3' => :'autoFreight3',
+        :'dc_storage_freight' => :'dcStorageFreight',
+        :'dc_freight1' => :'dcFreight1',
+        :'dc_freight2' => :'dcFreight2',
+        :'dc_freight3' => :'dcFreight3',
+        :'eg_delivered' => :'egDelivered',
+        :'balanced' => :'balanced',
+        :'eg_robot' => :'egRobot',
+        :'capped' => :'capped',
+        :'minor_penalties' => :'minorPenalties',
+        :'major_penalties' => :'majorPenalties',
+        :'init_tse' => :'initTSE'
+      }
+    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
+      {
+        :'auto_delivered' => :'Boolean',
+        :'auto_robot' => :'ApiV3FFAutoLocation',
+        :'preload' => :'Boolean',
+        :'auto_storage_freight' => :'Integer',
+        :'auto_freight1' => :'Integer',
+        :'auto_freight2' => :'Integer',
+        :'auto_freight3' => :'Integer',
+        :'dc_storage_freight' => :'Integer',
+        :'dc_freight1' => :'Integer',
+        :'dc_freight2' => :'Integer',
+        :'dc_freight3' => :'Integer',
+        :'eg_delivered' => :'Integer',
+        :'balanced' => :'Boolean',
+        :'eg_robot' => :'ApiV3FFEndLocation',
+        :'capped' => :'Integer',
+        :'minor_penalties' => :'Integer',
+        :'major_penalties' => :'Integer',
+        :'init_tse' => :'Boolean'
+      }
+    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::ApiV3FFRemoteAchievementsDetail` 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::ApiV3FFRemoteAchievementsDetail`. 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?(:'auto_delivered')
+        self.auto_delivered = attributes[:'auto_delivered']
+      else
+        self.auto_delivered = nil
+      end
+
+      if attributes.key?(:'auto_robot')
+        self.auto_robot = attributes[:'auto_robot']
+      else
+        self.auto_robot = nil
+      end
+
+      if attributes.key?(:'preload')
+        self.preload = attributes[:'preload']
+      else
+        self.preload = nil
+      end
+
+      if attributes.key?(:'auto_storage_freight')
+        self.auto_storage_freight = attributes[:'auto_storage_freight']
+      else
+        self.auto_storage_freight = nil
+      end
+
+      if attributes.key?(:'auto_freight1')
+        self.auto_freight1 = attributes[:'auto_freight1']
+      else
+        self.auto_freight1 = nil
+      end
+
+      if attributes.key?(:'auto_freight2')
+        self.auto_freight2 = attributes[:'auto_freight2']
+      else
+        self.auto_freight2 = nil
+      end
+
+      if attributes.key?(:'auto_freight3')
+        self.auto_freight3 = attributes[:'auto_freight3']
+      else
+        self.auto_freight3 = nil
+      end
+
+      if attributes.key?(:'dc_storage_freight')
+        self.dc_storage_freight = attributes[:'dc_storage_freight']
+      else
+        self.dc_storage_freight = nil
+      end
+
+      if attributes.key?(:'dc_freight1')
+        self.dc_freight1 = attributes[:'dc_freight1']
+      else
+        self.dc_freight1 = nil
+      end
+
+      if attributes.key?(:'dc_freight2')
+        self.dc_freight2 = attributes[:'dc_freight2']
+      else
+        self.dc_freight2 = nil
+      end
+
+      if attributes.key?(:'dc_freight3')
+        self.dc_freight3 = attributes[:'dc_freight3']
+      else
+        self.dc_freight3 = nil
+      end
+
+      if attributes.key?(:'eg_delivered')
+        self.eg_delivered = attributes[:'eg_delivered']
+      else
+        self.eg_delivered = nil
+      end
+
+      if attributes.key?(:'balanced')
+        self.balanced = attributes[:'balanced']
+      else
+        self.balanced = nil
+      end
+
+      if attributes.key?(:'eg_robot')
+        self.eg_robot = attributes[:'eg_robot']
+      else
+        self.eg_robot = nil
+      end
+
+      if attributes.key?(:'capped')
+        self.capped = attributes[:'capped']
+      else
+        self.capped = 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?(:'init_tse')
+        self.init_tse = attributes[:'init_tse']
+      else
+        self.init_tse = 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 @auto_delivered.nil?
+        invalid_properties.push('invalid value for "auto_delivered", auto_delivered cannot be nil.')
+      end
+
+      if @auto_robot.nil?
+        invalid_properties.push('invalid value for "auto_robot", auto_robot cannot be nil.')
+      end
+
+      if @preload.nil?
+        invalid_properties.push('invalid value for "preload", preload cannot be nil.')
+      end
+
+      if @auto_storage_freight.nil?
+        invalid_properties.push('invalid value for "auto_storage_freight", auto_storage_freight cannot be nil.')
+      end
+
+      if @auto_freight1.nil?
+        invalid_properties.push('invalid value for "auto_freight1", auto_freight1 cannot be nil.')
+      end
+
+      if @auto_freight2.nil?
+        invalid_properties.push('invalid value for "auto_freight2", auto_freight2 cannot be nil.')
+      end
+
+      if @auto_freight3.nil?
+        invalid_properties.push('invalid value for "auto_freight3", auto_freight3 cannot be nil.')
+      end
+
+      if @dc_storage_freight.nil?
+        invalid_properties.push('invalid value for "dc_storage_freight", dc_storage_freight cannot be nil.')
+      end
+
+      if @dc_freight1.nil?
+        invalid_properties.push('invalid value for "dc_freight1", dc_freight1 cannot be nil.')
+      end
+
+      if @dc_freight2.nil?
+        invalid_properties.push('invalid value for "dc_freight2", dc_freight2 cannot be nil.')
+      end
+
+      if @dc_freight3.nil?
+        invalid_properties.push('invalid value for "dc_freight3", dc_freight3 cannot be nil.')
+      end
+
+      if @eg_delivered.nil?
+        invalid_properties.push('invalid value for "eg_delivered", eg_delivered cannot be nil.')
+      end
+
+      if @balanced.nil?
+        invalid_properties.push('invalid value for "balanced", balanced cannot be nil.')
+      end
+
+      if @eg_robot.nil?
+        invalid_properties.push('invalid value for "eg_robot", eg_robot cannot be nil.')
+      end
+
+      if @capped.nil?
+        invalid_properties.push('invalid value for "capped", capped 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 @init_tse.nil?
+        invalid_properties.push('invalid value for "init_tse", init_tse 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_delivered.nil?
+      return false if @auto_robot.nil?
+      return false if @preload.nil?
+      return false if @auto_storage_freight.nil?
+      return false if @auto_freight1.nil?
+      return false if @auto_freight2.nil?
+      return false if @auto_freight3.nil?
+      return false if @dc_storage_freight.nil?
+      return false if @dc_freight1.nil?
+      return false if @dc_freight2.nil?
+      return false if @dc_freight3.nil?
+      return false if @eg_delivered.nil?
+      return false if @balanced.nil?
+      return false if @eg_robot.nil?
+      return false if @capped.nil?
+      return false if @minor_penalties.nil?
+      return false if @major_penalties.nil?
+      return false if @init_tse.nil?
+      true
+    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_robot Value to be assigned
+    def auto_robot=(auto_robot)
+      if auto_robot.nil?
+        fail ArgumentError, 'auto_robot cannot be nil'
+      end
+
+      @auto_robot = auto_robot
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] preload Value to be assigned
+    def preload=(preload)
+      if preload.nil?
+        fail ArgumentError, 'preload cannot be nil'
+      end
+
+      @preload = preload
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_storage_freight Value to be assigned
+    def auto_storage_freight=(auto_storage_freight)
+      if auto_storage_freight.nil?
+        fail ArgumentError, 'auto_storage_freight cannot be nil'
+      end
+
+      @auto_storage_freight = auto_storage_freight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_freight1 Value to be assigned
+    def auto_freight1=(auto_freight1)
+      if auto_freight1.nil?
+        fail ArgumentError, 'auto_freight1 cannot be nil'
+      end
+
+      @auto_freight1 = auto_freight1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_freight2 Value to be assigned
+    def auto_freight2=(auto_freight2)
+      if auto_freight2.nil?
+        fail ArgumentError, 'auto_freight2 cannot be nil'
+      end
+
+      @auto_freight2 = auto_freight2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_freight3 Value to be assigned
+    def auto_freight3=(auto_freight3)
+      if auto_freight3.nil?
+        fail ArgumentError, 'auto_freight3 cannot be nil'
+      end
+
+      @auto_freight3 = auto_freight3
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_storage_freight Value to be assigned
+    def dc_storage_freight=(dc_storage_freight)
+      if dc_storage_freight.nil?
+        fail ArgumentError, 'dc_storage_freight cannot be nil'
+      end
+
+      @dc_storage_freight = dc_storage_freight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_freight1 Value to be assigned
+    def dc_freight1=(dc_freight1)
+      if dc_freight1.nil?
+        fail ArgumentError, 'dc_freight1 cannot be nil'
+      end
+
+      @dc_freight1 = dc_freight1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_freight2 Value to be assigned
+    def dc_freight2=(dc_freight2)
+      if dc_freight2.nil?
+        fail ArgumentError, 'dc_freight2 cannot be nil'
+      end
+
+      @dc_freight2 = dc_freight2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dc_freight3 Value to be assigned
+    def dc_freight3=(dc_freight3)
+      if dc_freight3.nil?
+        fail ArgumentError, 'dc_freight3 cannot be nil'
+      end
+
+      @dc_freight3 = dc_freight3
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] eg_delivered Value to be assigned
+    def eg_delivered=(eg_delivered)
+      if eg_delivered.nil?
+        fail ArgumentError, 'eg_delivered cannot be nil'
+      end
+
+      @eg_delivered = eg_delivered
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] balanced Value to be assigned
+    def balanced=(balanced)
+      if balanced.nil?
+        fail ArgumentError, 'balanced cannot be nil'
+      end
+
+      @balanced = balanced
+    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] capped Value to be assigned
+    def capped=(capped)
+      if capped.nil?
+        fail ArgumentError, 'capped cannot be nil'
+      end
+
+      @capped = capped
+    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] init_tse Value to be assigned
+    def init_tse=(init_tse)
+      if init_tse.nil?
+        fail ArgumentError, 'init_tse cannot be nil'
+      end
+
+      @init_tse = init_tse
+    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 &&
+          auto_delivered == o.auto_delivered &&
+          auto_robot == o.auto_robot &&
+          preload == o.preload &&
+          auto_storage_freight == o.auto_storage_freight &&
+          auto_freight1 == o.auto_freight1 &&
+          auto_freight2 == o.auto_freight2 &&
+          auto_freight3 == o.auto_freight3 &&
+          dc_storage_freight == o.dc_storage_freight &&
+          dc_freight1 == o.dc_freight1 &&
+          dc_freight2 == o.dc_freight2 &&
+          dc_freight3 == o.dc_freight3 &&
+          eg_delivered == o.eg_delivered &&
+          balanced == o.balanced &&
+          eg_robot == o.eg_robot &&
+          capped == o.capped &&
+          minor_penalties == o.minor_penalties &&
+          major_penalties == o.major_penalties &&
+          init_tse == o.init_tse
+    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
+      [auto_delivered, auto_robot, preload, auto_storage_freight, auto_freight1, auto_freight2, auto_freight3, dc_storage_freight, dc_freight1, dc_freight2, dc_freight3, eg_delivered, balanced, eg_robot, capped, minor_penalties, major_penalties, init_tse].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