sports-odds-api 1.0.0

data/lib/sports_odds_api/models/sport.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    class Sport < SportsOddsAPI::Internal::Type::BaseModel
+      # @!attribute background_image
+      #
+      #   @return [String, nil]
+      optional :background_image, String, api_name: :backgroundImage
+
+      # @!attribute base_periods
+      #
+      #   @return [Array<String>, nil]
+      optional :base_periods, SportsOddsAPI::Internal::Type::ArrayOf[String], api_name: :basePeriods
+
+      # @!attribute clock_type
+      #
+      #   @return [String, nil]
+      optional :clock_type, String, api_name: :clockType
+
+      # @!attribute default_popularity_score
+      #
+      #   @return [Float, nil]
+      optional :default_popularity_score, Float, api_name: :defaultPopularityScore
+
+      # @!attribute enabled
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute event_word
+      #
+      #   @return [SportsOddsAPI::Models::Sport::EventWord, nil]
+      optional :event_word, -> { SportsOddsAPI::Sport::EventWord }, api_name: :eventWord
+
+      # @!attribute extra_periods
+      #
+      #   @return [Array<String>, nil]
+      optional :extra_periods, SportsOddsAPI::Internal::Type::ArrayOf[String], api_name: :extraPeriods
+
+      # @!attribute has_meaningful_home_away
+      #
+      #   @return [Boolean, nil]
+      optional :has_meaningful_home_away,
+               SportsOddsAPI::Internal::Type::Boolean,
+               api_name: :hasMeaningfulHomeAway
+
+      # @!attribute image_icon
+      #
+      #   @return [String, nil]
+      optional :image_icon, String, api_name: :imageIcon
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute point_word
+      #
+      #   @return [SportsOddsAPI::Models::Sport::PointWord, nil]
+      optional :point_word, -> { SportsOddsAPI::Sport::PointWord }, api_name: :pointWord
+
+      # @!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
+
+      # @!attribute square_image
+      #
+      #   @return [String, nil]
+      optional :square_image, String, api_name: :squareImage
+
+      # @!method initialize(background_image: nil, base_periods: nil, clock_type: nil, default_popularity_score: nil, enabled: nil, event_word: nil, extra_periods: nil, has_meaningful_home_away: nil, image_icon: nil, name: nil, point_word: nil, short_name: nil, sport_id: nil, square_image: nil)
+      #   @param background_image [String]
+      #   @param base_periods [Array<String>]
+      #   @param clock_type [String]
+      #   @param default_popularity_score [Float]
+      #   @param enabled [Boolean]
+      #   @param event_word [SportsOddsAPI::Models::Sport::EventWord]
+      #   @param extra_periods [Array<String>]
+      #   @param has_meaningful_home_away [Boolean]
+      #   @param image_icon [String]
+      #   @param name [String]
+      #   @param point_word [SportsOddsAPI::Models::Sport::PointWord]
+      #   @param short_name [String]
+      #   @param sport_id [String]
+      #   @param square_image [String]
+
+      # @see SportsOddsAPI::Models::Sport#event_word
+      class EventWord < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute long
+        #
+        #   @return [SportsOddsAPI::Models::Sport::EventWord::Long, nil]
+        optional :long, -> { SportsOddsAPI::Sport::EventWord::Long }
+
+        # @!attribute short
+        #
+        #   @return [SportsOddsAPI::Models::Sport::EventWord::Short, nil]
+        optional :short, -> { SportsOddsAPI::Sport::EventWord::Short }
+
+        # @!method initialize(long: nil, short: nil)
+        #   @param long [SportsOddsAPI::Models::Sport::EventWord::Long]
+        #   @param short [SportsOddsAPI::Models::Sport::EventWord::Short]
+
+        # @see SportsOddsAPI::Models::Sport::EventWord#long
+        class Long < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute plural
+          #
+          #   @return [String, nil]
+          optional :plural, String
+
+          # @!attribute singular
+          #
+          #   @return [String, nil]
+          optional :singular, String
+
+          # @!method initialize(plural: nil, singular: nil)
+          #   @param plural [String]
+          #   @param singular [String]
+        end
+
+        # @see SportsOddsAPI::Models::Sport::EventWord#short
+        class Short < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute plural
+          #
+          #   @return [String, nil]
+          optional :plural, String
+
+          # @!attribute singular
+          #
+          #   @return [String, nil]
+          optional :singular, String
+
+          # @!method initialize(plural: nil, singular: nil)
+          #   @param plural [String]
+          #   @param singular [String]
+        end
+      end
+
+      # @see SportsOddsAPI::Models::Sport#point_word
+      class PointWord < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute long
+        #
+        #   @return [SportsOddsAPI::Models::Sport::PointWord::Long, nil]
+        optional :long, -> { SportsOddsAPI::Sport::PointWord::Long }
+
+        # @!attribute short
+        #
+        #   @return [SportsOddsAPI::Models::Sport::PointWord::Short, nil]
+        optional :short, -> { SportsOddsAPI::Sport::PointWord::Short }
+
+        # @!method initialize(long: nil, short: nil)
+        #   @param long [SportsOddsAPI::Models::Sport::PointWord::Long]
+        #   @param short [SportsOddsAPI::Models::Sport::PointWord::Short]
+
+        # @see SportsOddsAPI::Models::Sport::PointWord#long
+        class Long < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute plural
+          #
+          #   @return [String, nil]
+          optional :plural, String
+
+          # @!attribute singular
+          #
+          #   @return [String, nil]
+          optional :singular, String
+
+          # @!method initialize(plural: nil, singular: nil)
+          #   @param plural [String]
+          #   @param singular [String]
+        end
+
+        # @see SportsOddsAPI::Models::Sport::PointWord#short
+        class Short < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute plural
+          #
+          #   @return [String, nil]
+          optional :plural, String
+
+          # @!attribute singular
+          #
+          #   @return [String, nil]
+          optional :singular, String
+
+          # @!method initialize(plural: nil, singular: nil)
+          #   @param plural [String]
+          #   @param singular [String]
+        end
+      end
+    end
+  end
+end

