sports-odds-api 1.0.0

data/lib/sports_odds_api/models/event_get_params.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Events#get
+    class EventGetParams < SportsOddsAPI::Internal::Type::BaseModel
+      extend SportsOddsAPI::Internal::Type::RequestParameters::Converter
+      include SportsOddsAPI::Internal::Type::RequestParameters
+
+      # @!attribute bookmaker_id
+      #   A bookmakerID or comma-separated list of bookmakerIDs to include odds for
+      #
+      #   @return [String, nil]
+      optional :bookmaker_id, String
+
+      # @!attribute cancelled
+      #   Only include cancelled Events (true), only non-cancelled Events (false) or all
+      #   Events (omit)
+      #
+      #   @return [Boolean, nil]
+      optional :cancelled, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute cursor
+      #   The cursor for the request. Used to get the next group of Events. This should be
+      #   the nextCursor from the prior response.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute ended
+      #   Only include Events which have have ended (true), only Events which have not
+      #   ended (false) or all Events (omit)
+      #
+      #   @return [Boolean, nil]
+      optional :ended, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute event_id
+      #   An eventID or comma-separated list of eventIDs to get Event data for
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
+      # @!attribute finalized
+      #   Only include finalized Events (true), exclude unfinalized Events (false) or all
+      #   Events (omit)
+      #
+      #   @return [Boolean, nil]
+      optional :finalized, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute include_alt_lines
+      #   Whether to include alternate lines in the odds byBookmaker data
+      #
+      #   @return [Boolean, nil]
+      optional :include_alt_lines, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute include_opposing_odds
+      #   Whether to include opposing odds for each included oddID
+      #
+      #   @return [Boolean, nil]
+      optional :include_opposing_odds, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute league_id
+      #   A leagueID or comma-separated list of leagueIDs to get Events for
+      #
+      #   @return [String, nil]
+      optional :league_id, String
+
+      # @!attribute limit
+      #   The maximum number of Events to return
+      #
+      #   @return [Float, nil]
+      optional :limit, Float
+
+      # @!attribute live
+      #   Only include live Events (true), only non-live Events (false) or all Events
+      #   (omit)
+      #
+      #   @return [Boolean, nil]
+      optional :live, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute odd_id
+      #   An oddID or comma-separated list of oddIDs to include odds for
+      #
+      #   @return [String, nil]
+      optional :odd_id, String
+
+      # @!attribute odds_available
+      #   Whether you want only Events which do (true) or do not (false) have odds markets
+      #   which are currently available (open for wagering)
+      #
+      #   @return [Boolean, nil]
+      optional :odds_available, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute odds_present
+      #   Whether you want only Events which do (true) or do not (false) have any
+      #   associated odds markets regardless of whether those odds markets are currently
+      #   available (open for wagering)
+      #
+      #   @return [Boolean, nil]
+      optional :odds_present, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute player_id
+      #   A playerID or comma-separated list of playerIDs to include Events (and
+      #   associated odds) for
+      #
+      #   @return [String, nil]
+      optional :player_id, String
+
+      # @!attribute sport_id
+      #   A sportID or comma-separated list of sportIDs to get Events for
+      #
+      #   @return [String, nil]
+      optional :sport_id, String
+
+      # @!attribute started
+      #   Only include Events which have have previously started (true), only Events which
+      #   have not previously started (false) or all Events (omit)
+      #
+      #   @return [Boolean, nil]
+      optional :started, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute starts_after
+      #   Get Events that start after this date
+      #
+      #   @return [Time, nil]
+      optional :starts_after, Time
+
+      # @!attribute starts_before
+      #   Get Events that start before this date
+      #
+      #   @return [Time, nil]
+      optional :starts_before, Time
+
+      # @!attribute team_id
+      #   A teamID or comma-separated list of teamIDs to include Events for
+      #
+      #   @return [String, nil]
+      optional :team_id, String
+
+      # @!attribute type
+      #   Only include Events of the specified type
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(bookmaker_id: nil, cancelled: nil, cursor: nil, ended: nil, event_id: 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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SportsOddsAPI::Models::EventGetParams} for more details.
+      #
+      #   @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 ended [Boolean] Only include Events which have have ended (true), only Events which have not end
+      #
+      #   @param event_id [String] An eventID or comma-separated list of eventIDs to get Event data for
+      #
+      #   @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_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
+      #
+      #   @param limit [Float] The maximum number of Events to return
+      #
+      #   @param live [Boolean] Only include live Events (true), only non-live Events (false) or all Events (omi
+      #
+      #   @param odd_id [String] An oddID or comma-separated list of oddIDs to include odds for
+      #
+      #   @param odds_available [Boolean] Whether you want only Events which do (true) or do not (false) have odds markets
+      #
+      #   @param odds_present [Boolean] Whether you want only Events which do (true) or do not (false) have any associat
+      #
+      #   @param player_id [String] A playerID or comma-separated list of playerIDs to include Events (and associate
+      #
+      #   @param sport_id [String] A sportID or comma-separated list of sportIDs to get Events for
+      #
+      #   @param started [Boolean] Only include Events which have have previously started (true), only Events which
+      #
+      #   @param starts_after [Time] Get Events that start after this date
+      #
+      #   @param starts_before [Time] Get Events that start before this date
+      #
+      #   @param team_id [String] A teamID or comma-separated list of teamIDs to include Events for
+      #
+      #   @param type [String] Only include Events of the specified type
+      #
+      #   @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sports_odds_api/models/league.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    class League < SportsOddsAPI::Internal::Type::BaseModel
+      # @!attribute enabled
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute league_id
+      #
+      #   @return [String, nil]
+      optional :league_id, String, api_name: :leagueID
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute short_name
+      #
+      #   @return [String, nil]
+      optional :short_name, String, api_name: :shortName
+
+      # @!attribute sport_id
+      #
+      #   @return [String, nil]
+      optional :sport_id, String, api_name: :sportID
+
+      # @!method initialize(enabled: nil, league_id: nil, name: nil, short_name: nil, sport_id: nil)
+      #   @param enabled [Boolean]
+      #   @param league_id [String]
+      #   @param name [String]
+      #   @param short_name [String]
+      #   @param sport_id [String]
+    end
+  end
+end

