new lib version [CI SKIP]

dist/index.d.ts

@@ -12,6 +12,7 @@ export type { CreateRunner } from './models/CreateRunner';
 export type { CreateRunnerGroup } from './models/CreateRunnerGroup';
 export type { CreateRunnerOrganisation } from './models/CreateRunnerOrganisation';
 export type { CreateRunnerTeam } from './models/CreateRunnerTeam';
+export type { CreateStatsClient } from './models/CreateStatsClient';
 export type { CreateTrack } from './models/CreateTrack';
 export type { CreateUser } from './models/CreateUser';
 export type { CreateUserGroup } from './models/CreateUserGroup';
@@ -50,6 +51,11 @@ export type { ResponseRunner } from './models/ResponseRunner';
 export type { ResponseRunnerGroup } from './models/ResponseRunnerGroup';
 export type { ResponseRunnerOrganisation } from './models/ResponseRunnerOrganisation';
 export type { ResponseRunnerTeam } from './models/ResponseRunnerTeam';
+export type { ResponseStats } from './models/ResponseStats';
+export type { ResponseStatsClient } from './models/ResponseStatsClient';
+export type { ResponseStatsOrgnisation } from './models/ResponseStatsOrgnisation';
+export type { ResponseStatsRunner } from './models/ResponseStatsRunner';
+export type { ResponseStatsTeam } from './models/ResponseStatsTeam';
 export type { ResponseTrack } from './models/ResponseTrack';
 export type { ResponseUser } from './models/ResponseUser';
 export type { ResponseUserGroup } from './models/ResponseUserGroup';
@@ -73,6 +79,9 @@ export type { RunnerTeamNeedsParentError } from './models/RunnerTeamNeedsParentE
 export type { RunnerTeamNotFoundError } from './models/RunnerTeamNotFoundError';
 export type { Scan } from './models/Scan';
 export type { ScanStation } from './models/ScanStation';
+export type { StatsClient } from './models/StatsClient';
+export type { StatsClientIdsNotMatchingError } from './models/StatsClientIdsNotMatchingError';
+export type { StatsClientNotFoundError } from './models/StatsClientNotFoundError';
 export type { Track } from './models/Track';
 export type { TrackIdsNotMatchingError } from './models/TrackIdsNotMatchingError';
 export type { TrackNotFoundError } from './models/TrackNotFoundError';
@@ -99,6 +108,8 @@ export { PermissionService } from './services/PermissionService';
 export { RunnerOrganisationService } from './services/RunnerOrganisationService';
 export { RunnerService } from './services/RunnerService';
 export { RunnerTeamService } from './services/RunnerTeamService';
+export { StatsClientService } from './services/StatsClientService';
+export { StatsService } from './services/StatsService';
 export { StatusService } from './services/StatusService';
 export { TrackService } from './services/TrackService';
 export { UserGroupService } from './services/UserGroupService';

dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserService = exports.UserGroupService = exports.TrackService = exports.StatusService = exports.RunnerTeamService = exports.RunnerService = exports.RunnerOrganisationService = exports.PermissionService = exports.ImportService = exports.AuthService = exports.UserAction = exports.ResponsePermission = exports.Permission = exports.CreatePermission = exports.OpenAPI = exports.ApiError = void 0;
+exports.UserService = exports.UserGroupService = exports.TrackService = exports.StatusService = exports.StatsService = exports.StatsClientService = exports.RunnerTeamService = exports.RunnerService = exports.RunnerOrganisationService = exports.PermissionService = exports.ImportService = exports.AuthService = exports.UserAction = exports.ResponsePermission = exports.Permission = exports.CreatePermission = exports.OpenAPI = exports.ApiError = void 0;
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -28,6 +28,10 @@ var RunnerService_1 = require("./services/RunnerService");
 Object.defineProperty(exports, "RunnerService", { enumerable: true, get: function () { return RunnerService_1.RunnerService; } });
 var RunnerTeamService_1 = require("./services/RunnerTeamService");
 Object.defineProperty(exports, "RunnerTeamService", { enumerable: true, get: function () { return RunnerTeamService_1.RunnerTeamService; } });
+var StatsClientService_1 = require("./services/StatsClientService");
+Object.defineProperty(exports, "StatsClientService", { enumerable: true, get: function () { return StatsClientService_1.StatsClientService; } });
+var StatsService_1 = require("./services/StatsService");
+Object.defineProperty(exports, "StatsService", { enumerable: true, get: function () { return StatsService_1.StatsService; } });
 var StatusService_1 = require("./services/StatusService");
 Object.defineProperty(exports, "StatusService", { enumerable: true, get: function () { return StatusService_1.StatusService; } });
 var TrackService_1 = require("./services/TrackService");