data/lib/sports_odds_api/models/sport_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Sports#get
+    class SportGetParams < SportsOddsAPI::Internal::Type::BaseModel
+      extend SportsOddsAPI::Internal::Type::RequestParameters::Converter
+      include SportsOddsAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sports_odds_api/models/sport_get_response.rb

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

data/lib/sports_odds_api/models/stat.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    class Stat < SportsOddsAPI::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute displays
+      #
+      #   @return [SportsOddsAPI::Models::Stat::Displays, nil]
+      optional :displays, -> { SportsOddsAPI::Stat::Displays }
+
+      # @!attribute is_score_stat
+      #
+      #   @return [Boolean, nil]
+      optional :is_score_stat, SportsOddsAPI::Internal::Type::Boolean, api_name: :isScoreStat
+
+      # @!attribute stat_id
+      #
+      #   @return [String, nil]
+      optional :stat_id, String, api_name: :statID
+
+      # @!attribute supported_levels
+      #
+      #   @return [SportsOddsAPI::Models::Stat::SupportedLevels, nil]
+      optional :supported_levels, -> { SportsOddsAPI::Stat::SupportedLevels }, api_name: :supportedLevels
+
+      # @!attribute supported_sports
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :supported_sports,
+               SportsOddsAPI::Internal::Type::HashOf[SportsOddsAPI::Internal::Type::Unknown],
+               api_name: :supportedSports
+
+      # @!attribute units
+      #
+      #   @return [SportsOddsAPI::Models::Stat::Units, nil]
+      optional :units, -> { SportsOddsAPI::Stat::Units }
+
+      # @!method initialize(description: nil, displays: nil, is_score_stat: nil, stat_id: nil, supported_levels: nil, supported_sports: nil, units: nil)
+      #   @param description [String]
+      #   @param displays [SportsOddsAPI::Models::Stat::Displays]
+      #   @param is_score_stat [Boolean]
+      #   @param stat_id [String]
+      #   @param supported_levels [SportsOddsAPI::Models::Stat::SupportedLevels]
+      #   @param supported_sports [Hash{Symbol=>Object}]
+      #   @param units [SportsOddsAPI::Models::Stat::Units]
+
+      # @see SportsOddsAPI::Models::Stat#displays
+      class Displays < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute long
+        #
+        #   @return [String, nil]
+        optional :long, String
+
+        # @!attribute short
+        #
+        #   @return [String, nil]
+        optional :short, String
+
+        # @!method initialize(long: nil, short: nil)
+        #   @param long [String]
+        #   @param short [String]
+      end
+
+      # @see SportsOddsAPI::Models::Stat#supported_levels
+      class SupportedLevels < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute all
+        #
+        #   @return [Boolean, nil]
+        optional :all, SportsOddsAPI::Internal::Type::Boolean
+
+        # @!attribute player
+        #
+        #   @return [Boolean, nil]
+        optional :player, SportsOddsAPI::Internal::Type::Boolean
+
+        # @!attribute team
+        #
+        #   @return [Boolean, nil]
+        optional :team, SportsOddsAPI::Internal::Type::Boolean
+
+        # @!method initialize(all: nil, player: nil, team: nil)
+        #   @param all [Boolean]
+        #   @param player [Boolean]
+        #   @param team [Boolean]
+      end
+
+      # @see SportsOddsAPI::Models::Stat#units
+      class Units < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute long
+        #
+        #   @return [SportsOddsAPI::Models::Stat::Units::Long, nil]
+        optional :long, -> { SportsOddsAPI::Stat::Units::Long }
+
+        # @!attribute short
+        #
+        #   @return [SportsOddsAPI::Models::Stat::Units::Short, nil]
+        optional :short, -> { SportsOddsAPI::Stat::Units::Short }
+
+        # @!method initialize(long: nil, short: nil)
+        #   @param long [SportsOddsAPI::Models::Stat::Units::Long]
+        #   @param short [SportsOddsAPI::Models::Stat::Units::Short]
+
+        # @see SportsOddsAPI::Models::Stat::Units#long
+        class Long < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute plural
+          #
+          #   @return [String, nil]
+          optional :plural, String
+
+          # @!attribute singular
+          #
+          #   @return [String, nil]
+          optional :singular, String
+
+          # @!method initialize(plural: nil, singular: nil)
+          #   @param plural [String]
+          #   @param singular [String]
+        end
+
+        # @see SportsOddsAPI::Models::Stat::Units#short
+        class Short < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute plural
+          #
+          #   @return [String, nil]
+          optional :plural, String
+
+          # @!attribute singular
+          #
+          #   @return [String, nil]
+          optional :singular, String
+
+          # @!method initialize(plural: nil, singular: nil)
+          #   @param plural [String]
+          #   @param singular [String]
+        end
+      end
+    end
+  end
+end

