sports-odds-api/client.d.ts

The official TypeScript library for the Sports Game Odds API

import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
export type { Logger, LogLevel } from "./internal/utils/log.js";
import * as Opts from "./internal/request-options.js";
import * as Errors from "./core/error.js";
import * as Pagination from "./core/pagination.js";
import { type NextCursorPageParams, NextCursorPageResponse } from "./core/pagination.js";
import * as Uploads from "./core/uploads.js";
import * as API from "./resources/index.js";
import { APIPromise } from "./core/api-promise.js";
import { Account, AccountUsage, RateLimitInterval } from "./resources/account.js";
import { Event, EventGetParams, Events, EventsNextCursorPage } from "./resources/events.js";
import { League, LeagueGetParams, LeagueGetResponse, Leagues } from "./resources/leagues.js";
import { Player, PlayerGetParams, Players, PlayersNextCursorPage } from "./resources/players.js";
import { Sport, SportGetResponse, Sports } from "./resources/sports.js";
import { Stat, StatGetParams, StatGetResponse, Stats } from "./resources/stats.js";
import { Stream, StreamEventsParams, StreamEventsResponse } from "./resources/stream.js";
import { Team, TeamGetParams, Teams, TeamsNextCursorPage } from "./resources/teams.js";
import { type Fetch } from "./internal/builtin-types.js";
import { HeadersLike, NullableHeaders } from "./internal/headers.js";
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
import { type LogLevel, type Logger } from "./internal/utils/log.js";
export interface ClientOptions {
    /**
     * API key via header
     */
    apiKeyHeader?: string | null | undefined;
    /**
     * API key via query param
     */
    apiKeyParam?: string | null | undefined;
    /**
     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
     *
     * Defaults to process.env['SPORTS_GAME_ODDS_BASE_URL'].
     */
    baseURL?: string | null | undefined;
    /**
     * The maximum amount of time (in milliseconds) that the client should wait for a response
     * from the server before timing out a single request.
     *
     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
     * much longer than this timeout before the promise succeeds or fails.
     *
     * @unit milliseconds
     */
    timeout?: number | undefined;
    /**
     * Additional `RequestInit` options to be passed to `fetch` calls.
     * Properties will be overridden by per-request `fetchOptions`.
     */
    fetchOptions?: MergedRequestInit | undefined;
    /**
     * Specify a custom `fetch` function implementation.
     *
     * If not provided, we expect that `fetch` is defined globally.
     */
    fetch?: Fetch | undefined;
    /**
     * The maximum number of times that the client will retry a request in case of a
     * temporary failure, like a network error or a 5XX error from the server.
     *
     * @default 2
     */
    maxRetries?: number | undefined;
    /**
     * Default headers to include with every request to the API.
     *
     * These can be removed in individual requests by explicitly setting the
     * header to `null` in request options.
     */
    defaultHeaders?: HeadersLike | undefined;
    /**
     * Default query parameters to include with every request to the API.
     *
     * These can be removed in individual requests by explicitly setting the
     * param to `undefined` in request options.
     */
    defaultQuery?: Record<string, string | undefined> | undefined;
    /**
     * Set the log level.
     *
     * Defaults to process.env['SPORTS_GAME_ODDS_LOG'] or 'warn' if it isn't set.
     */
    logLevel?: LogLevel | undefined;
    /**
     * Set the logger.
     *
     * Defaults to globalThis.console.
     */
    logger?: Logger | undefined;
}
/**
 * API Client for interfacing with the Sports Game Odds API.
 */