dist/models/CreatePermission.d.ts

@@ -11,7 +11,8 @@ export declare namespace CreatePermission {
         TRACK = "TRACK",
         USER = "USER",
         USERGROUP = "USERGROUP",
-        PERMISSION = "PERMISSION"
+        PERMISSION = "PERMISSION",
+        STATSCLIENT = "STATSCLIENT"
     }
     enum action {
         GET = "GET",

dist/models/CreatePermission.js

@@ -15,6 +15,7 @@ var CreatePermission;
         target["USER"] = "USER";
         target["USERGROUP"] = "USERGROUP";
         target["PERMISSION"] = "PERMISSION";
+        target["STATSCLIENT"] = "STATSCLIENT";
     })(target = CreatePermission.target || (CreatePermission.target = {}));
     let action;
     (function (action) {

dist/models/CreateStatsClient.d.ts

@@ -0,0 +1,3 @@
+export declare type CreateStatsClient = {
+    description?: string;
+};

dist/models/CreateStatsClient.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/Permission.d.ts

@@ -11,7 +11,8 @@ export declare namespace Permission {
         TRACK = "TRACK",
         USER = "USER",
         USERGROUP = "USERGROUP",
-        PERMISSION = "PERMISSION"
+        PERMISSION = "PERMISSION",
+        STATSCLIENT = "STATSCLIENT"
     }
     enum action {
         GET = "GET",

dist/models/Permission.js

@@ -15,6 +15,7 @@ var Permission;
         target["USER"] = "USER";
         target["USERGROUP"] = "USERGROUP";
         target["PERMISSION"] = "PERMISSION";
+        target["STATSCLIENT"] = "STATSCLIENT";
     })(target = Permission.target || (Permission.target = {}));
     let action;
     (function (action) {

dist/models/ResponsePermission.d.ts

@@ -13,7 +13,8 @@ export declare namespace ResponsePermission {
         TRACK = "TRACK",
         USER = "USER",
         USERGROUP = "USERGROUP",
-        PERMISSION = "PERMISSION"
+        PERMISSION = "PERMISSION",
+        STATSCLIENT = "STATSCLIENT"
     }
     enum action {
         GET = "GET",

dist/models/ResponsePermission.js

@@ -15,6 +15,7 @@ var ResponsePermission;
         target["USER"] = "USER";
         target["USERGROUP"] = "USERGROUP";
         target["PERMISSION"] = "PERMISSION";
+        target["STATSCLIENT"] = "STATSCLIENT";
     })(target = ResponsePermission.target || (ResponsePermission.target = {}));
     let action;
     (function (action) {

dist/models/ResponseStats.d.ts

@@ -0,0 +1,10 @@
+export declare type ResponseStats = {
+    total_runners: number;
+    total_teams: number;
+    total_orgs: number;
+    total_users: number;
+    total_scans: number;
+    total_distance: number;
+    total_donation: number;
+    average_distance: number;
+};

dist/models/ResponseStats.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/ResponseStatsClient.d.ts

@@ -0,0 +1,6 @@
+export declare type ResponseStatsClient = {
+    id: number;
+    description?: string;
+    key?: string;
+    prefix: string;
+};

dist/models/ResponseStatsClient.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/ResponseStatsOrgnisation.d.ts

@@ -0,0 +1,6 @@
+export declare type ResponseStatsOrgnisation = {
+    id: number;
+    name: string;
+    distance: number;
+    donationAmount: number;
+};

dist/models/ResponseStatsOrgnisation.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/ResponseStatsRunner.d.ts

@@ -0,0 +1,10 @@
+import type { RunnerGroup } from './RunnerGroup';
+export declare type ResponseStatsRunner = {
+    id: number;
+    firstname: string;
+    middlename: string;
+    lastname: string;
+    distance: number;
+    donationAmount: number;
+    group: RunnerGroup;
+};

dist/models/ResponseStatsRunner.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/ResponseStatsTeam.d.ts

@@ -0,0 +1,8 @@
+import type { RunnerGroup } from './RunnerGroup';
+export declare type ResponseStatsTeam = {
+    id: number;
+    name: string;
+    distance: number;
+    donationAmount: number;
+    parent: RunnerGroup;
+};

dist/models/ResponseStatsTeam.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/Runner.d.ts

@@ -1,6 +1,7 @@
 export declare type Runner = {
     group: string;
     distance: number;
+    distanceDonationAmount: number;
     id: number;
     firstname: string;
     middlename?: string;

dist/models/RunnerGroup.d.ts

@@ -2,4 +2,6 @@ export declare type RunnerGroup = {
     id: number;
     name: string;
     contact?: any;
+    distance: number;
+    distanceDonationAmount: number;
 };

dist/models/RunnerOrganisation.d.ts

@@ -1,5 +1,7 @@
 export declare type RunnerOrganisation = {
     address?: any;
+    distance: number;
+    distanceDonationAmount: number;
     id: number;
     name: string;
     contact?: any;

dist/models/RunnerTeam.d.ts

@@ -3,4 +3,6 @@ export declare type RunnerTeam = {
     id: number;
     name: string;
     contact?: any;
+    distance: number;
+    distanceDonationAmount: number;
 };

dist/models/StatsClient.d.ts

@@ -0,0 +1,7 @@
+export declare type StatsClient = {
+    id: number;
+    description?: string;
+    prefix: string;
+    key: string;
+    cleartextkey?: string;
+};

dist/models/StatsClient.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/StatsClientIdsNotMatchingError.d.ts

@@ -0,0 +1,4 @@
+export declare type StatsClientIdsNotMatchingError = {
+    name: string;
+    message: string;
+};

dist/models/StatsClientIdsNotMatchingError.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/StatsClientNotFoundError.d.ts

@@ -0,0 +1,4 @@
+export declare type StatsClientNotFoundError = {
+    name: string;
+    message: string;
+};

dist/models/StatsClientNotFoundError.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/services/StatsClientService.d.ts

@@ -0,0 +1,37 @@
+import type { CreateStatsClient } from '../models/CreateStatsClient';
+import type { ResponseEmpty } from '../models/ResponseEmpty';
+import type { ResponseStatsClient } from '../models/ResponseStatsClient';
+export declare class StatsClientService {
+    /**
+     * Get all
+     * Lists all stats clients. Please remember that the key can only be viewed on creation.
+     * @returns ResponseStatsClient
+     * @throws ApiError
+     */
+    static statsClientControllerGetAll(): Promise<Array<ResponseStatsClient>>;
+    /**
+     * Post
+     * Create a new stats client. <br> Please remember that the client's key will be generated automaticly and that it can only be viewed on creation.
+     * @param requestBody CreateStatsClient
+     * @returns ResponseStatsClient
+     * @throws ApiError
+     */
+    static statsClientControllerPost(requestBody?: CreateStatsClient): Promise<ResponseStatsClient>;
+    /**
+     * Get one
+     * Lists all information about the stats client whose id got provided. Please remember that the key can only be viewed on creation.
+     * @param id
+     * @returns ResponseStatsClient
+     * @throws ApiError
+     */
+    static statsClientControllerGetOne(id: number): Promise<ResponseStatsClient>;
+    /**
+     * Remove
+     * Delete the stats client whose id you provided. <br> If no client with this id exists it will just return 204(no content).
+     * @param id
+     * @returns ResponseStatsClient
+     * @returns ResponseEmpty
+     * @throws ApiError
+     */
+    static statsClientControllerRemove(id: number): Promise<ResponseStatsClient | ResponseEmpty>;
+}

dist/services/StatsClientService.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatsClientService = void 0;
+const request_1 = require("../core/request");
+class StatsClientService {
+    /**
+     * Get all
+     * Lists all stats clients. Please remember that the key can only be viewed on creation.
+     * @returns ResponseStatsClient
+     * @throws ApiError
+     */
+    static async statsClientControllerGetAll() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/statsclients`,
+        });
+        return result.body;
+    }
+    /**
+     * Post
+     * Create a new stats client. <br> Please remember that the client's key will be generated automaticly and that it can only be viewed on creation.
+     * @param requestBody CreateStatsClient
+     * @returns ResponseStatsClient
+     * @throws ApiError
+     */
+    static async statsClientControllerPost(requestBody) {
+        const result = await request_1.request({
+            method: 'POST',
+            path: `/api/statsclients`,
+            body: requestBody,
+        });
+        return result.body;
+    }
+    /**
+     * Get one
+     * Lists all information about the stats client whose id got provided. Please remember that the key can only be viewed on creation.
+     * @param id
+     * @returns ResponseStatsClient
+     * @throws ApiError
+     */
+    static async statsClientControllerGetOne(id) {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/statsclients/${id}`,
+        });
+        return result.body;
+    }
+    /**
+     * Remove
+     * Delete the stats client whose id you provided. <br> If no client with this id exists it will just return 204(no content).
+     * @param id
+     * @returns ResponseStatsClient
+     * @returns ResponseEmpty
+     * @throws ApiError
+     */
+    static async statsClientControllerRemove(id) {
+        const result = await request_1.request({
+            method: 'DELETE',
+            path: `/api/statsclients/${id}`,
+        });
+        return result.body;
+    }
+}
+exports.StatsClientService = StatsClientService;

dist/services/StatsService.d.ts

@@ -0,0 +1,62 @@
+import type { ResponseStats } from '../models/ResponseStats';
+import type { ResponseStatsOrgnisation } from '../models/ResponseStatsOrgnisation';
+import type { ResponseStatsRunner } from '../models/ResponseStatsRunner';
+import type { ResponseStatsTeam } from '../models/ResponseStatsTeam';
+export declare class StatsService {
+    /**
+     * Get
+     * A very basic stats endpoint providing basic counters for a dashboard or simmilar
+     * @returns ResponseStats
+     * @throws ApiError
+     */
+    static statsControllerGet(): Promise<ResponseStats>;
+    /**
+     * Get top runners by distance
+     * Returns the top ten runners by distance.
+     * @returns ResponseStatsRunner
+     * @throws ApiError
+     */
+    static statsControllerGetTopRunnersByDistance(): Promise<Array<ResponseStatsRunner>>;
+    /**
+     * Get top runners by donations
+     * Returns the top ten runners by donations.
+     * @returns ResponseStatsRunner
+     * @throws ApiError
+     */
+    static statsControllerGetTopRunnersByDonations(): Promise<Array<ResponseStatsRunner>>;
+    /**
+     * Get top runners by track time
+     * Returns the top ten fastest track times (with their runner and the runner's group).
+     * @returns ResponseStatsRunner
+     * @throws ApiError
+     */
+    static statsControllerGetTopRunnersByTrackTime(): Promise<Array<ResponseStatsRunner>>;
+    /**
+     * Get top teams by distance
+     * Returns the top ten teams by distance.
+     * @returns ResponseStatsTeam
+     * @throws ApiError
+     */
+    static statsControllerGetTopTeamsByDistance(): Promise<Array<ResponseStatsTeam>>;
+    /**
+     * Get top teams by donations
+     * Returns the top ten teams by donations.
+     * @returns ResponseStatsTeam
+     * @throws ApiError
+     */
+    static statsControllerGetTopTeamsByDonations(): Promise<Array<ResponseStatsTeam>>;
+    /**
+     * Get top orgs by distance
+     * Returns the top ten organisations by distance.
+     * @returns ResponseStatsOrgnisation
+     * @throws ApiError
+     */
+    static statsControllerGetTopOrgsByDistance(): Promise<Array<ResponseStatsOrgnisation>>;
+    /**
+     * Get top orgs by donations
+     * Returns the top ten organisations by donations.
+     * @returns ResponseStatsOrgnisation
+     * @throws ApiError
+     */
+    static statsControllerGetTopOrgsByDonations(): Promise<Array<ResponseStatsOrgnisation>>;
+}

dist/services/StatsService.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatsService = void 0;
+const request_1 = require("../core/request");
+class StatsService {
+    /**
+     * Get
+     * A very basic stats endpoint providing basic counters for a dashboard or simmilar
+     * @returns ResponseStats
+     * @throws ApiError
+     */
+    static async statsControllerGet() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top runners by distance
+     * Returns the top ten runners by distance.
+     * @returns ResponseStatsRunner
+     * @throws ApiError
+     */
+    static async statsControllerGetTopRunnersByDistance() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/runners/distance`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top runners by donations
+     * Returns the top ten runners by donations.
+     * @returns ResponseStatsRunner
+     * @throws ApiError
+     */
+    static async statsControllerGetTopRunnersByDonations() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/runners/donations`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top runners by track time
+     * Returns the top ten fastest track times (with their runner and the runner's group).
+     * @returns ResponseStatsRunner
+     * @throws ApiError
+     */
+    static async statsControllerGetTopRunnersByTrackTime() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/scans`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top teams by distance
+     * Returns the top ten teams by distance.
+     * @returns ResponseStatsTeam
+     * @throws ApiError
+     */
+    static async statsControllerGetTopTeamsByDistance() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/teams/distance`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top teams by donations
+     * Returns the top ten teams by donations.
+     * @returns ResponseStatsTeam
+     * @throws ApiError
+     */
+    static async statsControllerGetTopTeamsByDonations() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/teams/donations`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top orgs by distance
+     * Returns the top ten organisations by distance.
+     * @returns ResponseStatsOrgnisation
+     * @throws ApiError
+     */
+    static async statsControllerGetTopOrgsByDistance() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/organisations/distance`,
+        });
+        return result.body;
+    }
+    /**
+     * Get top orgs by donations
+     * Returns the top ten organisations by donations.
+     * @returns ResponseStatsOrgnisation
+     * @throws ApiError
+     */
+    static async statsControllerGetTopOrgsByDonations() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/stats/organisations/donations`,
+        });
+        return result.body;
+    }
+}
+exports.StatsService = StatsService;

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@odit/lfk-client-node",
 	"description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for NodeJS applications.",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"license": "CC-BY-NC-SA-4.0",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",