sports-odds-api 1.2.2 → 1.3.0

data/lib/sports_odds_api/resources/events.rb

@@ -2,19 +2,20 @@
 
 module SportsOddsAPI
   module Resources
+    # Get info about Events (includes odds, results, teams, and other metadata)
     class Events
       # Some parameter documentations has been truncated, see
       # {SportsOddsAPI::Models::EventGetParams} for more details.
       #
       # Get a list of Events
       #
-      # @overload get(bookmaker_id: nil, cancelled: nil, cursor: nil, ended: nil, event_id: nil, event_ids: nil, finalized: nil, include_alt_lines: nil, include_opposing_odds: nil, league_id: nil, limit: nil, live: nil, odd_id: nil, odds_available: nil, odds_present: nil, player_id: nil, sport_id: nil, started: nil, starts_after: nil, starts_before: nil, team_id: nil, type: nil, request_options: {})
+      # @overload get(bookmaker_id: nil, cancelled: nil, cursor: nil, ended: nil, event_id: nil, event_ids: nil, expand_results: nil, finalized: nil, include_alt_lines: nil, include_open_close_odds: nil, include_opposing_odds: nil, league_id: nil, limit: nil, live: nil, odd_id: nil, odds_available: nil, odds_present: nil, player_id: nil, sport_id: nil, started: nil, starts_after: nil, starts_before: nil, team_id: nil, type: nil, request_options: {})
       #
       # @param bookmaker_id [String] A bookmakerID or comma-separated list of bookmakerIDs to include odds for
       #
       # @param cancelled [Boolean] Only include cancelled Events (true), only non-cancelled Events (false) or all E
       #
-      # @param cursor [String] The cursor for the request. Used to get the next group of Events. This should be
+      # @param cursor [String] The cursor for the request. Used to get the next group of Events. This is an opa
       #
       # @param ended [Boolean] Only include Events which have have ended (true), only Events which have not end
       #
@@ -22,10 +23,14 @@ module SportsOddsAPI
       #
       # @param event_ids [String] A comma separated list of eventIDs to get Event data for
       #
+      # @param expand_results [Boolean] Whether to expand the results object to include all stat values rather than just
+      #
       # @param finalized [Boolean] Only include finalized Events (true), exclude unfinalized Events (false) or all
       #
       # @param include_alt_lines [Boolean] Whether to include alternate lines in the odds byBookmaker data
       #
+      # @param include_open_close_odds [Boolean] Whether to include open and close odds values (openOdds, closeOdds, openSpread,
+      #
       # @param include_opposing_odds [Boolean] Whether to include opposing odds for each included oddID
       #
       # @param league_id [String] A leagueID or comma-separated list of leagueIDs to get Events for
@@ -61,14 +66,17 @@ module SportsOddsAPI
       # @see SportsOddsAPI::Models::EventGetParams
       def get(params = {})
         parsed, options = SportsOddsAPI::EventGetParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "events/",