data/lib/sports_odds_api/models/league_get_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Leagues#get
+    class LeagueGetParams < SportsOddsAPI::Internal::Type::BaseModel
+      extend SportsOddsAPI::Internal::Type::RequestParameters::Converter
+      include SportsOddsAPI::Internal::Type::RequestParameters
+
+      # @!attribute league_id
+      #   The league to get data for
+      #
+      #   @return [String, nil]
+      optional :league_id, String
+
+      # @!attribute sport_id
+      #   The sport to get leagues for
+      #
+      #   @return [String, nil]
+      optional :sport_id, String
+
+      # @!method initialize(league_id: nil, sport_id: nil, request_options: {})
+      #   @param league_id [String] The league to get data for
+      #
+      #   @param sport_id [String] The sport to get leagues for
+      #
+      #   @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sports_odds_api/models/league_get_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @type [SportsOddsAPI::Internal::Type::Converter]
+    LeagueGetResponse = SportsOddsAPI::Internal::Type::ArrayOf[-> { SportsOddsAPI::League }]
+  end
+end

data/lib/sports_odds_api/models/player.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Players#get
+    class Player < SportsOddsAPI::Internal::Type::BaseModel
+      # @!attribute aliases
+      #
+      #   @return [Array<String>, nil]
+      optional :aliases, SportsOddsAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute jersey_number
+      #
+      #   @return [Float, nil]
+      optional :jersey_number, Float, api_name: :jerseyNumber
+
+      # @!attribute league_id
+      #
+      #   @return [String, nil]
+      optional :league_id, String, api_name: :leagueID
+
+      # @!attribute lookups
+      #
+      #   @return [SportsOddsAPI::Models::Player::Lookups, nil]
+      optional :lookups, -> { SportsOddsAPI::Player::Lookups }
+
+      # @!attribute names
+      #
+      #   @return [SportsOddsAPI::Models::Player::Names, nil]
+      optional :names, -> { SportsOddsAPI::Player::Names }
+
+      # @!attribute player_id
+      #
+      #   @return [String, nil]
+      optional :player_id, String, api_name: :playerID
+
+      # @!attribute player_teams
+      #
+      #   @return [Hash{Symbol=>SportsOddsAPI::Models::Player::PlayerTeam}, nil]
+      optional :player_teams,
+               -> { SportsOddsAPI::Internal::Type::HashOf[SportsOddsAPI::Player::PlayerTeam] },
+               api_name: :playerTeams
+
+      # @!attribute position
+      #
+      #   @return [String, nil]
+      optional :position, String
+
+      # @!attribute sport_id
+      #
+      #   @return [String, nil]
+      optional :sport_id, String, api_name: :sportID
+
+      # @!attribute team_id
+      #
+      #   @return [String, nil]
+      optional :team_id, String, api_name: :teamID
+
+      # @!method initialize(aliases: nil, jersey_number: nil, league_id: nil, lookups: nil, names: nil, player_id: nil, player_teams: nil, position: nil, sport_id: nil, team_id: nil)
+      #   @param aliases [Array<String>]
+      #   @param jersey_number [Float]
+      #   @param league_id [String]
+      #   @param lookups [SportsOddsAPI::Models::Player::Lookups]
+      #   @param names [SportsOddsAPI::Models::Player::Names]
+      #   @param player_id [String]
+      #   @param player_teams [Hash{Symbol=>SportsOddsAPI::Models::Player::PlayerTeam}]
+      #   @param position [String]
+      #   @param sport_id [String]
+      #   @param team_id [String]
+
+      # @see SportsOddsAPI::Models::Player#lookups
+      class Lookups < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute any_name
+        #
+        #   @return [Array<String>, nil]
+        optional :any_name, SportsOddsAPI::Internal::Type::ArrayOf[String], api_name: :anyName
+
+        # @!attribute full_name
+        #
+        #   @return [Array<String>, nil]
+        optional :full_name, SportsOddsAPI::Internal::Type::ArrayOf[String], api_name: :fullName
+
+        # @!attribute initials
+        #
+        #   @return [Array<String>, nil]
+        optional :initials, SportsOddsAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(any_name: nil, full_name: nil, initials: nil)
+        #   @param any_name [Array<String>]
+        #   @param full_name [Array<String>]
+        #   @param initials [Array<String>]
+      end
+
+      # @see SportsOddsAPI::Models::Player#names
+      class Names < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute display_
+        #
+        #   @return [String, nil]
+        optional :display_, String, api_name: :display
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName
+
+        # @!method initialize(display_: nil, first_name: nil, last_name: nil)
+        #   @param display_ [String]
+        #   @param first_name [String]
+        #   @param last_name [String]
+      end
+
+      class PlayerTeam < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute team_id
+        #
+        #   @return [String, nil]
+        optional :team_id, String, api_name: :teamID
+
+        # @!method initialize(team_id: nil)
+        #   @param team_id [String]
+      end
+    end
+  end
+end