export declare class SportsGameOdds {
    #private;
    apiKeyHeader: string | null;
    apiKeyParam: string | null;
    baseURL: string;
    maxRetries: number;
    timeout: number;
    logger: Logger | undefined;
    logLevel: LogLevel | undefined;
    fetchOptions: MergedRequestInit | undefined;
    private fetch;
    protected idempotencyHeader?: string;
    private _options;
    /**
     * API Client for interfacing with the Sports Game Odds API.
     *
     * @param {string | null | undefined} [opts.apiKeyHeader=process.env['SPORTS_ODDS_API_KEY_HEADER'] ?? null]
     * @param {string | null | undefined} [opts.apiKeyParam=process.env['SPORTS_ODDS_API_KEY_HEADER'] ?? null]
     * @param {string} [opts.baseURL=process.env['SPORTS_GAME_ODDS_BASE_URL'] ?? https://api.sportsgameodds.com/v2] - Override the default base URL for the API.
     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
     * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
     * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
     * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
     */
    constructor({ baseURL, apiKeyHeader, apiKeyParam, ...opts }?: ClientOptions);
    /**
     * Create a new client instance re-using the same options given to the current client with optional overriding.
     */
    withOptions(options: Partial<ClientOptions>): this;
    protected defaultQuery(): Record<string, string | undefined> | undefined;
    protected validateHeaders({ values, nulls }: NullableHeaders): void;
    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
    /**
     * Basic re-implementation of `qs.stringify` for primitive types.
     */
    protected stringifyQuery(query: Record<string, unknown>): string;
    private getUserAgent;
    protected defaultIdempotencyKey(): string;
    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
    buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
    /**
     * Used as a callback for mutating the given `FinalRequestOptions` object.
     */
    protected prepareOptions(options: FinalRequestOptions): Promise<void>;
    /**
     * Used as a callback for mutating the given `RequestInit` object.
     *
     * This is useful for cases where you want to add certain headers based off of
     * the request properties, e.g. `method` or `url`.
     */
    protected prepareRequest(request: RequestInit, { url, options }: {
        url: string;
        options: FinalRequestOptions;
    }): Promise<void>;
    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    private methodRequest;
    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
    private makeRequest;
    getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(path: string, Page: new (...args: any[]) => PageClass, opts?: RequestOptions): Pagination.PagePromise<PageClass, Item>;
    requestAPIList<Item = unknown, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass, options: FinalRequestOptions): Pagination.PagePromise<PageClass, Item>;
    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
    private shouldRetry;
    private retryRequest;
    private calculateDefaultRetryTimeoutMillis;
    buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
        retryCount?: number;
    }): Promise<{
        req: FinalizedRequestInit;
        url: string;
        timeout: number;
    }>;
    private buildHeaders;
    private buildBody;
    static SportsGameOdds: typeof SportsGameOdds;
    static DEFAULT_TIMEOUT: number;
    static SportsGameOddsError: typeof Errors.SportsGameOddsError;
    static APIError: typeof Errors.APIError;
    static APIConnectionError: typeof Errors.APIConnectionError;
    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
    static APIUserAbortError: typeof Errors.APIUserAbortError;
    static NotFoundError: typeof Errors.NotFoundError;
    static ConflictError: typeof Errors.ConflictError;
    static RateLimitError: typeof Errors.RateLimitError;
    static BadRequestError: typeof Errors.BadRequestError;
    static AuthenticationError: typeof Errors.AuthenticationError;
    static InternalServerError: typeof Errors.InternalServerError;
    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
    static toFile: typeof Uploads.toFile;
    events: API.Events;
    teams: API.Teams;
    players: API.Players;
    leagues: API.Leagues;
    sports: API.Sports;
    stats: API.Stats;
    account: API.Account;
    stream: API.Stream;
}
export declare namespace SportsGameOdds {
    export type RequestOptions = Opts.RequestOptions;
    export import NextCursorPage = Pagination.NextCursorPage;
    export { type NextCursorPageParams as NextCursorPageParams, type NextCursorPageResponse as NextCursorPageResponse, };
    export { Events as Events, type Event as Event, type EventsNextCursorPage as EventsNextCursorPage, type EventGetParams as EventGetParams, };
    export { Teams as Teams, type Team as Team, type TeamsNextCursorPage as TeamsNextCursorPage, type TeamGetParams as TeamGetParams, };
    export { Players as Players, type Player as Player, type PlayersNextCursorPage as PlayersNextCursorPage, type PlayerGetParams as PlayerGetParams, };
    export { Leagues as Leagues, type League as League, type LeagueGetResponse as LeagueGetResponse, type LeagueGetParams as LeagueGetParams, };
    export { Sports as Sports, type Sport as Sport, type SportGetResponse as SportGetResponse };
    export { Stats as Stats, type Stat as Stat, type StatGetResponse as StatGetResponse, type StatGetParams as StatGetParams, };
    export { Account as Account, type AccountUsage as AccountUsage, type RateLimitInterval as RateLimitInterval, };
    export { Stream as Stream, type StreamEventsResponse as StreamEventsResponse, type StreamEventsParams as StreamEventsParams, };
}
//# sourceMappingURL=client.d.ts.map