data/lib/sports_odds_api/models/stat_get_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Stats#get
+    class StatGetParams < SportsOddsAPI::Internal::Type::BaseModel
+      extend SportsOddsAPI::Internal::Type::RequestParameters::Converter
+      include SportsOddsAPI::Internal::Type::RequestParameters
+
+      # @!attribute sport_id
+      #   SportID to get StatIDs for
+      #
+      #   @return [String, nil]
+      optional :sport_id, String
+
+      # @!attribute stat_id
+      #   StatID to get data for
+      #
+      #   @return [String, nil]
+      optional :stat_id, String
+
+      # @!attribute stat_level
+      #   Level of the stat, must be used in combination with sportID. Must be one of all,
+      #   player, or team. Shows stats that are applicable to that specified entity,
+      #   defaults to all.
+      #
+      #   @return [String, nil]
+      optional :stat_level, String
+
+      # @!method initialize(sport_id: nil, stat_id: nil, stat_level: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SportsOddsAPI::Models::StatGetParams} for more details.
+      #
+      #   @param sport_id [String] SportID to get StatIDs for
+      #
+      #   @param stat_id [String] StatID to get data for
+      #
+      #   @param stat_level [String] Level of the stat, must be used in combination with sportID. Must be one of all,
+      #
+      #   @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sports_odds_api/models/stat_get_response.rb

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