-          query: parsed.transform_keys(
+          query: query.transform_keys(
             bookmaker_id: "bookmakerID",
             event_id: "eventID",
             event_ids: "eventIDs",
+            expand_results: "expandResults",
             include_alt_lines: "includeAltLines",
+            include_open_close_odds: "includeOpenCloseOdds",
             include_opposing_odds: "includeOpposingOdds",
             league_id: "leagueID",
             odd_id: "oddID",

data/lib/sports_odds_api/resources/leagues.rb

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get League-related data
     class Leagues
       # Get a list of Leagues
       #
@@ -18,10 +19,11 @@ module SportsOddsAPI
       # @see SportsOddsAPI::Models::LeagueGetParams
       def get(params = {})
         parsed, options = SportsOddsAPI::LeagueGetParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "leagues/",
-          query: parsed.transform_keys(league_id: "leagueID", sport_id: "sportID"),
+          query: query.transform_keys(league_id: "leagueID", sport_id: "sportID"),
           unwrap: :data,
           model: SportsOddsAPI::Internal::Type::ArrayOf[SportsOddsAPI::League],
           options: options

data/lib/sports_odds_api/resources/markets.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Resources
+    # Get metadata on supported Markets
+    class Markets
+      # Some parameter documentations has been truncated, see
+      # {SportsOddsAPI::Models::MarketGetParams} for more details.
+      #
+      # Get a list of Markets
+      #
+      # @overload get(bet_type_id: nil, bookmaker_id: nil, cursor: nil, is_main_market: nil, is_prop: nil, is_sub_period: nil, is_supported: nil, league_id: nil, limit: nil, odd_id: nil, period_id: nil, prop_type: nil, side_id: nil, sport_id: nil, stat_entity_id: nil, stat_id: nil, request_options: {})
+      #
+      # @param bet_type_id [String] A single betTypeID or comma-separated list of betTypeIDs to filter Markets by
+      #
+      # @param bookmaker_id [String] A single bookmakerID or comma-separated list of bookmakerIDs to filter Markets b
+      #
+      # @param cursor [String] The cursor for pagination. Use nextCursor from prior response.
+      #
+      # @param is_main_market [Boolean] Filter to only include main markets (main period moneyline, spread, and over/und
+      #
+      # @param is_prop [Boolean] Filter by whether it is any type of prop bet market
+      #
+      # @param is_sub_period [Boolean] Filter by whether it tracks a sub/non-main period
+      #
+      # @param is_supported [Boolean] Filter whether this market is fully supported by at least 1 bookmaker in at leas
+      #
+      # @param league_id [String] A single leagueID or comma-separated list of leagueIDs to filter Markets by
+      #
+      # @param limit [Float] The maximum number of Markets to return (default: 100, max: 10000)
+      #
+      # @param odd_id [String] A single oddID or comma-separated list of oddIDs. Used to specify specific Marke
+      #
+      # @param period_id [String] A single periodID or comma-separated list of periodIDs to filter Markets by
+      #
+      # @param prop_type [String] Filter by prop type (game_prop, team_prop, player_prop, other_prop)
+      #
+      # @param side_id [String] A single sideID or comma-separated list of sideIDs to filter Markets by
+      #
+      # @param sport_id [String] A single sportID or comma-separated list of sportIDs to filter Markets by
+      #
+      # @param stat_entity_id [String] A single statEntityID or comma-separated list of statEntityIDs to filter Markets
+      #
+      # @param stat_id [String] A single statID or comma-separated list of statIDs to filter Markets by
+      #
+      # @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SportsOddsAPI::Internal::NextCursorPage<SportsOddsAPI::Models::Market>]
+      #
+      # @see SportsOddsAPI::Models::MarketGetParams
+      def get(params = {})
+        parsed, options = SportsOddsAPI::MarketGetParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "markets/",
+          query: query.transform_keys(
+            bet_type_id: "betTypeID",
+            bookmaker_id: "bookmakerID",
+            is_main_market: "isMainMarket",
+            is_prop: "isProp",
+            is_sub_period: "isSubPeriod",
+            is_supported: "isSupported",
+            league_id: "leagueID",
+            odd_id: "oddID",
+            period_id: "periodID",
+            prop_type: "propType",
+            side_id: "sideID",
+            sport_id: "sportID",
+            stat_entity_id: "statEntityID",
+            stat_id: "statID"
+          ),
+          page: SportsOddsAPI::Internal::NextCursorPage,
+          model: SportsOddsAPI::Market,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SportsOddsAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/sports_odds_api/resources/players.rb

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get Player-related data
     class Players
       # Some parameter documentations has been truncated, see
       # {SportsOddsAPI::Models::PlayerGetParams} for more details.
@@ -10,7 +11,7 @@ module SportsOddsAPI
       #
       # @overload get(cursor: nil, event_id: nil, limit: nil, player_id: nil, team_id: nil, request_options: {})
       #
-      # @param cursor [String] The cursor for the request. Used to get the next group of Players. This should b
+      # @param cursor [String] The cursor for the request. Used to get the next group of Players. This is an op
       #
       # @param event_id [String] EventID to get Players data for
       #
@@ -27,10 +28,11 @@ module SportsOddsAPI
       # @see SportsOddsAPI::Models::PlayerGetParams
       def get(params = {})
         parsed, options = SportsOddsAPI::PlayerGetParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "players/",
-          query: parsed.transform_keys(event_id: "eventID", player_id: "playerID", team_id: "teamID"),
+          query: query.transform_keys(event_id: "eventID", player_id: "playerID", team_id: "teamID"),
           page: SportsOddsAPI::Internal::NextCursorPage,
           model: SportsOddsAPI::Player,
           options: options

data/lib/sports_odds_api/resources/sports.rb

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get Sport-related data
     class Sports
       # Get a list of sports
       #

data/lib/sports_odds_api/resources/stats.rb

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get data on specific Stats
     class Stats
       # Some parameter documentations has been truncated, see
       # {SportsOddsAPI::Models::StatGetParams} for more details.
@@ -23,10 +24,11 @@ module SportsOddsAPI
       # @see SportsOddsAPI::Models::StatGetParams
       def get(params = {})
         parsed, options = SportsOddsAPI::StatGetParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "stats/",
-          query: parsed.transform_keys(sport_id: "sportID", stat_id: "statID", stat_level: "statLevel"),
+          query: query.transform_keys(sport_id: "sportID", stat_id: "statID", stat_level: "statLevel"),
           unwrap: :data,
           model: SportsOddsAPI::Internal::Type::ArrayOf[SportsOddsAPI::Stat],
           options: options

data/lib/sports_odds_api/resources/stream.rb

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get info about Events (includes odds, results, teams, and other metadata)
     class Stream
       # Setup streamed (WebSocket) connection
       #
@@ -20,10 +21,11 @@ module SportsOddsAPI
       # @see SportsOddsAPI::Models::StreamEventsParams
       def events(params = {})
         parsed, options = SportsOddsAPI::StreamEventsParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "stream/events",
-          query: parsed.transform_keys(event_id: "eventID", league_id: "leagueID"),
+          query: query.transform_keys(event_id: "eventID", league_id: "leagueID"),
           model: SportsOddsAPI::Models::StreamEventsResponse,
           options: options
         )

data/lib/sports_odds_api/resources/teams.rb

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get Team-related data
     class Teams
       # Some parameter documentations has been truncated, see
       # {SportsOddsAPI::Models::TeamGetParams} for more details.
@@ -10,7 +11,7 @@ module SportsOddsAPI
       #
       # @overload get(cursor: nil, league_id: nil, limit: nil, sport_id: nil, team_id: nil, request_options: {})
       #
-      # @param cursor [String] The cursor for the request. Used to get the next group of Teams. This should be
+      # @param cursor [String] The cursor for the request. Used to get the next group of Teams. This is an opaq
       #
       # @param league_id [String] A single leagueID or comma-separated list of leagueIDs to get Teams for
       #
@@ -27,10 +28,11 @@ module SportsOddsAPI
       # @see SportsOddsAPI::Models::TeamGetParams
       def get(params = {})
         parsed, options = SportsOddsAPI::TeamGetParams.dump_request(params)
+        query = SportsOddsAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "teams/",
-          query: parsed.transform_keys(league_id: "leagueID", sport_id: "sportID", team_id: "teamID"),
+          query: query.transform_keys(league_id: "leagueID", sport_id: "sportID", team_id: "teamID"),
           page: SportsOddsAPI::Internal::NextCursorPage,
           model: SportsOddsAPI::Team,
           options: options

data/lib/sports_odds_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SportsOddsAPI
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/sports_odds_api.rb

@@ -60,6 +60,8 @@ require_relative "sports_odds_api/models/event_get_params"
 require_relative "sports_odds_api/models/league"
 require_relative "sports_odds_api/models/league_get_params"
 require_relative "sports_odds_api/models/league_get_response"
+require_relative "sports_odds_api/models/market"
+require_relative "sports_odds_api/models/market_get_params"
 require_relative "sports_odds_api/models/player"
 require_relative "sports_odds_api/models/player_get_params"
 require_relative "sports_odds_api/models/rate_limit_interval"
@@ -77,6 +79,7 @@ require_relative "sports_odds_api/models"
 require_relative "sports_odds_api/resources/account"
 require_relative "sports_odds_api/resources/events"
 require_relative "sports_odds_api/resources/leagues"
+require_relative "sports_odds_api/resources/markets"
 require_relative "sports_odds_api/resources/players"
 require_relative "sports_odds_api/resources/sports"
 require_relative "sports_odds_api/resources/stats"

data/rbi/sports_odds_api/client.rbi

@@ -18,27 +18,39 @@ module SportsOddsAPI
     sig { returns(T.nilable(String)) }
     attr_reader :api_key_param
 
+    # Get info about Events (includes odds, results, teams, and other metadata)
     sig { returns(SportsOddsAPI::Resources::Events) }
     attr_reader :events
 
+    # Get metadata on supported Markets
+    sig { returns(SportsOddsAPI::Resources::Markets) }
+    attr_reader :markets
+
+    # Get Team-related data
     sig { returns(SportsOddsAPI::Resources::Teams) }
     attr_reader :teams
 
+    # Get Player-related data
     sig { returns(SportsOddsAPI::Resources::Players) }
     attr_reader :players
 
+    # Get League-related data
     sig { returns(SportsOddsAPI::Resources::Leagues) }
     attr_reader :leagues
 
+    # Get Sport-related data
     sig { returns(SportsOddsAPI::Resources::Sports) }
     attr_reader :sports
 
+    # Get data on specific Stats
     sig { returns(SportsOddsAPI::Resources::Stats) }
     attr_reader :stats
 
+    # Get data related to your Account & API key
     sig { returns(SportsOddsAPI::Resources::Account) }
     attr_reader :account
 
+    # Get info about Events (includes odds, results, teams, and other metadata)
     sig { returns(SportsOddsAPI::Resources::Stream) }
     attr_reader :stream
 

data/rbi/sports_odds_api/internal/util.rbi

@@ -148,12 +148,20 @@ module SportsOddsAPI
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)
@@ -296,11 +304,31 @@ module SportsOddsAPI
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: SportsOddsAPI::Internal::AnyHash).returns(
+            SportsOddsAPI::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: SportsOddsAPI::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(