@victorycode/sdk 0.0.0-stage → 1.0.0

package/dist/esm/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>;
+}

package/dist/esm/apis/GamesApi.js

@@ -0,0 +1,306 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+import { AddVideoToGameWithS3LinkDtoToJSON, } from '../models/AddVideoToGameWithS3LinkDto';
+import { ClientCreateGameWithVideoUrlDtoToJSON, } from '../models/ClientCreateGameWithVideoUrlDto';
+import { GameDetailsResponseFromJSON, } from '../models/GameDetailsResponse';
+import { ListGamesPaginatedResponseDtoFromJSON, } from '../models/ListGamesPaginatedResponseDto';
+import { ListVideoPaginatedResponseDtoFromJSON, } from '../models/ListVideoPaginatedResponseDto';
+import { SingleVideoResponseDtoFromJSON, } from '../models/SingleVideoResponseDto';
+/**
+ *
+ */
+export class GamesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for addVideoToGame without sending the request
+     */
+    addVideoToGameRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['gameId'] == null) {
+                throw new runtime.RequiredError('gameId', 'Required parameter "gameId" was null or undefined when calling addVideoToGame().');
+            }
+            if (requestParameters['addVideoToGameWithS3LinkDto'] == null) {
+                throw new runtime.RequiredError('addVideoToGameWithS3LinkDto', 'Required parameter "addVideoToGameWithS3LinkDto" was null or undefined when calling addVideoToGame().');
+            }
+            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/games/{gameId}/video`;
+            urlPath = urlPath.replace('{gameId}', encodeURIComponent(String(requestParameters['gameId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AddVideoToGameWithS3LinkDtoToJSON(requestParameters['addVideoToGameWithS3LinkDto']),
+            };
+        });
+    }
+    /**
+     * Adds a new video to game.
+     * Add new video to a game
+     */
+    addVideoToGameRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.addVideoToGameRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SingleVideoResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Adds a new video to game.
+     * Add new video to a game
+     */
+    addVideoToGame(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.addVideoToGameRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for createGameWithVideoUrl without sending the request
+     */
+    createGameWithVideoUrlRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['clientCreateGameWithVideoUrlDto'] == null) {
+                throw new runtime.RequiredError('clientCreateGameWithVideoUrlDto', 'Required parameter "clientCreateGameWithVideoUrlDto" was null or undefined when calling createGameWithVideoUrl().');
+            }
+            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/games`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ClientCreateGameWithVideoUrlDtoToJSON(requestParameters['clientCreateGameWithVideoUrlDto']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createGameWithVideoUrlRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GameDetailsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createGameWithVideoUrlRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getGameDetails without sending the request
+     */
+    getGameDetailsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['gameId'] == null) {
+                throw new runtime.RequiredError('gameId', 'Required parameter "gameId" was null or undefined when calling getGameDetails().');
+            }
+            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/games/{gameId}`;
+            urlPath = urlPath.replace('{gameId}', encodeURIComponent(String(requestParameters['gameId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Retrieves the core metadata for a single game, including date, time, location, and teams who participated.
+     * Get a Single Game.
+     */
+    getGameDetailsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGameDetailsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GameDetailsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves the core metadata for a single game, including date, time, location, and teams who participated.
+     * Get a Single Game.
+     */
+    getGameDetails(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getGameDetailsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getGames without sending the request
+     */
+    getGamesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            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/games`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Retrieves a paginated list of games, with optional filters for team, upload status, and date-time range.
+     * List and Filter Games.
+     */
+    getGamesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getGamesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListGamesPaginatedResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves a paginated list of games, with optional filters for team, upload status, and date-time range.
+     * List and Filter Games.
+     */
+    getGames() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getGamesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getVideosOfGame without sending the request
+     */
+    getVideosOfGameRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['gameId'] == null) {
+                throw new runtime.RequiredError('gameId', 'Required parameter "gameId" was null or undefined when calling getVideosOfGame().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            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/games/{gameId}/videos`;
+            urlPath = urlPath.replace('{gameId}', encodeURIComponent(String(requestParameters['gameId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Retrieves a list of videos of a game.
+     * Get a list of videos of a game
+     */
+    getVideosOfGameRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getVideosOfGameRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListVideoPaginatedResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves a list of videos of a game.
+     * Get a list of videos of a game
+     */
+    getVideosOfGame(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getVideosOfGameRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/MascotApi.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 CreateMascotDto } from '../models/CreateMascotDto';
+import { type DeleteResponseDto } from '../models/DeleteResponseDto';
+import { type ListMascotPaginatedResponseDto } from '../models/ListMascotPaginatedResponseDto';
+import { type SingleMascotResponseDto } from '../models/SingleMascotResponseDto';
+import { type UpdateMascotDto } from '../models/UpdateMascotDto';
+export interface CreateMascotRequest {
+    /**
+     *
+     */
+    createMascotDto: CreateMascotDto;
+}
+export interface DeleteMascotRequest {
+    /**
+     *
+     */
+    id: string;
+}
+export interface GetMascotsRequest {
+    /**
+     *
+     */
+    limit?: number;
+    /**
+     *
+     */
+    page?: number;
+    /**
+     *
+     */
+    search?: string;
+}
+export interface UpdateMascotRequest {
+    /**
+     *
+     */
+    id: string;
+    /**
+     *
+     */
+    updateMascotDto: UpdateMascotDto;
+}
+/**
+ *
+ */
+export declare class MascotApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createMascot without sending the request
+     */
+    createMascotRequestOpts(requestParameters: CreateMascotRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new mascot record with a name and description. An optional mascot image can be uploaded as part of the multipart form data.
+     * Create a new mascot
+     */
+    createMascotRaw(requestParameters: CreateMascotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SingleMascotResponseDto>>;
+    /**
+     * Creates a new mascot record with a name and description. An optional mascot image can be uploaded as part of the multipart form data.
+     * Create a new mascot
+     */
+    createMascot(requestParameters: CreateMascotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SingleMascotResponseDto>;
+    /**
+     * Creates request options for deleteMascot without sending the request
+     */
+    deleteMascotRequestOpts(requestParameters: DeleteMascotRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Permanently deletes a mascot record from the system.
+     * Delete a mascot
+     */
+    deleteMascotRaw(requestParameters: DeleteMascotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteResponseDto>>;
+    /**
+     * Permanently deletes a mascot record from the system.
+     * Delete a mascot
+     */
+    deleteMascot(requestParameters: DeleteMascotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteResponseDto>;
+    /**
+     * Creates request options for getMascots without sending the request
+     */
+    getMascotsRequestOpts(requestParameters: GetMascotsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a paginated list of all mascots. Supports searching by name and pagination through query parameters.
+     * Get all mascots
+     */
+    getMascotsRaw(requestParameters: GetMascotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMascotPaginatedResponseDto>>;
+    /**
+     * Retrieves a paginated list of all mascots. Supports searching by name and pagination through query parameters.
+     * Get all mascots
+     */
+    getMascots(requestParameters?: GetMascotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMascotPaginatedResponseDto>;
+    /**
+     * Creates request options for updateMascot without sending the request
+     */
+    updateMascotRequestOpts(requestParameters: UpdateMascotRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates the details of an existing mascot identified by its ID. Allows updating the name, description, and mascot image.
+     * Update a mascot
+     */
+    updateMascotRaw(requestParameters: UpdateMascotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SingleMascotResponseDto>>;
+    /**
+     * Updates the details of an existing mascot identified by its ID. Allows updating the name, description, and mascot image.
+     * Update a mascot
+     */
+    updateMascot(requestParameters: UpdateMascotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SingleMascotResponseDto>;
+}