data/lib/sports_odds_api/models/stream_events_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Stream#events
+    class StreamEventsParams < SportsOddsAPI::Internal::Type::BaseModel
+      extend SportsOddsAPI::Internal::Type::RequestParameters::Converter
+      include SportsOddsAPI::Internal::Type::RequestParameters
+
+      # @!attribute event_id
+      #   An eventID to stream events for
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
+      # @!attribute feed
+      #   The feed you would like to subscribe to
+      #
+      #   @return [String, nil]
+      optional :feed, String
+
+      # @!attribute league_id
+      #   A leagueID to stream events for
+      #
+      #   @return [String, nil]
+      optional :league_id, String
+
+      # @!method initialize(event_id: nil, feed: nil, league_id: nil, request_options: {})
+      #   @param event_id [String] An eventID to stream events for
+      #
+      #   @param feed [String] The feed you would like to subscribe to
+      #
+      #   @param league_id [String] A leagueID to stream events for
+      #
+      #   @param request_options [SportsOddsAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sports_odds_api/models/stream_events_response.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module SportsOddsAPI
+  module Models
+    # @see SportsOddsAPI::Resources::Stream#events
+    class StreamEventsResponse < SportsOddsAPI::Internal::Type::BaseModel
+      # @!attribute channel
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute data
+      #
+      #   @return [Array<SportsOddsAPI::Models::Event>, nil]
+      optional :data, -> { SportsOddsAPI::Internal::Type::ArrayOf[SportsOddsAPI::Event] }
+
+      # @!attribute pusher_key
+      #
+      #   @return [String, nil]
+      optional :pusher_key, String, api_name: :pusherKey
+
+      # @!attribute pusher_options
+      #
+      #   @return [SportsOddsAPI::Models::StreamEventsResponse::PusherOptions, nil]
+      optional :pusher_options,
+               -> { SportsOddsAPI::Models::StreamEventsResponse::PusherOptions },
+               api_name: :pusherOptions
+
+      # @!attribute success
+      #
+      #   @return [Boolean, nil]
+      optional :success, SportsOddsAPI::Internal::Type::Boolean
+
+      # @!attribute user
+      #
+      #   @return [String, nil]
+      optional :user, String
+
+      # @!method initialize(channel: nil, data: nil, pusher_key: nil, pusher_options: nil, success: nil, user: nil)
+      #   @param channel [String]
+      #   @param data [Array<SportsOddsAPI::Models::Event>]
+      #   @param pusher_key [String]
+      #   @param pusher_options [SportsOddsAPI::Models::StreamEventsResponse::PusherOptions]
+      #   @param success [Boolean]
+      #   @param user [String]
+
+      # @see SportsOddsAPI::Models::StreamEventsResponse#pusher_options
+      class PusherOptions < SportsOddsAPI::Internal::Type::BaseModel
+        # @!attribute channel_authorization
+        #
+        #   @return [SportsOddsAPI::Models::StreamEventsResponse::PusherOptions::ChannelAuthorization, nil]
+        optional :channel_authorization,
+                 -> { SportsOddsAPI::Models::StreamEventsResponse::PusherOptions::ChannelAuthorization },
+                 api_name: :channelAuthorization
+
+        # @!attribute cluster
+        #
+        #   @return [String, nil]
+        optional :cluster, String
+
+        # @!attribute http_host
+        #
+        #   @return [String, nil]
+        optional :http_host, String, api_name: :httpHost
+
+        # @!attribute http_port
+        #
+        #   @return [Integer, nil]
+        optional :http_port, Integer, api_name: :httpPort
+
+        # @!attribute https_port
+        #
+        #   @return [Integer, nil]
+        optional :https_port, Integer, api_name: :httpsPort
+
+        # @!attribute ws_host
+        #
+        #   @return [String, nil]
+        optional :ws_host, String, api_name: :wsHost
+
+        # @!attribute ws_port
+        #
+        #   @return [Integer, nil]
+        optional :ws_port, Integer, api_name: :wsPort
+
+        # @!attribute wss_port
+        #
+        #   @return [Integer, nil]
+        optional :wss_port, Integer, api_name: :wssPort
+
+        # @!method initialize(channel_authorization: nil, cluster: nil, http_host: nil, http_port: nil, https_port: nil, ws_host: nil, ws_port: nil, wss_port: nil)
+        #   @param channel_authorization [SportsOddsAPI::Models::StreamEventsResponse::PusherOptions::ChannelAuthorization]
+        #   @param cluster [String]
+        #   @param http_host [String]
+        #   @param http_port [Integer]
+        #   @param https_port [Integer]
+        #   @param ws_host [String]
+        #   @param ws_port [Integer]
+        #   @param wss_port [Integer]
+
+        # @see SportsOddsAPI::Models::StreamEventsResponse::PusherOptions#channel_authorization
+        class ChannelAuthorization < SportsOddsAPI::Internal::Type::BaseModel
+          # @!attribute endpoint
+          #
+          #   @return [String, nil]
+          optional :endpoint, String
+
+          # @!attribute headers
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :headers, SportsOddsAPI::Internal::Type::HashOf[String]
+
+          # @!method initialize(endpoint: nil, headers: nil)
+          #   @param endpoint [String]
+          #   @param headers [Hash{Symbol=>String}]
+        end
+      end
+    end
+  end
+end