@stadar/sdk 0.1.7

package/src/apis/SeriesApi.ts

@@ -0,0 +1,454 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stadar Esports Data API
+ * Read-only, betting-friendly esports data across all major competitive titles. Flat-tier pricing (no per-game gates), Polar- billed subscriptions (Merchant of Record), sandbox keys for evaluation. See https://stadar.net for tier pricing. All endpoints under `/v1/...`. The version in `info.version` matches the URL prefix; non-breaking field additions ship in `/v1`, breaking changes get a `/v2`. We commit to 24 months of `/v1` support after `/v2` ships. Times are UTC end-to-end (RFC 3339). Localization is the client\'s problem. Cursors are opaque base64 strings; treat them as such. 
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: api@stadar.net
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type ErrorEnvelope,
+    ErrorEnvelopeFromJSON,
+    ErrorEnvelopeToJSON,
+} from '../models/ErrorEnvelope';
+import {
+    type MatchesListResponse,
+    MatchesListResponseFromJSON,
+    MatchesListResponseToJSON,
+} from '../models/MatchesListResponse';
+import {
+    type SeriesEnvelope,
+    SeriesEnvelopeFromJSON,
+    SeriesEnvelopeToJSON,
+} from '../models/SeriesEnvelope';
+import {
+    type SeriesListResponse,
+    SeriesListResponseFromJSON,
+    SeriesListResponseToJSON,
+} from '../models/SeriesListResponse';
+import {
+    type TournamentsListResponse,
+    TournamentsListResponseFromJSON,
+    TournamentsListResponseToJSON,
+} from '../models/TournamentsListResponse';
+
+export interface SeriesGetRequest {
+    idslug: string;
+    leagueId?: number;
+}
+
+export interface SeriesListRequest {
+    cursor?: string;
+    limit?: number;
+    game?: string;
+    leagueId?: number;
+    year?: number;
+}
+
+export interface SeriesListMatchesRequest {
+    idslug: string;
+    cursor?: string;
+    limit?: number;
+    status?: SeriesListMatchesStatusEnum;
+}
+
+export interface SeriesListTournamentsRequest {
+    idslug: string;
+    cursor?: string;
+    limit?: number;
+}
+
+/**
+ * SeriesApi - interface
+ * 
+ * @export
+ * @interface SeriesApiInterface
+ */
+export interface SeriesApiInterface {
+    /**
+     * Creates request options for seriesGet without sending the request
+     * @param {string} idslug 
+     * @param {number} [leagueId] Required when path is a slug (slugs are league-scoped).
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesGetRequestOpts(requestParameters: SeriesGetRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get a single series
+     * @param {string} idslug 
+     * @param {number} [leagueId] Required when path is a slug (slugs are league-scoped).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesGetRaw(requestParameters: SeriesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SeriesEnvelope>>;
+
+    /**
+     * Get a single series
+     */
+    seriesGet(requestParameters: SeriesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SeriesEnvelope>;
+
+    /**
+     * Creates request options for seriesList without sending the request
+     * @param {string} [cursor] Opaque pagination cursor. Hand back the value from &#x60;meta.next_cursor&#x60; to fetch the next page. Cursors are valid for at least 24 hours; treat them as opaque strings. 
+     * @param {number} [limit] Items per page. 1-200, default 50. (Pro+ on &#x60;/v1/matches&#x60; may request up to 10k via &#x60;?bulk&#x3D;true&#x60;.)
+     * @param {string} [game] 
+     * @param {number} [leagueId] 
+     * @param {number} [year] 
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesListRequestOpts(requestParameters: SeriesListRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List series
+     * @param {string} [cursor] Opaque pagination cursor. Hand back the value from &#x60;meta.next_cursor&#x60; to fetch the next page. Cursors are valid for at least 24 hours; treat them as opaque strings. 
+     * @param {number} [limit] Items per page. 1-200, default 50. (Pro+ on &#x60;/v1/matches&#x60; may request up to 10k via &#x60;?bulk&#x3D;true&#x60;.)
+     * @param {string} [game] 
+     * @param {number} [leagueId] 
+     * @param {number} [year] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesListRaw(requestParameters: SeriesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SeriesListResponse>>;
+
+    /**
+     * List series
+     */
+    seriesList(requestParameters: SeriesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SeriesListResponse>;
+
+    /**
+     * Creates request options for seriesListMatches without sending the request
+     * @param {string} idslug 
+     * @param {string} [cursor] Opaque pagination cursor. Hand back the value from &#x60;meta.next_cursor&#x60; to fetch the next page. Cursors are valid for at least 24 hours; treat them as opaque strings. 
+     * @param {number} [limit] Items per page. 1-200, default 50. (Pro+ on &#x60;/v1/matches&#x60; may request up to 10k via &#x60;?bulk&#x3D;true&#x60;.)
+     * @param {'scheduled' | 'live' | 'completed' | 'cancelled' | 'postponed'} [status] 
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesListMatchesRequestOpts(requestParameters: SeriesListMatchesRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Matches within a series
+     * @param {string} idslug 
+     * @param {string} [cursor] Opaque pagination cursor. Hand back the value from &#x60;meta.next_cursor&#x60; to fetch the next page. Cursors are valid for at least 24 hours; treat them as opaque strings. 
+     * @param {number} [limit] Items per page. 1-200, default 50. (Pro+ on &#x60;/v1/matches&#x60; may request up to 10k via &#x60;?bulk&#x3D;true&#x60;.)
+     * @param {'scheduled' | 'live' | 'completed' | 'cancelled' | 'postponed'} [status] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesListMatchesRaw(requestParameters: SeriesListMatchesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MatchesListResponse>>;
+
+    /**
+     * Matches within a series
+     */
+    seriesListMatches(requestParameters: SeriesListMatchesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MatchesListResponse>;
+
+    /**
+     * Creates request options for seriesListTournaments without sending the request
+     * @param {string} idslug 
+     * @param {string} [cursor] Opaque pagination cursor. Hand back the value from &#x60;meta.next_cursor&#x60; to fetch the next page. Cursors are valid for at least 24 hours; treat them as opaque strings. 
+     * @param {number} [limit] Items per page. 1-200, default 50. (Pro+ on &#x60;/v1/matches&#x60; may request up to 10k via &#x60;?bulk&#x3D;true&#x60;.)
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesListTournamentsRequestOpts(requestParameters: SeriesListTournamentsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Tournaments within a series
+     * @param {string} idslug 
+     * @param {string} [cursor] Opaque pagination cursor. Hand back the value from &#x60;meta.next_cursor&#x60; to fetch the next page. Cursors are valid for at least 24 hours; treat them as opaque strings. 
+     * @param {number} [limit] Items per page. 1-200, default 50. (Pro+ on &#x60;/v1/matches&#x60; may request up to 10k via &#x60;?bulk&#x3D;true&#x60;.)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SeriesApiInterface
+     */
+    seriesListTournamentsRaw(requestParameters: SeriesListTournamentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TournamentsListResponse>>;
+
+    /**
+     * Tournaments within a series
+     */
+    seriesListTournaments(requestParameters: SeriesListTournamentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TournamentsListResponse>;
+
+}
+
+/**
+ * 
+ */
+export class SeriesApi extends runtime.BaseAPI implements SeriesApiInterface {
+
+    /**
+     * Creates request options for seriesGet without sending the request
+     */
+    async seriesGetRequestOpts(requestParameters: SeriesGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['idslug'] == null) {
+            throw new runtime.RequiredError(
+                'idslug',
+                'Required parameter "idslug" was null or undefined when calling seriesGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['leagueId'] != null) {
+            queryParameters['league_id'] = requestParameters['leagueId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("apiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/series/{idslug}`;
+        urlPath = urlPath.replace('{idslug}', encodeURIComponent(String(requestParameters['idslug'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get a single series
+     */
+    async seriesGetRaw(requestParameters: SeriesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SeriesEnvelope>> {
+        const requestOptions = await this.seriesGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SeriesEnvelopeFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a single series
+     */
+    async seriesGet(requestParameters: SeriesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SeriesEnvelope> {
+        const response = await this.seriesGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for seriesList without sending the request
+     */
+    async seriesListRequestOpts(requestParameters: SeriesListRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['game'] != null) {
+            queryParameters['game'] = requestParameters['game'];
+        }
+
+        if (requestParameters['leagueId'] != null) {
+            queryParameters['league_id'] = requestParameters['leagueId'];
+        }
+
+        if (requestParameters['year'] != null) {
+            queryParameters['year'] = requestParameters['year'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("apiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/series`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List series
+     */
+    async seriesListRaw(requestParameters: SeriesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SeriesListResponse>> {
+        const requestOptions = await this.seriesListRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SeriesListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List series
+     */
+    async seriesList(requestParameters: SeriesListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SeriesListResponse> {
+        const response = await this.seriesListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for seriesListMatches without sending the request
+     */
+    async seriesListMatchesRequestOpts(requestParameters: SeriesListMatchesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['idslug'] == null) {
+            throw new runtime.RequiredError(
+                'idslug',
+                'Required parameter "idslug" was null or undefined when calling seriesListMatches().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("apiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/series/{idslug}/matches`;
+        urlPath = urlPath.replace('{idslug}', encodeURIComponent(String(requestParameters['idslug'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Matches within a series
+     */
+    async seriesListMatchesRaw(requestParameters: SeriesListMatchesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MatchesListResponse>> {
+        const requestOptions = await this.seriesListMatchesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MatchesListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Matches within a series
+     */
+    async seriesListMatches(requestParameters: SeriesListMatchesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MatchesListResponse> {
+        const response = await this.seriesListMatchesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for seriesListTournaments without sending the request
+     */
+    async seriesListTournamentsRequestOpts(requestParameters: SeriesListTournamentsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['idslug'] == null) {
+            throw new runtime.RequiredError(
+                'idslug',
+                'Required parameter "idslug" was null or undefined when calling seriesListTournaments().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("apiKey", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/series/{idslug}/tournaments`;
+        urlPath = urlPath.replace('{idslug}', encodeURIComponent(String(requestParameters['idslug'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Tournaments within a series
+     */
+    async seriesListTournamentsRaw(requestParameters: SeriesListTournamentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TournamentsListResponse>> {
+        const requestOptions = await this.seriesListTournamentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TournamentsListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Tournaments within a series
+     */
+    async seriesListTournaments(requestParameters: SeriesListTournamentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TournamentsListResponse> {
+        const response = await this.seriesListTournamentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const SeriesListMatchesStatusEnum = {
+    Scheduled: 'scheduled',
+    Live: 'live',
+    Completed: 'completed',
+    Cancelled: 'cancelled',
+    Postponed: 'postponed'
+} as const;
+export type SeriesListMatchesStatusEnum = typeof SeriesListMatchesStatusEnum[keyof typeof SeriesListMatchesStatusEnum];