ftc_api_v3_client 0.1.0

data/lib/ftc_api_v3_client/api/teams_api.rb

@@ -0,0 +1,349 @@
+=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 TeamsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get teams information
+    # Get information for a specific team. If a team's number changed during the season, this endpoint can be called with the old number and it will return the new one.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param number [String] The team's number
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Team]
+    def get_team(cmp_year, number, opts = {})
+      data, _status_code, _headers = get_team_with_http_info(cmp_year, number, opts)
+      data
+    end
+
+    # Get teams information
+    # Get information for a specific team. If a team's number changed during the season, this endpoint can be called with the old number and it will return the new one.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param number [String] The team's number
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Team, Integer, Hash)>] ApiV3Team data, response status code and response headers
+    def get_team_with_http_info(cmp_year, number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TeamsApi.get_team ...'
+      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 TeamsApi.get_team"
+      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 TeamsApi.get_team"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/teams/{number}'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.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] || 'ApiV3Team'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"TeamsApi.get_team",
+        :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: TeamsApi#get_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get detailed team information
+    # Get detailed information for a specific team. Includes all awards, events, matches, and leagues. If a team's number changed during the season, this endpoint can be called with the old number and it will return the new one.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param number [String] The team&#39;s number
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3TeamDetails]
+    def get_team_details(cmp_year, number, opts = {})
+      data, _status_code, _headers = get_team_details_with_http_info(cmp_year, number, opts)
+      data
+    end
+
+    # Get detailed team information
+    # Get detailed information for a specific team. Includes all awards, events, matches, and leagues. If a team&#39;s number changed during the season, this endpoint can be called with the old number and it will return the new one.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param number [String] The team&#39;s number
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3TeamDetails, Integer, Hash)>] ApiV3TeamDetails data, response status code and response headers
+    def get_team_details_with_http_info(cmp_year, number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TeamsApi.get_team_details ...'
+      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 TeamsApi.get_team_details"
+      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 TeamsApi.get_team_details"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/teams/{number}/details'.sub('{' + 'cmpYear' + '}', CGI.escape(cmp_year.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] || 'ApiV3TeamDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"TeamsApi.get_team_details",
+        :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: TeamsApi#get_team_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get team history
+    # Get cross-season history for a specific team number. General information will be from the last season the team competed in.
+    # @param number [String] The team&#39;s number
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3TeamHistory]
+    def get_team_history(number, opts = {})
+      data, _status_code, _headers = get_team_history_with_http_info(number, opts)
+      data
+    end
+
+    # Get team history
+    # Get cross-season history for a specific team number. General information will be from the last season the team competed in.
+    # @param number [String] The team&#39;s number
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3TeamHistory, Integer, Hash)>] ApiV3TeamHistory data, response status code and response headers
+    def get_team_history_with_http_info(number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TeamsApi.get_team_history ...'
+      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 TeamsApi.get_team_history"
+      end
+      # resource path
+      local_var_path = '/api/v3/teams/{number}'.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] || 'ApiV3TeamHistory'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"TeamsApi.get_team_history",
+        :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: TeamsApi#get_team_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List team avatars for a season
+    # Lists all current team avatars for a season. If all you need is to display avatars with the standard FIRST fallback and scaling, directly link `/avatars/composed/{cmpYear}.css` instead of using this endpoint. Use a div with the classes `team-avatar` and `team-{number}` to display the avatar. Use the css variable `--avatar-size` to control the size of the avatar in px (defaults to 40).
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3TeamAvatars]
+    def list_team_avatars(cmp_year, opts = {})
+      data, _status_code, _headers = list_team_avatars_with_http_info(cmp_year, opts)
+      data
+    end
+
+    # List team avatars for a season
+    # Lists all current team avatars for a season. If all you need is to display avatars with the standard FIRST fallback and scaling, directly link &#x60;/avatars/composed/{cmpYear}.css&#x60; instead of using this endpoint. Use a div with the classes &#x60;team-avatar&#x60; and &#x60;team-{number}&#x60; to display the avatar. Use the css variable &#x60;--avatar-size&#x60; to control the size of the avatar in px (defaults to 40).
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3TeamAvatars, Integer, Hash)>] ApiV3TeamAvatars data, response status code and response headers
+    def list_team_avatars_with_http_info(cmp_year, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TeamsApi.list_team_avatars ...'
+      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 TeamsApi.list_team_avatars"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/avatars'.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] || 'ApiV3TeamAvatars'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"TeamsApi.list_team_avatars",
+        :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: TeamsApi#list_team_avatars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List teams for a season
+    # Lists all registered teams for the given FTC season. In some cases, teams with incomplete registrations may be included in event results but not returned in this list. Use the event's team list for that information if necessary.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [ApiV3Teams]
+    def list_teams(cmp_year, opts = {})
+      data, _status_code, _headers = list_teams_with_http_info(cmp_year, opts)
+      data
+    end
+
+    # List teams for a season
+    # Lists all registered teams for the given FTC season. In some cases, teams with incomplete registrations may be included in event results but not returned in this list. Use the event&#39;s team list for that information if necessary.
+    # @param cmp_year [String] The year of the FIRST Championship for the requested season
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiV3Teams, Integer, Hash)>] ApiV3Teams data, response status code and response headers
+    def list_teams_with_http_info(cmp_year, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TeamsApi.list_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 TeamsApi.list_teams"
+      end
+      # resource path
+      local_var_path = '/api/v3/seasons/{cmpYear}/teams'.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] || 'ApiV3Teams'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"TeamsApi.list_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: TeamsApi#list_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end