@victorycode/sdk 0.0.0-stage → 1.0.0

package/src/apis/GamesApi.ts

@@ -0,0 +1,420 @@
+/* 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 AddVideoToGameWithS3LinkDto,
+    AddVideoToGameWithS3LinkDtoToJSON,
+} from '../models/AddVideoToGameWithS3LinkDto';
+import {
+    type ClientCreateGameWithVideoUrlDto,
+    ClientCreateGameWithVideoUrlDtoToJSON,
+} from '../models/ClientCreateGameWithVideoUrlDto';
+import {
+    type GameDetailsResponse,
+    GameDetailsResponseFromJSON,
+} from '../models/GameDetailsResponse';
+import {
+    type ListGamesPaginatedResponseDto,
+    ListGamesPaginatedResponseDtoFromJSON,
+} from '../models/ListGamesPaginatedResponseDto';
+import {
+    type ListVideoPaginatedResponseDto,
+    ListVideoPaginatedResponseDtoFromJSON,
+} from '../models/ListVideoPaginatedResponseDto';
+import {
+    type SingleVideoResponseDto,
+    SingleVideoResponseDtoFromJSON,
+} 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 class GamesApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for addVideoToGame without sending the request
+     */
+    async addVideoToGameRequestOpts(requestParameters: AddVideoToGameRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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/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
+     */
+    async addVideoToGameRaw(requestParameters: AddVideoToGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SingleVideoResponseDto>> {
+        const requestOptions = await this.addVideoToGameRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SingleVideoResponseDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Adds a new video to game.
+     * Add new video to a game
+     */
+    async addVideoToGame(requestParameters: AddVideoToGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SingleVideoResponseDto> {
+        const response = await this.addVideoToGameRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createGameWithVideoUrl without sending the request
+     */
+    async createGameWithVideoUrlRequestOpts(requestParameters: CreateGameWithVideoUrlRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientCreateGameWithVideoUrlDto'] == null) {
+            throw new runtime.RequiredError(
+                'clientCreateGameWithVideoUrlDto',
+                'Required parameter "clientCreateGameWithVideoUrlDto" was null or undefined when calling createGameWithVideoUrl().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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/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
+     */
+    async createGameWithVideoUrlRaw(requestParameters: CreateGameWithVideoUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameDetailsResponse>> {
+        const requestOptions = await this.createGameWithVideoUrlRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async createGameWithVideoUrl(requestParameters: CreateGameWithVideoUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameDetailsResponse> {
+        const response = await this.createGameWithVideoUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getGameDetails without sending the request
+     */
+    async getGameDetailsRequestOpts(requestParameters: GetGameDetailsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['gameId'] == null) {
+            throw new runtime.RequiredError(
+                'gameId',
+                'Required parameter "gameId" was null or undefined when calling getGameDetails().'
+            );
+        }
+
+        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/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.
+     */
+    async getGameDetailsRaw(requestParameters: GetGameDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GameDetailsResponse>> {
+        const requestOptions = await this.getGameDetailsRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async getGameDetails(requestParameters: GetGameDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GameDetailsResponse> {
+        const response = await this.getGameDetailsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getGames without sending the request
+     */
+    async getGamesRequestOpts(requestParameters: GetGamesRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        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: 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/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.
+     */
+    async getGamesRaw(requestParameters: GetGamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListGamesPaginatedResponseDto>> {
+        const requestOptions = await this.getGamesRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async getGames(requestParameters: GetGamesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListGamesPaginatedResponseDto> {
+        const response = await this.getGamesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getVideosOfGame without sending the request
+     */
+    async getVideosOfGameRequestOpts(requestParameters: GetVideosOfGameRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['gameId'] == null) {
+            throw new runtime.RequiredError(
+                'gameId',
+                'Required parameter "gameId" was null or undefined when calling getVideosOfGame().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        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/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
+     */
+    async getVideosOfGameRaw(requestParameters: GetVideosOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVideoPaginatedResponseDto>> {
+        const requestOptions = await this.getVideosOfGameRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async getVideosOfGame(requestParameters: GetVideosOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVideoPaginatedResponseDto> {
+        const response = await this.getVideosOfGameRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}