@victorycode/sdk 0.0.0-stage → 1.0.0

package/src/apis/PlaysEventsApi.ts

@@ -0,0 +1,399 @@
+/* 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 ListGameAllPlaysResponseDto,
+    ListGameAllPlaysResponseDtoFromJSON,
+} from '../models/ListGameAllPlaysResponseDto';
+import {
+    type ListPlayClipsResponseDto,
+    ListPlayClipsResponseDtoFromJSON,
+} from '../models/ListPlayClipsResponseDto';
+import {
+    type PlayClipListItemDto,
+    PlayClipListItemDtoFromJSON,
+} from '../models/PlayClipListItemDto';
+
+export interface GetPlayByIdRequest {
+    /**
+     * 
+     */
+    playId: string;
+}
+
+export interface GetPlaysOfGameRequest {
+    /**
+     * 
+     */
+    gameId: string;
+    /**
+     * The number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * The number of results to skip for pagination.
+     */
+    offset?: number;
+    /**
+     * 
+     */
+    search?: string;
+    /**
+     * Filter by down number
+     */
+    down?: GetPlaysOfGameDownEnum;
+    /**
+     * Filter by distance zone (yards to go)
+     */
+    distanceZone?: GetPlaysOfGameDistanceZoneEnum;
+    /**
+     * Filter by analyzed play type
+     */
+    playType?: GetPlaysOfGamePlayTypeEnum;
+}
+
+export interface GetPlaysOfVideoRequest {
+    /**
+     * 
+     */
+    videoId: string;
+    /**
+     * The number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * The number of results to skip for pagination.
+     */
+    offset?: number;
+    /**
+     * 
+     */
+    search?: string;
+    /**
+     * Filter by down number
+     */
+    down?: GetPlaysOfVideoDownEnum;
+    /**
+     * Filter by distance zone (yards to go)
+     */
+    distanceZone?: GetPlaysOfVideoDistanceZoneEnum;
+    /**
+     * Filter by analyzed play type
+     */
+    playType?: GetPlaysOfVideoPlayTypeEnum;
+}
+
+/**
+ * 
+ */
+export class PlaysEventsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getPlayById without sending the request
+     */
+    async getPlayByIdRequestOpts(requestParameters: GetPlayByIdRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['playId'] == null) {
+            throw new runtime.RequiredError(
+                'playId',
+                'Required parameter "playId" was null or undefined when calling getPlayById().'
+            );
+        }
+
+        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/plays/{playId}`;
+        urlPath = urlPath.replace('{playId}', encodeURIComponent(String(requestParameters['playId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves the complete metadata for a single play clip by its unique ID.
+     * Get the single Play Clip
+     */
+    async getPlayByIdRaw(requestParameters: GetPlayByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlayClipListItemDto>> {
+        const requestOptions = await this.getPlayByIdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PlayClipListItemDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the complete metadata for a single play clip by its unique ID.
+     * Get the single Play Clip
+     */
+    async getPlayById(requestParameters: GetPlayByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlayClipListItemDto> {
+        const response = await this.getPlayByIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getPlaysOfGame without sending the request
+     */
+    async getPlaysOfGameRequestOpts(requestParameters: GetPlaysOfGameRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['gameId'] == null) {
+            throw new runtime.RequiredError(
+                'gameId',
+                'Required parameter "gameId" was null or undefined when calling getPlaysOfGame().'
+            );
+        }
+
+        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'];
+        }
+
+        if (requestParameters['down'] != null) {
+            queryParameters['down'] = requestParameters['down'];
+        }
+
+        if (requestParameters['distanceZone'] != null) {
+            queryParameters['distanceZone'] = requestParameters['distanceZone'];
+        }
+
+        if (requestParameters['playType'] != null) {
+            queryParameters['playType'] = requestParameters['playType'];
+        }
+
+        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/{gameId}/plays`;
+        urlPath = urlPath.replace('{gameId}', encodeURIComponent(String(requestParameters['gameId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves a paginated list of all plays for a given game. The results can be filtered by various play attributes.
+     * Get a list of all plays for a game
+     */
+    async getPlaysOfGameRaw(requestParameters: GetPlaysOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListGameAllPlaysResponseDto>> {
+        const requestOptions = await this.getPlaysOfGameRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListGameAllPlaysResponseDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a paginated list of all plays for a given game. The results can be filtered by various play attributes.
+     * Get a list of all plays for a game
+     */
+    async getPlaysOfGame(requestParameters: GetPlaysOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListGameAllPlaysResponseDto> {
+        const response = await this.getPlaysOfGameRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getPlaysOfVideo without sending the request
+     */
+    async getPlaysOfVideoRequestOpts(requestParameters: GetPlaysOfVideoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['videoId'] == null) {
+            throw new runtime.RequiredError(
+                'videoId',
+                'Required parameter "videoId" was null or undefined when calling getPlaysOfVideo().'
+            );
+        }
+
+        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'];
+        }
+
+        if (requestParameters['down'] != null) {
+            queryParameters['down'] = requestParameters['down'];
+        }
+
+        if (requestParameters['distanceZone'] != null) {
+            queryParameters['distanceZone'] = requestParameters['distanceZone'];
+        }
+
+        if (requestParameters['playType'] != null) {
+            queryParameters['playType'] = requestParameters['playType'];
+        }
+
+        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/videos/{videoId}/plays`;
+        urlPath = urlPath.replace('{videoId}', encodeURIComponent(String(requestParameters['videoId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieves a paginated list of all play clips for a given video. The results can be filtered by various play attributes.
+     * Get a list of play clips for a video
+     */
+    async getPlaysOfVideoRaw(requestParameters: GetPlaysOfVideoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPlayClipsResponseDto>> {
+        const requestOptions = await this.getPlaysOfVideoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListPlayClipsResponseDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a paginated list of all play clips for a given video. The results can be filtered by various play attributes.
+     * Get a list of play clips for a video
+     */
+    async getPlaysOfVideo(requestParameters: GetPlaysOfVideoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPlayClipsResponseDto> {
+        const response = await this.getPlaysOfVideoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetPlaysOfGameDownEnum = {
+    _1: '1',
+    _2: '2',
+    _3: '3',
+    _4: '4',
+} as const;
+export type GetPlaysOfGameDownEnum = typeof GetPlaysOfGameDownEnum[keyof typeof GetPlaysOfGameDownEnum];
+/**
+ * @export
+ */
+export const GetPlaysOfGameDistanceZoneEnum = {
+    Short: 'SHORT',
+    Medium: 'MEDIUM',
+    Long: 'LONG',
+    XLong: 'X_LONG',
+} as const;
+export type GetPlaysOfGameDistanceZoneEnum = typeof GetPlaysOfGameDistanceZoneEnum[keyof typeof GetPlaysOfGameDistanceZoneEnum];
+/**
+ * @export
+ */
+export const GetPlaysOfGamePlayTypeEnum = {
+    Run: 'RUN',
+    Pass: 'PASS',
+    FieldGoal: 'FIELD_GOAL',
+    Kickoff: 'KICKOFF',
+    Punt: 'PUNT',
+    ExtraPoint: 'EXTRA_POINT',
+    TwoPointConversion: 'TWO_POINT_CONVERSION',
+    NoPlay: 'NO_PLAY',
+    Unidentifiable: 'UNIDENTIFIABLE',
+} as const;
+export type GetPlaysOfGamePlayTypeEnum = typeof GetPlaysOfGamePlayTypeEnum[keyof typeof GetPlaysOfGamePlayTypeEnum];
+/**
+ * @export
+ */
+export const GetPlaysOfVideoDownEnum = {
+    _1: '1',
+    _2: '2',
+    _3: '3',
+    _4: '4',
+} as const;
+export type GetPlaysOfVideoDownEnum = typeof GetPlaysOfVideoDownEnum[keyof typeof GetPlaysOfVideoDownEnum];
+/**
+ * @export
+ */
+export const GetPlaysOfVideoDistanceZoneEnum = {
+    Short: 'SHORT',
+    Medium: 'MEDIUM',
+    Long: 'LONG',
+    XLong: 'X_LONG',
+} as const;
+export type GetPlaysOfVideoDistanceZoneEnum = typeof GetPlaysOfVideoDistanceZoneEnum[keyof typeof GetPlaysOfVideoDistanceZoneEnum];
+/**
+ * @export
+ */
+export const GetPlaysOfVideoPlayTypeEnum = {
+    Run: 'RUN',
+    Pass: 'PASS',
+    FieldGoal: 'FIELD_GOAL',
+    Kickoff: 'KICKOFF',
+    Punt: 'PUNT',
+    ExtraPoint: 'EXTRA_POINT',
+    TwoPointConversion: 'TWO_POINT_CONVERSION',
+    NoPlay: 'NO_PLAY',
+    Unidentifiable: 'UNIDENTIFIABLE',
+} as const;
+export type GetPlaysOfVideoPlayTypeEnum = typeof GetPlaysOfVideoPlayTypeEnum[keyof typeof GetPlaysOfVideoPlayTypeEnum];