ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/models/api_v3_playoff_rankings.rb

@@ -0,0 +1,166 @@
+=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 ApiV3PlayoffRankings < ApiModelBase
+    attr_accessor :rankings
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rankings' => :'rankings'
+      }
+    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
+      {
+        :'rankings' => :'Array<ApiV3PlayoffRanking>'
+      }
+    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::ApiV3PlayoffRankings` 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::ApiV3PlayoffRankings`. 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?(:'rankings')
+        if (value = attributes[:'rankings']).is_a?(Array)
+          self.rankings = value
+        end
+      else
+        self.rankings = 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 @rankings.nil?
+        invalid_properties.push('invalid value for "rankings", rankings 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 @rankings.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rankings Value to be assigned
+    def rankings=(rankings)
+      if rankings.nil?
+        fail ArgumentError, 'rankings cannot be nil'
+      end
+
+      @rankings = rankings
+    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 &&
+          rankings == o.rankings
+    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
+      [rankings].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

data/lib/ftc_api_v3_client/models/api_v3_playoff_series_description.rb

@@ -0,0 +1,347 @@
+=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
+  # A series in a single-elimination structure
+  class ApiV3PlayoffSeriesDescription < ApiModelBase
+    attr_accessor :series_id
+
+    attr_accessor :name
+
+    attr_accessor :short_name
+
+    attr_accessor :matches_to_win
+
+    attr_accessor :round
+
+    attr_accessor :red
+
+    attr_accessor :blue
+
+    attr_accessor :finals
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'series_id' => :'seriesId',
+        :'name' => :'name',
+        :'short_name' => :'shortName',
+        :'matches_to_win' => :'matchesToWin',
+        :'round' => :'round',
+        :'red' => :'red',
+        :'blue' => :'blue',
+        :'finals' => :'finals'
+      }
+    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
+      {
+        :'series_id' => :'Integer',
+        :'name' => :'String',
+        :'short_name' => :'String',
+        :'matches_to_win' => :'Integer',
+        :'round' => :'Integer',
+        :'red' => :'ApiV3AllianceDescription',
+        :'blue' => :'ApiV3AllianceDescription',
+        :'finals' => :'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::ApiV3PlayoffSeriesDescription` 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::ApiV3PlayoffSeriesDescription`. 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?(:'series_id')
+        self.series_id = attributes[:'series_id']
+      else
+        self.series_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'short_name')
+        self.short_name = attributes[:'short_name']
+      else
+        self.short_name = nil
+      end
+
+      if attributes.key?(:'matches_to_win')
+        self.matches_to_win = attributes[:'matches_to_win']
+      else
+        self.matches_to_win = nil
+      end
+
+      if attributes.key?(:'round')
+        self.round = attributes[:'round']
+      else
+        self.round = nil
+      end
+
+      if attributes.key?(:'red')
+        self.red = attributes[:'red']
+      else
+        self.red = nil
+      end
+
+      if attributes.key?(:'blue')
+        self.blue = attributes[:'blue']
+      else
+        self.blue = nil
+      end
+
+      if attributes.key?(:'finals')
+        self.finals = attributes[:'finals']
+      else
+        self.finals = 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 @series_id.nil?
+        invalid_properties.push('invalid value for "series_id", series_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @short_name.nil?
+        invalid_properties.push('invalid value for "short_name", short_name cannot be nil.')
+      end
+
+      if @matches_to_win.nil?
+        invalid_properties.push('invalid value for "matches_to_win", matches_to_win cannot be nil.')
+      end
+
+      if @round.nil?
+        invalid_properties.push('invalid value for "round", round cannot be nil.')
+      end
+
+      if @red.nil?
+        invalid_properties.push('invalid value for "red", red cannot be nil.')
+      end
+
+      if @blue.nil?
+        invalid_properties.push('invalid value for "blue", blue cannot be nil.')
+      end
+
+      if @finals.nil?
+        invalid_properties.push('invalid value for "finals", finals 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 @series_id.nil?
+      return false if @name.nil?
+      return false if @short_name.nil?
+      return false if @matches_to_win.nil?
+      return false if @round.nil?
+      return false if @red.nil?
+      return false if @blue.nil?
+      return false if @finals.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] series_id Value to be assigned
+    def series_id=(series_id)
+      if series_id.nil?
+        fail ArgumentError, 'series_id cannot be nil'
+      end
+
+      @series_id = series_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] short_name Value to be assigned
+    def short_name=(short_name)
+      if short_name.nil?
+        fail ArgumentError, 'short_name cannot be nil'
+      end
+
+      @short_name = short_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] matches_to_win Value to be assigned
+    def matches_to_win=(matches_to_win)
+      if matches_to_win.nil?
+        fail ArgumentError, 'matches_to_win cannot be nil'
+      end
+
+      @matches_to_win = matches_to_win
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] round Value to be assigned
+    def round=(round)
+      if round.nil?
+        fail ArgumentError, 'round cannot be nil'
+      end
+
+      @round = round
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] red Value to be assigned
+    def red=(red)
+      if red.nil?
+        fail ArgumentError, 'red cannot be nil'
+      end
+
+      @red = red
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] blue Value to be assigned
+    def blue=(blue)
+      if blue.nil?
+        fail ArgumentError, 'blue cannot be nil'
+      end
+
+      @blue = blue
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] finals Value to be assigned
+    def finals=(finals)
+      if finals.nil?
+        fail ArgumentError, 'finals cannot be nil'
+      end
+
+      @finals = finals
+    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 &&
+          series_id == o.series_id &&
+          name == o.name &&
+          short_name == o.short_name &&
+          matches_to_win == o.matches_to_win &&
+          round == o.round &&
+          red == o.red &&
+          blue == o.blue &&
+          finals == o.finals
+    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
+      [series_id, name, short_name, matches_to_win, round, red, blue, finals].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