ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/api/regions_api.rb

@@ -0,0 +1,292 @@
+=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 RegionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get region from a season
+    # Gets details for a single region for a season.
+    # @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 [ApiV3Region]
+    def get_region(cmp_year, region_code, opts = {})
+      data, _status_code, _headers = get_region_with_http_info(cmp_year, region_code, opts)
+      data
+    end
+
+    # Get region from a season
+    # Gets details for a single region for a season.
+    # @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<(ApiV3Region, Integer, Hash)>] ApiV3Region data, response status code and response headers
+    def get_region_with_http_info(cmp_year, region_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RegionsApi.get_region ...'
+      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 RegionsApi.get_region"
+      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 RegionsApi.get_region"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}'.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] || 'ApiV3Region'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"RegionsApi.get_region",
+        :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: RegionsApi#get_region\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List events for a regions
+    # Lists all events in a region
+    # @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 [ApiV3Events]
+    def list_region_events(cmp_year, region_code, opts = {})
+      data, _status_code, _headers = list_region_events_with_http_info(cmp_year, region_code, opts)
+      data
+    end
+
+    # List events for a regions
+    # Lists all events in a region
+    # @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<(ApiV3Events, Integer, Hash)>] ApiV3Events data, response status code and response headers
+    def list_region_events_with_http_info(cmp_year, region_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RegionsApi.list_region_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 RegionsApi.list_region_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 RegionsApi.list_region_events"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/events'.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] || 'ApiV3Events'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"RegionsApi.list_region_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: RegionsApi#list_region_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List teams for a region
+    # Lists all registered teams assigned to the given region.
+    # @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 [ApiV3Teams]
+    def list_region_teams(cmp_year, region_code, opts = {})
+      data, _status_code, _headers = list_region_teams_with_http_info(cmp_year, region_code, opts)
+      data
+    end
+
+    # List teams for a region
+    # Lists all registered teams assigned to the given region.
+    # @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<(ApiV3Teams, Integer, Hash)>] ApiV3Teams data, response status code and response headers
+    def list_region_teams_with_http_info(cmp_year, region_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RegionsApi.list_region_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 RegionsApi.list_region_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 RegionsApi.list_region_teams"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions/{regionCode}/teams'.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] || 'ApiV3Teams'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"RegionsApi.list_region_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: RegionsApi#list_region_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List regions for a season
+    # Lists all active regions for a season.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Regions]
+    def list_regions(cmp_year, opts = {})
+      data, _status_code, _headers = list_regions_with_http_info(cmp_year, opts)
+      data
+    end
+
+    # List regions for a season
+    # Lists all active regions 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<(ApiV3Regions, Integer, Hash)>] ApiV3Regions data, response status code and response headers
+    def list_regions_with_http_info(cmp_year, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RegionsApi.list_regions ...'
+      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 RegionsApi.list_regions"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/regions'.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] || 'ApiV3Regions'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"RegionsApi.list_regions",
+        :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: RegionsApi#list_regions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ftc_api_v3_client/api/seasons_api.rb

@@ -0,0 +1,142 @@
+=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 SeasonsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get single FTC season
+    # Lists basic information about the given FTC season
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Season]
+    def get_season(cmp_year, opts = {})
+      data, _status_code, _headers = get_season_with_http_info(cmp_year, opts)
+      data
+    end
+
+    # Get single FTC season
+    # Lists basic information about the given FTC season
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Season, Integer, Hash)>] ApiV3Season data, response status code and response headers
+    def get_season_with_http_info(cmp_year, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SeasonsApi.get_season ...'
+      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 SeasonsApi.get_season"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}'.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] || 'ApiV3Season'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SeasonsApi.get_season",
+        :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: SeasonsApi#get_season\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all FTC seasons
+    # Lists basic information about all FTC seasons with data available through this API
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Seasons]
+    def list_seasons(opts = {})
+      data, _status_code, _headers = list_seasons_with_http_info(opts)
+      data
+    end
+
+    # List all FTC seasons
+    # Lists basic information about all FTC seasons with data available through this API
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Seasons, Integer, Hash)>] ApiV3Seasons data, response status code and response headers
+    def list_seasons_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SeasonsApi.list_seasons ...'
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons'
+
+      # 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] || 'ApiV3Seasons'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SeasonsApi.list_seasons",
+        :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: SeasonsApi#list_seasons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end