@footballbingo/client 1.0.0

package/dist/services/CommunityTacticsBoardsService.d.ts

@@ -0,0 +1,230 @@
+import type { ApiResponseDTO } from '../models/ApiResponseDTO';
+import type { TacticsBoardDTO } from '../models/TacticsBoardDTO';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+export declare class CommunityTacticsBoardsService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Create a new tactics board
+     * Create a tactics board with formations for two teams and tactical drawings. Works for both authenticated and anonymous users. Anonymous boards can later be claimed.
+     * @param requestBody
+     * @returns any Tactics board created successfully
+     * @throws ApiError
+     */
+    postApiV1CommunityTacticsBoards(requestBody: {
+        /**
+         * Title of the tactics board
+         */
+        title: string;
+        /**
+         * Optional description
+         */
+        description?: string;
+        /**
+         * Formation for Team A
+         */
+        formationTeamA: string;
+        /**
+         * Formation for Team B
+         */
+        formationTeamB: string;
+        /**
+         * Tactical drawings and annotations
+         */
+        boardData: Record<string, any>;
+        /**
+         * Whether the board is publicly visible
+         */
+        isPublic?: boolean;
+        /**
+         * Board mode (generic or team-specific)
+         */
+        boardMode?: 'generic' | 'team';
+        /**
+         * Team A ID (for team mode)
+         */
+        teamAId?: number;
+        /**
+         * Team B ID (for team mode)
+         */
+        teamBId?: number;
+        /**
+         * Team A name
+         */
+        teamAName?: string;
+        /**
+         * Team B name
+         */
+        teamBName?: string;
+        /**
+         * Team A logo URL
+         */
+        teamALogo?: string;
+        /**
+         * Team B logo URL
+         */
+        teamBLogo?: string;
+        /**
+         * Related fixture ID
+         */
+        fixtureId?: number;
+    }): CancelablePromise<(ApiResponseDTO & {
+        data?: TacticsBoardDTO;
+    })>;
+    /**
+     * Get user's tactics boards
+     * Retrieve all tactics boards created by the authenticated user with pagination and sorting
+     * @param limit Number of boards to return
+     * @param offset Number of boards to skip
+     * @param sortBy Field to sort by
+     * @param sortOrder Sort order
+     * @returns any User's tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoards(limit?: number, offset?: number, sortBy?: 'createdAt' | 'updatedAt' | 'viewCount', sortOrder?: 'asc' | 'desc'): CancelablePromise<{
+        success?: boolean;
+        data?: {
+            boards?: Array<TacticsBoardDTO>;
+            total?: number;
+            limit?: number;
+            offset?: number;
+        };
+    }>;
+    /**
+     * Get tactics board by ID
+     * Retrieve a specific tactics board by its ID. Returns public boards or boards owned by the authenticated user.
+     * @param id Tactics board ID
+     * @returns any Tactics board retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoards1(id: string): CancelablePromise<(ApiResponseDTO & {
+        data?: TacticsBoardDTO;
+    })>;
+    /**
+     * Update tactics board
+     * Update an existing tactics board. Only the owner can update their board.
+     * @param id Tactics board ID
+     * @param requestBody
+     * @returns any Tactics board updated successfully
+     * @throws ApiError
+     */
+    putApiV1CommunityTacticsBoards(id: string, requestBody: {
+        title?: string;
+        description?: string;
+        formationTeamA?: string;
+        formationTeamB?: string;
+        boardData?: Record<string, any>;
+        isPublic?: boolean;
+        boardMode?: 'generic' | 'team';
+        teamAId?: number;
+        teamBId?: number;
+        teamAName?: string;
+        teamBName?: string;
+        teamALogo?: string;
+        teamBLogo?: string;
+        fixtureId?: number;
+    }): CancelablePromise<(ApiResponseDTO & {
+        data?: TacticsBoardDTO;
+    })>;
+    /**
+     * Delete tactics board
+     * Delete a tactics board. Only the owner can delete their board.
+     * @param id Tactics board ID
+     * @returns void
+     * @throws ApiError
+     */
+    deleteApiV1CommunityTacticsBoards(id: string): CancelablePromise<void>;
+    /**
+     * Get tactics board by share token
+     * Retrieve a public tactics board using its unique share token
+     * @param shareToken Unique share token
+     * @returns any Tactics board retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsShare(shareToken: string): CancelablePromise<(ApiResponseDTO & {
+        data?: TacticsBoardDTO;
+    })>;
+    /**
+     * Claim anonymous tactics board
+     * Claim ownership of an anonymous tactics board
+     * @param id Tactics board ID
+     * @returns any Tactics board claimed successfully
+     * @throws ApiError
+     */
+    postApiV1CommunityTacticsBoardsClaim(id: string): CancelablePromise<{
+        success?: boolean;
+        data?: {
+            id?: string;
+            userId?: string;
+            message?: string;
+        };
+    }>;
+    /**
+     * Browse public tactics boards
+     * Search and filter public tactics boards with pagination and sorting
+     * @param search Search text for title or description
+     * @param formationTeamA Filter by Team A formation
+     * @param formationTeamB Filter by Team B formation
+     * @param boardMode Filter by board mode
+     * @param teamAId Filter by Team A ID
+     * @param teamBId Filter by Team B ID
+     * @param fixtureId Filter by fixture ID
+     * @param sortBy Field to sort by
+     * @param sortOrder Sort order
+     * @param limit Number of boards per page
+     * @param offset Number of boards to skip
+     * @returns any Tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsBrowse(search?: string, formationTeamA?: string, formationTeamB?: string, boardMode?: 'generic' | 'team', teamAId?: number, teamBId?: number, fixtureId?: number, sortBy?: 'createdAt' | 'updatedAt' | 'viewCount', sortOrder?: 'asc' | 'desc', limit?: number, offset?: number): CancelablePromise<{
+        success?: boolean;
+        data?: {
+            boards?: Array<TacticsBoardDTO>;
+            total?: number;
+            limit?: number;
+            offset?: number;
+            hasMore?: boolean;
+        };
+    }>;
+    /**
+     * Get trending tactics boards
+     * Retrieve the most viewed tactics boards in the last 7 days
+     * @param limit Number of trending boards to return
+     * @returns any Trending tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsTrending(limit?: number): CancelablePromise<{
+        success?: boolean;
+        data?: {
+            boards?: Array<TacticsBoardDTO>;
+        };
+    }>;
+    /**
+     * Get popular tactics boards
+     * Retrieve the most viewed tactics boards of all time
+     * @param limit Number of popular boards to return
+     * @returns any Popular tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsPopular(limit?: number): CancelablePromise<{
+        success?: boolean;
+        data?: {
+            boards?: Array<TacticsBoardDTO>;
+        };
+    }>;
+    /**
+     * Export tactics board as image
+     * Export a tactics board as an SVG image or data URL
+     * @param id Tactics board ID
+     * @param format Export format
+     * @returns any Tactics board exported successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsExport(id: string, format?: 'svg' | 'data-url'): CancelablePromise<{
+        success?: boolean;
+        data?: {
+            dataUrl?: string;
+        };
+    }>;
+}

package/dist/services/CommunityTacticsBoardsService.js

@@ -0,0 +1,272 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommunityTacticsBoardsService = void 0;
+class CommunityTacticsBoardsService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * Create a new tactics board
+     * Create a tactics board with formations for two teams and tactical drawings. Works for both authenticated and anonymous users. Anonymous boards can later be claimed.
+     * @param requestBody
+     * @returns any Tactics board created successfully
+     * @throws ApiError
+     */
+    postApiV1CommunityTacticsBoards(requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/api/v1/community/tactics-boards',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error - missing required fields`,
+                500: `Server error while creating tactics board`,
+            },
+        });
+    }
+    /**
+     * Get user's tactics boards
+     * Retrieve all tactics boards created by the authenticated user with pagination and sorting
+     * @param limit Number of boards to return
+     * @param offset Number of boards to skip
+     * @param sortBy Field to sort by
+     * @param sortOrder Sort order
+     * @returns any User's tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoards(limit = 20, offset, sortBy = 'createdAt', sortOrder = 'desc') {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards',
+            query: {
+                'limit': limit,
+                'offset': offset,
+                'sortBy': sortBy,
+                'sortOrder': sortOrder,
+            },
+            errors: {
+                401: `Authentication required`,
+                500: `Server error while fetching tactics boards`,
+            },
+        });
+    }
+    /**
+     * Get tactics board by ID
+     * Retrieve a specific tactics board by its ID. Returns public boards or boards owned by the authenticated user.
+     * @param id Tactics board ID
+     * @returns any Tactics board retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoards1(id) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                400: `Tactics board ID is required`,
+                403: `Permission denied - board is private`,
+                404: `Tactics board not found`,
+                500: `Server error while fetching tactics board`,
+            },
+        });
+    }
+    /**
+     * Update tactics board
+     * Update an existing tactics board. Only the owner can update their board.
+     * @param id Tactics board ID
+     * @param requestBody
+     * @returns any Tactics board updated successfully
+     * @throws ApiError
+     */
+    putApiV1CommunityTacticsBoards(id, requestBody) {
+        return this.httpRequest.request({
+            method: 'PUT',
+            url: '/api/v1/community/tactics-boards/{id}',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid tactics board ID`,
+                401: `Authentication required`,
+                403: `Permission denied - not the owner`,
+                404: `Tactics board not found`,
+                500: `Server error while updating tactics board`,
+            },
+        });
+    }
+    /**
+     * Delete tactics board
+     * Delete a tactics board. Only the owner can delete their board.
+     * @param id Tactics board ID
+     * @returns void
+     * @throws ApiError
+     */
+    deleteApiV1CommunityTacticsBoards(id) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/api/v1/community/tactics-boards/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                400: `Invalid tactics board ID`,
+                401: `Authentication required`,
+                403: `Permission denied - not the owner`,
+                404: `Tactics board not found`,
+                500: `Server error while deleting tactics board`,
+            },
+        });
+    }
+    /**
+     * Get tactics board by share token
+     * Retrieve a public tactics board using its unique share token
+     * @param shareToken Unique share token
+     * @returns any Tactics board retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsShare(shareToken) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards/share/{shareToken}',
+            path: {
+                'shareToken': shareToken,
+            },
+            errors: {
+                400: `Share token is required`,
+                404: `Tactics board not found or is private`,
+                500: `Server error while fetching tactics board`,
+            },
+        });
+    }
+    /**
+     * Claim anonymous tactics board
+     * Claim ownership of an anonymous tactics board
+     * @param id Tactics board ID
+     * @returns any Tactics board claimed successfully
+     * @throws ApiError
+     */
+    postApiV1CommunityTacticsBoardsClaim(id) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/api/v1/community/tactics-boards/{id}/claim',
+            path: {
+                'id': id,
+            },
+            errors: {
+                400: `Invalid tactics board ID`,
+                401: `Authentication required`,
+                403: `Board already has an owner`,
+                404: `Tactics board not found`,
+                500: `Server error while claiming tactics board`,
+            },
+        });
+    }
+    /**
+     * Browse public tactics boards
+     * Search and filter public tactics boards with pagination and sorting
+     * @param search Search text for title or description
+     * @param formationTeamA Filter by Team A formation
+     * @param formationTeamB Filter by Team B formation
+     * @param boardMode Filter by board mode
+     * @param teamAId Filter by Team A ID
+     * @param teamBId Filter by Team B ID
+     * @param fixtureId Filter by fixture ID
+     * @param sortBy Field to sort by
+     * @param sortOrder Sort order
+     * @param limit Number of boards per page
+     * @param offset Number of boards to skip
+     * @returns any Tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsBrowse(search, formationTeamA, formationTeamB, boardMode, teamAId, teamBId, fixtureId, sortBy = 'createdAt', sortOrder = 'desc', limit = 20, offset) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards/browse',
+            query: {
+                'search': search,
+                'formationTeamA': formationTeamA,
+                'formationTeamB': formationTeamB,
+                'boardMode': boardMode,
+                'teamAId': teamAId,
+                'teamBId': teamBId,
+                'fixtureId': fixtureId,
+                'sortBy': sortBy,
+                'sortOrder': sortOrder,
+                'limit': limit,
+                'offset': offset,
+            },
+            errors: {
+                500: `Server error while browsing tactics boards`,
+            },
+        });
+    }
+    /**
+     * Get trending tactics boards
+     * Retrieve the most viewed tactics boards in the last 7 days
+     * @param limit Number of trending boards to return
+     * @returns any Trending tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsTrending(limit = 10) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards/trending',
+            query: {
+                'limit': limit,
+            },
+            errors: {
+                500: `Server error while fetching trending tactics boards`,
+            },
+        });
+    }
+    /**
+     * Get popular tactics boards
+     * Retrieve the most viewed tactics boards of all time
+     * @param limit Number of popular boards to return
+     * @returns any Popular tactics boards retrieved successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsPopular(limit = 10) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards/popular',
+            query: {
+                'limit': limit,
+            },
+            errors: {
+                500: `Server error while fetching popular tactics boards`,
+            },
+        });
+    }
+    /**
+     * Export tactics board as image
+     * Export a tactics board as an SVG image or data URL
+     * @param id Tactics board ID
+     * @param format Export format
+     * @returns any Tactics board exported successfully
+     * @throws ApiError
+     */
+    getApiV1CommunityTacticsBoardsExport(id, format = 'svg') {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/v1/community/tactics-boards/{id}/export',
+            path: {
+                'id': id,
+            },
+            query: {
+                'format': format,
+            },
+            errors: {
+                400: `Invalid tactics board ID or format`,
+                403: `Permission denied - board is private`,
+                404: `Tactics board not found`,
+                500: `Server error while exporting tactics board`,
+            },
+        });
+    }
+}
+exports.CommunityTacticsBoardsService = CommunityTacticsBoardsService;