sports-odds-api 1.2.2 → 1.3.0

data/rbi/sports_odds_api/models/team.rbi

@@ -8,6 +8,12 @@ module SportsOddsAPI
           T.any(SportsOddsAPI::Team, SportsOddsAPI::Internal::AnyHash)
         end
 
+      sig { returns(T.nilable(SportsOddsAPI::Team::Coach)) }
+      attr_reader :coach
+
+      sig { params(coach: SportsOddsAPI::Team::Coach::OrHash).void }
+      attr_writer :coach
+
       sig { returns(T.nilable(SportsOddsAPI::Team::Colors)) }
       attr_reader :colors
 
@@ -38,6 +44,12 @@ module SportsOddsAPI
       sig { params(names: SportsOddsAPI::Team::Names::OrHash).void }
       attr_writer :names
 
+      sig { returns(T.nilable(SportsOddsAPI::Team::Owner)) }
+      attr_reader :owner
+
+      sig { params(owner: SportsOddsAPI::Team::Owner::OrHash).void }
+      attr_writer :owner
+
       sig { returns(T.nilable(String)) }
       attr_reader :sport_id
 
@@ -56,47 +68,83 @@ module SportsOddsAPI
       sig { params(team_id: String).void }
       attr_writer :team_id
 
+      sig { returns(T.nilable(SportsOddsAPI::Team::Venue)) }
+      attr_reader :venue
+
+      sig { params(venue: SportsOddsAPI::Team::Venue::OrHash).void }
+      attr_writer :venue
+
       sig do
         params(
+          coach: SportsOddsAPI::Team::Coach::OrHash,
           colors: SportsOddsAPI::Team::Colors::OrHash,
           league_id: String,
           logo: String,
           lookups: SportsOddsAPI::Team::Lookups::OrHash,
           names: SportsOddsAPI::Team::Names::OrHash,
+          owner: SportsOddsAPI::Team::Owner::OrHash,
           sport_id: String,
           standings: SportsOddsAPI::Team::Standings::OrHash,
-          team_id: String
+          team_id: String,
+          venue: SportsOddsAPI::Team::Venue::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        coach: nil,
         colors: nil,
         league_id: nil,
         logo: nil,
         lookups: nil,
         names: nil,
+        owner: nil,
         sport_id: nil,
         standings: nil,
-        team_id: nil
+        team_id: nil,
+        venue: nil
       )
       end
 
       sig do
         override.returns(
           {
+            coach: SportsOddsAPI::Team::Coach,
             colors: SportsOddsAPI::Team::Colors,
             league_id: String,
             logo: String,
             lookups: SportsOddsAPI::Team::Lookups,
             names: SportsOddsAPI::Team::Names,
+            owner: SportsOddsAPI::Team::Owner,
             sport_id: String,
             standings: SportsOddsAPI::Team::Standings,
-            team_id: String
+            team_id: String,
+            venue: SportsOddsAPI::Team::Venue
           }
         )
       end
       def to_hash
       end
 
+      class Coach < SportsOddsAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SportsOddsAPI::Team::Coach, SportsOddsAPI::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { params(name: String).returns(T.attached_class) }
+        def self.new(name: nil)
+        end
+
+        sig { override.returns({ name: String }) }
+        def to_hash
+        end
+      end
+
       class Colors < SportsOddsAPI::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -220,6 +268,27 @@ module SportsOddsAPI
         end
       end
 
+      class Owner < SportsOddsAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SportsOddsAPI::Team::Owner, SportsOddsAPI::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { params(name: String).returns(T.attached_class) }
+        def self.new(name: nil)
+        end
+
+        sig { override.returns({ name: String }) }
+        def to_hash
+        end
+      end
+
       class Standings < SportsOddsAPI::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -229,6 +298,12 @@ module SportsOddsAPI
             )
           end
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :last5
+
+        sig { params(last5: String).void }
+        attr_writer :last5
+
         sig { returns(T.nilable(Float)) }
         attr_reader :losses
 
@@ -253,6 +328,12 @@ module SportsOddsAPI
         sig { params(record: String).void }
         attr_writer :record
 
+        sig { returns(T.nilable(Float)) }
+        attr_reader :streak
+
+        sig { params(streak: Float).void }
+        attr_writer :streak
+
         sig { returns(T.nilable(Float)) }
         attr_reader :ties
 
@@ -267,19 +348,23 @@ module SportsOddsAPI
 
         sig do
           params(
+            last5: String,
             losses: Float,
             played: Float,
             position: String,
             record: String,
+            streak: Float,
             ties: Float,
             wins: Float
           ).returns(T.attached_class)
         end
         def self.new(
+          last5: nil,
           losses: nil,
           played: nil,
           position: nil,
           record: nil,
+          streak: nil,
           ties: nil,
           wins: nil
         )
