ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/api/events_api.rb

@@ -0,0 +1,934 @@
+=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 'cgi'
+
+module FtcApiV3Client
+  class EventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get event from season
+    # Get detailed information about a single event
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Event]
+    def get_event(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event from season
+    # Get detailed information about a single event
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Event, Integer, Hash)>] ApiV3Event data, response status code and response headers
+    def get_event_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3Event'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get event advancement (from)
+    # Gets advancement list for teams advancing from this event to the next level of competition
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3AdvancementFrom]
+    def get_event_advancement_from(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_advancement_from_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event advancement (from)
+    # Gets advancement list for teams advancing from this event to the next level of competition
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3AdvancementFrom, Integer, Hash)>] ApiV3AdvancementFrom data, response status code and response headers
+    def get_event_advancement_from_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_advancement_from ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_advancement_from"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_advancement_from"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/advancement/from'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3AdvancementFrom'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_advancement_from",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_advancement_from\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get event alliance selections
+    #         Gets alliance selection operations for the given event, including accepts and declines. These         are presented in the order in which they occurred. Refer to the season's competition manual to         confirm the order of alliance selections that year. If you are looking for the final alliances         and are not interested in analyzing the selection process itself, we recommend using the         GetEventAlliances endpoint instead. 
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3AllianceSelections]
+    def get_event_alliance_selections(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_alliance_selections_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event alliance selections
+    #         Gets alliance selection operations for the given event, including accepts and declines. These         are presented in the order in which they occurred. Refer to the season&#39;s competition manual to         confirm the order of alliance selections that year. If you are looking for the final alliances         and are not interested in analyzing the selection process itself, we recommend using the         GetEventAlliances endpoint instead. 
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3AllianceSelections, Integer, Hash)>] ApiV3AllianceSelections data, response status code and response headers
+    def get_event_alliance_selections_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_alliance_selections ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_alliance_selections"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_alliance_selections"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/alliances/selections'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3AllianceSelections'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_alliance_selections",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_alliance_selections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get event alliances
+    # Gets playoff alliances for the given event
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3PlayoffAlliances]
+    def get_event_alliances(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_alliances_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event alliances
+    # Gets playoff alliances for the given event
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3PlayoffAlliances, Integer, Hash)>] ApiV3PlayoffAlliances data, response status code and response headers
+    def get_event_alliances_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_alliances ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_alliances"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_alliances"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/alliances'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3PlayoffAlliances'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_alliances",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_alliances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get event awards
+    # Gets award information and recipients for the given event.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Awards]
+    def get_event_awards(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_awards_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event awards
+    # Gets award information and recipients for the given event.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Awards, Integer, Hash)>] ApiV3Awards data, response status code and response headers
+    def get_event_awards_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_awards ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_awards"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_awards"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/awards'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3Awards'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_awards",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_awards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get match details
+    # Gets details for a single match, including season-specific score details.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param tournament_level [ApiV3TournamentLevel] The tournament level of the match
+    # @param series [String] The series of the match (0 for non-playoff matches). For remote events, the team number for the match.
+    # @param number [Integer] The match number
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3MatchDetails]
+    def get_event_match(cmp_year, event_code, tournament_level, series, number, opts = {})
+      data, _status_code, _headers = get_event_match_with_http_info(cmp_year, event_code, tournament_level, series, number, opts)
+      data
+    end
+
+    # Get match details
+    # Gets details for a single match, including season-specific score details.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param tournament_level [ApiV3TournamentLevel] The tournament level of the match
+    # @param series [String] The series of the match (0 for non-playoff matches). For remote events, the team number for the match.
+    # @param number [Integer] The match number
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3MatchDetails, Integer, Hash)>] ApiV3MatchDetails data, response status code and response headers
+    def get_event_match_with_http_info(cmp_year, event_code, tournament_level, series, number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_match ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_match"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_match"
+      end
+      # verify the required parameter 'tournament_level' is set
+      if @api_client.config.client_side_validation && tournament_level.nil?
+        fail ArgumentError, "Missing the required parameter 'tournament_level' when calling EventsApi.get_event_match"
+      end
+      # verify the required parameter 'series' is set
+      if @api_client.config.client_side_validation && series.nil?
+        fail ArgumentError, "Missing the required parameter 'series' when calling EventsApi.get_event_match"
+      end
+      # verify the required parameter 'number' is set
+      if @api_client.config.client_side_validation && number.nil?
+        fail ArgumentError, "Missing the required parameter 'number' when calling EventsApi.get_event_match"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/matches/{tournamentLevel}/{series}/{number}'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s)).sub('{' + 'tournamentLevel' + '}', CGI.escape(tournament_level.to_s)).sub('{' + 'series' + '}', CGI.escape(series.to_s)).sub('{' + 'number' + '}', CGI.escape(number.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3MatchDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_match",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get pit map
+    # Gets data representation of pit map
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3PitMap]
+    def get_event_pit_map(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_pit_map_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get pit map
+    # Gets data representation of pit map
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3PitMap, Integer, Hash)>] ApiV3PitMap data, response status code and response headers
+    def get_event_pit_map_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_pit_map ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_pit_map"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_pit_map"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/pitMap'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3PitMap'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_pit_map",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_pit_map\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get event playoff rankings
+    # Gets playoff rankings for a given event. Each sort order field is season-specific: see the season's competition manual for definitions. Only applicable to events using round-robin playoffs (e.g. FIRST Championship da Vinci)
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3PlayoffRankings]
+    def get_event_playoff_rankings(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_playoff_rankings_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event playoff rankings
+    # Gets playoff rankings for a given event. Each sort order field is season-specific: see the season&#39;s competition manual for definitions. Only applicable to events using round-robin playoffs (e.g. FIRST Championship da Vinci)
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3PlayoffRankings, Integer, Hash)>] ApiV3PlayoffRankings data, response status code and response headers
+    def get_event_playoff_rankings_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_playoff_rankings ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_playoff_rankings"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_playoff_rankings"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/playoffRankings'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3PlayoffRankings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_playoff_rankings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_playoff_rankings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get playoff structure
+    # Gets programmatic description of the playoff structure (e.g. bracket) structure for event. Contains sufficient information to construct a bracket display.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3PlayoffStructure]
+    def get_event_playoff_structure(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_playoff_structure_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get playoff structure
+    # Gets programmatic description of the playoff structure (e.g. bracket) structure for event. Contains sufficient information to construct a bracket display.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3PlayoffStructure, Integer, Hash)>] ApiV3PlayoffStructure data, response status code and response headers
+    def get_event_playoff_structure_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_playoff_structure ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_playoff_structure"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_playoff_structure"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/playoffStructure'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3PlayoffStructure'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_playoff_structure",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_playoff_structure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get event rankings
+    # Gets rankings for a given event. Each sort order field is season-specific: see the season's competition manual for definitions. Do not use for league meets or multi-division parent events
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Rankings]
+    def get_event_rankings(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = get_event_rankings_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # Get event rankings
+    # Gets rankings for a given event. Each sort order field is season-specific: see the season&#39;s competition manual for definitions. Do not use for league meets or multi-division parent events
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Rankings, Integer, Hash)>] ApiV3Rankings data, response status code and response headers
+    def get_event_rankings_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event_rankings ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.get_event_rankings"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.get_event_rankings"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/rankings'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3Rankings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event_rankings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_event_rankings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List event matches
+    # Gets matches for a given event. Includes winner and score information if available. Score details must be fetched per match.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @option opts [ApiV3TournamentLevel] :phase Filter matches to a specific phase
+    # @return [ApiV3Matches]
+    def list_event_matches(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = list_event_matches_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # List event matches
+    # Gets matches for a given event. Includes winner and score information if available. Score details must be fetched per match.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @option opts [ApiV3TournamentLevel] :phase Filter matches to a specific phase
+    # @return [Array<(ApiV3Matches, Integer, Hash)>] ApiV3Matches data, response status code and response headers
+    def list_event_matches_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.list_event_matches ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.list_event_matches"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.list_event_matches"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/matches'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'phase'] = opts[:'phase'] if !opts[:'phase'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3Matches'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.list_event_matches",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#list_event_matches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List teams for an event
+    # Lists all teams competing at the event. This includes division assignments if published for this event (and this event is a multi-division parent event). In some cases, teams may be award recipients but not returned in this list. Their information can be fetched individually by number.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3EventParticipants]
+    def list_event_teams(cmp_year, event_code, opts = {})
+      data, _status_code, _headers = list_event_teams_with_http_info(cmp_year, event_code, opts)
+      data
+    end
+
+    # List teams for an event
+    # Lists all teams competing at the event. This includes division assignments if published for this event (and this event is a multi-division parent event). In some cases, teams may be award recipients but not returned in this list. Their information can be fetched individually by number.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param event_code [String] The code (abbreviation) for the event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3EventParticipants, Integer, Hash)>] ApiV3EventParticipants data, response status code and response headers
+    def list_event_teams_with_http_info(cmp_year, event_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.list_event_teams ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.list_event_teams"
+      end
+      # verify the required parameter 'event_code' is set
+      if @api_client.config.client_side_validation && event_code.nil?
+        fail ArgumentError, "Missing the required parameter 'event_code' when calling EventsApi.list_event_teams"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events/{eventCode}/teams'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'eventCode' + '}', CGI.escape(event_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3EventParticipants'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.list_event_teams",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#list_event_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List events for a season
+    # Lists all events for a season
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Events]
+    def list_events(cmp_year, opts = {})
+      data, _status_code, _headers = list_events_with_http_info(cmp_year, opts)
+      data
+    end
+
+    # List events for a season
+    # Lists all events for a season
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Events, Integer, Hash)>] ApiV3Events data, response status code and response headers
+    def list_events_with_http_info(cmp_year, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.list_events ...'
+      end
+      # verify the required parameter 'cmp_year' is set
+      if @api_client.config.client_side_validation && cmp_year.nil?
+        fail ArgumentError, "Missing the required parameter 'cmp_year' when calling EventsApi.list_events"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/events'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiV3Events'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.list_events",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#list_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end