@victorycode/sdk 0.0.0-stage → 1.0.0

package/src/apis/GameRecapApi.ts

@@ -0,0 +1,372 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Victory Code Client API
+ * Client APIs for Tactix partners: authenticate, upload game video, and retrieve games, plays, game recaps and team metadata.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * 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 GameBoxScoreResponseDto,
+    GameBoxScoreResponseDtoFromJSON,
+} from '../models/GameBoxScoreResponseDto';
+import {
+    type GameRecapScoringSummaryProResponse,
+    GameRecapScoringSummaryProResponseFromJSON,
+} from '../models/GameRecapScoringSummaryProResponse';
+import {
+    type GameRecapScoringSummaryResponse,
+    GameRecapScoringSummaryResponseFromJSON,
+} from '../models/GameRecapScoringSummaryResponse';
+import {
+    type GameRecapTeamStatsResponse,
+    GameRecapTeamStatsResponseFromJSON,
+} from '../models/GameRecapTeamStatsResponse';
+import {
+    type GameScoreResponse,
+    GameScoreResponseFromJSON,
+} from '../models/GameScoreResponse';
+
+export interface GetGameRecapGameBoxScoreRequest {
+    /**
+     * 
+     */
+    videoId: string;
+}
+
+export interface GetGameRecapScoreRequest {
+    /**
+     * 
+     */
+    videoId: string;
+}
+
+export interface GetGameRecapScoringSummaryRequest {
+    /**
+     * 
+     */
+    videoId: string;
+}
+
+export interface GetGameRecapScoringSummaryProRequest {
+    /**
+     * 
+     */
+    videoId: string;
+}
+
+export interface GetGameRecapTeamStatsRequest {
+    /**
+     * 
+     */
+    videoId: string;
+}
+
+/**
+ * 
+ */
+export class GameRecapApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getGameRecapGameBoxScore without sending the request
+     */
+    async getGameRecapGameBoxScoreRequestOpts(requestParameters: GetGameRecapGameBoxScoreRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['videoId'] == null) {
+            throw new runtime.RequiredError(
+                'videoId',
+                'Required parameter "videoId" was null or undefined when calling getGameRecapGameBoxScore().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Client-App-Token", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["App-Id"] = await this.configuration.apiKey("App-Id"); // Client-App-Id authentication
+        }
+
+
+        let urlPath = `/api/v1/client/game-recap/{videoId}/game-box-score`;
+        urlPath = urlPath.replace('{videoId}', encodeURIComponent(String(requestParameters['videoId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves full game box score stats for both teams and players for a specific game.
+     * Get the Game Recap Game Box Score for a specific Game.
+     */
+    async getGameRecapGameBoxScoreRaw(requestParameters: GetGameRecapGameBoxScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameBoxScoreResponseDto>> {
+        const requestOptions = await this.getGameRecapGameBoxScoreRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GameBoxScoreResponseDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves full game box score stats for both teams and players for a specific game.
+     * Get the Game Recap Game Box Score for a specific Game.
+     */
+    async getGameRecapGameBoxScore(requestParameters: GetGameRecapGameBoxScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameBoxScoreResponseDto> {
+        const response = await this.getGameRecapGameBoxScoreRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getGameRecapScore without sending the request
+     */
+    async getGameRecapScoreRequestOpts(requestParameters: GetGameRecapScoreRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['videoId'] == null) {
+            throw new runtime.RequiredError(
+                'videoId',
+                'Required parameter "videoId" was null or undefined when calling getGameRecapScore().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Client-App-Token", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["App-Id"] = await this.configuration.apiKey("App-Id"); // Client-App-Id authentication
+        }
+
+
+        let urlPath = `/api/v1/client/game-recap/{videoId}/score`;
+        urlPath = urlPath.replace('{videoId}', encodeURIComponent(String(requestParameters['videoId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves the final score and the score breakdown by quarter and overtime periods for both the home and away teams.
+     * Get the Game Recap Score for a specific Game.
+     */
+    async getGameRecapScoreRaw(requestParameters: GetGameRecapScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameScoreResponse>> {
+        const requestOptions = await this.getGameRecapScoreRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GameScoreResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the final score and the score breakdown by quarter and overtime periods for both the home and away teams.
+     * Get the Game Recap Score for a specific Game.
+     */
+    async getGameRecapScore(requestParameters: GetGameRecapScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameScoreResponse> {
+        const response = await this.getGameRecapScoreRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getGameRecapScoringSummary without sending the request
+     */
+    async getGameRecapScoringSummaryRequestOpts(requestParameters: GetGameRecapScoringSummaryRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['videoId'] == null) {
+            throw new runtime.RequiredError(
+                'videoId',
+                'Required parameter "videoId" was null or undefined when calling getGameRecapScoringSummary().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Client-App-Token", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["App-Id"] = await this.configuration.apiKey("App-Id"); // Client-App-Id authentication
+        }
+
+
+        let urlPath = `/api/v1/client/game-recap/{videoId}/scoring-summary`;
+        urlPath = urlPath.replace('{videoId}', encodeURIComponent(String(requestParameters['videoId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves a chronological list of all scoring plays for a specific game, including details about the play, the drive, and the resulting score.
+     * Get the Game Recap Scoring Summary for a specific Game.
+     */
+    async getGameRecapScoringSummaryRaw(requestParameters: GetGameRecapScoringSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameRecapScoringSummaryResponse>> {
+        const requestOptions = await this.getGameRecapScoringSummaryRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GameRecapScoringSummaryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a chronological list of all scoring plays for a specific game, including details about the play, the drive, and the resulting score.
+     * Get the Game Recap Scoring Summary for a specific Game.
+     */
+    async getGameRecapScoringSummary(requestParameters: GetGameRecapScoringSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameRecapScoringSummaryResponse> {
+        const response = await this.getGameRecapScoringSummaryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getGameRecapScoringSummaryPro without sending the request
+     */
+    async getGameRecapScoringSummaryProRequestOpts(requestParameters: GetGameRecapScoringSummaryProRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['videoId'] == null) {
+            throw new runtime.RequiredError(
+                'videoId',
+                'Required parameter "videoId" was null or undefined when calling getGameRecapScoringSummaryPro().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Client-App-Token", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["App-Id"] = await this.configuration.apiKey("App-Id"); // Client-App-Id authentication
+        }
+
+
+        let urlPath = `/api/v1/client/game-recap/{videoId}/scoring-summary-pro`;
+        urlPath = urlPath.replace('{videoId}', encodeURIComponent(String(requestParameters['videoId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves the full pro scoring summary for a specific game with drive context and players involved for each scoring play.
+     * Get the Game Recap Scoring Summary Pro for a specific Game.
+     */
+    async getGameRecapScoringSummaryProRaw(requestParameters: GetGameRecapScoringSummaryProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameRecapScoringSummaryProResponse>> {
+        const requestOptions = await this.getGameRecapScoringSummaryProRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GameRecapScoringSummaryProResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the full pro scoring summary for a specific game with drive context and players involved for each scoring play.
+     * Get the Game Recap Scoring Summary Pro for a specific Game.
+     */
+    async getGameRecapScoringSummaryPro(requestParameters: GetGameRecapScoringSummaryProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameRecapScoringSummaryProResponse> {
+        const response = await this.getGameRecapScoringSummaryProRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getGameRecapTeamStats without sending the request
+     */
+    async getGameRecapTeamStatsRequestOpts(requestParameters: GetGameRecapTeamStatsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['videoId'] == null) {
+            throw new runtime.RequiredError(
+                'videoId',
+                'Required parameter "videoId" was null or undefined when calling getGameRecapTeamStats().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Client-App-Token", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["App-Id"] = await this.configuration.apiKey("App-Id"); // Client-App-Id authentication
+        }
+
+
+        let urlPath = `/api/v1/client/game-recap/{videoId}/team-stats`;
+        urlPath = urlPath.replace('{videoId}', encodeURIComponent(String(requestParameters['videoId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves a detailed statistical breakdown for both the home and away teams, covering offense, defense, and special teams performance.
+     * Get the Game Recap Team Stats for a specific Game.
+     */
+    async getGameRecapTeamStatsRaw(requestParameters: GetGameRecapTeamStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameRecapTeamStatsResponse>> {
+        const requestOptions = await this.getGameRecapTeamStatsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GameRecapTeamStatsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a detailed statistical breakdown for both the home and away teams, covering offense, defense, and special teams performance.
+     * Get the Game Recap Team Stats for a specific Game.
+     */
+    async getGameRecapTeamStats(requestParameters: GetGameRecapTeamStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameRecapTeamStatsResponse> {
+        const response = await this.getGameRecapTeamStatsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}