ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/models/api_v3_event.rb

@@ -0,0 +1,559 @@
+=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 ApiV3Event < ApiModelBase
+    attr_accessor :code
+
+    attr_accessor :name
+
+    attr_accessor :type
+
+    attr_accessor :format
+
+    attr_accessor :start_date
+
+    attr_accessor :end_date
+
+    attr_accessor :region_code
+
+    attr_accessor :league_code
+
+    attr_accessor :parent_event_code
+
+    attr_accessor :divisions
+
+    attr_accessor :venue
+
+    attr_accessor :street_address
+
+    attr_accessor :street_address2
+
+    attr_accessor :city
+
+    attr_accessor :state
+
+    attr_accessor :country
+
+    attr_accessor :coordinates
+
+    attr_accessor :website
+
+    attr_accessor :live_streams
+
+    attr_accessor :field_count
+
+    attr_accessor :capacity
+
+    attr_accessor :published
+
+    # All timestamps related to the event are exposed in the API as local date/times in the event timezone
+    attr_accessor :timezone
+
+    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
+      {
+        :'code' => :'code',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'format' => :'format',
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate',
+        :'region_code' => :'regionCode',
+        :'league_code' => :'leagueCode',
+        :'parent_event_code' => :'parentEventCode',
+        :'divisions' => :'divisions',
+        :'venue' => :'venue',
+        :'street_address' => :'streetAddress',
+        :'street_address2' => :'streetAddress2',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'country' => :'country',
+        :'coordinates' => :'coordinates',
+        :'website' => :'website',
+        :'live_streams' => :'liveStreams',
+        :'field_count' => :'fieldCount',
+        :'capacity' => :'capacity',
+        :'published' => :'published',
+        :'timezone' => :'timezone'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'name' => :'String',
+        :'type' => :'ApiV3EventType',
+        :'format' => :'ApiV3EventFormat',
+        :'start_date' => :'Date',
+        :'end_date' => :'Date',
+        :'region_code' => :'String',
+        :'league_code' => :'String',
+        :'parent_event_code' => :'String',
+        :'divisions' => :'Array<ApiV3Division>',
+        :'venue' => :'String',
+        :'street_address' => :'String',
+        :'street_address2' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'country' => :'String',
+        :'coordinates' => :'ApiV3Coordinates',
+        :'website' => :'String',
+        :'live_streams' => :'Array<ApiV3EventLiveStream>',
+        :'field_count' => :'Integer',
+        :'capacity' => :'Integer',
+        :'published' => :'Boolean',
+        :'timezone' => :'String'
+      }
+    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::ApiV3Event` 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::ApiV3Event`. 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?(:'code')
+        self.code = attributes[:'code']
+      else
+        self.code = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      else
+        self.format = nil
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      else
+        self.start_date = nil
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      else
+        self.end_date = nil
+      end
+
+      if attributes.key?(:'region_code')
+        self.region_code = attributes[:'region_code']
+      else
+        self.region_code = nil
+      end
+
+      if attributes.key?(:'league_code')
+        self.league_code = attributes[:'league_code']
+      end
+
+      if attributes.key?(:'parent_event_code')
+        self.parent_event_code = attributes[:'parent_event_code']
+      end
+
+      if attributes.key?(:'divisions')
+        if (value = attributes[:'divisions']).is_a?(Array)
+          self.divisions = value
+        end
+      else
+        self.divisions = nil
+      end
+
+      if attributes.key?(:'venue')
+        self.venue = attributes[:'venue']
+      end
+
+      if attributes.key?(:'street_address')
+        self.street_address = attributes[:'street_address']
+      end
+
+      if attributes.key?(:'street_address2')
+        self.street_address2 = attributes[:'street_address2']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'coordinates')
+        self.coordinates = attributes[:'coordinates']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'live_streams')
+        if (value = attributes[:'live_streams']).is_a?(Array)
+          self.live_streams = value
+        end
+      end
+
+      if attributes.key?(:'field_count')
+        self.field_count = attributes[:'field_count']
+      else
+        self.field_count = nil
+      end
+
+      if attributes.key?(:'capacity')
+        self.capacity = attributes[:'capacity']
+      end
+
+      if attributes.key?(:'published')
+        self.published = attributes[:'published']
+      else
+        self.published = nil
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      else
+        self.timezone = 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 @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @format.nil?
+        invalid_properties.push('invalid value for "format", format cannot be nil.')
+      end
+
+      if @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      if @end_date.nil?
+        invalid_properties.push('invalid value for "end_date", end_date cannot be nil.')
+      end
+
+      if @region_code.nil?
+        invalid_properties.push('invalid value for "region_code", region_code cannot be nil.')
+      end
+
+      if @divisions.nil?
+        invalid_properties.push('invalid value for "divisions", divisions cannot be nil.')
+      end
+
+      if @field_count.nil?
+        invalid_properties.push('invalid value for "field_count", field_count cannot be nil.')
+      end
+
+      if @published.nil?
+        invalid_properties.push('invalid value for "published", published cannot be nil.')
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone 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 @code.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      return false if @format.nil?
+      return false if @start_date.nil?
+      return false if @end_date.nil?
+      return false if @region_code.nil?
+      return false if @divisions.nil?
+      return false if @field_count.nil?
+      return false if @published.nil?
+      return false if @timezone.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if code.nil?
+        fail ArgumentError, 'code cannot be nil'
+      end
+
+      @code = code
+    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] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] format Value to be assigned
+    def format=(format)
+      if format.nil?
+        fail ArgumentError, 'format cannot be nil'
+      end
+
+      @format = format
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_date Value to be assigned
+    def start_date=(start_date)
+      if start_date.nil?
+        fail ArgumentError, 'start_date cannot be nil'
+      end
+
+      @start_date = start_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] end_date Value to be assigned
+    def end_date=(end_date)
+      if end_date.nil?
+        fail ArgumentError, 'end_date cannot be nil'
+      end
+
+      @end_date = end_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] region_code Value to be assigned
+    def region_code=(region_code)
+      if region_code.nil?
+        fail ArgumentError, 'region_code cannot be nil'
+      end
+
+      @region_code = region_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] divisions Value to be assigned
+    def divisions=(divisions)
+      if divisions.nil?
+        fail ArgumentError, 'divisions cannot be nil'
+      end
+
+      @divisions = divisions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] field_count Value to be assigned
+    def field_count=(field_count)
+      if field_count.nil?
+        fail ArgumentError, 'field_count cannot be nil'
+      end
+
+      @field_count = field_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] published Value to be assigned
+    def published=(published)
+      if published.nil?
+        fail ArgumentError, 'published cannot be nil'
+      end
+
+      @published = published
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timezone Value to be assigned
+    def timezone=(timezone)
+      if timezone.nil?
+        fail ArgumentError, 'timezone cannot be nil'
+      end
+
+      @timezone = timezone
+    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 &&
+          code == o.code &&
+          name == o.name &&
+          type == o.type &&
+          format == o.format &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          region_code == o.region_code &&
+          league_code == o.league_code &&
+          parent_event_code == o.parent_event_code &&
+          divisions == o.divisions &&
+          venue == o.venue &&
+          street_address == o.street_address &&
+          street_address2 == o.street_address2 &&
+          city == o.city &&
+          state == o.state &&
+          country == o.country &&
+          coordinates == o.coordinates &&
+          website == o.website &&
+          live_streams == o.live_streams &&
+          field_count == o.field_count &&
+          capacity == o.capacity &&
+          published == o.published &&
+          timezone == o.timezone
+    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
+      [code, name, type, format, start_date, end_date, region_code, league_code, parent_event_code, divisions, venue, street_address, street_address2, city, state, country, coordinates, website, live_streams, field_count, capacity, published, timezone].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_event_format.rb

@@ -0,0 +1,41 @@
+=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 ApiV3EventFormat
+    TRADITIONAL = "TRADITIONAL".freeze
+    REMOTE = "REMOTE".freeze
+    HYBRID = "HYBRID".freeze
+
+    def self.all_vars
+      @all_vars ||= [TRADITIONAL, REMOTE, HYBRID].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ApiV3EventFormat.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ApiV3EventFormat"
+    end
+  end
+end