@victorycode/sdk 0.0.0-stage → 1.0.0

package/dist/apis/GameRecapApi.js

@@ -0,0 +1,292 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GameRecapApi = void 0;
+const runtime = require("../runtime");
+const GameBoxScoreResponseDto_1 = require("../models/GameBoxScoreResponseDto");
+const GameRecapScoringSummaryProResponse_1 = require("../models/GameRecapScoringSummaryProResponse");
+const GameRecapScoringSummaryResponse_1 = require("../models/GameRecapScoringSummaryResponse");
+const GameRecapTeamStatsResponse_1 = require("../models/GameRecapTeamStatsResponse");
+const GameScoreResponse_1 = require("../models/GameScoreResponse");
+/**
+ *
+ */
+class GameRecapApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getGameRecapGameBoxScore without sending the request
+     */
+    getGameRecapGameBoxScoreRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['videoId'] == null) {
+                throw new runtime.RequiredError('videoId', 'Required parameter "videoId" was null or undefined when calling getGameRecapGameBoxScore().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("Client-App-Token", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["App-Id"] = yield 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.
+     */
+    getGameRecapGameBoxScoreRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGameRecapGameBoxScoreRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GameBoxScoreResponseDto_1.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.
+     */
+    getGameRecapGameBoxScore(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getGameRecapGameBoxScoreRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getGameRecapScore without sending the request
+     */
+    getGameRecapScoreRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['videoId'] == null) {
+                throw new runtime.RequiredError('videoId', 'Required parameter "videoId" was null or undefined when calling getGameRecapScore().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("Client-App-Token", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["App-Id"] = yield 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.
+     */
+    getGameRecapScoreRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGameRecapScoreRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GameScoreResponse_1.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.
+     */
+    getGameRecapScore(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getGameRecapScoreRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getGameRecapScoringSummary without sending the request
+     */
+    getGameRecapScoringSummaryRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['videoId'] == null) {
+                throw new runtime.RequiredError('videoId', 'Required parameter "videoId" was null or undefined when calling getGameRecapScoringSummary().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("Client-App-Token", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["App-Id"] = yield 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.
+     */
+    getGameRecapScoringSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGameRecapScoringSummaryRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GameRecapScoringSummaryResponse_1.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.
+     */
+    getGameRecapScoringSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getGameRecapScoringSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getGameRecapScoringSummaryPro without sending the request
+     */
+    getGameRecapScoringSummaryProRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['videoId'] == null) {
+                throw new runtime.RequiredError('videoId', 'Required parameter "videoId" was null or undefined when calling getGameRecapScoringSummaryPro().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("Client-App-Token", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["App-Id"] = yield 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.
+     */
+    getGameRecapScoringSummaryProRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGameRecapScoringSummaryProRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GameRecapScoringSummaryProResponse_1.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.
+     */
+    getGameRecapScoringSummaryPro(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getGameRecapScoringSummaryProRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getGameRecapTeamStats without sending the request
+     */
+    getGameRecapTeamStatsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['videoId'] == null) {
+                throw new runtime.RequiredError('videoId', 'Required parameter "videoId" was null or undefined when calling getGameRecapTeamStats().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("Client-App-Token", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["App-Id"] = yield 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.
+     */
+    getGameRecapTeamStatsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGameRecapTeamStatsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GameRecapTeamStatsResponse_1.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.
+     */
+    getGameRecapTeamStats(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getGameRecapTeamStatsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.GameRecapApi = GameRecapApi;

package/dist/apis/GamesApi.d.ts

@@ -0,0 +1,143 @@
+/**
+ * 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 AddVideoToGameWithS3LinkDto } from '../models/AddVideoToGameWithS3LinkDto';
+import { type ClientCreateGameWithVideoUrlDto } from '../models/ClientCreateGameWithVideoUrlDto';
+import { type GameDetailsResponse } from '../models/GameDetailsResponse';
+import { type ListGamesPaginatedResponseDto } from '../models/ListGamesPaginatedResponseDto';
+import { type ListVideoPaginatedResponseDto } from '../models/ListVideoPaginatedResponseDto';
+import { type SingleVideoResponseDto } from '../models/SingleVideoResponseDto';
+export interface AddVideoToGameRequest {
+    /**
+     *
+     */
+    gameId: string;
+    /**
+     *
+     */
+    addVideoToGameWithS3LinkDto: AddVideoToGameWithS3LinkDto;
+}
+export interface CreateGameWithVideoUrlRequest {
+    /**
+     *
+     */
+    clientCreateGameWithVideoUrlDto: ClientCreateGameWithVideoUrlDto;
+}
+export interface GetGameDetailsRequest {
+    /**
+     *
+     */
+    gameId: string;
+}
+export interface GetGamesRequest {
+    /**
+     * The number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * The number of results to skip for pagination.
+     */
+    offset?: number;
+    /**
+     *
+     */
+    search?: string;
+}
+export interface GetVideosOfGameRequest {
+    /**
+     *
+     */
+    gameId: string;
+    /**
+     * The number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * The number of results to skip for pagination.
+     */
+    offset?: number;
+}
+/**
+ *
+ */
+export declare class GamesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for addVideoToGame without sending the request
+     */
+    addVideoToGameRequestOpts(requestParameters: AddVideoToGameRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Adds a new video to game.
+     * Add new video to a game
+     */
+    addVideoToGameRaw(requestParameters: AddVideoToGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SingleVideoResponseDto>>;
+    /**
+     * Adds a new video to game.
+     * Add new video to a game
+     */
+    addVideoToGame(requestParameters: AddVideoToGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SingleVideoResponseDto>;
+    /**
+     * Creates request options for createGameWithVideoUrl without sending the request
+     */
+    createGameWithVideoUrlRequestOpts(requestParameters: CreateGameWithVideoUrlRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Registers a new game and associates a video URL (e.g., from a third-party source) with it in a single step.
+     * Create a new Game with Video URL
+     */
+    createGameWithVideoUrlRaw(requestParameters: CreateGameWithVideoUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameDetailsResponse>>;
+    /**
+     * Registers a new game and associates a video URL (e.g., from a third-party source) with it in a single step.
+     * Create a new Game with Video URL
+     */
+    createGameWithVideoUrl(requestParameters: CreateGameWithVideoUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameDetailsResponse>;
+    /**
+     * Creates request options for getGameDetails without sending the request
+     */
+    getGameDetailsRequestOpts(requestParameters: GetGameDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the core metadata for a single game, including date, time, location, and teams who participated.
+     * Get a Single Game.
+     */
+    getGameDetailsRaw(requestParameters: GetGameDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameDetailsResponse>>;
+    /**
+     * Retrieves the core metadata for a single game, including date, time, location, and teams who participated.
+     * Get a Single Game.
+     */
+    getGameDetails(requestParameters: GetGameDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameDetailsResponse>;
+    /**
+     * Creates request options for getGames without sending the request
+     */
+    getGamesRequestOpts(requestParameters: GetGamesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a paginated list of games, with optional filters for team, upload status, and date-time range.
+     * List and Filter Games.
+     */
+    getGamesRaw(requestParameters: GetGamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListGamesPaginatedResponseDto>>;
+    /**
+     * Retrieves a paginated list of games, with optional filters for team, upload status, and date-time range.
+     * List and Filter Games.
+     */
+    getGames(requestParameters?: GetGamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListGamesPaginatedResponseDto>;
+    /**
+     * Creates request options for getVideosOfGame without sending the request
+     */
+    getVideosOfGameRequestOpts(requestParameters: GetVideosOfGameRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a list of videos of a game.
+     * Get a list of videos of a game
+     */
+    getVideosOfGameRaw(requestParameters: GetVideosOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVideoPaginatedResponseDto>>;
+    /**
+     * Retrieves a list of videos of a game.
+     * Get a list of videos of a game
+     */
+    getVideosOfGame(requestParameters: GetVideosOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVideoPaginatedResponseDto>;
+}