@@ -288,10 +373,12 @@ module SportsOddsAPI
         sig do
           override.returns(
             {
+              last5: String,
               losses: Float,
               played: Float,
               position: String,
               record: String,
+              streak: Float,
               ties: Float,
               wins: Float
             }
@@ -300,6 +387,102 @@ module SportsOddsAPI
         def to_hash
         end
       end
+
+      class Venue < SportsOddsAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SportsOddsAPI::Team::Venue, SportsOddsAPI::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :address
+
+        sig { params(address: String).void }
+        attr_writer :address
+
+        sig { returns(T.nilable(Float)) }
+        attr_reader :capacity
+
+        sig { params(capacity: Float).void }
+        attr_writer :capacity
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :city
+
+        sig { params(city: String).void }
+        attr_writer :city
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :country_code
+
+        sig { params(country_code: String).void }
+        attr_writer :country_code
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :country_name
+
+        sig { params(country_name: String).void }
+        attr_writer :country_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_code
+
+        sig { params(region_code: String).void }
+        attr_writer :region_code
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_name
+
+        sig { params(region_name: String).void }
+        attr_writer :region_name
+
+        sig do
+          params(
+            address: String,
+            capacity: Float,
+            city: String,
+            country_code: String,
+            country_name: String,
+            name: String,
+            region_code: String,
+            region_name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          address: nil,
+          capacity: nil,
+          city: nil,
+          country_code: nil,
+          country_name: nil,
+          name: nil,
+          region_code: nil,
+          region_name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              address: String,
+              capacity: Float,
+              city: String,
+              country_code: String,
+              country_name: String,
+              name: String,
+              region_code: String,
+              region_name: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sports_odds_api/models/team_get_params.rbi

@@ -11,8 +11,8 @@ module SportsOddsAPI
           T.any(SportsOddsAPI::TeamGetParams, SportsOddsAPI::Internal::AnyHash)
         end
 
-      # The cursor for the request. Used to get the next group of Teams. This should be
-      # the nextCursor from the prior response.
+      # The cursor for the request. Used to get the next group of Teams. This is an
+      # opaque token — pass the nextCursor value from the prior response unchanged.
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
 
@@ -58,8 +58,8 @@ module SportsOddsAPI
         ).returns(T.attached_class)
       end
       def self.new(
-        # The cursor for the request. Used to get the next group of Teams. This should be
-        # the nextCursor from the prior response.
+        # The cursor for the request. Used to get the next group of Teams. This is an
+        # opaque token — pass the nextCursor value from the prior response unchanged.
         cursor: nil,
         # A single leagueID or comma-separated list of leagueIDs to get Teams for
         league_id: nil,

data/rbi/sports_odds_api/models.rbi

@@ -13,6 +13,10 @@ module SportsOddsAPI
 
   LeagueGetParams = SportsOddsAPI::Models::LeagueGetParams
 
+  Market = SportsOddsAPI::Models::Market
+
+  MarketGetParams = SportsOddsAPI::Models::MarketGetParams
+
   Player = SportsOddsAPI::Models::Player
 
   PlayerGetParams = SportsOddsAPI::Models::PlayerGetParams

data/rbi/sports_odds_api/resources/account.rbi

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get data related to your Account & API key
     class Account
       # Get rate-limits and usage data about your API key
       sig do

data/rbi/sports_odds_api/resources/events.rbi

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get info about Events (includes odds, results, teams, and other metadata)
     class Events
       # Get a list of Events
       sig do
@@ -12,8 +13,10 @@ module SportsOddsAPI
           ended: T::Boolean,
           event_id: String,
           event_ids: String,
+          expand_results: T::Boolean,
           finalized: T::Boolean,
           include_alt_lines: T::Boolean,
+          include_open_close_odds: T::Boolean,
           include_opposing_odds: T::Boolean,
           league_id: String,
           limit: Float,
@@ -37,8 +40,8 @@ module SportsOddsAPI
         # Only include cancelled Events (true), only non-cancelled Events (false) or all
         # Events (omit)
         cancelled: nil,
-        # The cursor for the request. Used to get the next group of Events. This should be
-        # the nextCursor from the prior response.
+        # The cursor for the request. Used to get the next group of Events. This is an
+        # opaque token — pass the nextCursor value from the prior response unchanged.
         cursor: nil,
         # Only include Events which have have ended (true), only Events which have not
         # ended (false) or all Events (omit)
@@ -47,11 +50,17 @@ module SportsOddsAPI
         event_id: nil,
         # A comma separated list of eventIDs to get Event data for
         event_ids: nil,
+        # Whether to expand the results object to include all stat values rather than just
+        # the base set
+        expand_results: nil,
         # Only include finalized Events (true), exclude unfinalized Events (false) or all
         # Events (omit)
         finalized: nil,
         # Whether to include alternate lines in the odds byBookmaker data
         include_alt_lines: nil,
+        # Whether to include open and close odds values (openOdds, closeOdds, openSpread,
+        # closeSpread, openOverUnder, closeOverUnder) in the odds byBookmaker data
+        include_open_close_odds: nil,
         # Whether to include opposing odds for each included oddID
         include_opposing_odds: nil,
         # A leagueID or comma-separated list of leagueIDs to get Events for

data/rbi/sports_odds_api/resources/leagues.rbi

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get League-related data
     class Leagues
       # Get a list of Leagues
       sig do

data/rbi/sports_odds_api/resources/markets.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module SportsOddsAPI
+  module Resources
+    # Get metadata on supported Markets
+    class Markets
+      # Get a list of Markets
+      sig do
+        params(
+          bet_type_id: String,
+          bookmaker_id: String,
+          cursor: String,
+          is_main_market: T::Boolean,
+          is_prop: T::Boolean,
+          is_sub_period: T::Boolean,
+          is_supported: T::Boolean,
+          league_id: String,
+          limit: Float,
+          odd_id: String,
+          period_id: String,
+          prop_type: String,
+          side_id: String,
+          sport_id: String,
+          stat_entity_id: String,
+          stat_id: String,
+          request_options: SportsOddsAPI::RequestOptions::OrHash
+        ).returns(
+          SportsOddsAPI::Internal::NextCursorPage[SportsOddsAPI::Market]
+        )
+      end
+      def get(
+        # A single betTypeID or comma-separated list of betTypeIDs to filter Markets by
+        bet_type_id: nil,
+        # A single bookmakerID or comma-separated list of bookmakerIDs to filter Markets
+        # by
+        bookmaker_id: nil,
+        # The cursor for pagination. Use nextCursor from prior response.
+        cursor: nil,
+        # Filter to only include main markets (main period moneyline, spread, and
+        # over/under)
+        is_main_market: nil,
+        # Filter by whether it is any type of prop bet market
+        is_prop: nil,
+        # Filter by whether it tracks a sub/non-main period
+        is_sub_period: nil,
+        # Filter whether this market is fully supported by at least 1 bookmaker in at
+        # least 1 league. Defaults to true if not specified.
+        is_supported: nil,
+        # A single leagueID or comma-separated list of leagueIDs to filter Markets by
+        league_id: nil,
+        # The maximum number of Markets to return (default: 100, max: 10000)
+        limit: nil,
+        # A single oddID or comma-separated list of oddIDs. Used to specify specific
+        # Markets to return.
+        odd_id: nil,
+        # A single periodID or comma-separated list of periodIDs to filter Markets by
+        period_id: nil,
+        # Filter by prop type (game_prop, team_prop, player_prop, other_prop)
+        prop_type: nil,
+        # A single sideID or comma-separated list of sideIDs to filter Markets by
+        side_id: nil,
+        # A single sportID or comma-separated list of sportIDs to filter Markets by
+        sport_id: nil,
+        # A single statEntityID or comma-separated list of statEntityIDs to filter Markets
+        # by
+        stat_entity_id: nil,
+        # A single statID or comma-separated list of statIDs to filter Markets by
+        stat_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SportsOddsAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/sports_odds_api/resources/players.rbi

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get Player-related data
     class Players
       # Get a list of Players for a specific Team or Event
       sig do
@@ -17,8 +18,8 @@ module SportsOddsAPI
         )
       end
       def get(
-        # The cursor for the request. Used to get the next group of Players. This should
-        # be the nextCursor from the prior response.
+        # The cursor for the request. Used to get the next group of Players. This is an
+        # opaque token — pass the nextCursor value from the prior response unchanged.
         cursor: nil,
         # EventID to get Players data for
         event_id: nil,

data/rbi/sports_odds_api/resources/sports.rbi

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

data/rbi/sports_odds_api/resources/stats.rbi

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get data on specific Stats
     class Stats
       # Get a list of StatIDs
       sig do

data/rbi/sports_odds_api/resources/stream.rbi

@@ -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
       sig do

data/rbi/sports_odds_api/resources/teams.rbi

@@ -2,6 +2,7 @@
 
 module SportsOddsAPI
   module Resources
+    # Get Team-related data
     class Teams
       # Get a list of Teams by ID or league
       sig do
@@ -15,8 +16,8 @@ module SportsOddsAPI
         ).returns(SportsOddsAPI::Internal::NextCursorPage[SportsOddsAPI::Team])
       end
       def get(
-        # The cursor for the request. Used to get the next group of Teams. This should be
-        # the nextCursor from the prior response.
+        # The cursor for the request. Used to get the next group of Teams. This is an
+        # opaque token — pass the nextCursor value from the prior response unchanged.
         cursor: nil,
         # A single leagueID or comma-separated list of leagueIDs to get Teams for
         league_id: nil,

data/sig/sports_odds_api/client.rbs

@@ -14,6 +14,8 @@ module SportsOddsAPI
 
     attr_reader events: SportsOddsAPI::Resources::Events
 
+    attr_reader markets: SportsOddsAPI::Resources::Markets
+
     attr_reader teams: SportsOddsAPI::Resources::Teams
 
     attr_reader players: SportsOddsAPI::Resources::Players

data/sig/sports_odds_api/internal/util.rbs

@@ -45,8 +45,12 @@ module SportsOddsAPI
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]
@@ -106,6 +110,16 @@ module SportsOddsAPI
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,