// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import MiniSearch from 'minisearch'; import * as fs from 'node:fs/promises'; import * as path from 'node:path'; import { getLogger } from './logger'; type PerLanguageData = { method?: string; example?: string; }; type MethodEntry = { name: string; endpoint: string; httpMethod: string; summary: string; description: string; stainlessPath: string; qualified: string; params?: string[]; response?: string; markdown?: string; perLanguage?: Record; }; type ProseChunk = { content: string; tag: string; sectionContext?: string; source?: string; }; type MiniSearchDocument = { id: string; kind: 'http_method' | 'prose'; name?: string; endpoint?: string; summary?: string; description?: string; qualified?: string; stainlessPath?: string; content?: string; sectionContext?: string; _original: Record; }; type SearchResult = { results: (string | Record)[]; }; const EMBEDDED_METHODS: MethodEntry[] = [ { name: 'get', endpoint: '/events/', httpMethod: 'get', summary: '', description: 'Get a list of Events', stainlessPath: '(resource) events > (method) get', qualified: 'client.events.get', params: [ 'bookmakerID?: string;', 'cancelled?: boolean;', 'cursor?: string;', 'ended?: boolean;', 'eventID?: string;', 'eventIDs?: string;', 'expandResults?: boolean;', 'finalized?: boolean;', 'includeAltLines?: boolean;', 'includeOpenCloseOdds?: boolean;', 'includeOpposingOdds?: boolean;', 'leagueID?: string;', 'limit?: number;', 'live?: boolean;', 'oddID?: string;', 'oddsAvailable?: boolean;', 'oddsPresent?: boolean;', 'playerID?: string;', 'sportID?: string;', 'started?: boolean;', 'startsAfter?: string;', 'startsBefore?: string;', 'teamID?: string;', 'type?: string;', ], response: "{ activity?: { count?: number; score?: number; }; eventID?: string; info?: { broadcasts?: { broadcasterID?: string; name?: string; type?: 'tv' | 'webstream' | 'subscription' | 'sportsbook'; }[]; referee?: { name?: string; }; seasonWeek?: string; venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }; }; leagueID?: string; manual?: boolean; odds?: object; players?: object; results?: object; sportID?: string; status?: { cancelled?: boolean; completed?: boolean; currentPeriodID?: string; delayed?: boolean; displayLong?: string; displayShort?: string; ended?: boolean; finalized?: boolean; hardStart?: boolean; live?: boolean; oddsAvailable?: boolean; oddsPresent?: boolean; periods?: { ended?: string[]; started?: string[]; }; previousPeriodID?: string; reGrade?: boolean; started?: boolean; startsAt?: string; }; teams?: { away?: { colors?: object; logo?: string; names?: object; score?: number; statEntityID?: string; teamID?: string; }; home?: { colors?: object; logo?: string; names?: object; score?: number; statEntityID?: string; teamID?: string; }; }; type?: string; }", markdown: "## get\n\n`client.events.get(bookmakerID?: string, cancelled?: boolean, cursor?: string, ended?: boolean, eventID?: string, eventIDs?: string, expandResults?: boolean, finalized?: boolean, includeAltLines?: boolean, includeOpenCloseOdds?: boolean, includeOpposingOdds?: boolean, leagueID?: string, limit?: number, live?: boolean, oddID?: string, oddsAvailable?: boolean, oddsPresent?: boolean, playerID?: string, sportID?: string, started?: boolean, startsAfter?: string, startsBefore?: string, teamID?: string, type?: string): { activity?: object; eventID?: string; info?: object; leagueID?: string; manual?: boolean; odds?: object; players?: object; results?: object; sportID?: string; status?: object; teams?: object; type?: string; }`\n\n**get** `/events/`\n\nGet a list of Events\n\n### Parameters\n\n- `bookmakerID?: string`\n A bookmakerID or comma-separated list of bookmakerIDs to include odds for\n\n- `cancelled?: boolean`\n Only include cancelled Events (true), only non-cancelled Events (false) or all Events (omit)\n\n- `cursor?: string`\n 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.\n\n- `ended?: boolean`\n Only include Events which have have ended (true), only Events which have not ended (false) or all Events (omit)\n\n- `eventID?: string`\n An eventID to get Event data for\n\n- `eventIDs?: string`\n A comma separated list of eventIDs to get Event data for\n\n- `expandResults?: boolean`\n Whether to expand the results object to include all stat values rather than just the base set\n\n- `finalized?: boolean`\n Only include finalized Events (true), exclude unfinalized Events (false) or all Events (omit)\n\n- `includeAltLines?: boolean`\n Whether to include alternate lines in the odds byBookmaker data\n\n- `includeOpenCloseOdds?: boolean`\n Whether to include open and close odds values (openOdds, closeOdds, openSpread, closeSpread, openOverUnder, closeOverUnder) in the odds byBookmaker data\n\n- `includeOpposingOdds?: boolean`\n Whether to include opposing odds for each included oddID\n\n- `leagueID?: string`\n A leagueID or comma-separated list of leagueIDs to get Events for\n\n- `limit?: number`\n The maximum number of Events to return\n\n- `live?: boolean`\n Only include live Events (true), only non-live Events (false) or all Events (omit)\n\n- `oddID?: string`\n An oddID or comma-separated list of oddIDs to include odds for\n\n- `oddsAvailable?: boolean`\n Whether you want only Events which do (true) or do not (false) have odds markets which are currently available (open for wagering)\n\n- `oddsPresent?: boolean`\n 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)\n\n- `playerID?: string`\n A playerID or comma-separated list of playerIDs to include Events (and associated odds) for\n\n- `sportID?: string`\n A sportID or comma-separated list of sportIDs to get Events for\n\n- `started?: boolean`\n Only include Events which have have previously started (true), only Events which have not previously started (false) or all Events (omit)\n\n- `startsAfter?: string`\n Get Events that start after this date\n\n- `startsBefore?: string`\n Get Events that start before this date\n\n- `teamID?: string`\n A teamID or comma-separated list of teamIDs to include Events for\n\n- `type?: string`\n Only include Events of the specified type\n\n### Returns\n\n- `{ activity?: { count?: number; score?: number; }; eventID?: string; info?: { broadcasts?: { broadcasterID?: string; name?: string; type?: 'tv' | 'webstream' | 'subscription' | 'sportsbook'; }[]; referee?: { name?: string; }; seasonWeek?: string; venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }; }; leagueID?: string; manual?: boolean; odds?: object; players?: object; results?: object; sportID?: string; status?: { cancelled?: boolean; completed?: boolean; currentPeriodID?: string; delayed?: boolean; displayLong?: string; displayShort?: string; ended?: boolean; finalized?: boolean; hardStart?: boolean; live?: boolean; oddsAvailable?: boolean; oddsPresent?: boolean; periods?: { ended?: string[]; started?: string[]; }; previousPeriodID?: string; reGrade?: boolean; started?: boolean; startsAt?: string; }; teams?: { away?: { colors?: object; logo?: string; names?: object; score?: number; statEntityID?: string; teamID?: string; }; home?: { colors?: object; logo?: string; names?: object; score?: number; statEntityID?: string; teamID?: string; }; }; type?: string; }`\n\n - `activity?: { count?: number; score?: number; }`\n - `eventID?: string`\n - `info?: { broadcasts?: { broadcasterID?: string; name?: string; type?: 'tv' | 'webstream' | 'subscription' | 'sportsbook'; }[]; referee?: { name?: string; }; seasonWeek?: string; venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }; }`\n - `leagueID?: string`\n - `manual?: boolean`\n - `odds?: object`\n - `players?: object`\n - `results?: object`\n - `sportID?: string`\n - `status?: { cancelled?: boolean; completed?: boolean; currentPeriodID?: string; delayed?: boolean; displayLong?: string; displayShort?: string; ended?: boolean; finalized?: boolean; hardStart?: boolean; live?: boolean; oddsAvailable?: boolean; oddsPresent?: boolean; periods?: { ended?: string[]; started?: string[]; }; previousPeriodID?: string; reGrade?: boolean; started?: boolean; startsAt?: string; }`\n - `teams?: { away?: { colors?: { primary?: string; primaryContrast?: string; secondary?: string; secondaryContrast?: string; }; logo?: string; names?: { long?: string; medium?: string; short?: string; }; score?: number; statEntityID?: string; teamID?: string; }; home?: { colors?: { primary?: string; primaryContrast?: string; secondary?: string; secondaryContrast?: string; }; logo?: string; names?: { long?: string; medium?: string; short?: string; }; score?: number; statEntityID?: string; teamID?: string; }; }`\n - `type?: string`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\n// Automatically fetches more pages as needed.\nfor await (const event of client.events.get()) {\n console.log(event);\n}\n```", perLanguage: { go: { method: 'client.Events.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tpage, err := client.Events.Get(context.TODO(), sportsoddsapi.EventGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, java: { method: 'events().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.events.EventGetPage;\nimport com.sportsgameodds.api.models.events.EventGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n EventGetPage page = client.events().get();\n }\n}', }, python: { method: 'events.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\npage = client.events.get()\npage = page.data[0]\nprint(page.activity)', }, ruby: { method: 'events.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\npage = sports_game_odds.events.get\n\nputs(page)', }, typescript: { method: 'client.events.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const event of client.events.get()) {\n console.log(event.activity);\n}", }, http: { example: 'curl https://api.sportsgameodds.com/v2/events/', }, }, }, { name: 'get', endpoint: '/markets/', httpMethod: 'get', summary: '', description: 'Get a list of Markets', stainlessPath: '(resource) markets > (method) get', qualified: 'client.markets.get', params: [ 'betTypeID?: string;', 'bookmakerID?: string;', 'cursor?: string;', 'isMainMarket?: boolean;', 'isProp?: boolean;', 'isSubPeriod?: boolean;', 'isSupported?: boolean;', 'leagueID?: string;', 'limit?: number;', 'oddID?: string;', 'periodID?: string;', 'propType?: string;', 'sideID?: string;', 'sportID?: string;', 'statEntityID?: string;', 'statID?: string;', ], response: "{ activeEvents?: number; betTypeID?: string; isMainDerivative?: boolean; isMainMarket?: boolean; isProp?: boolean; isSubPeriod?: boolean; isSupported?: boolean; marketGroupID?: string; marketGroupName?: string; marketGroupNameAlias?: string; marketGroupNameBySport?: object; oddID?: string; periodID?: string; playerID?: string; propType?: 'game_prop' | 'team_prop' | 'player_prop' | 'other_prop'; sideID?: string; statEntityID?: string; statID?: string; support?: object; teamID?: string; }", markdown: "## get\n\n`client.markets.get(betTypeID?: string, bookmakerID?: string, cursor?: string, isMainMarket?: boolean, isProp?: boolean, isSubPeriod?: boolean, isSupported?: boolean, leagueID?: string, limit?: number, oddID?: string, periodID?: string, propType?: string, sideID?: string, sportID?: string, statEntityID?: string, statID?: string): { activeEvents?: number; betTypeID?: string; isMainDerivative?: boolean; isMainMarket?: boolean; isProp?: boolean; isSubPeriod?: boolean; isSupported?: boolean; marketGroupID?: string; marketGroupName?: string; marketGroupNameAlias?: string; marketGroupNameBySport?: object; oddID?: string; periodID?: string; playerID?: string; propType?: 'game_prop' | 'team_prop' | 'player_prop' | 'other_prop'; sideID?: string; statEntityID?: string; statID?: string; support?: object; teamID?: string; }`\n\n**get** `/markets/`\n\nGet a list of Markets\n\n### Parameters\n\n- `betTypeID?: string`\n A single betTypeID or comma-separated list of betTypeIDs to filter Markets by\n\n- `bookmakerID?: string`\n A single bookmakerID or comma-separated list of bookmakerIDs to filter Markets by\n\n- `cursor?: string`\n The cursor for pagination. Use nextCursor from prior response.\n\n- `isMainMarket?: boolean`\n Filter to only include main markets (main period moneyline, spread, and over/under)\n\n- `isProp?: boolean`\n Filter by whether it is any type of prop bet market\n\n- `isSubPeriod?: boolean`\n Filter by whether it tracks a sub/non-main period\n\n- `isSupported?: boolean`\n Filter whether this market is fully supported by at least 1 bookmaker in at least 1 league. Defaults to true if not specified.\n\n- `leagueID?: string`\n A single leagueID or comma-separated list of leagueIDs to filter Markets by\n\n- `limit?: number`\n The maximum number of Markets to return (default: 100, max: 10000)\n\n- `oddID?: string`\n A single oddID or comma-separated list of oddIDs. Used to specify specific Markets to return.\n\n- `periodID?: string`\n A single periodID or comma-separated list of periodIDs to filter Markets by\n\n- `propType?: string`\n Filter by prop type (game_prop, team_prop, player_prop, other_prop)\n\n- `sideID?: string`\n A single sideID or comma-separated list of sideIDs to filter Markets by\n\n- `sportID?: string`\n A single sportID or comma-separated list of sportIDs to filter Markets by\n\n- `statEntityID?: string`\n A single statEntityID or comma-separated list of statEntityIDs to filter Markets by\n\n- `statID?: string`\n A single statID or comma-separated list of statIDs to filter Markets by\n\n### Returns\n\n- `{ activeEvents?: number; betTypeID?: string; isMainDerivative?: boolean; isMainMarket?: boolean; isProp?: boolean; isSubPeriod?: boolean; isSupported?: boolean; marketGroupID?: string; marketGroupName?: string; marketGroupNameAlias?: string; marketGroupNameBySport?: object; oddID?: string; periodID?: string; playerID?: string; propType?: 'game_prop' | 'team_prop' | 'player_prop' | 'other_prop'; sideID?: string; statEntityID?: string; statID?: string; support?: object; teamID?: string; }`\n\n - `activeEvents?: number`\n - `betTypeID?: string`\n - `isMainDerivative?: boolean`\n - `isMainMarket?: boolean`\n - `isProp?: boolean`\n - `isSubPeriod?: boolean`\n - `isSupported?: boolean`\n - `marketGroupID?: string`\n - `marketGroupName?: string`\n - `marketGroupNameAlias?: string`\n - `marketGroupNameBySport?: object`\n - `oddID?: string`\n - `periodID?: string`\n - `playerID?: string`\n - `propType?: 'game_prop' | 'team_prop' | 'player_prop' | 'other_prop'`\n - `sideID?: string`\n - `statEntityID?: string`\n - `statID?: string`\n - `support?: object`\n - `teamID?: string`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\n// Automatically fetches more pages as needed.\nfor await (const market of client.markets.get()) {\n console.log(market);\n}\n```", perLanguage: { go: { method: 'client.Markets.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tpage, err := client.Markets.Get(context.TODO(), sportsoddsapi.MarketGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, java: { method: 'markets().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.markets.MarketGetPage;\nimport com.sportsgameodds.api.models.markets.MarketGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n MarketGetPage page = client.markets().get();\n }\n}', }, python: { method: 'markets.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\npage = client.markets.get()\npage = page.data[0]\nprint(page.side_id)', }, ruby: { method: 'markets.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\npage = sports_game_odds.markets.get\n\nputs(page)', }, typescript: { method: 'client.markets.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const market of client.markets.get()) {\n console.log(market.sideID);\n}", }, http: { example: 'curl https://api.sportsgameodds.com/v2/markets/', }, }, }, { name: 'get', endpoint: '/teams/', httpMethod: 'get', summary: '', description: 'Get a list of Teams by ID or league', stainlessPath: '(resource) teams > (method) get', qualified: 'client.teams.get', params: [ 'cursor?: string;', 'leagueID?: string;', 'limit?: number;', 'sportID?: string;', 'teamID?: string;', ], response: '{ coach?: { name?: string; }; colors?: { primary?: string; primaryContrast?: string; secondary?: string; secondaryContrast?: string; }; leagueID?: string; logo?: string; lookups?: { teamName?: string[]; }; names?: { long?: string; medium?: string; short?: string; }; owner?: { name?: string; }; sportID?: string; standings?: { last5?: string; losses?: number; played?: number; position?: string; record?: string; streak?: number; ties?: number; wins?: number; }; teamID?: string; venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }; }', markdown: "## get\n\n`client.teams.get(cursor?: string, leagueID?: string, limit?: number, sportID?: string, teamID?: string): { coach?: object; colors?: object; leagueID?: string; logo?: string; lookups?: object; names?: object; owner?: object; sportID?: string; standings?: object; teamID?: string; venue?: object; }`\n\n**get** `/teams/`\n\nGet a list of Teams by ID or league\n\n### Parameters\n\n- `cursor?: string`\n 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.\n\n- `leagueID?: string`\n A single leagueID or comma-separated list of leagueIDs to get Teams for\n\n- `limit?: number`\n The maximum number of Teams to return\n\n- `sportID?: string`\n A single sportID or comma-separated list of sportIDs to get Teams for\n\n- `teamID?: string`\n A single teamID or comma-separated list of teamIDs to get data for\n\n### Returns\n\n- `{ coach?: { name?: string; }; colors?: { primary?: string; primaryContrast?: string; secondary?: string; secondaryContrast?: string; }; leagueID?: string; logo?: string; lookups?: { teamName?: string[]; }; names?: { long?: string; medium?: string; short?: string; }; owner?: { name?: string; }; sportID?: string; standings?: { last5?: string; losses?: number; played?: number; position?: string; record?: string; streak?: number; ties?: number; wins?: number; }; teamID?: string; venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }; }`\n\n - `coach?: { name?: string; }`\n - `colors?: { primary?: string; primaryContrast?: string; secondary?: string; secondaryContrast?: string; }`\n - `leagueID?: string`\n - `logo?: string`\n - `lookups?: { teamName?: string[]; }`\n - `names?: { long?: string; medium?: string; short?: string; }`\n - `owner?: { name?: string; }`\n - `sportID?: string`\n - `standings?: { last5?: string; losses?: number; played?: number; position?: string; record?: string; streak?: number; ties?: number; wins?: number; }`\n - `teamID?: string`\n - `venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\n// Automatically fetches more pages as needed.\nfor await (const team of client.teams.get()) {\n console.log(team);\n}\n```", perLanguage: { go: { method: 'client.Teams.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tpage, err := client.Teams.Get(context.TODO(), sportsoddsapi.TeamGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, java: { method: 'teams().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.teams.TeamGetPage;\nimport com.sportsgameodds.api.models.teams.TeamGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n TeamGetPage page = client.teams().get();\n }\n}', }, python: { method: 'teams.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\npage = client.teams.get()\npage = page.data[0]\nprint(page.coach)', }, ruby: { method: 'teams.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\npage = sports_game_odds.teams.get\n\nputs(page)', }, typescript: { method: 'client.teams.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const team of client.teams.get()) {\n console.log(team.coach);\n}", }, http: { example: 'curl https://api.sportsgameodds.com/v2/teams/', }, }, }, { name: 'get', endpoint: '/players/', httpMethod: 'get', summary: '', description: 'Get a list of Players for a specific Team or Event', stainlessPath: '(resource) players > (method) get', qualified: 'client.players.get', params: [ 'cursor?: string;', 'eventID?: string;', 'limit?: number;', 'playerID?: string;', 'teamID?: string;', ], response: '{ aliases?: string[]; jerseyNumber?: number; leagueID?: string; lookups?: { anyName?: string[]; fullName?: string[]; initials?: string[]; }; names?: { display?: string; firstName?: string; lastName?: string; }; playerID?: string; playerTeams?: object; position?: string; sportID?: string; teamID?: string; }', markdown: "## get\n\n`client.players.get(cursor?: string, eventID?: string, limit?: number, playerID?: string, teamID?: string): { aliases?: string[]; jerseyNumber?: number; leagueID?: string; lookups?: object; names?: object; playerID?: string; playerTeams?: object; position?: string; sportID?: string; teamID?: string; }`\n\n**get** `/players/`\n\nGet a list of Players for a specific Team or Event\n\n### Parameters\n\n- `cursor?: string`\n 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.\n\n- `eventID?: string`\n EventID to get Players data for\n\n- `limit?: number`\n The maximum number of Players to return\n\n- `playerID?: string`\n PlayerID to get data for\n\n- `teamID?: string`\n TeamID to get Players data for\n\n### Returns\n\n- `{ aliases?: string[]; jerseyNumber?: number; leagueID?: string; lookups?: { anyName?: string[]; fullName?: string[]; initials?: string[]; }; names?: { display?: string; firstName?: string; lastName?: string; }; playerID?: string; playerTeams?: object; position?: string; sportID?: string; teamID?: string; }`\n\n - `aliases?: string[]`\n - `jerseyNumber?: number`\n - `leagueID?: string`\n - `lookups?: { anyName?: string[]; fullName?: string[]; initials?: string[]; }`\n - `names?: { display?: string; firstName?: string; lastName?: string; }`\n - `playerID?: string`\n - `playerTeams?: object`\n - `position?: string`\n - `sportID?: string`\n - `teamID?: string`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\n// Automatically fetches more pages as needed.\nfor await (const player of client.players.get()) {\n console.log(player);\n}\n```", perLanguage: { go: { method: 'client.Players.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tpage, err := client.Players.Get(context.TODO(), sportsoddsapi.PlayerGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, java: { method: 'players().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.players.PlayerGetPage;\nimport com.sportsgameodds.api.models.players.PlayerGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n PlayerGetPage page = client.players().get();\n }\n}', }, python: { method: 'players.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\npage = client.players.get()\npage = page.data[0]\nprint(page.aliases)', }, ruby: { method: 'players.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\npage = sports_game_odds.players.get\n\nputs(page)', }, typescript: { method: 'client.players.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const player of client.players.get()) {\n console.log(player.aliases);\n}", }, http: { example: 'curl https://api.sportsgameodds.com/v2/players/', }, }, }, { name: 'get', endpoint: '/leagues/', httpMethod: 'get', summary: '', description: 'Get a list of Leagues', stainlessPath: '(resource) leagues > (method) get', qualified: 'client.leagues.get', params: ['leagueID?: string;', 'sportID?: string;'], response: '{ enabled?: boolean; leagueID?: string; name?: string; shortName?: string; sportID?: string; }[]', markdown: "## get\n\n`client.leagues.get(leagueID?: string, sportID?: string): object[]`\n\n**get** `/leagues/`\n\nGet a list of Leagues\n\n### Parameters\n\n- `leagueID?: string`\n The league to get data for\n\n- `sportID?: string`\n The sport to get leagues for\n\n### Returns\n\n- `{ enabled?: boolean; leagueID?: string; name?: string; shortName?: string; sportID?: string; }[]`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\nconst leagues = await client.leagues.get();\n\nconsole.log(leagues);\n```", perLanguage: { go: { method: 'client.Leagues.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tleagues, err := client.Leagues.Get(context.TODO(), sportsoddsapi.LeagueGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", leagues)\n}\n', }, java: { method: 'leagues().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.leagues.League;\nimport com.sportsgameodds.api.models.leagues.LeagueGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n List leagues = client.leagues().get();\n }\n}', }, python: { method: 'leagues.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\nleagues = client.leagues.get()\nprint(leagues)', }, ruby: { method: 'leagues.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\nleagues = sports_game_odds.leagues.get\n\nputs(leagues)', }, typescript: { method: 'client.leagues.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst leagues = await client.leagues.get();\n\nconsole.log(leagues);", }, http: { example: 'curl https://api.sportsgameodds.com/v2/leagues/', }, }, }, { name: 'get', endpoint: '/sports/', httpMethod: 'get', summary: '', description: 'Get a list of sports', stainlessPath: '(resource) sports > (method) get', qualified: 'client.sports.get', response: '{ backgroundImage?: string; basePeriods?: string[]; clockType?: string; defaultPopularityScore?: number; enabled?: boolean; eventWord?: { long?: object; short?: object; }; extraPeriods?: string[]; hasMeaningfulHomeAway?: boolean; imageIcon?: string; name?: string; pointWord?: { long?: object; short?: object; }; shortName?: string; sportID?: string; squareImage?: string; }[]', markdown: "## get\n\n`client.sports.get(): object[]`\n\n**get** `/sports/`\n\nGet a list of sports\n\n### Returns\n\n- `{ backgroundImage?: string; basePeriods?: string[]; clockType?: string; defaultPopularityScore?: number; enabled?: boolean; eventWord?: { long?: object; short?: object; }; extraPeriods?: string[]; hasMeaningfulHomeAway?: boolean; imageIcon?: string; name?: string; pointWord?: { long?: object; short?: object; }; shortName?: string; sportID?: string; squareImage?: string; }[]`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\nconst sports = await client.sports.get();\n\nconsole.log(sports);\n```", perLanguage: { go: { method: 'client.Sports.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tsports, err := client.Sports.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sports)\n}\n', }, java: { method: 'sports().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.sports.Sport;\nimport com.sportsgameodds.api.models.sports.SportGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n List sports = client.sports().get();\n }\n}', }, python: { method: 'sports.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\nsports = client.sports.get()\nprint(sports)', }, ruby: { method: 'sports.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\nsports = sports_game_odds.sports.get\n\nputs(sports)', }, typescript: { method: 'client.sports.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst sports = await client.sports.get();\n\nconsole.log(sports);", }, http: { example: 'curl https://api.sportsgameodds.com/v2/sports/', }, }, }, { name: 'get', endpoint: '/stats/', httpMethod: 'get', summary: '', description: 'Get a list of StatIDs', stainlessPath: '(resource) stats > (method) get', qualified: 'client.stats.get', params: ['sportID?: string;', 'statID?: string;', 'statLevel?: string;'], response: '{ description?: string; displays?: { long?: string; short?: string; }; isScoreStat?: boolean; statID?: string; supportedLevels?: { all?: boolean; player?: boolean; team?: boolean; }; supportedSports?: object; units?: { long?: object; short?: object; }; }[]', markdown: "## get\n\n`client.stats.get(sportID?: string, statID?: string, statLevel?: string): object[]`\n\n**get** `/stats/`\n\nGet a list of StatIDs\n\n### Parameters\n\n- `sportID?: string`\n SportID to get StatIDs for\n\n- `statID?: string`\n StatID to get data for\n\n- `statLevel?: string`\n 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.\n\n### Returns\n\n- `{ description?: string; displays?: { long?: string; short?: string; }; isScoreStat?: boolean; statID?: string; supportedLevels?: { all?: boolean; player?: boolean; team?: boolean; }; supportedSports?: object; units?: { long?: object; short?: object; }; }[]`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\nconst stats = await client.stats.get();\n\nconsole.log(stats);\n```", perLanguage: { go: { method: 'client.Stats.Get', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tstats, err := client.Stats.Get(context.TODO(), sportsoddsapi.StatGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", stats)\n}\n', }, java: { method: 'stats().get', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.stats.Stat;\nimport com.sportsgameodds.api.models.stats.StatGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n List stats = client.stats().get();\n }\n}', }, python: { method: 'stats.get', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\nstats = client.stats.get()\nprint(stats)', }, ruby: { method: 'stats.get', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\nstats = sports_game_odds.stats.get\n\nputs(stats)', }, typescript: { method: 'client.stats.get', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst stats = await client.stats.get();\n\nconsole.log(stats);", }, http: { example: 'curl https://api.sportsgameodds.com/v2/stats/', }, }, }, { name: 'get_usage', endpoint: '/account/usage', httpMethod: 'get', summary: '', description: 'Get rate-limits and usage data about your API key', stainlessPath: '(resource) account > (method) get_usage', qualified: 'client.account.getUsage', response: '{ customerID?: string; email?: string; isActive?: boolean; keyID?: string; rateLimits?: { per-day?: object; per-hour?: object; per-minute?: object; per-month?: object; per-second?: object; }; tier?: string; }', markdown: "## get_usage\n\n`client.account.getUsage(): { customerID?: string; email?: string; isActive?: boolean; keyID?: string; rateLimits?: object; tier?: string; }`\n\n**get** `/account/usage`\n\nGet rate-limits and usage data about your API key\n\n### Returns\n\n- `{ customerID?: string; email?: string; isActive?: boolean; keyID?: string; rateLimits?: { per-day?: object; per-hour?: object; per-minute?: object; per-month?: object; per-second?: object; }; tier?: string; }`\n\n - `customerID?: string`\n - `email?: string`\n - `isActive?: boolean`\n - `keyID?: string`\n - `rateLimits?: { per-day?: { current-entities?: number; current-requests?: number; max-entities?: 'unlimited' | number; max-requests?: 'unlimited' | number; }; per-hour?: { current-entities?: number; current-requests?: number; max-entities?: 'unlimited' | number; max-requests?: 'unlimited' | number; }; per-minute?: { current-entities?: number; current-requests?: number; max-entities?: 'unlimited' | number; max-requests?: 'unlimited' | number; }; per-month?: { current-entities?: number; current-requests?: number; max-entities?: 'unlimited' | number; max-requests?: 'unlimited' | number; }; per-second?: { current-entities?: number; current-requests?: number; max-entities?: 'unlimited' | number; max-requests?: 'unlimited' | number; }; }`\n - `tier?: string`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\nconst accountUsage = await client.account.getUsage();\n\nconsole.log(accountUsage);\n```", perLanguage: { go: { method: 'client.Account.GetUsage', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\taccountUsage, err := client.Account.GetUsage(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", accountUsage.CustomerID)\n}\n', }, java: { method: 'account().getUsage', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.account.AccountGetUsageParams;\nimport com.sportsgameodds.api.models.account.AccountUsage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n AccountUsage accountUsage = client.account().getUsage();\n }\n}', }, python: { method: 'account.get_usage', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\naccount_usage = client.account.get_usage()\nprint(account_usage.customer_id)', }, ruby: { method: 'account.get_usage', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\naccount_usage = sports_game_odds.account.get_usage\n\nputs(account_usage)', }, typescript: { method: 'client.account.getUsage', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst accountUsage = await client.account.getUsage();\n\nconsole.log(accountUsage.customerID);", }, http: { example: 'curl https://api.sportsgameodds.com/v2/account/usage', }, }, }, { name: 'events', endpoint: '/stream/events', httpMethod: 'get', summary: '', description: 'Setup streamed (WebSocket) connection', stainlessPath: '(resource) stream > (method) events', qualified: 'client.stream.events', params: ['eventID?: string;', 'feed?: string;', 'leagueID?: string;'], response: '{ channel?: string; data?: { activity?: object; eventID?: string; info?: object; leagueID?: string; manual?: boolean; odds?: object; players?: object; results?: object; sportID?: string; status?: object; teams?: object; type?: string; }[]; pusherKey?: string; pusherOptions?: { channelAuthorization?: { endpoint?: string; headers?: object; }; cluster?: string; httpHost?: string; httpPort?: number; httpsPort?: number; wsHost?: string; wsPort?: number; wssPort?: number; }; success?: boolean; user?: string; }', markdown: "## events\n\n`client.stream.events(eventID?: string, feed?: string, leagueID?: string): { channel?: string; data?: event[]; pusherKey?: string; pusherOptions?: object; success?: boolean; user?: string; }`\n\n**get** `/stream/events`\n\nSetup streamed (WebSocket) connection\n\n### Parameters\n\n- `eventID?: string`\n An eventID to stream events for\n\n- `feed?: string`\n The feed you would like to subscribe to\n\n- `leagueID?: string`\n A leagueID to stream events for\n\n### Returns\n\n- `{ channel?: string; data?: { activity?: object; eventID?: string; info?: object; leagueID?: string; manual?: boolean; odds?: object; players?: object; results?: object; sportID?: string; status?: object; teams?: object; type?: string; }[]; pusherKey?: string; pusherOptions?: { channelAuthorization?: { endpoint?: string; headers?: object; }; cluster?: string; httpHost?: string; httpPort?: number; httpsPort?: number; wsHost?: string; wsPort?: number; wssPort?: number; }; success?: boolean; user?: string; }`\n\n - `channel?: string`\n - `data?: { activity?: { count?: number; score?: number; }; eventID?: string; info?: { broadcasts?: { broadcasterID?: string; name?: string; type?: 'tv' | 'webstream' | 'subscription' | 'sportsbook'; }[]; referee?: { name?: string; }; seasonWeek?: string; venue?: { address?: string; capacity?: number; city?: string; countryCode?: string; countryName?: string; name?: string; regionCode?: string; regionName?: string; }; }; leagueID?: string; manual?: boolean; odds?: object; players?: object; results?: object; sportID?: string; status?: { cancelled?: boolean; completed?: boolean; currentPeriodID?: string; delayed?: boolean; displayLong?: string; displayShort?: string; ended?: boolean; finalized?: boolean; hardStart?: boolean; live?: boolean; oddsAvailable?: boolean; oddsPresent?: boolean; periods?: { ended?: string[]; started?: string[]; }; previousPeriodID?: string; reGrade?: boolean; started?: boolean; startsAt?: string; }; teams?: { away?: { colors?: object; logo?: string; names?: object; score?: number; statEntityID?: string; teamID?: string; }; home?: { colors?: object; logo?: string; names?: object; score?: number; statEntityID?: string; teamID?: string; }; }; type?: string; }[]`\n - `pusherKey?: string`\n - `pusherOptions?: { channelAuthorization?: { endpoint?: string; headers?: object; }; cluster?: string; httpHost?: string; httpPort?: number; httpsPort?: number; wsHost?: string; wsPort?: number; wssPort?: number; }`\n - `success?: boolean`\n - `user?: string`\n\n### Example\n\n```typescript\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds();\n\nconst response = await client.stream.events();\n\nconsole.log(response);\n```", perLanguage: { go: { method: 'client.Stream.Events', example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"),\n\t)\n\tresponse, err := client.Stream.Events(context.TODO(), sportsoddsapi.StreamEventsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Channel)\n}\n', }, java: { method: 'stream().events', example: 'package com.sportsgameodds.api.example;\n\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.stream.StreamEventsParams;\nimport com.sportsgameodds.api.models.stream.StreamEventsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n SportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\n StreamEventsResponse response = client.stream().events();\n }\n}', }, python: { method: 'stream.events', example: 'import os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\nresponse = client.stream.events()\nprint(response.channel)', }, ruby: { method: 'stream.events', example: 'require "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(api_key_param: "My API Key Param")\n\nresponse = sports_game_odds.stream.events\n\nputs(response)', }, typescript: { method: 'client.stream.events', example: "import SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst response = await client.stream.events();\n\nconsole.log(response.channel);", }, http: { example: 'curl https://api.sportsgameodds.com/v2/stream/events', }, }, }, ]; const EMBEDDED_READMES: { language: string; content: string }[] = [ { language: 'go', content: '# Sports Game Odds Go API Library\n\nGo Reference\n\nThe Sports Game Odds Go library provides convenient access to the [Sports Game Odds REST API](https://sportsgameodds.com/docs/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Sports Game Odds MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=sports-odds-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInNwb3J0cy1vZGRzLWFwaS1tY3AiXSwiZW52Ijp7IlNQT1JUU19PRERTX0FQSV9LRVlfSEVBREVSIjoiTXkgQVBJIEtleSBQYXJhbSJ9fQ)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22sports-odds-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22sports-odds-api-mcp%22%5D%2C%22env%22%3A%7B%22SPORTS_ODDS_API_KEY_HEADER%22%3A%22My%20API%20Key%20Param%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/SportsGameOdds/sports-odds-api-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/SportsGameOdds/sports-odds-api-go@v1.2.0\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/SportsGameOdds/sports-odds-api-go"\n\t"github.com/SportsGameOdds/sports-odds-api-go/option"\n)\n\nfunc main() {\n\tclient := sportsoddsapi.NewClient(\n\t\toption.WithAPIKeyParam("My API Key Param"), // defaults to os.LookupEnv("SPORTS_ODDS_API_KEY_HEADER")\n\t)\n\tpage, err := client.Events.Get(context.TODO(), sportsoddsapi.EventGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.Events.Get(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/SportsGameOdds/sports-odds-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.Events.GetAutoPaging(context.TODO(), sportsoddsapi.EventGetParams{\n\tLimit: sportsoddsapi.Float(30),\n})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tevent := iter.Current()\n\tfmt.Printf("%+v\\n", event)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.Events.Get(context.TODO(), sportsoddsapi.EventGetParams{\n\tLimit: sportsoddsapi.Float(30),\n})\nfor page != nil {\n\tfor _, event := range page.Data {\n\t\tfmt.Printf("%+v\\n", event)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.Events.Get(context.TODO(), sportsoddsapi.EventGetParams{})\nif err != nil {\n\tvar apierr *sportsoddsapi.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/events/": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.Events.Get(\n\tctx,\n\tsportsoddsapi.EventGetParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := sportsoddsapi.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.Events.Get(\n\tcontext.TODO(),\n\tsportsoddsapi.EventGetParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.Events.Get(\n\tcontext.TODO(),\n\tsportsoddsapi.EventGetParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/SportsGameOdds/sports-odds-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', }, { language: 'java', content: '# Sports Game Odds Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.sportsgameodds.api/sports-odds-api)](https://central.sonatype.com/artifact/com.sportsgameodds.api/sports-odds-api/1.3.0)\n[![javadoc](https://javadoc.io/badge2/com.sportsgameodds.api/sports-odds-api/1.3.0/javadoc.svg)](https://javadoc.io/doc/com.sportsgameodds.api/sports-odds-api/1.3.0)\n\n\nThe Sports Game Odds Java SDK provides convenient access to the [Sports Game Odds REST API](https://sportsgameodds.com/docs/) from applications written in Java.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Sports Game Odds MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=sports-odds-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInNwb3J0cy1vZGRzLWFwaS1tY3AiXSwiZW52Ijp7IlNQT1JUU19PRERTX0FQSV9LRVlfSEVBREVSIjoiTXkgQVBJIEtleSBQYXJhbSJ9fQ)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22sports-odds-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22sports-odds-api-mcp%22%5D%2C%22env%22%3A%7B%22SPORTS_ODDS_API_KEY_HEADER%22%3A%22My%20API%20Key%20Param%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [sportsgameodds.com](https://sportsgameodds.com/docs/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.sportsgameodds.api/sports-odds-api/1.3.0).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.sportsgameodds.api:sports-odds-api:1.3.0")\n~~~\n\n### Maven\n\n~~~xml\n\n com.sportsgameodds.api\n sports-odds-api\n 1.3.0\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.events.EventGetPage;\nimport com.sportsgameodds.api.models.events.EventGetParams;\n\n// Configures using the `sportsgameodds.sportsOddsApiKeyHeader`, `sportsgameodds.sportsOddsApiKeyHeader` and `sportsgameodds.baseUrl` system properties\n// Or configures using the `SPORTS_ODDS_API_KEY_HEADER`, `SPORTS_ODDS_API_KEY_HEADER` and `SPORTS_GAME_ODDS_BASE_URL` environment variables\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\nEventGetPage page = client.events().get();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\n\n// Configures using the `sportsgameodds.sportsOddsApiKeyHeader`, `sportsgameodds.sportsOddsApiKeyHeader` and `sportsgameodds.baseUrl` system properties\n// Or configures using the `SPORTS_ODDS_API_KEY_HEADER`, `SPORTS_ODDS_API_KEY_HEADER` and `SPORTS_GAME_ODDS_BASE_URL` environment variables\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n```\n\nOr manually:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .apiKeyHeader("My API Key Header")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n // Configures using the `sportsgameodds.sportsOddsApiKeyHeader`, `sportsgameodds.sportsOddsApiKeyHeader` and `sportsgameodds.baseUrl` system properties\n // Or configures using the `SPORTS_ODDS_API_KEY_HEADER`, `SPORTS_ODDS_API_KEY_HEADER` and `SPORTS_GAME_ODDS_BASE_URL` environment variables\n .fromEnv()\n .apiKeyHeader("My API Key Header")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| -------------- | --------------------------------------- | ---------------------------- | -------- | ------------------------------------- |\n| `apiKeyHeader` | `sportsgameodds.sportsOddsApiKeyHeader` | `SPORTS_ODDS_API_KEY_HEADER` | false | - |\n| `apiKeyParam` | `sportsgameodds.sportsOddsApiKeyHeader` | `SPORTS_ODDS_API_KEY_HEADER` | false | - |\n| `baseUrl` | `sportsgameodds.baseUrl` | `SPORTS_GAME_ODDS_BASE_URL` | true | `"https://api.sportsgameodds.com/v2"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\n\nSportsGameOddsClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Sports Game Odds API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.events().get(...)` should be called with an instance of `EventGetParams`, and it will return an instance of `EventGetPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.models.events.EventGetPageAsync;\nimport com.sportsgameodds.api.models.events.EventGetParams;\nimport java.util.concurrent.CompletableFuture;\n\n// Configures using the `sportsgameodds.sportsOddsApiKeyHeader`, `sportsgameodds.sportsOddsApiKeyHeader` and `sportsgameodds.baseUrl` system properties\n// Or configures using the `SPORTS_ODDS_API_KEY_HEADER`, `SPORTS_ODDS_API_KEY_HEADER` and `SPORTS_GAME_ODDS_BASE_URL` environment variables\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.fromEnv();\n\nCompletableFuture page = client.async().events().get();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClientAsync;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClientAsync;\nimport com.sportsgameodds.api.models.events.EventGetPageAsync;\nimport com.sportsgameodds.api.models.events.EventGetParams;\nimport java.util.concurrent.CompletableFuture;\n\n// Configures using the `sportsgameodds.sportsOddsApiKeyHeader`, `sportsgameodds.sportsOddsApiKeyHeader` and `sportsgameodds.baseUrl` system properties\n// Or configures using the `SPORTS_ODDS_API_KEY_HEADER`, `SPORTS_ODDS_API_KEY_HEADER` and `SPORTS_GAME_ODDS_BASE_URL` environment variables\nSportsGameOddsClientAsync client = SportsGameOddsOkHttpClientAsync.fromEnv();\n\nCompletableFuture page = client.events().get();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.sportsgameodds.api.core.http.Headers;\nimport com.sportsgameodds.api.core.http.HttpResponseFor;\nimport com.sportsgameodds.api.models.events.EventGetPage;\nimport com.sportsgameodds.api.models.events.EventGetParams;\n\nHttpResponseFor page = client.events().withRawResponse().get();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.sportsgameodds.api.models.events.EventGetPage;\n\nEventGetPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`SportsGameOddsServiceException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/SportsGameOddsServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`SportsGameOddsIoException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/SportsGameOddsIoException.kt): I/O networking errors.\n\n- [`SportsGameOddsRetryableException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/SportsGameOddsRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`SportsGameOddsInvalidDataException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/SportsGameOddsInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`SportsGameOddsException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/SportsGameOddsException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.sportsgameodds.api.models.events.Event;\nimport com.sportsgameodds.api.models.events.EventGetPage;\n\nEventGetPage page = client.events().get();\n\n// Process as an Iterable\nfor (Event event : page.autoPager()) {\n System.out.println(event);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(event -> System.out.println(event));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.sportsgameodds.api.core.http.AsyncStreamResponse;\nimport com.sportsgameodds.api.models.events.Event;\nimport com.sportsgameodds.api.models.events.EventGetPageAsync;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().events().get();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(event -> {\n System.out.println(event);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(Event event) {\n System.out.println(event);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(event -> {\n System.out.println(event);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.sportsgameodds.api.models.events.Event;\nimport com.sportsgameodds.api.models.events.EventGetPage;\n\nEventGetPage page = client.events().get();\nwhile (true) {\n for (Event event : page.items()) {\n System.out.println(event);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nEnable logging by setting the `SPORTS_GAME_ODDS_LOG` environment variable to `info`:\n\n```sh\nexport SPORTS_GAME_ODDS_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport SPORTS_GAME_ODDS_LOG=debug\n```\n\nOr configure the client manually using the `logLevel` method:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.core.LogLevel;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n .logLevel(LogLevel.INFO)\n .build();\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `sports-odds-api-core` is published with a [configuration file](sports-odds-api-core/src/main/resources/META-INF/proguard/sports-odds-api-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`SportsGameOddsOkHttpClient`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClient.kt) or [`SportsGameOddsOkHttpClientAsync`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.sportsgameodds.api.models.events.EventGetPage;\n\nEventGetPage page = client.events().get(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport java.time.Duration;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .build();\n```\n\nIf the proxy responds with `407 Proxy Authentication Required`, supply credentials by also configuring `proxyAuthenticator`:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport com.sportsgameodds.api.core.http.ProxyAuthenticator;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n .proxy(...)\n // Or a custom implementation of `ProxyAuthenticator`.\n .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\nimport java.time.Duration;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `sports-odds-api-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`SportsGameOddsClient`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClient.kt), [`SportsGameOddsClientAsync`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientAsync.kt), [`SportsGameOddsClientImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientImpl.kt), and [`SportsGameOddsClientAsyncImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientAsyncImpl.kt), all of which can work with any HTTP client\n- `sports-odds-api-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`SportsGameOddsOkHttpClient`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClient.kt) and [`SportsGameOddsOkHttpClientAsync`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClientAsync.kt), which provide a way to construct [`SportsGameOddsClientImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientImpl.kt) and [`SportsGameOddsClientAsyncImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientAsyncImpl.kt), respectively, using OkHttp\n- `sports-odds-api`\n - Depends on and exposes the APIs of both `sports-odds-api-core` and `sports-odds-api-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`sports-odds-api` dependency](#installation) with `sports-odds-api-core`\n2. Copy `sports-odds-api-client-okhttp`\'s [`OkHttpClient`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`SportsGameOddsClientImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientImpl.kt) or [`SportsGameOddsClientAsyncImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientAsyncImpl.kt), similarly to [`SportsGameOddsOkHttpClient`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClient.kt) or [`SportsGameOddsOkHttpClientAsync`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`sports-odds-api` dependency](#installation) with `sports-odds-api-core`\n2. Write a class that implements the [`HttpClient`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/core/http/HttpClient.kt) interface\n3. Construct [`SportsGameOddsClientImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientImpl.kt) or [`SportsGameOddsClientAsyncImpl`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/client/SportsGameOddsClientAsyncImpl.kt), similarly to [`SportsGameOddsOkHttpClient`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClient.kt) or [`SportsGameOddsOkHttpClientAsync`](sports-odds-api-client-okhttp/src/main/kotlin/com/sportsgameodds/api/client/okhttp/SportsGameOddsOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.sportsgameodds.api.core.JsonValue;\nimport com.sportsgameodds.api.models.events.EventGetParams;\n\nEventGetParams params = EventGetParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/core/Values.kt) object to its setter:\n\n```java\nimport com.sportsgameodds.api.models.events.EventGetParams;\n\nEventGetParams params = EventGetParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.sportsgameodds.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.sportsgameodds.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.account().getUsage(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.sportsgameodds.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField field = client.account().getUsage(params)._field();\n\nif (field.isMissing()) {\n // The property is absent from the JSON response\n} else if (field.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = field.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = field.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`SportsGameOddsInvalidDataException`](sports-odds-api-core/src/main/kotlin/com/sportsgameodds/api/errors/SportsGameOddsInvalidDataException.kt) only if you directly access the property.\n\nValidating the response is _not_ forwards compatible with new types from the API for existing fields.\n\nIf you would still prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.sportsgameodds.api.models.account.AccountUsage;\n\nAccountUsage accountUsage = client.account().getUsage(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.sportsgameodds.api.models.events.EventGetPage;\n\nEventGetPage page = client.events().get(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.sportsgameodds.api.client.SportsGameOddsClient;\nimport com.sportsgameodds.api.client.okhttp.SportsGameOddsOkHttpClient;\n\nSportsGameOddsClient client = SportsGameOddsOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/SportsGameOdds/sports-odds-api-java/issues) with questions, bugs, or suggestions.\n', }, { language: 'python', content: '# Sports Game Odds Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/sports-odds-api.svg?label=pypi%20(stable))](https://pypi.org/project/sports-odds-api/)\n\nThe Sports Game Odds Python library provides convenient access to the Sports Game Odds REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Sports Game Odds MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=sports-odds-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInNwb3J0cy1vZGRzLWFwaS1tY3AiXSwiZW52Ijp7IlNQT1JUU19PRERTX0FQSV9LRVlfSEVBREVSIjoiTXkgQVBJIEtleSBQYXJhbSJ9fQ)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22sports-odds-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22sports-odds-api-mcp%22%5D%2C%22env%22%3A%7B%22SPORTS_ODDS_API_KEY_HEADER%22%3A%22My%20API%20Key%20Param%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [sportsgameodds.com](https://sportsgameodds.com/docs/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install sports-odds-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nimport os\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\n\npage = client.events.get()\nprint(page.data)\n```\n\nWhile you can provide a `api_key_header` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `SPORTS_ODDS_API_KEY_HEADER="My API Key Header"` to your `.env` file\nso that your API Key Header is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncSportsGameOdds` instead of `SportsGameOdds` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom sports_odds_api import AsyncSportsGameOdds\n\nclient = AsyncSportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n)\n\nasync def main() -> None:\n page = await client.events.get()\n print(page.data)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install sports-odds-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport os\nimport asyncio\nfrom sports_odds_api import DefaultAioHttpClient\nfrom sports_odds_api import AsyncSportsGameOdds\n\nasync def main() -> None:\n async with AsyncSportsGameOdds(\n api_key_param=os.environ.get("SPORTS_ODDS_API_KEY_HEADER"), # This is the default and can be omitted\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.events.get()\n print(page.data)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Sports Game Odds API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds()\n\nall_events = []\n# Automatically fetches more pages as needed.\nfor event in client.events.get(\n limit=30,\n):\n # Do something with event here\n all_events.append(event)\nprint(all_events)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom sports_odds_api import AsyncSportsGameOdds\n\nclient = AsyncSportsGameOdds()\n\nasync def main() -> None:\n all_events = []\n # Iterate through items across all pages, issuing requests as needed.\n async for event in client.events.get(\n limit=30,\n):\n all_events.append(event)\n print(all_events)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.events.get(\n limit=30,\n)\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.data)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.events.get(\n limit=30,\n)\n\nprint(f"next page cursor: {first_page.next_cursor}") # => "next page cursor: ..."\nfor event in first_page.data:\n print(event.activity)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `sports_odds_api.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `sports_odds_api.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `sports_odds_api.APIError`.\n\n```python\nimport sports_odds_api\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds()\n\ntry:\n client.events.get()\nexcept sports_odds_api.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept sports_odds_api.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept sports_odds_api.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom sports_odds_api import SportsGameOdds\n\n# Configure the default for all requests:\nclient = SportsGameOdds(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).events.get()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom sports_odds_api import SportsGameOdds\n\n# Configure the default for all requests:\nclient = SportsGameOdds(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = SportsGameOdds(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).events.get()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `SPORTS_GAME_ODDS_LOG` to `info`.\n\n```shell\n$ export SPORTS_GAME_ODDS_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom sports_odds_api import SportsGameOdds\n\nclient = SportsGameOdds()\nresponse = client.events.with_raw_response.get()\nprint(response.headers.get(\'X-My-Header\'))\n\nevent = response.parse() # get the object that `events.get()` would have returned\nprint(event.activity)\n```\n\nThese methods return an [`APIResponse`](https://github.com/SportsGameOdds/sports-odds-api-python/tree/main/src/sports_odds_api/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/SportsGameOdds/sports-odds-api-python/tree/main/src/sports_odds_api/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith client.events.with_streaming_response.get() as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom sports_odds_api import SportsGameOdds, DefaultHttpxClient\n\nclient = SportsGameOdds(\n # Or use the `SPORTS_GAME_ODDS_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom sports_odds_api import SportsGameOdds\n\nwith SportsGameOdds() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/SportsGameOdds/sports-odds-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport sports_odds_api\nprint(sports_odds_api.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', }, { language: 'ruby', content: '# Sports Game Odds Ruby API library\n\nThe Sports Game Odds Ruby library provides convenient access to the Sports Game Odds REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/SportsGameOdds/sports-odds-api-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Sports Game Odds MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=sports-odds-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInNwb3J0cy1vZGRzLWFwaS1tY3AiXSwiZW52Ijp7IlNQT1JUU19PRERTX0FQSV9LRVlfSEVBREVSIjoiTXkgQVBJIEtleSBQYXJhbSJ9fQ)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22sports-odds-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22sports-odds-api-mcp%22%5D%2C%22env%22%3A%7B%22SPORTS_ODDS_API_KEY_HEADER%22%3A%22My%20API%20Key%20Param%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/sports-odds-api).\n\nThe REST API documentation can be found on [sportsgameodds.com](https://sportsgameodds.com/docs/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "sports-odds-api", "~> 1.2.3"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "sports_odds_api"\n\nsports_game_odds = SportsOddsAPI::Client.new(\n api_key_param: ENV["SPORTS_ODDS_API_KEY_HEADER"] # This is the default and can be omitted\n)\n\npage = sports_game_odds.events.get\n\nputs(page.activity)\n```\n\n\n\n### Pagination\n\nList methods in the Sports Game Odds API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = sports_game_odds.events.get(limit: 30)\n\n# Fetch single item from page.\nevent = page.data[0]\nputs(event.activity)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |event|\n puts(event.activity)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.data[0].activity)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `SportsOddsAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n event = sports_game_odds.events.get\nrescue SportsOddsAPI::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue SportsOddsAPI::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue SportsOddsAPI::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nsports_game_odds = SportsOddsAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nsports_game_odds.events.get(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nsports_game_odds = SportsOddsAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nsports_game_odds.events.get(request_options: {timeout: 5})\n```\n\nOn timeout, `SportsOddsAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `SportsOddsAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n sports_game_odds.events.get(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `SportsOddsAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `SportsOddsAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nsports_game_odds.events.get \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nsports_game_odds.events.get\n\n# You can also splat a full Params class:\nparams = SportsOddsAPI::EventGetParams.new\nsports_game_odds.events.get(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :game_prop\nputs(SportsOddsAPI::Market::PropType::GAME_PROP)\n\n# Revealed type: `T.all(SportsOddsAPI::Market::PropType, Symbol)`\nT.reveal_type(SportsOddsAPI::Market::PropType::GAME_PROP)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\nSportsOddsAPI::Market.new(\n prop_type: SportsOddsAPI::Market::PropType::GAME_PROP,\n # …\n)\n\nSportsOddsAPI::Market.new(\n prop_type: :game_prop,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/SportsGameOdds/sports-odds-api-ruby/tree/main/CONTRIBUTING.md).\n', }, { language: 'typescript', content: "# Sports Odds API - Live Sports Data & Sportsbook Betting Odds - Powered by SportsGameOdds API Library\n\n[![NPM version](https://img.shields.io/npm/v/sports-odds-api.svg?label=npm%20(stable))](https://npmjs.org/package/sports-odds-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sports-odds-api)\n\nThis library provides convenient access to the Sports Game Odds REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [sportsgameodds.com](https://sportsgameodds.com/docs/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Sports Game Odds MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=sports-odds-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInNwb3J0cy1vZGRzLWFwaS1tY3AiXSwiZW52Ijp7IlNQT1JUU19PRERTX0FQSV9LRVlfSEVBREVSIjoiTXkgQVBJIEtleSBQYXJhbSJ9fQ)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22sports-odds-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22sports-odds-api-mcp%22%5D%2C%22env%22%3A%7B%22SPORTS_ODDS_API_KEY_HEADER%22%3A%22My%20API%20Key%20Param%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install sports-odds-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst page = await client.events.get();\nconst event = page.data[0];\n\nconsole.log(event.activity);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n apiKeyParam: process.env['SPORTS_ODDS_API_KEY_HEADER'], // This is the default and can be omitted\n});\n\nconst [event]: [SportsGameOdds.Event] = await client.events.get();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst page = await client.events.get().catch(async (err) => {\n if (err instanceof SportsGameOdds.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new SportsGameOdds({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.events.get({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new SportsGameOdds({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.events.get({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the SportsGameOdds API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllEvents(params) {\n const allEvents = [];\n // Automatically fetches more pages as needed.\n for await (const event of client.events.get({ limit: 30 })) {\n allEvents.push(event);\n }\n return allEvents;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.events.get({ limit: 30 });\nfor (const event of page.data) {\n console.log(event);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new SportsGameOdds();\n\nconst response = await client.events.get().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.events.get().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const event of page) {\n console.log(event.activity);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `SPORTS_GAME_ODDS_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new SportsGameOdds({\n logger: logger.child({ name: 'SportsGameOdds' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.events.get({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\nimport fetch from 'my-fetch';\n\nconst client = new SportsGameOdds({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new SportsGameOdds({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport SportsGameOdds from 'sports-odds-api';\n\nconst client = new SportsGameOdds({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport SportsGameOdds from 'npm:sports-odds-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new SportsGameOdds({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/SportsGameOdds/sports-odds-api-typescript/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", }, ]; const INDEX_OPTIONS = { fields: [ 'name', 'endpoint', 'summary', 'description', 'qualified', 'stainlessPath', 'content', 'sectionContext', ], storeFields: ['kind', '_original'], searchOptions: { prefix: true, fuzzy: 0.1, boost: { name: 5, stainlessPath: 3, endpoint: 3, qualified: 3, summary: 2, content: 1, description: 1, } as Record, }, }; /** * Self-contained local search engine backed by MiniSearch. * Method data is embedded at SDK build time; prose documents * can be loaded from an optional docs directory at runtime. */ export class LocalDocsSearch { private methodIndex: MiniSearch; private proseIndex: MiniSearch; private constructor() { this.methodIndex = new MiniSearch(INDEX_OPTIONS); this.proseIndex = new MiniSearch(INDEX_OPTIONS); } static async create(opts?: { docsDir?: string }): Promise { const instance = new LocalDocsSearch(); instance.indexMethods(EMBEDDED_METHODS); for (const readme of EMBEDDED_READMES) { instance.indexProse(readme.content, `readme:${readme.language}`); } if (opts?.docsDir) { await instance.loadDocsDirectory(opts.docsDir); } return instance; } search(props: { query: string; language?: string; detail?: string; maxResults?: number; maxLength?: number; }): SearchResult { const { query, language = 'typescript', detail = 'default', maxResults = 5, maxLength = 100_000 } = props; const useMarkdown = detail === 'verbose' || detail === 'high'; // Search both indices and merge results by score. // Filter prose hits so language-tagged content (READMEs and docs with // frontmatter) only matches the requested language. const methodHits = this.methodIndex .search(query) .map((hit) => ({ ...hit, _kind: 'http_method' as const })); const proseHits = this.proseIndex .search(query) .filter((hit) => { const source = ((hit as Record)['_original'] as ProseChunk | undefined)?.source; if (!source) return true; // Check for language-tagged sources: "readme:" or "lang::" let taggedLang: string | undefined; if (source.startsWith('readme:')) taggedLang = source.slice('readme:'.length); else if (source.startsWith('lang:')) taggedLang = source.split(':')[1]; if (!taggedLang) return true; return taggedLang === language || (language === 'javascript' && taggedLang === 'typescript'); }) .map((hit) => ({ ...hit, _kind: 'prose' as const })); const merged = [...methodHits, ...proseHits].sort((a, b) => b.score - a.score); const top = merged.slice(0, maxResults); const fullResults: (string | Record)[] = []; for (const hit of top) { const original = (hit as Record)['_original']; if (hit._kind === 'http_method') { const m = original as MethodEntry; if (useMarkdown && m.markdown) { fullResults.push(m.markdown); } else { // Use per-language data when available, falling back to the // top-level fields (which are TypeScript-specific in the // legacy codepath). const langData = m.perLanguage?.[language]; fullResults.push({ method: langData?.method ?? m.qualified, summary: m.summary, description: m.description, endpoint: `${m.httpMethod.toUpperCase()} ${m.endpoint}`, ...(langData?.example ? { example: langData.example } : {}), ...(m.params ? { params: m.params } : {}), ...(m.response ? { response: m.response } : {}), }); } } else { const c = original as ProseChunk; fullResults.push({ content: c.content, ...(c.source ? { source: c.source } : {}), }); } } let totalLength = 0; const results: (string | Record)[] = []; for (const result of fullResults) { const len = typeof result === 'string' ? result.length : JSON.stringify(result).length; totalLength += len; if (totalLength > maxLength) break; results.push(result); } if (results.length < fullResults.length) { results.unshift(`Truncated; showing ${results.length} of ${fullResults.length} results.`); } return { results }; } private indexMethods(methods: MethodEntry[]): void { const docs: MiniSearchDocument[] = methods.map((m, i) => ({ id: `method-${i}`, kind: 'http_method' as const, name: m.name, endpoint: m.endpoint, summary: m.summary, description: m.description, qualified: m.qualified, stainlessPath: m.stainlessPath, _original: m as unknown as Record, })); if (docs.length > 0) { this.methodIndex.addAll(docs); } } private async loadDocsDirectory(docsDir: string): Promise { let entries; try { entries = await fs.readdir(docsDir, { withFileTypes: true }); } catch (err) { getLogger().warn({ err, docsDir }, 'Could not read docs directory'); return; } const files = entries .filter((e) => e.isFile()) .filter((e) => e.name.endsWith('.md') || e.name.endsWith('.markdown') || e.name.endsWith('.json')); for (const file of files) { try { const filePath = path.join(docsDir, file.name); const content = await fs.readFile(filePath, 'utf-8'); if (file.name.endsWith('.json')) { const texts = extractTexts(JSON.parse(content)); if (texts.length > 0) { this.indexProse(texts.join('\n\n'), file.name); } } else { // Parse optional YAML frontmatter for language tagging. // Files with a "language" field in frontmatter will only // surface in searches for that language. // // Example: // --- // language: python // --- // # Error handling in Python // ... const frontmatter = parseFrontmatter(content); const source = frontmatter.language ? `lang:${frontmatter.language}:${file.name}` : file.name; this.indexProse(content, source); } } catch (err) { getLogger().warn({ err, file: file.name }, 'Failed to index docs file'); } } } private indexProse(markdown: string, source: string): void { const chunks = chunkMarkdown(markdown); const baseId = this.proseIndex.documentCount; const docs: MiniSearchDocument[] = chunks.map((chunk, i) => ({ id: `prose-${baseId + i}`, kind: 'prose' as const, content: chunk.content, ...(chunk.sectionContext != null ? { sectionContext: chunk.sectionContext } : {}), _original: { ...chunk, source } as unknown as Record, })); if (docs.length > 0) { this.proseIndex.addAll(docs); } } } /** Lightweight markdown chunker — splits on headers, chunks by word count. */ function chunkMarkdown(markdown: string): { content: string; tag: string; sectionContext?: string }[] { // Strip YAML frontmatter const stripped = markdown.replace(/^---\n[\s\S]*?\n---\n?/, ''); const lines = stripped.split('\n'); const chunks: { content: string; tag: string; sectionContext?: string }[] = []; const headers: string[] = []; let current: string[] = []; const flush = () => { const text = current.join('\n').trim(); if (!text) return; const sectionContext = headers.length > 0 ? headers.join(' > ') : undefined; // Split into ~200-word chunks const words = text.split(/\s+/); for (let i = 0; i < words.length; i += 200) { const slice = words.slice(i, i + 200).join(' '); if (slice) { chunks.push({ content: slice, tag: 'p', ...(sectionContext != null ? { sectionContext } : {}) }); } } current = []; }; for (const line of lines) { const headerMatch = line.match(/^(#{1,6})\s+(.+)/); if (headerMatch) { flush(); const level = headerMatch[1]!.length; const text = headerMatch[2]!.trim(); while (headers.length >= level) headers.pop(); headers.push(text); } else { current.push(line); } } flush(); return chunks; } /** Recursively extracts string values from a JSON structure. */ function extractTexts(data: unknown, depth = 0): string[] { if (depth > 10) return []; if (typeof data === 'string') return data.trim() ? [data] : []; if (Array.isArray(data)) return data.flatMap((item) => extractTexts(item, depth + 1)); if (typeof data === 'object' && data !== null) { return Object.values(data).flatMap((v) => extractTexts(v, depth + 1)); } return []; } /** Parses YAML frontmatter from a markdown string, extracting the language field if present. */ function parseFrontmatter(markdown: string): { language?: string } { const match = markdown.match(/^---\n([\s\S]*?)\n---/); if (!match) return {}; const body = match[1] ?? ''; const langMatch = body.match(/^language:\s*(.+)$/m); return langMatch ? { language: langMatch[1]!.trim() } : {}; }