@victorycode/sdk 0.0.0-stage → 1.0.0

package/dist/apis/ClassificationApi.d.ts

@@ -0,0 +1,114 @@
+/**
+ * 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 CreateClassificationDto } from '../models/CreateClassificationDto';
+import { type DeleteResponseDto } from '../models/DeleteResponseDto';
+import { type ListClassificationPaginatedResponseDto } from '../models/ListClassificationPaginatedResponseDto';
+import { type SingleClassificationResponseDto } from '../models/SingleClassificationResponseDto';
+import { type UpdateClassificationDto } from '../models/UpdateClassificationDto';
+export interface CreateClassificationRequest {
+    /**
+     *
+     */
+    createClassificationDto: CreateClassificationDto;
+}
+export interface DeleteClassificationRequest {
+    /**
+     *
+     */
+    id: string;
+}
+export interface GetClassificationsRequest {
+    /**
+     *
+     */
+    limit?: number;
+    /**
+     *
+     */
+    page?: number;
+    /**
+     *
+     */
+    search?: string;
+}
+export interface UpdateClassificationRequest {
+    /**
+     *
+     */
+    id: string;
+    /**
+     *
+     */
+    updateClassificationDto: UpdateClassificationDto;
+}
+/**
+ *
+ */
+export declare class ClassificationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createClassification without sending the request
+     */
+    createClassificationRequestOpts(requestParameters: CreateClassificationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new classification entry for categorizing teams.
+     * Create a new classification
+     */
+    createClassificationRaw(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SingleClassificationResponseDto>>;
+    /**
+     * Creates a new classification entry for categorizing teams.
+     * Create a new classification
+     */
+    createClassification(requestParameters: CreateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SingleClassificationResponseDto>;
+    /**
+     * Creates request options for deleteClassification without sending the request
+     */
+    deleteClassificationRequestOpts(requestParameters: DeleteClassificationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Permanently deletes a team classification from the system.
+     * Delete a classification
+     */
+    deleteClassificationRaw(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteResponseDto>>;
+    /**
+     * Permanently deletes a team classification from the system.
+     * Delete a classification
+     */
+    deleteClassification(requestParameters: DeleteClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteResponseDto>;
+    /**
+     * Creates request options for getClassifications without sending the request
+     */
+    getClassificationsRequestOpts(requestParameters: GetClassificationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a paginated list of all team classifications available in the system.
+     * Get all classifications
+     */
+    getClassificationsRaw(requestParameters: GetClassificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListClassificationPaginatedResponseDto>>;
+    /**
+     * Retrieves a paginated list of all team classifications available in the system.
+     * Get all classifications
+     */
+    getClassifications(requestParameters?: GetClassificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListClassificationPaginatedResponseDto>;
+    /**
+     * Creates request options for updateClassification without sending the request
+     */
+    updateClassificationRequestOpts(requestParameters: UpdateClassificationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing team classification entry identified by its ID.
+     * Update a classification
+     */
+    updateClassificationRaw(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SingleClassificationResponseDto>>;
+    /**
+     * Updates an existing team classification entry identified by its ID.
+     * Update a classification
+     */
+    updateClassification(requestParameters: UpdateClassificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SingleClassificationResponseDto>;
+}

package/dist/apis/ClassificationApi.js

@@ -0,0 +1,252 @@
+"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.ClassificationApi = void 0;
+const runtime = require("../runtime");
+const CreateClassificationDto_1 = require("../models/CreateClassificationDto");
+const DeleteResponseDto_1 = require("../models/DeleteResponseDto");
+const ListClassificationPaginatedResponseDto_1 = require("../models/ListClassificationPaginatedResponseDto");
+const SingleClassificationResponseDto_1 = require("../models/SingleClassificationResponseDto");
+const UpdateClassificationDto_1 = require("../models/UpdateClassificationDto");
+/**
+ *
+ */
+class ClassificationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createClassification without sending the request
+     */
+    createClassificationRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createClassificationDto'] == null) {
+                throw new runtime.RequiredError('createClassificationDto', 'Required parameter "createClassificationDto" was null or undefined when calling createClassification().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/classifications`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, CreateClassificationDto_1.CreateClassificationDtoToJSON)(requestParameters['createClassificationDto']),
+            };
+        });
+    }
+    /**
+     * Creates a new classification entry for categorizing teams.
+     * Create a new classification
+     */
+    createClassificationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createClassificationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, SingleClassificationResponseDto_1.SingleClassificationResponseDtoFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a new classification entry for categorizing teams.
+     * Create a new classification
+     */
+    createClassification(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createClassificationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteClassification without sending the request
+     */
+    deleteClassificationRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteClassification().');
+            }
+            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/classifications/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Permanently deletes a team classification from the system.
+     * Delete a classification
+     */
+    deleteClassificationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteClassificationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeleteResponseDto_1.DeleteResponseDtoFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Permanently deletes a team classification from the system.
+     * Delete a classification
+     */
+    deleteClassification(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteClassificationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getClassifications without sending the request
+     */
+    getClassificationsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['search'] != null) {
+                queryParameters['search'] = requestParameters['search'];
+            }
+            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/classifications`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Retrieves a paginated list of all team classifications available in the system.
+     * Get all classifications
+     */
+    getClassificationsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getClassificationsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListClassificationPaginatedResponseDto_1.ListClassificationPaginatedResponseDtoFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Retrieves a paginated list of all team classifications available in the system.
+     * Get all classifications
+     */
+    getClassifications() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getClassificationsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateClassification without sending the request
+     */
+    updateClassificationRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateClassification().');
+            }
+            if (requestParameters['updateClassificationDto'] == null) {
+                throw new runtime.RequiredError('updateClassificationDto', 'Required parameter "updateClassificationDto" was null or undefined when calling updateClassification().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/classifications/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, UpdateClassificationDto_1.UpdateClassificationDtoToJSON)(requestParameters['updateClassificationDto']),
+            };
+        });
+    }
+    /**
+     * Updates an existing team classification entry identified by its ID.
+     * Update a classification
+     */
+    updateClassificationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateClassificationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, SingleClassificationResponseDto_1.SingleClassificationResponseDtoFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Updates an existing team classification entry identified by its ID.
+     * Update a classification
+     */
+    updateClassification(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateClassificationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.ClassificationApi = ClassificationApi;

package/dist/apis/GameRecapApi.d.ts

@@ -0,0 +1,122 @@
+/**
+ * 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 } from '../models/GameBoxScoreResponseDto';
+import { type GameRecapScoringSummaryProResponse } from '../models/GameRecapScoringSummaryProResponse';
+import { type GameRecapScoringSummaryResponse } from '../models/GameRecapScoringSummaryResponse';
+import { type GameRecapTeamStatsResponse } from '../models/GameRecapTeamStatsResponse';
+import { type GameScoreResponse } 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 declare class GameRecapApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getGameRecapGameBoxScore without sending the request
+     */
+    getGameRecapGameBoxScoreRequestOpts(requestParameters: GetGameRecapGameBoxScoreRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: GetGameRecapGameBoxScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameBoxScoreResponseDto>>;
+    /**
+     * 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: GetGameRecapGameBoxScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameBoxScoreResponseDto>;
+    /**
+     * Creates request options for getGameRecapScore without sending the request
+     */
+    getGameRecapScoreRequestOpts(requestParameters: GetGameRecapScoreRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: GetGameRecapScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameScoreResponse>>;
+    /**
+     * 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: GetGameRecapScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameScoreResponse>;
+    /**
+     * Creates request options for getGameRecapScoringSummary without sending the request
+     */
+    getGameRecapScoringSummaryRequestOpts(requestParameters: GetGameRecapScoringSummaryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: GetGameRecapScoringSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameRecapScoringSummaryResponse>>;
+    /**
+     * 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: GetGameRecapScoringSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameRecapScoringSummaryResponse>;
+    /**
+     * Creates request options for getGameRecapScoringSummaryPro without sending the request
+     */
+    getGameRecapScoringSummaryProRequestOpts(requestParameters: GetGameRecapScoringSummaryProRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: GetGameRecapScoringSummaryProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameRecapScoringSummaryProResponse>>;
+    /**
+     * 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: GetGameRecapScoringSummaryProRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameRecapScoringSummaryProResponse>;
+    /**
+     * Creates request options for getGameRecapTeamStats without sending the request
+     */
+    getGameRecapTeamStatsRequestOpts(requestParameters: GetGameRecapTeamStatsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: GetGameRecapTeamStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameRecapTeamStatsResponse>>;
+    /**
+     * 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: GetGameRecapTeamStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameRecapTeamStatsResponse>;
+}