data/lib/sports_odds_api/models/player_get_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Players#get
+    class PlayerGetParams < SportsOddsAPI::Internal::Type::BaseModel
+      extend SportsOddsAPI::Internal::Type::RequestParameters::Converter
+      include SportsOddsAPI::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   The cursor for the request. Used to get the next group of Players. This should
+      #   be the nextCursor from the prior response.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute event_id
+      #   EventID to get Players data for
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
+      # @!attribute limit
+      #   The maximum number of Players to return
+      #
+      #   @return [Float, nil]
+      optional :limit, Float
+
+      # @!attribute player_id
+      #   PlayerID to get data for
+      #
+      #   @return [String, nil]
+      optional :player_id, String
+
+      # @!attribute team_id
+      #   TeamID to get Players data for
+      #
+      #   @return [String, nil]
+      optional :team_id, String
+
+      # @!method initialize(cursor: nil, event_id: nil, limit: nil, player_id: nil, team_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SportsOddsAPI::Models::PlayerGetParams} for more details.
+      #
+      #   @param cursor [String] The cursor for the request. Used to get the next group of Players. This should b
+      #
+      #   @param event_id [String] EventID to get Players data for
+      #
+      #   @param limit [Float] The maximum number of Players to return
+      #
+      #   @param player_id [String] PlayerID to get data for
+      #
+      #   @param team_id [String] TeamID to get Players data for
+      #
+      #   @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sports_odds_api/models/rate_limit_interval.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    class RateLimitInterval < SportsOddsAPI::Internal::Type::BaseModel
+      # @!attribute current_entities
+      #   Current number of entities accessed in the interval
+      #
+      #   @return [Integer, nil]
+      optional :current_entities, Integer, api_name: :"current-entities"
+
+      # @!attribute current_requests
+      #   Current number of requests made in the interval
+      #
+      #   @return [Integer, nil]
+      optional :current_requests, Integer, api_name: :"current-requests"
+
+      # @!attribute max_entities
+      #   Maximum allowed entity accesses in the interval
+      #
+      #   @return [Symbol, Integer, SportsOddsAPI::Models::RateLimitInterval::MaxEntities, nil]
+      optional :max_entities,
+               union: -> { SportsOddsAPI::RateLimitInterval::MaxEntities },
+               api_name: :"max-entities"
+
+      # @!attribute max_requests
+      #   Maximum allowed requests in the interval
+      #
+      #   @return [Symbol, Integer, SportsOddsAPI::Models::RateLimitInterval::MaxRequests, nil]
+      optional :max_requests,
+               union: -> { SportsOddsAPI::RateLimitInterval::MaxRequests },
+               api_name: :"max-requests"
+
+      # @!method initialize(current_entities: nil, current_requests: nil, max_entities: nil, max_requests: nil)
+      #   @param current_entities [Integer] Current number of entities accessed in the interval
+      #
+      #   @param current_requests [Integer] Current number of requests made in the interval
+      #
+      #   @param max_entities [Symbol, Integer, SportsOddsAPI::Models::RateLimitInterval::MaxEntities] Maximum allowed entity accesses in the interval
+      #
+      #   @param max_requests [Symbol, Integer, SportsOddsAPI::Models::RateLimitInterval::MaxRequests] Maximum allowed requests in the interval
+
+      # Maximum allowed entity accesses in the interval
+      #
+      # @see SportsOddsAPI::Models::RateLimitInterval#max_entities
+      module MaxEntities
+        extend SportsOddsAPI::Internal::Type::Union
+
+        variant const: -> { SportsOddsAPI::Models::RateLimitInterval::MaxEntities::UNLIMITED }
+
+        variant Integer
+
+        # @!method self.variants
+        #   @return [Array(Symbol, Integer)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(SportsOddsAPI::RateLimitInterval::MaxEntities::TaggedSymbol, Integer) }
+        end
+
+        # @!group
+
+        UNLIMITED = :unlimited
+
+        # @!endgroup
+      end
+
+      # Maximum allowed requests in the interval
+      #
+      # @see SportsOddsAPI::Models::RateLimitInterval#max_requests
+      module MaxRequests
+        extend SportsOddsAPI::Internal::Type::Union
+
+        variant const: -> { SportsOddsAPI::Models::RateLimitInterval::MaxRequests::UNLIMITED }
+
+        variant Integer
+
+        # @!method self.variants
+        #   @return [Array(Symbol, Integer)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(SportsOddsAPI::RateLimitInterval::MaxRequests::TaggedSymbol, Integer) }
+        end
+
+        # @!group
+
+        UNLIMITED = :unlimited
+
+        # @!endgroup
+      end
+    end
+  end
+end