@victorycode/sdk 0.0.0-stage → 1.0.0

package/dist/esm/apis/MascotApi.js

@@ -0,0 +1,248 @@
+/* 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 { CreateMascotDtoToJSON, } from '../models/CreateMascotDto';
+import { DeleteResponseDtoFromJSON, } from '../models/DeleteResponseDto';
+import { ListMascotPaginatedResponseDtoFromJSON, } from '../models/ListMascotPaginatedResponseDto';
+import { SingleMascotResponseDtoFromJSON, } from '../models/SingleMascotResponseDto';
+import { UpdateMascotDtoToJSON, } from '../models/UpdateMascotDto';
+/**
+ *
+ */
+export class MascotApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createMascot without sending the request
+     */
+    createMascotRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createMascotDto'] == null) {
+                throw new runtime.RequiredError('createMascotDto', 'Required parameter "createMascotDto" was null or undefined when calling createMascot().');
+            }
+            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/mascots`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateMascotDtoToJSON(requestParameters['createMascotDto']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createMascotRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SingleMascotResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createMascotRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteMascot without sending the request
+     */
+    deleteMascotRequestOpts(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 deleteMascot().');
+            }
+            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/mascots/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Permanently deletes a mascot record from the system.
+     * Delete a mascot
+     */
+    deleteMascotRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteMascotRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DeleteResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Permanently deletes a mascot record from the system.
+     * Delete a mascot
+     */
+    deleteMascot(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteMascotRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getMascots without sending the request
+     */
+    getMascotsRequestOpts(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/mascots`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Retrieves a paginated list of all mascots. Supports searching by name and pagination through query parameters.
+     * Get all mascots
+     */
+    getMascotsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getMascotsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListMascotPaginatedResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves a paginated list of all mascots. Supports searching by name and pagination through query parameters.
+     * Get all mascots
+     */
+    getMascots() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getMascotsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateMascot without sending the request
+     */
+    updateMascotRequestOpts(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 updateMascot().');
+            }
+            if (requestParameters['updateMascotDto'] == null) {
+                throw new runtime.RequiredError('updateMascotDto', 'Required parameter "updateMascotDto" was null or undefined when calling updateMascot().');
+            }
+            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/mascots/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateMascotDtoToJSON(requestParameters['updateMascotDto']),
+            };
+        });
+    }
+    /**
+     * Updates the details of an existing mascot identified by its ID. Allows updating the name, description, and mascot image.
+     * Update a mascot
+     */
+    updateMascotRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateMascotRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SingleMascotResponseDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates the details of an existing mascot identified by its ID. Allows updating the name, description, and mascot image.
+     * Update a mascot
+     */
+    updateMascot(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateMascotRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/PlaysEventsApi.d.ts

@@ -0,0 +1,198 @@
+/**
+ * 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 } from '../models/ListGameAllPlaysResponseDto';
+import { type ListPlayClipsResponseDto } from '../models/ListPlayClipsResponseDto';
+import { type PlayClipListItemDto } 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 declare class PlaysEventsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getPlayById without sending the request
+     */
+    getPlayByIdRequestOpts(requestParameters: GetPlayByIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the complete metadata for a single play clip by its unique ID.
+     * Get the single Play Clip
+     */
+    getPlayByIdRaw(requestParameters: GetPlayByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlayClipListItemDto>>;
+    /**
+     * Retrieves the complete metadata for a single play clip by its unique ID.
+     * Get the single Play Clip
+     */
+    getPlayById(requestParameters: GetPlayByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlayClipListItemDto>;
+    /**
+     * Creates request options for getPlaysOfGame without sending the request
+     */
+    getPlaysOfGameRequestOpts(requestParameters: GetPlaysOfGameRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getPlaysOfGameRaw(requestParameters: GetPlaysOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListGameAllPlaysResponseDto>>;
+    /**
+     * 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
+     */
+    getPlaysOfGame(requestParameters: GetPlaysOfGameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListGameAllPlaysResponseDto>;
+    /**
+     * Creates request options for getPlaysOfVideo without sending the request
+     */
+    getPlaysOfVideoRequestOpts(requestParameters: GetPlaysOfVideoRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getPlaysOfVideoRaw(requestParameters: GetPlaysOfVideoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPlayClipsResponseDto>>;
+    /**
+     * 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
+     */
+    getPlaysOfVideo(requestParameters: GetPlaysOfVideoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPlayClipsResponseDto>;
+}
+/**
+ * @export
+ */
+export declare const GetPlaysOfGameDownEnum: {
+    readonly _1: "1";
+    readonly _2: "2";
+    readonly _3: "3";
+    readonly _4: "4";
+};
+export type GetPlaysOfGameDownEnum = typeof GetPlaysOfGameDownEnum[keyof typeof GetPlaysOfGameDownEnum];
+/**
+ * @export
+ */
+export declare const GetPlaysOfGameDistanceZoneEnum: {
+    readonly Short: "SHORT";
+    readonly Medium: "MEDIUM";
+    readonly Long: "LONG";
+    readonly XLong: "X_LONG";
+};
+export type GetPlaysOfGameDistanceZoneEnum = typeof GetPlaysOfGameDistanceZoneEnum[keyof typeof GetPlaysOfGameDistanceZoneEnum];
+/**
+ * @export
+ */
+export declare const GetPlaysOfGamePlayTypeEnum: {
+    readonly Run: "RUN";
+    readonly Pass: "PASS";
+    readonly FieldGoal: "FIELD_GOAL";
+    readonly Kickoff: "KICKOFF";
+    readonly Punt: "PUNT";
+    readonly ExtraPoint: "EXTRA_POINT";
+    readonly TwoPointConversion: "TWO_POINT_CONVERSION";
+    readonly NoPlay: "NO_PLAY";
+    readonly Unidentifiable: "UNIDENTIFIABLE";
+};
+export type GetPlaysOfGamePlayTypeEnum = typeof GetPlaysOfGamePlayTypeEnum[keyof typeof GetPlaysOfGamePlayTypeEnum];
+/**
+ * @export
+ */
+export declare const GetPlaysOfVideoDownEnum: {
+    readonly _1: "1";
+    readonly _2: "2";
+    readonly _3: "3";
+    readonly _4: "4";
+};
+export type GetPlaysOfVideoDownEnum = typeof GetPlaysOfVideoDownEnum[keyof typeof GetPlaysOfVideoDownEnum];
+/**
+ * @export
+ */
+export declare const GetPlaysOfVideoDistanceZoneEnum: {
+    readonly Short: "SHORT";
+    readonly Medium: "MEDIUM";
+    readonly Long: "LONG";
+    readonly XLong: "X_LONG";
+};
+export type GetPlaysOfVideoDistanceZoneEnum = typeof GetPlaysOfVideoDistanceZoneEnum[keyof typeof GetPlaysOfVideoDistanceZoneEnum];
+/**
+ * @export
+ */
+export declare const GetPlaysOfVideoPlayTypeEnum: {
+    readonly Run: "RUN";
+    readonly Pass: "PASS";
+    readonly FieldGoal: "FIELD_GOAL";
+    readonly Kickoff: "KICKOFF";
+    readonly Punt: "PUNT";
+    readonly ExtraPoint: "EXTRA_POINT";
+    readonly TwoPointConversion: "TWO_POINT_CONVERSION";
+    readonly NoPlay: "NO_PLAY";
+    readonly Unidentifiable: "UNIDENTIFIABLE";
+};
+export type GetPlaysOfVideoPlayTypeEnum = typeof GetPlaysOfVideoPlayTypeEnum[keyof typeof GetPlaysOfVideoPlayTypeEnum];