ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/api/leagues_api.rb

@@ -0,0 +1,391 @@
+=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 LeaguesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Gets a single league from a region
+    # Gets a leagues for a region in a season, including any children
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3LeagueDetails]
+    def get_league(cmp_year, region_code, league_code, opts = {})
+      data, _status_code, _headers = get_league_with_http_info(cmp_year, region_code, league_code, opts)
+      data
+    end
+
+    # Gets a single league from a region
+    # Gets a leagues for a region in a season, including any children
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3LeagueDetails, Integer, Hash)>] ApiV3LeagueDetails data, response status code and response headers
+    def get_league_with_http_info(cmp_year, region_code, league_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeaguesApi.get_league ...'
+      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 LeaguesApi.get_league"
+      end
+      # verify the required parameter 'region_code' is set
+      if @api_client.config.client_side_validation && region_code.nil?
+        fail ArgumentError, "Missing the required parameter 'region_code' when calling LeaguesApi.get_league"
+      end
+      # verify the required parameter 'league_code' is set
+      if @api_client.config.client_side_validation && league_code.nil?
+        fail ArgumentError, "Missing the required parameter 'league_code' when calling LeaguesApi.get_league"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'regionCode' + '}', CGI.escape(region_code.to_s)).sub('{' + 'leagueCode' + '}', CGI.escape(league_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] || 'ApiV3LeagueDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LeaguesApi.get_league",
+        :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: LeaguesApi#get_league\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get rankings for a league
+    # Gets league rankings for a given league. This only includes matches played in League Meets. For rankings including the League Tournament, use the tournament event's rankings endpoint instead. Each sort order field is season-specific: see the season's competition manual for definitions. The last non-zero sort order is the scoring system randomly generated tiebreaker value.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Rankings]
+    def get_league_rankings(cmp_year, region_code, league_code, opts = {})
+      data, _status_code, _headers = get_league_rankings_with_http_info(cmp_year, region_code, league_code, opts)
+      data
+    end
+
+    # Get rankings for a league
+    # Gets league rankings for a given league. This only includes matches played in League Meets. For rankings including the League Tournament, use the tournament event&#39;s rankings endpoint instead. Each sort order field is season-specific: see the season&#39;s competition manual for definitions. The last non-zero sort order is the scoring system randomly generated tiebreaker value.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Rankings, Integer, Hash)>] ApiV3Rankings data, response status code and response headers
+    def get_league_rankings_with_http_info(cmp_year, region_code, league_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeaguesApi.get_league_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 LeaguesApi.get_league_rankings"
+      end
+      # verify the required parameter 'region_code' is set
+      if @api_client.config.client_side_validation && region_code.nil?
+        fail ArgumentError, "Missing the required parameter 'region_code' when calling LeaguesApi.get_league_rankings"
+      end
+      # verify the required parameter 'league_code' is set
+      if @api_client.config.client_side_validation && league_code.nil?
+        fail ArgumentError, "Missing the required parameter 'league_code' when calling LeaguesApi.get_league_rankings"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/rankings'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'regionCode' + '}', CGI.escape(region_code.to_s)).sub('{' + 'leagueCode' + '}', CGI.escape(league_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 => :"LeaguesApi.get_league_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: LeaguesApi#get_league_rankings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List events for a league
+    # Lists all events in a league, including events in child leagues.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Events]
+    def list_league_events(cmp_year, region_code, league_code, opts = {})
+      data, _status_code, _headers = list_league_events_with_http_info(cmp_year, region_code, league_code, opts)
+      data
+    end
+
+    # List events for a league
+    # Lists all events in a league, including events in child leagues.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Events, Integer, Hash)>] ApiV3Events data, response status code and response headers
+    def list_league_events_with_http_info(cmp_year, region_code, league_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeaguesApi.list_league_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 LeaguesApi.list_league_events"
+      end
+      # verify the required parameter 'region_code' is set
+      if @api_client.config.client_side_validation && region_code.nil?
+        fail ArgumentError, "Missing the required parameter 'region_code' when calling LeaguesApi.list_league_events"
+      end
+      # verify the required parameter 'league_code' is set
+      if @api_client.config.client_side_validation && league_code.nil?
+        fail ArgumentError, "Missing the required parameter 'league_code' when calling LeaguesApi.list_league_events"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/events'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'regionCode' + '}', CGI.escape(region_code.to_s)).sub('{' + 'leagueCode' + '}', CGI.escape(league_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] || 'ApiV3Events'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LeaguesApi.list_league_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: LeaguesApi#list_league_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List teams for a league
+    # Lists all teams assigned to the given league.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Teams]
+    def list_league_teams(cmp_year, region_code, league_code, opts = {})
+      data, _status_code, _headers = list_league_teams_with_http_info(cmp_year, region_code, league_code, opts)
+      data
+    end
+
+    # List teams for a league
+    # Lists all teams assigned to the given league.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param league_code [String] The code (abbreviation) for the league
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Teams, Integer, Hash)>] ApiV3Teams data, response status code and response headers
+    def list_league_teams_with_http_info(cmp_year, region_code, league_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeaguesApi.list_league_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 LeaguesApi.list_league_teams"
+      end
+      # verify the required parameter 'region_code' is set
+      if @api_client.config.client_side_validation && region_code.nil?
+        fail ArgumentError, "Missing the required parameter 'region_code' when calling LeaguesApi.list_league_teams"
+      end
+      # verify the required parameter 'league_code' is set
+      if @api_client.config.client_side_validation && league_code.nil?
+        fail ArgumentError, "Missing the required parameter 'league_code' when calling LeaguesApi.list_league_teams"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/teams'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'regionCode' + '}', CGI.escape(region_code.to_s)).sub('{' + 'leagueCode' + '}', CGI.escape(league_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] || 'ApiV3Teams'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LeaguesApi.list_league_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: LeaguesApi#list_league_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists leagues for a region
+    # Lists all leagues for a region in a season. Parent/child relationships can be determined from the `parentCode` field of each league. League parents are guaranteed to be in the same region as their children.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Leagues]
+    def list_leagues(cmp_year, region_code, opts = {})
+      data, _status_code, _headers = list_leagues_with_http_info(cmp_year, region_code, opts)
+      data
+    end
+
+    # Lists leagues for a region
+    # Lists all leagues for a region in a season. Parent/child relationships can be determined from the &#x60;parentCode&#x60; field of each league. League parents are guaranteed to be in the same region as their children.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param region_code [String] The code (abbreviation) for the region
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Leagues, Integer, Hash)>] ApiV3Leagues data, response status code and response headers
+    def list_leagues_with_http_info(cmp_year, region_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeaguesApi.list_leagues ...'
+      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 LeaguesApi.list_leagues"
+      end
+      # verify the required parameter 'region_code' is set
+      if @api_client.config.client_side_validation && region_code.nil?
+        fail ArgumentError, "Missing the required parameter 'region_code' when calling LeaguesApi.list_leagues"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.to_s)).sub('{' + 'regionCode' + '}', CGI.escape(region_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] || 'ApiV3Leagues'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LeaguesApi.list_leagues",
+        :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: LeaguesApi#list_leagues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end