From ad908448461fde632bf196d08247b67b32bb864f Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Thu, 2 Feb 2023 16:14:10 +0100 Subject: [PATCH] Fresh dist --- dist/core/request.d.ts | 2 +- dist/core/request.js | 5 ++++- dist/services/AuthService.d.ts | 22 ++++++++++---------- dist/services/AuthService.js | 18 ++++++++-------- dist/services/DonationService.d.ts | 16 +++++++------- dist/services/DonationService.js | 16 +++++++------- dist/services/DonorService.d.ts | 12 +++++------ dist/services/DonorService.js | 12 +++++------ dist/services/GroupContactService.d.ts | 12 +++++------ dist/services/GroupContactService.js | 12 +++++------ dist/services/ImportService.d.ts | 12 +++++------ dist/services/ImportService.js | 12 +++++------ dist/services/MeService.d.ts | 8 +++---- dist/services/MeService.js | 8 +++---- dist/services/PermissionService.d.ts | 12 +++++------ dist/services/PermissionService.js | 12 +++++------ dist/services/RunnerCardService.d.ts | 14 ++++++------- dist/services/RunnerCardService.js | 14 ++++++------- dist/services/RunnerOrganizationService.d.ts | 14 ++++++------- dist/services/RunnerOrganizationService.js | 14 ++++++------- dist/services/RunnerSelfService.d.ts | 16 +++++++------- dist/services/RunnerSelfService.js | 16 +++++++------- dist/services/RunnerService.d.ts | 14 ++++++------- dist/services/RunnerService.js | 14 ++++++------- dist/services/RunnerTeamService.d.ts | 14 ++++++------- dist/services/RunnerTeamService.js | 14 ++++++------- dist/services/ScanService.d.ts | 16 +++++++------- dist/services/ScanService.js | 16 +++++++------- dist/services/ScanStationService.d.ts | 12 +++++------ dist/services/ScanStationService.js | 12 +++++------ dist/services/StatsClientService.d.ts | 10 ++++----- dist/services/StatsClientService.js | 10 ++++----- dist/services/StatsService.d.ts | 18 ++++++++-------- dist/services/StatsService.js | 18 ++++++++-------- dist/services/StatusService.d.ts | 4 ++-- dist/services/StatusService.js | 4 ++-- dist/services/TrackService.d.ts | 12 +++++------ dist/services/TrackService.js | 12 +++++------ dist/services/UserGroupService.d.ts | 14 ++++++------- dist/services/UserGroupService.js | 14 ++++++------- dist/services/UserService.d.ts | 14 ++++++------- dist/services/UserService.js | 14 ++++++------- package.json | 2 +- 43 files changed, 270 insertions(+), 267 deletions(-) diff --git a/dist/core/request.d.ts b/dist/core/request.d.ts index 425f4ca..10c785c 100644 --- a/dist/core/request.d.ts +++ b/dist/core/request.d.ts @@ -3,7 +3,7 @@ import type { ApiResult } from './ApiResult'; /** * Request using fetch client * @param options The request options from the the service - * @result ApiResult + * @returns ApiResult * @throws ApiError */ export declare function request(options: ApiRequestOptions): Promise; diff --git a/dist/core/request.js b/dist/core/request.js index 27342f5..7ac80d5 100644 --- a/dist/core/request.js +++ b/dist/core/request.js @@ -111,6 +111,9 @@ async function sendRequest(options, url) { headers: await getHeaders(options), body: getRequestBody(options), }; + if (OpenAPI_1.OpenAPI.WITH_CREDENTIALS) { + request.credentials = 'include'; + } return await fetch(url, request); } function getResponseHeader(response, responseHeader) { @@ -162,7 +165,7 @@ function catchErrors(options, result) { /** * Request using fetch client * @param options The request options from the the service - * @result ApiResult + * @returns ApiResult * @throws ApiError */ async function request(options) { diff --git a/dist/services/AuthService.d.ts b/dist/services/AuthService.d.ts index a78b085..85f0d31 100644 --- a/dist/services/AuthService.d.ts +++ b/dist/services/AuthService.d.ts @@ -17,28 +17,28 @@ export declare class AuthService { /** * Login * Login with your username/email and password.
You will receive: - * * access token (use it as a bearer token) - * * refresh token (will also be sent as a cookie) + * * access token (use it as a bearer token) + * * refresh token (will also be sent as a cookie) * @param requestBody CreateAuth - * @result any + * @returns any * @throws ApiError */ - static authControllerLogin(requestBody?: CreateAuth): Promise<(ResponseAuth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError | InvalidCredentialsError)>; + static authControllerLogin(requestBody?: CreateAuth): Promise<(ResponseAuth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>; /** * Logout * Logout using your refresh token.
This instantly invalidates all your access and refresh tokens. * @param requestBody HandleLogout - * @result any + * @returns any * @throws ApiError */ - static authControllerLogout(requestBody?: HandleLogout): Promise<(Logout | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError | InvalidCredentialsError)>; + static authControllerLogout(requestBody?: HandleLogout): Promise<(Logout | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>; /** * Refresh * Refresh your access and refresh tokens using a valid refresh token.
You will receive: - * * access token (use it as a bearer token) - * * refresh token (will also be sent as a cookie) + * * access token (use it as a bearer token) + * * refresh token (will also be sent as a cookie) * @param requestBody RefreshAuth - * @result any + * @returns any * @throws ApiError */ static authControllerRefresh(requestBody?: RefreshAuth): Promise<(ResponseAuth | JwtNotProvidedError | IllegalJWTError | UserNotFoundError | RefreshTokenCountInvalidError)>; @@ -47,7 +47,7 @@ export declare class AuthService { * Request a password reset token.
This will provide you with a reset token that you can use by posting to /api/auth/reset/{token}. * @param locale * @param requestBody CreateResetToken - * @result ResponseEmpty + * @returns ResponseEmpty * @throws ApiError */ static authControllerGetResetToken(locale?: string, requestBody?: CreateResetToken): Promise; @@ -56,7 +56,7 @@ export declare class AuthService { * Reset a user's utilising a valid password reset token.
This will set the user's password to the one you provided in the body.
To get a reset token post to /api/auth/reset with your username. * @param token * @param requestBody ResetPassword - * @result any + * @returns any * @throws ApiError */ static authControllerResetPassword(token: string, requestBody?: ResetPassword): Promise<(ResponseAuth | UserNotFoundError | UsernameOrEmailNeededError)>; diff --git a/dist/services/AuthService.js b/dist/services/AuthService.js index 33981ff..5e0438b 100644 --- a/dist/services/AuthService.js +++ b/dist/services/AuthService.js @@ -6,10 +6,10 @@ class AuthService { /** * Login * Login with your username/email and password.
You will receive: - * * access token (use it as a bearer token) - * * refresh token (will also be sent as a cookie) + * * access token (use it as a bearer token) + * * refresh token (will also be sent as a cookie) * @param requestBody CreateAuth - * @result any + * @returns any * @throws ApiError */ static async authControllerLogin(requestBody) { @@ -24,7 +24,7 @@ class AuthService { * Logout * Logout using your refresh token.
This instantly invalidates all your access and refresh tokens. * @param requestBody HandleLogout - * @result any + * @returns any * @throws ApiError */ static async authControllerLogout(requestBody) { @@ -38,10 +38,10 @@ class AuthService { /** * Refresh * Refresh your access and refresh tokens using a valid refresh token.
You will receive: - * * access token (use it as a bearer token) - * * refresh token (will also be sent as a cookie) + * * access token (use it as a bearer token) + * * refresh token (will also be sent as a cookie) * @param requestBody RefreshAuth - * @result any + * @returns any * @throws ApiError */ static async authControllerRefresh(requestBody) { @@ -57,7 +57,7 @@ class AuthService { * Request a password reset token.
This will provide you with a reset token that you can use by posting to /api/auth/reset/{token}. * @param locale * @param requestBody CreateResetToken - * @result ResponseEmpty + * @returns ResponseEmpty * @throws ApiError */ static async authControllerGetResetToken(locale, requestBody) { @@ -76,7 +76,7 @@ class AuthService { * Reset a user's utilising a valid password reset token.
This will set the user's password to the one you provided in the body.
To get a reset token post to /api/auth/reset with your username. * @param token * @param requestBody ResetPassword - * @result any + * @returns any * @throws ApiError */ static async authControllerResetPassword(token, requestBody) { diff --git a/dist/services/DonationService.d.ts b/dist/services/DonationService.d.ts index fc2c5a2..f0a5bab 100644 --- a/dist/services/DonationService.d.ts +++ b/dist/services/DonationService.d.ts @@ -9,7 +9,7 @@ export declare class DonationService { /** * Get all * Lists all donations (fixed or distance based) from all donors.
This includes the donations's runner's distance ran(if distance donation). - * @result any + * @returns any * @throws ApiError */ static donationControllerGetAll(): Promise<(Array | Array)>; @@ -17,7 +17,7 @@ export declare class DonationService { * Get one * Lists all information about the donation whose id got provided. This includes the donation's runner's distance ran (if distance donation). * @param id - * @result any + * @returns any * @throws ApiError */ static donationControllerGetOne(id: number): Promise<(ResponseDonation | ResponseDistanceDonation)>; @@ -26,8 +26,8 @@ export declare class DonationService { * Delete the donation whose id you provided.
If no donation with this id exists it will just return 204(no content). * @param id * @param force - * @result any - * @result ResponseEmpty + * @returns any + * @returns ResponseEmpty * @throws ApiError */ static donationControllerRemove(id: number, force?: boolean): Promise<(ResponseDonation | ResponseDistanceDonation) | ResponseEmpty>; @@ -35,7 +35,7 @@ export declare class DonationService { * Post fixed * Create a fixed donation (not distance donation - use /donations/distance instead).
Please rmemember to provide the donation's donors's id and amount. * @param requestBody CreateFixedDonation - * @result ResponseDonation + * @returns ResponseDonation * @throws ApiError */ static donationControllerPostFixed(requestBody?: CreateFixedDonation): Promise; @@ -43,7 +43,7 @@ export declare class DonationService { * Post distance * Create a distance donation (not fixed donation - use /donations/fixed instead).
Please rmemember to provide the donation's donors's and runners ids and amount per distance (kilometer). * @param requestBody CreateDistanceDonation - * @result ResponseDistanceDonation + * @returns ResponseDistanceDonation * @throws ApiError */ static donationControllerPostDistance(requestBody?: CreateDistanceDonation): Promise; @@ -52,7 +52,7 @@ export declare class DonationService { * Update the fixed donation (not distance donation - use /donations/distance instead) whose id you provided.
Please remember that ids can't be changed and amounts must be positive. * @param id * @param requestBody UpdateFixedDonation - * @result ResponseDonation + * @returns ResponseDonation * @throws ApiError */ static donationControllerPutFixed(id: number, requestBody?: UpdateFixedDonation): Promise; @@ -61,7 +61,7 @@ export declare class DonationService { * Update the distance donation (not fixed donation - use /donations/fixed instead) whose id you provided.
Please remember that ids can't be changed and amountPerDistance must be positive. * @param id * @param requestBody UpdateDistanceDonation - * @result ResponseDonation + * @returns ResponseDonation * @throws ApiError */ static donationControllerPutDistance(id: number, requestBody?: UpdateDistanceDonation): Promise; diff --git a/dist/services/DonationService.js b/dist/services/DonationService.js index f36bde5..32344dc 100644 --- a/dist/services/DonationService.js +++ b/dist/services/DonationService.js @@ -6,7 +6,7 @@ class DonationService { /** * Get all * Lists all donations (fixed or distance based) from all donors.
This includes the donations's runner's distance ran(if distance donation). - * @result any + * @returns any * @throws ApiError */ static async donationControllerGetAll() { @@ -20,7 +20,7 @@ class DonationService { * Get one * Lists all information about the donation whose id got provided. This includes the donation's runner's distance ran (if distance donation). * @param id - * @result any + * @returns any * @throws ApiError */ static async donationControllerGetOne(id) { @@ -35,8 +35,8 @@ class DonationService { * Delete the donation whose id you provided.
If no donation with this id exists it will just return 204(no content). * @param id * @param force - * @result any - * @result ResponseEmpty + * @returns any + * @returns ResponseEmpty * @throws ApiError */ static async donationControllerRemove(id, force) { @@ -53,7 +53,7 @@ class DonationService { * Post fixed * Create a fixed donation (not distance donation - use /donations/distance instead).
Please rmemember to provide the donation's donors's id and amount. * @param requestBody CreateFixedDonation - * @result ResponseDonation + * @returns ResponseDonation * @throws ApiError */ static async donationControllerPostFixed(requestBody) { @@ -68,7 +68,7 @@ class DonationService { * Post distance * Create a distance donation (not fixed donation - use /donations/fixed instead).
Please rmemember to provide the donation's donors's and runners ids and amount per distance (kilometer). * @param requestBody CreateDistanceDonation - * @result ResponseDistanceDonation + * @returns ResponseDistanceDonation * @throws ApiError */ static async donationControllerPostDistance(requestBody) { @@ -84,7 +84,7 @@ class DonationService { * Update the fixed donation (not distance donation - use /donations/distance instead) whose id you provided.
Please remember that ids can't be changed and amounts must be positive. * @param id * @param requestBody UpdateFixedDonation - * @result ResponseDonation + * @returns ResponseDonation * @throws ApiError */ static async donationControllerPutFixed(id, requestBody) { @@ -100,7 +100,7 @@ class DonationService { * Update the distance donation (not fixed donation - use /donations/fixed instead) whose id you provided.
Please remember that ids can't be changed and amountPerDistance must be positive. * @param id * @param requestBody UpdateDistanceDonation - * @result ResponseDonation + * @returns ResponseDonation * @throws ApiError */ static async donationControllerPutDistance(id, requestBody) { diff --git a/dist/services/DonorService.d.ts b/dist/services/DonorService.d.ts index 247a506..3a521a2 100644 --- a/dist/services/DonorService.d.ts +++ b/dist/services/DonorService.d.ts @@ -6,7 +6,7 @@ export declare class DonorService { /** * Get all * Lists all donor.
This includes the donor's current donation amount. - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static donorControllerGetAll(): Promise>; @@ -14,7 +14,7 @@ export declare class DonorService { * Post * Create a new donor. * @param requestBody CreateDonor - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static donorControllerPost(requestBody?: CreateDonor): Promise; @@ -22,7 +22,7 @@ export declare class DonorService { * Get one * Lists all information about the donor whose id got provided.
This includes the donor's current donation amount. * @param id - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static donorControllerGetOne(id: number): Promise; @@ -31,7 +31,7 @@ export declare class DonorService { * Update the donor whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateDonor - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static donorControllerPut(id: number, requestBody?: UpdateDonor): Promise; @@ -40,8 +40,8 @@ export declare class DonorService { * Delete the donor whose id you provided.
If no donor with this id exists it will just return 204(no content).
If the donor still has donations associated this will fail, please provide the query param ?force=true to delete the donor with all associated donations. * @param id * @param force - * @result ResponseDonor - * @result ResponseEmpty + * @returns ResponseDonor + * @returns ResponseEmpty * @throws ApiError */ static donorControllerRemove(id: number, force?: boolean): Promise; diff --git a/dist/services/DonorService.js b/dist/services/DonorService.js index f78f67f..cfe0ef6 100644 --- a/dist/services/DonorService.js +++ b/dist/services/DonorService.js @@ -6,7 +6,7 @@ class DonorService { /** * Get all * Lists all donor.
This includes the donor's current donation amount. - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static async donorControllerGetAll() { @@ -20,7 +20,7 @@ class DonorService { * Post * Create a new donor. * @param requestBody CreateDonor - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static async donorControllerPost(requestBody) { @@ -35,7 +35,7 @@ class DonorService { * Get one * Lists all information about the donor whose id got provided.
This includes the donor's current donation amount. * @param id - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static async donorControllerGetOne(id) { @@ -50,7 +50,7 @@ class DonorService { * Update the donor whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateDonor - * @result ResponseDonor + * @returns ResponseDonor * @throws ApiError */ static async donorControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class DonorService { * Delete the donor whose id you provided.
If no donor with this id exists it will just return 204(no content).
If the donor still has donations associated this will fail, please provide the query param ?force=true to delete the donor with all associated donations. * @param id * @param force - * @result ResponseDonor - * @result ResponseEmpty + * @returns ResponseDonor + * @returns ResponseEmpty * @throws ApiError */ static async donorControllerRemove(id, force) { diff --git a/dist/services/GroupContactService.d.ts b/dist/services/GroupContactService.d.ts index d783af3..3a56e67 100644 --- a/dist/services/GroupContactService.d.ts +++ b/dist/services/GroupContactService.d.ts @@ -6,7 +6,7 @@ export declare class GroupContactService { /** * Get all * Lists all contacts.
This includes the contact's associated groups. - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static groupContactControllerGetAll(): Promise>; @@ -14,7 +14,7 @@ export declare class GroupContactService { * Post * Create a new contact. * @param requestBody CreateGroupContact - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static groupContactControllerPost(requestBody?: CreateGroupContact): Promise; @@ -22,7 +22,7 @@ export declare class GroupContactService { * Get one * Lists all information about the contact whose id got provided.
This includes the contact's associated groups. * @param id - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static groupContactControllerGetOne(id: number): Promise; @@ -31,7 +31,7 @@ export declare class GroupContactService { * Update the contact whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateGroupContact - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static groupContactControllerPut(id: number, requestBody?: UpdateGroupContact): Promise; @@ -40,8 +40,8 @@ export declare class GroupContactService { * Delete the contact whose id you provided.
If no contact with this id exists it will just return 204(no content).
This won't delete any groups associated with the contact. * @param id * @param force - * @result ResponseGroupContact - * @result ResponseEmpty + * @returns ResponseGroupContact + * @returns ResponseEmpty * @throws ApiError */ static groupContactControllerRemove(id: number, force?: boolean): Promise; diff --git a/dist/services/GroupContactService.js b/dist/services/GroupContactService.js index f48e7b9..8add9c3 100644 --- a/dist/services/GroupContactService.js +++ b/dist/services/GroupContactService.js @@ -6,7 +6,7 @@ class GroupContactService { /** * Get all * Lists all contacts.
This includes the contact's associated groups. - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static async groupContactControllerGetAll() { @@ -20,7 +20,7 @@ class GroupContactService { * Post * Create a new contact. * @param requestBody CreateGroupContact - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static async groupContactControllerPost(requestBody) { @@ -35,7 +35,7 @@ class GroupContactService { * Get one * Lists all information about the contact whose id got provided.
This includes the contact's associated groups. * @param id - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static async groupContactControllerGetOne(id) { @@ -50,7 +50,7 @@ class GroupContactService { * Update the contact whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateGroupContact - * @result ResponseGroupContact + * @returns ResponseGroupContact * @throws ApiError */ static async groupContactControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class GroupContactService { * Delete the contact whose id you provided.
If no contact with this id exists it will just return 204(no content).
This won't delete any groups associated with the contact. * @param id * @param force - * @result ResponseGroupContact - * @result ResponseEmpty + * @returns ResponseGroupContact + * @returns ResponseEmpty * @throws ApiError */ static async groupContactControllerRemove(id, force) { diff --git a/dist/services/ImportService.d.ts b/dist/services/ImportService.d.ts index 5cd9e52..3977284 100644 --- a/dist/services/ImportService.d.ts +++ b/dist/services/ImportService.d.ts @@ -6,7 +6,7 @@ export declare class ImportService { * Create new runners from json and insert them into the provided group.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param group * @param requestBody ImportRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static importControllerPostJson(group?: number, requestBody?: Array): Promise>; @@ -15,7 +15,7 @@ export declare class ImportService { * Create new runners from json and insert them into the provided org.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param id * @param requestBody ImportRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static importControllerPostOrgsJson(id: number, requestBody?: Array): Promise>; @@ -24,7 +24,7 @@ export declare class ImportService { * Create new runners from json and insert them into the provided team * @param id * @param requestBody ImportRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static importControllerPostTeamsJson(id: number, requestBody?: Array): Promise>; @@ -32,7 +32,7 @@ export declare class ImportService { * Post csv * Create new runners from csv and insert them into the provided group.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param group - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static importControllerPostCsv(group?: number): Promise>; @@ -40,7 +40,7 @@ export declare class ImportService { * Post orgs csv * Create new runners from csv and insert them into the provided org.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static importControllerPostOrgsCsv(id: number): Promise>; @@ -48,7 +48,7 @@ export declare class ImportService { * Post teams csv * Create new runners from csv and insert them into the provided team * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static importControllerPostTeamsCsv(id: number): Promise>; diff --git a/dist/services/ImportService.js b/dist/services/ImportService.js index af7bbe0..a7cf7e0 100644 --- a/dist/services/ImportService.js +++ b/dist/services/ImportService.js @@ -8,7 +8,7 @@ class ImportService { * Create new runners from json and insert them into the provided group.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param group * @param requestBody ImportRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async importControllerPostJson(group, requestBody) { @@ -27,7 +27,7 @@ class ImportService { * Create new runners from json and insert them into the provided org.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param id * @param requestBody ImportRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async importControllerPostOrgsJson(id, requestBody) { @@ -43,7 +43,7 @@ class ImportService { * Create new runners from json and insert them into the provided team * @param id * @param requestBody ImportRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async importControllerPostTeamsJson(id, requestBody) { @@ -58,7 +58,7 @@ class ImportService { * Post csv * Create new runners from csv and insert them into the provided group.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param group - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async importControllerPostCsv(group) { @@ -75,7 +75,7 @@ class ImportService { * Post orgs csv * Create new runners from csv and insert them into the provided org.
If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead. * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async importControllerPostOrgsCsv(id) { @@ -89,7 +89,7 @@ class ImportService { * Post teams csv * Create new runners from csv and insert them into the provided team * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async importControllerPostTeamsCsv(id) { diff --git a/dist/services/MeService.d.ts b/dist/services/MeService.d.ts index de908cd..928758f 100644 --- a/dist/services/MeService.d.ts +++ b/dist/services/MeService.d.ts @@ -5,7 +5,7 @@ export declare class MeService { /** * Get * Lists all information about yourself. - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static meControllerGet(): Promise; @@ -13,7 +13,7 @@ export declare class MeService { * Put * Update the yourself.
You can't edit your own permissions or group memberships here - Please use the /api/users/:id enpoint instead.
Please remember that ids can't be changed. * @param requestBody UpdateUser - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static meControllerPut(requestBody?: UpdateUser): Promise; @@ -21,14 +21,14 @@ export declare class MeService { * Remove * Delete yourself.
You have to confirm your decision by providing the ?force=true query param.
If there are any permissions directly granted to you they will get deleted as well. * @param force - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static meControllerRemove(force?: boolean): Promise; /** * Get permissions * Lists all permissions granted to the you sorted into directly granted and inherited as permission response objects. - * @result ResponseUserPermissions + * @returns ResponseUserPermissions * @throws ApiError */ static meControllerGetPermissions(): Promise; diff --git a/dist/services/MeService.js b/dist/services/MeService.js index 9d0d533..5c551a6 100644 --- a/dist/services/MeService.js +++ b/dist/services/MeService.js @@ -6,7 +6,7 @@ class MeService { /** * Get * Lists all information about yourself. - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async meControllerGet() { @@ -20,7 +20,7 @@ class MeService { * Put * Update the yourself.
You can't edit your own permissions or group memberships here - Please use the /api/users/:id enpoint instead.
Please remember that ids can't be changed. * @param requestBody UpdateUser - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async meControllerPut(requestBody) { @@ -35,7 +35,7 @@ class MeService { * Remove * Delete yourself.
You have to confirm your decision by providing the ?force=true query param.
If there are any permissions directly granted to you they will get deleted as well. * @param force - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async meControllerRemove(force) { @@ -51,7 +51,7 @@ class MeService { /** * Get permissions * Lists all permissions granted to the you sorted into directly granted and inherited as permission response objects. - * @result ResponseUserPermissions + * @returns ResponseUserPermissions * @throws ApiError */ static async meControllerGetPermissions() { diff --git a/dist/services/PermissionService.d.ts b/dist/services/PermissionService.d.ts index 0911cce..3092e86 100644 --- a/dist/services/PermissionService.d.ts +++ b/dist/services/PermissionService.d.ts @@ -7,7 +7,7 @@ export declare class PermissionService { /** * Get all * Lists all permissions for all users and groups. - * @result ResponsePermission + * @returns ResponsePermission * @throws ApiError */ static permissionControllerGetAll(): Promise>; @@ -15,7 +15,7 @@ export declare class PermissionService { * Post * Create a new permission for a existing principal(user/group).
If a permission with this target, action and prinicpal already exists that permission will be returned instead of creating a new one. * @param requestBody CreatePermission - * @result ResponsePermission + * @returns ResponsePermission * @throws ApiError */ static permissionControllerPost(requestBody?: CreatePermission): Promise; @@ -23,7 +23,7 @@ export declare class PermissionService { * Get one * Lists all information about the permission whose id got provided. * @param id - * @result ResponsePermission + * @returns ResponsePermission * @throws ApiError */ static permissionControllerGetOne(id: number): Promise; @@ -32,7 +32,7 @@ export declare class PermissionService { * Update a permission object.
If updateing the permission object would result in duplicate permission (same target, action and principal) this permission will get deleted and the existing permission will be returned.
Please remember that ids can't be changed. * @param id * @param requestBody UpdatePermission - * @result ResponsePrincipal + * @returns ResponsePrincipal * @throws ApiError */ static permissionControllerPut(id: number, requestBody?: UpdatePermission): Promise; @@ -41,8 +41,8 @@ export declare class PermissionService { * Deletes the permission whose id you provide.
If no permission with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponsePermission - * @result ResponseEmpty + * @returns ResponsePermission + * @returns ResponseEmpty * @throws ApiError */ static permissionControllerRemove(id: number, force?: boolean): Promise; diff --git a/dist/services/PermissionService.js b/dist/services/PermissionService.js index b18aada..05bc703 100644 --- a/dist/services/PermissionService.js +++ b/dist/services/PermissionService.js @@ -6,7 +6,7 @@ class PermissionService { /** * Get all * Lists all permissions for all users and groups. - * @result ResponsePermission + * @returns ResponsePermission * @throws ApiError */ static async permissionControllerGetAll() { @@ -20,7 +20,7 @@ class PermissionService { * Post * Create a new permission for a existing principal(user/group).
If a permission with this target, action and prinicpal already exists that permission will be returned instead of creating a new one. * @param requestBody CreatePermission - * @result ResponsePermission + * @returns ResponsePermission * @throws ApiError */ static async permissionControllerPost(requestBody) { @@ -35,7 +35,7 @@ class PermissionService { * Get one * Lists all information about the permission whose id got provided. * @param id - * @result ResponsePermission + * @returns ResponsePermission * @throws ApiError */ static async permissionControllerGetOne(id) { @@ -50,7 +50,7 @@ class PermissionService { * Update a permission object.
If updateing the permission object would result in duplicate permission (same target, action and principal) this permission will get deleted and the existing permission will be returned.
Please remember that ids can't be changed. * @param id * @param requestBody UpdatePermission - * @result ResponsePrincipal + * @returns ResponsePrincipal * @throws ApiError */ static async permissionControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class PermissionService { * Deletes the permission whose id you provide.
If no permission with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponsePermission - * @result ResponseEmpty + * @returns ResponsePermission + * @returns ResponseEmpty * @throws ApiError */ static async permissionControllerRemove(id, force) { diff --git a/dist/services/RunnerCardService.d.ts b/dist/services/RunnerCardService.d.ts index 351f03b..c51817b 100644 --- a/dist/services/RunnerCardService.d.ts +++ b/dist/services/RunnerCardService.d.ts @@ -6,7 +6,7 @@ export declare class RunnerCardService { /** * Get all * Lists all card. - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static runnerCardControllerGetAll(): Promise>; @@ -14,7 +14,7 @@ export declare class RunnerCardService { * Post * Create a new card.
You can provide a associated runner by id but you don't have to. * @param requestBody CreateRunnerCard - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static runnerCardControllerPost(requestBody?: CreateRunnerCard): Promise; @@ -22,7 +22,7 @@ export declare class RunnerCardService { * Get one * Lists all information about the card whose id got provided. * @param id - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static runnerCardControllerGetOne(id: number): Promise; @@ -31,7 +31,7 @@ export declare class RunnerCardService { * Update the card whose id you provided.
Scans created via this card will still be associated with the old runner.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunnerCard - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static runnerCardControllerPut(id: number, requestBody?: UpdateRunnerCard): Promise; @@ -40,8 +40,8 @@ export declare class RunnerCardService { * Delete the card whose id you provided.
If no card with this id exists it will just return 204(no content).
If the card still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with by this card - please disable it instead or just remove the runner association). * @param id * @param force - * @result ResponseRunnerCard - * @result ResponseEmpty + * @returns ResponseRunnerCard + * @returns ResponseEmpty * @throws ApiError */ static runnerCardControllerRemove(id: number, force?: boolean): Promise; @@ -50,7 +50,7 @@ export declare class RunnerCardService { * Create blank cards in bulk.
Just provide the count as a query param and wait for the 200 response.
You can provide the 'returnCards' query param if you want to receive the RESPONSERUNNERCARD objects in the response. * @param count * @param returnCards - * @result ResponseEmpty + * @returns ResponseEmpty * @throws ApiError */ static runnerCardControllerPostBlancoBulk(count?: number, returnCards?: boolean): Promise; diff --git a/dist/services/RunnerCardService.js b/dist/services/RunnerCardService.js index 2cd65ab..5c03707 100644 --- a/dist/services/RunnerCardService.js +++ b/dist/services/RunnerCardService.js @@ -6,7 +6,7 @@ class RunnerCardService { /** * Get all * Lists all card. - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static async runnerCardControllerGetAll() { @@ -20,7 +20,7 @@ class RunnerCardService { * Post * Create a new card.
You can provide a associated runner by id but you don't have to. * @param requestBody CreateRunnerCard - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static async runnerCardControllerPost(requestBody) { @@ -35,7 +35,7 @@ class RunnerCardService { * Get one * Lists all information about the card whose id got provided. * @param id - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static async runnerCardControllerGetOne(id) { @@ -50,7 +50,7 @@ class RunnerCardService { * Update the card whose id you provided.
Scans created via this card will still be associated with the old runner.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunnerCard - * @result ResponseRunnerCard + * @returns ResponseRunnerCard * @throws ApiError */ static async runnerCardControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class RunnerCardService { * Delete the card whose id you provided.
If no card with this id exists it will just return 204(no content).
If the card still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with by this card - please disable it instead or just remove the runner association). * @param id * @param force - * @result ResponseRunnerCard - * @result ResponseEmpty + * @returns ResponseRunnerCard + * @returns ResponseEmpty * @throws ApiError */ static async runnerCardControllerRemove(id, force) { @@ -85,7 +85,7 @@ class RunnerCardService { * Create blank cards in bulk.
Just provide the count as a query param and wait for the 200 response.
You can provide the 'returnCards' query param if you want to receive the RESPONSERUNNERCARD objects in the response. * @param count * @param returnCards - * @result ResponseEmpty + * @returns ResponseEmpty * @throws ApiError */ static async runnerCardControllerPostBlancoBulk(count, returnCards) { diff --git a/dist/services/RunnerOrganizationService.d.ts b/dist/services/RunnerOrganizationService.d.ts index 326b9fa..4d3f00f 100644 --- a/dist/services/RunnerOrganizationService.d.ts +++ b/dist/services/RunnerOrganizationService.d.ts @@ -7,7 +7,7 @@ export declare class RunnerOrganizationService { /** * Get all * Lists all organizations.
This includes their address, contact and teams (if existing/associated). - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static runnerOrganizationControllerGetAll(): Promise>; @@ -15,7 +15,7 @@ export declare class RunnerOrganizationService { * Post * Create a new organsisation. * @param requestBody CreateRunnerOrganization - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static runnerOrganizationControllerPost(requestBody?: CreateRunnerOrganization): Promise; @@ -23,7 +23,7 @@ export declare class RunnerOrganizationService { * Get one * Lists all information about the organization whose id got provided. * @param id - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static runnerOrganizationControllerGetOne(id: number): Promise; @@ -32,7 +32,7 @@ export declare class RunnerOrganizationService { * Update the organization whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunnerOrganization - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static runnerOrganizationControllerPut(id: number, requestBody?: UpdateRunnerOrganization): Promise; @@ -41,8 +41,8 @@ export declare class RunnerOrganizationService { * Delete the organsisation whose id you provided.
If the organization still has runners and/or teams associated this will fail.
To delete the organization with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while).
This won't delete the associated contact.
If no organization with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseRunnerOrganization - * @result ResponseEmpty + * @returns ResponseRunnerOrganization + * @returns ResponseEmpty * @throws ApiError */ static runnerOrganizationControllerRemove(id: number, force?: boolean): Promise; @@ -51,7 +51,7 @@ export declare class RunnerOrganizationService { * Lists all runners from this org and it's teams (if you don't provide the ?onlyDirect=true param).
This includes the runner's group and distance ran. * @param id * @param onlyDirect - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static runnerOrganizationControllerGetRunners(id: number, onlyDirect?: boolean): Promise>; diff --git a/dist/services/RunnerOrganizationService.js b/dist/services/RunnerOrganizationService.js index 78466fa..09afb4d 100644 --- a/dist/services/RunnerOrganizationService.js +++ b/dist/services/RunnerOrganizationService.js @@ -6,7 +6,7 @@ class RunnerOrganizationService { /** * Get all * Lists all organizations.
This includes their address, contact and teams (if existing/associated). - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static async runnerOrganizationControllerGetAll() { @@ -20,7 +20,7 @@ class RunnerOrganizationService { * Post * Create a new organsisation. * @param requestBody CreateRunnerOrganization - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static async runnerOrganizationControllerPost(requestBody) { @@ -35,7 +35,7 @@ class RunnerOrganizationService { * Get one * Lists all information about the organization whose id got provided. * @param id - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static async runnerOrganizationControllerGetOne(id) { @@ -50,7 +50,7 @@ class RunnerOrganizationService { * Update the organization whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunnerOrganization - * @result ResponseRunnerOrganization + * @returns ResponseRunnerOrganization * @throws ApiError */ static async runnerOrganizationControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class RunnerOrganizationService { * Delete the organsisation whose id you provided.
If the organization still has runners and/or teams associated this will fail.
To delete the organization with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while).
This won't delete the associated contact.
If no organization with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseRunnerOrganization - * @result ResponseEmpty + * @returns ResponseRunnerOrganization + * @returns ResponseEmpty * @throws ApiError */ static async runnerOrganizationControllerRemove(id, force) { @@ -85,7 +85,7 @@ class RunnerOrganizationService { * Lists all runners from this org and it's teams (if you don't provide the ?onlyDirect=true param).
This includes the runner's group and distance ran. * @param id * @param onlyDirect - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async runnerOrganizationControllerGetRunners(id, onlyDirect) { diff --git a/dist/services/RunnerSelfService.d.ts b/dist/services/RunnerSelfService.d.ts index 5326f07..1f9a9d4 100644 --- a/dist/services/RunnerSelfService.d.ts +++ b/dist/services/RunnerSelfService.d.ts @@ -9,7 +9,7 @@ export declare class RunnerSelfService { * Get * Lists all information about yourself.
Please provide your runner jwt(that code we gave you during registration) for auth.
If you lost your jwt/personalized link please use the forgot endpoint. * @param jwt - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static runnerSelfServiceControllerGet(jwt: string): Promise; @@ -18,7 +18,7 @@ export declare class RunnerSelfService { * Deletes all information about yourself.
Please provide your runner jwt(that code we gave you during registration) for auth.
If you lost your jwt/personalized link please use the forgot endpoint. * @param jwt * @param force - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static runnerSelfServiceControllerRemove(jwt: string, force?: boolean): Promise; @@ -26,14 +26,14 @@ export declare class RunnerSelfService { * Get scans * Lists all your (runner) scans.
Please provide your runner jwt(that code we gave you during registration) for auth.
If you lost your jwt/personalized link please contact support. * @param jwt - * @result ResponseSelfServiceScan + * @returns ResponseSelfServiceScan * @throws ApiError */ static runnerSelfServiceControllerGetScans(jwt: string): Promise>; /** * Get station me * Lists basic information about the station whose token got provided.
This includes it's associated track. - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static runnerSelfServiceControllerGetStationMe(): Promise; @@ -42,7 +42,7 @@ export declare class RunnerSelfService { * Use this endpoint to reuqest a new selfservice token/link to be sent to your mail address (rate limited to one mail every 24hrs). * @param mail * @param locale - * @result any Successful response + * @returns any Successful response * @throws ApiError */ static runnerSelfServiceControllerRequestNewToken(mail?: string, locale?: string): Promise; @@ -51,7 +51,7 @@ export declare class RunnerSelfService { * Create a new selfservice runner in the citizen org.
This endpoint shoud be used to allow "everyday citizen" to register themselves.
You have to provide a mail address, b/c the future we'll implement email verification. * @param locale * @param requestBody CreateSelfServiceCitizenRunner - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static runnerSelfServiceControllerRegisterRunner(locale?: string, requestBody?: CreateSelfServiceCitizenRunner): Promise; @@ -61,7 +61,7 @@ export declare class RunnerSelfService { * @param token * @param locale * @param requestBody CreateSelfServiceRunner - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static runnerSelfServiceControllerRegisterOrganizationRunner(token: string, locale?: string, requestBody?: CreateSelfServiceRunner): Promise; @@ -69,7 +69,7 @@ export declare class RunnerSelfService { * Get selfservice org * Get the basic info and teams for a org. * @param token - * @result ResponseSelfServiceOrganisation + * @returns ResponseSelfServiceOrganisation * @throws ApiError */ static runnerSelfServiceControllerGetSelfserviceOrg(token: string): Promise; diff --git a/dist/services/RunnerSelfService.js b/dist/services/RunnerSelfService.js index 5492374..20cf66d 100644 --- a/dist/services/RunnerSelfService.js +++ b/dist/services/RunnerSelfService.js @@ -7,7 +7,7 @@ class RunnerSelfService { * Get * Lists all information about yourself.
Please provide your runner jwt(that code we gave you during registration) for auth.
If you lost your jwt/personalized link please use the forgot endpoint. * @param jwt - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static async runnerSelfServiceControllerGet(jwt) { @@ -22,7 +22,7 @@ class RunnerSelfService { * Deletes all information about yourself.
Please provide your runner jwt(that code we gave you during registration) for auth.
If you lost your jwt/personalized link please use the forgot endpoint. * @param jwt * @param force - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static async runnerSelfServiceControllerRemove(jwt, force) { @@ -39,7 +39,7 @@ class RunnerSelfService { * Get scans * Lists all your (runner) scans.
Please provide your runner jwt(that code we gave you during registration) for auth.
If you lost your jwt/personalized link please contact support. * @param jwt - * @result ResponseSelfServiceScan + * @returns ResponseSelfServiceScan * @throws ApiError */ static async runnerSelfServiceControllerGetScans(jwt) { @@ -52,7 +52,7 @@ class RunnerSelfService { /** * Get station me * Lists basic information about the station whose token got provided.
This includes it's associated track. - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static async runnerSelfServiceControllerGetStationMe() { @@ -67,7 +67,7 @@ class RunnerSelfService { * Use this endpoint to reuqest a new selfservice token/link to be sent to your mail address (rate limited to one mail every 24hrs). * @param mail * @param locale - * @result any Successful response + * @returns any Successful response * @throws ApiError */ static async runnerSelfServiceControllerRequestNewToken(mail, locale) { @@ -86,7 +86,7 @@ class RunnerSelfService { * Create a new selfservice runner in the citizen org.
This endpoint shoud be used to allow "everyday citizen" to register themselves.
You have to provide a mail address, b/c the future we'll implement email verification. * @param locale * @param requestBody CreateSelfServiceCitizenRunner - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static async runnerSelfServiceControllerRegisterRunner(locale, requestBody) { @@ -106,7 +106,7 @@ class RunnerSelfService { * @param token * @param locale * @param requestBody CreateSelfServiceRunner - * @result ResponseSelfServiceRunner + * @returns ResponseSelfServiceRunner * @throws ApiError */ static async runnerSelfServiceControllerRegisterOrganizationRunner(token, locale, requestBody) { @@ -124,7 +124,7 @@ class RunnerSelfService { * Get selfservice org * Get the basic info and teams for a org. * @param token - * @result ResponseSelfServiceOrganisation + * @returns ResponseSelfServiceOrganisation * @throws ApiError */ static async runnerSelfServiceControllerGetSelfserviceOrg(token) { diff --git a/dist/services/RunnerService.d.ts b/dist/services/RunnerService.d.ts index 735b349..48684e6 100644 --- a/dist/services/RunnerService.d.ts +++ b/dist/services/RunnerService.d.ts @@ -10,7 +10,7 @@ export declare class RunnerService { /** * Get all * Lists all runners from all teams/orgs.
This includes the runner's group and distance ran. - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static runnerControllerGetAll(): Promise>; @@ -18,7 +18,7 @@ export declare class RunnerService { * Post * Create a new runner.
Please remeber to provide the runner's group's id. * @param requestBody CreateRunner - * @result any + * @returns any * @throws ApiError */ static runnerControllerPost(requestBody?: CreateRunner): Promise<(ResponseRunner | RunnerGroupNeededError | RunnerGroupNotFoundError)>; @@ -26,7 +26,7 @@ export declare class RunnerService { * Get one * Lists all information about the runner whose id got provided. * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static runnerControllerGetOne(id: number): Promise; @@ -35,7 +35,7 @@ export declare class RunnerService { * Update the runner whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static runnerControllerPut(id: number, requestBody?: UpdateRunner): Promise; @@ -44,8 +44,8 @@ export declare class RunnerService { * Delete the runner whose id you provided.
This will also delete all scans and cards associated with the runner.
If no runner with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseRunner - * @result ResponseEmpty + * @returns ResponseRunner + * @returns ResponseEmpty * @throws ApiError */ static runnerControllerRemove(id: number, force?: boolean): Promise; @@ -53,7 +53,7 @@ export declare class RunnerService { * Get scans * Lists all scans of the runner whose id got provided.
If you only want the valid scans just add the ?onlyValid=true query param. * @param id - * @result any + * @returns any * @throws ApiError */ static runnerControllerGetScans(id: number): Promise<(Array | Array)>; diff --git a/dist/services/RunnerService.js b/dist/services/RunnerService.js index 8e20171..f5b5aa4 100644 --- a/dist/services/RunnerService.js +++ b/dist/services/RunnerService.js @@ -6,7 +6,7 @@ class RunnerService { /** * Get all * Lists all runners from all teams/orgs.
This includes the runner's group and distance ran. - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async runnerControllerGetAll() { @@ -20,7 +20,7 @@ class RunnerService { * Post * Create a new runner.
Please remeber to provide the runner's group's id. * @param requestBody CreateRunner - * @result any + * @returns any * @throws ApiError */ static async runnerControllerPost(requestBody) { @@ -35,7 +35,7 @@ class RunnerService { * Get one * Lists all information about the runner whose id got provided. * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async runnerControllerGetOne(id) { @@ -50,7 +50,7 @@ class RunnerService { * Update the runner whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunner - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async runnerControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class RunnerService { * Delete the runner whose id you provided.
This will also delete all scans and cards associated with the runner.
If no runner with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseRunner - * @result ResponseEmpty + * @returns ResponseRunner + * @returns ResponseEmpty * @throws ApiError */ static async runnerControllerRemove(id, force) { @@ -84,7 +84,7 @@ class RunnerService { * Get scans * Lists all scans of the runner whose id got provided.
If you only want the valid scans just add the ?onlyValid=true query param. * @param id - * @result any + * @returns any * @throws ApiError */ static async runnerControllerGetScans(id) { diff --git a/dist/services/RunnerTeamService.d.ts b/dist/services/RunnerTeamService.d.ts index 5819fb1..69f22e3 100644 --- a/dist/services/RunnerTeamService.d.ts +++ b/dist/services/RunnerTeamService.d.ts @@ -7,7 +7,7 @@ export declare class RunnerTeamService { /** * Get all * Lists all teams.
This includes their parent organization and contact (if existing/associated). - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static runnerTeamControllerGetAll(): Promise>; @@ -15,7 +15,7 @@ export declare class RunnerTeamService { * Post * Create a new organsisation.
Please remember to provide it's parent group's id. * @param requestBody CreateRunnerTeam - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static runnerTeamControllerPost(requestBody?: CreateRunnerTeam): Promise; @@ -23,7 +23,7 @@ export declare class RunnerTeamService { * Get one * Lists all information about the team whose id got provided. * @param id - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static runnerTeamControllerGetOne(id: number): Promise; @@ -32,7 +32,7 @@ export declare class RunnerTeamService { * Update the team whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunnerTeam - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static runnerTeamControllerPut(id: number, requestBody?: UpdateRunnerTeam): Promise; @@ -41,8 +41,8 @@ export declare class RunnerTeamService { * Delete the team whose id you provided.
If the team still has runners associated this will fail.
To delete the team with all associated runners set the force QueryParam to true (cascading deletion might take a while).
This won't delete the associated contact.
If no team with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseRunnerTeam - * @result ResponseEmpty + * @returns ResponseRunnerTeam + * @returns ResponseEmpty * @throws ApiError */ static runnerTeamControllerRemove(id: number, force?: boolean): Promise; @@ -50,7 +50,7 @@ export declare class RunnerTeamService { * Get runners * Lists all runners from this team.
This includes the runner's group and distance ran. * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static runnerTeamControllerGetRunners(id: number): Promise>; diff --git a/dist/services/RunnerTeamService.js b/dist/services/RunnerTeamService.js index 2aae3ca..e57a8c2 100644 --- a/dist/services/RunnerTeamService.js +++ b/dist/services/RunnerTeamService.js @@ -6,7 +6,7 @@ class RunnerTeamService { /** * Get all * Lists all teams.
This includes their parent organization and contact (if existing/associated). - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static async runnerTeamControllerGetAll() { @@ -20,7 +20,7 @@ class RunnerTeamService { * Post * Create a new organsisation.
Please remember to provide it's parent group's id. * @param requestBody CreateRunnerTeam - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static async runnerTeamControllerPost(requestBody) { @@ -35,7 +35,7 @@ class RunnerTeamService { * Get one * Lists all information about the team whose id got provided. * @param id - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static async runnerTeamControllerGetOne(id) { @@ -50,7 +50,7 @@ class RunnerTeamService { * Update the team whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateRunnerTeam - * @result ResponseRunnerTeam + * @returns ResponseRunnerTeam * @throws ApiError */ static async runnerTeamControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class RunnerTeamService { * Delete the team whose id you provided.
If the team still has runners associated this will fail.
To delete the team with all associated runners set the force QueryParam to true (cascading deletion might take a while).
This won't delete the associated contact.
If no team with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseRunnerTeam - * @result ResponseEmpty + * @returns ResponseRunnerTeam + * @returns ResponseEmpty * @throws ApiError */ static async runnerTeamControllerRemove(id, force) { @@ -84,7 +84,7 @@ class RunnerTeamService { * Get runners * Lists all runners from this team.
This includes the runner's group and distance ran. * @param id - * @result ResponseRunner + * @returns ResponseRunner * @throws ApiError */ static async runnerTeamControllerGetRunners(id) { diff --git a/dist/services/ScanService.d.ts b/dist/services/ScanService.d.ts index 28338e3..f732db5 100644 --- a/dist/services/ScanService.d.ts +++ b/dist/services/ScanService.d.ts @@ -9,7 +9,7 @@ export declare class ScanService { /** * Get all * Lists all scans (normal or track) from all runners.
This includes the scan's runner's distance ran. - * @result any + * @returns any * @throws ApiError */ static scanControllerGetAll(): Promise<(Array | Array)>; @@ -17,7 +17,7 @@ export declare class ScanService { * Post * Create a new scan (not track scan - use /scans/trackscans instead).
Please rmemember to provide the scan's runner's id and distance. * @param requestBody CreateScan - * @result ResponseScan + * @returns ResponseScan * @throws ApiError */ static scanControllerPost(requestBody?: CreateScan): Promise; @@ -25,7 +25,7 @@ export declare class ScanService { * Get one * Lists all information about the scan whose id got provided. This includes the scan's runner's distance ran. * @param id - * @result any + * @returns any * @throws ApiError */ static scanControllerGetOne(id: number): Promise<(ResponseScan | ResponseTrackScan)>; @@ -34,7 +34,7 @@ export declare class ScanService { * Update the scan (not track scan use /scans/trackscans/:id instead) whose id you provided.
Please remember that ids can't be changed and distances must be positive. * @param id * @param requestBody UpdateScan - * @result ResponseScan + * @returns ResponseScan * @throws ApiError */ static scanControllerPut(id: number, requestBody?: UpdateScan): Promise; @@ -43,8 +43,8 @@ export declare class ScanService { * Delete the scan whose id you provided.
If no scan with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseScan - * @result ResponseEmpty + * @returns ResponseScan + * @returns ResponseEmpty * @throws ApiError */ static scanControllerRemove(id: number, force?: boolean): Promise; @@ -52,7 +52,7 @@ export declare class ScanService { * Post track scans * Create a new track scan (for "normal" scans use /scans instead).
Please remember that to provide the scan's card's station's id. * @param requestBody CreateTrackScan - * @result ResponseTrackScan + * @returns ResponseTrackScan * @throws ApiError */ static scanControllerPostTrackScans(requestBody?: CreateTrackScan): Promise; @@ -61,7 +61,7 @@ export declare class ScanService { * Update the track scan (not "normal" scan use /scans/trackscans/:id instead) whose id you provided.
Please remember that only the validity, runner and track can be changed. * @param id * @param requestBody UpdateTrackScan - * @result ResponseTrackScan + * @returns ResponseTrackScan * @throws ApiError */ static scanControllerPutTrackScan(id: number, requestBody?: UpdateTrackScan): Promise; diff --git a/dist/services/ScanService.js b/dist/services/ScanService.js index abcf2e8..bbe931c 100644 --- a/dist/services/ScanService.js +++ b/dist/services/ScanService.js @@ -6,7 +6,7 @@ class ScanService { /** * Get all * Lists all scans (normal or track) from all runners.
This includes the scan's runner's distance ran. - * @result any + * @returns any * @throws ApiError */ static async scanControllerGetAll() { @@ -20,7 +20,7 @@ class ScanService { * Post * Create a new scan (not track scan - use /scans/trackscans instead).
Please rmemember to provide the scan's runner's id and distance. * @param requestBody CreateScan - * @result ResponseScan + * @returns ResponseScan * @throws ApiError */ static async scanControllerPost(requestBody) { @@ -35,7 +35,7 @@ class ScanService { * Get one * Lists all information about the scan whose id got provided. This includes the scan's runner's distance ran. * @param id - * @result any + * @returns any * @throws ApiError */ static async scanControllerGetOne(id) { @@ -50,7 +50,7 @@ class ScanService { * Update the scan (not track scan use /scans/trackscans/:id instead) whose id you provided.
Please remember that ids can't be changed and distances must be positive. * @param id * @param requestBody UpdateScan - * @result ResponseScan + * @returns ResponseScan * @throws ApiError */ static async scanControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class ScanService { * Delete the scan whose id you provided.
If no scan with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseScan - * @result ResponseEmpty + * @returns ResponseScan + * @returns ResponseEmpty * @throws ApiError */ static async scanControllerRemove(id, force) { @@ -84,7 +84,7 @@ class ScanService { * Post track scans * Create a new track scan (for "normal" scans use /scans instead).
Please remember that to provide the scan's card's station's id. * @param requestBody CreateTrackScan - * @result ResponseTrackScan + * @returns ResponseTrackScan * @throws ApiError */ static async scanControllerPostTrackScans(requestBody) { @@ -100,7 +100,7 @@ class ScanService { * Update the track scan (not "normal" scan use /scans/trackscans/:id instead) whose id you provided.
Please remember that only the validity, runner and track can be changed. * @param id * @param requestBody UpdateTrackScan - * @result ResponseTrackScan + * @returns ResponseTrackScan * @throws ApiError */ static async scanControllerPutTrackScan(id, requestBody) { diff --git a/dist/services/ScanStationService.d.ts b/dist/services/ScanStationService.d.ts index 79ee286..43375a0 100644 --- a/dist/services/ScanStationService.d.ts +++ b/dist/services/ScanStationService.d.ts @@ -6,7 +6,7 @@ export declare class ScanStationService { /** * Get all * Lists all stations.
This includes their associated tracks. - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static scanStationControllerGetAll(): Promise>; @@ -14,7 +14,7 @@ export declare class ScanStationService { * Post * Create a new station.
Please remeber to provide the station's track's id.
Please also remember that the station key is only visibe on creation. * @param requestBody CreateScanStation - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static scanStationControllerPost(requestBody?: CreateScanStation): Promise; @@ -22,7 +22,7 @@ export declare class ScanStationService { * Get one * Lists all information about the station whose id got provided.
This includes it's associated track. * @param id - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static scanStationControllerGetOne(id: number): Promise; @@ -31,7 +31,7 @@ export declare class ScanStationService { * Update the station whose id you provided.
Please remember that only the description and enabled state can be changed. * @param id * @param requestBody UpdateScanStation - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static scanStationControllerPut(id: number, requestBody?: UpdateScanStation): Promise; @@ -40,8 +40,8 @@ export declare class ScanStationService { * Delete the station whose id you provided.
If no station with this id exists it will just return 204(no content).
If the station still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with/created by this station - please disable it instead). * @param id * @param force - * @result ResponseScanStation - * @result ResponseEmpty + * @returns ResponseScanStation + * @returns ResponseEmpty * @throws ApiError */ static scanStationControllerRemove(id: number, force?: boolean): Promise; diff --git a/dist/services/ScanStationService.js b/dist/services/ScanStationService.js index 9c5ce94..514a9b1 100644 --- a/dist/services/ScanStationService.js +++ b/dist/services/ScanStationService.js @@ -6,7 +6,7 @@ class ScanStationService { /** * Get all * Lists all stations.
This includes their associated tracks. - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static async scanStationControllerGetAll() { @@ -20,7 +20,7 @@ class ScanStationService { * Post * Create a new station.
Please remeber to provide the station's track's id.
Please also remember that the station key is only visibe on creation. * @param requestBody CreateScanStation - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static async scanStationControllerPost(requestBody) { @@ -35,7 +35,7 @@ class ScanStationService { * Get one * Lists all information about the station whose id got provided.
This includes it's associated track. * @param id - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static async scanStationControllerGetOne(id) { @@ -50,7 +50,7 @@ class ScanStationService { * Update the station whose id you provided.
Please remember that only the description and enabled state can be changed. * @param id * @param requestBody UpdateScanStation - * @result ResponseScanStation + * @returns ResponseScanStation * @throws ApiError */ static async scanStationControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class ScanStationService { * Delete the station whose id you provided.
If no station with this id exists it will just return 204(no content).
If the station still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with/created by this station - please disable it instead). * @param id * @param force - * @result ResponseScanStation - * @result ResponseEmpty + * @returns ResponseScanStation + * @returns ResponseEmpty * @throws ApiError */ static async scanStationControllerRemove(id, force) { diff --git a/dist/services/StatsClientService.d.ts b/dist/services/StatsClientService.d.ts index 29d2d0a..b917634 100644 --- a/dist/services/StatsClientService.d.ts +++ b/dist/services/StatsClientService.d.ts @@ -5,7 +5,7 @@ export declare class StatsClientService { /** * Get all * Lists all stats clients. Please remember that the key can only be viewed on creation. - * @result ResponseStatsClient + * @returns ResponseStatsClient * @throws ApiError */ static statsClientControllerGetAll(): Promise>; @@ -13,7 +13,7 @@ export declare class StatsClientService { * Post * Create a new stats client.
Please remember that the client's key will be generated automaticly and that it can only be viewed on creation. * @param requestBody CreateStatsClient - * @result ResponseStatsClient + * @returns ResponseStatsClient * @throws ApiError */ static statsClientControllerPost(requestBody?: CreateStatsClient): Promise; @@ -21,7 +21,7 @@ export declare class StatsClientService { * 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 - * @result ResponseStatsClient + * @returns ResponseStatsClient * @throws ApiError */ static statsClientControllerGetOne(id: number): Promise; @@ -30,8 +30,8 @@ export declare class StatsClientService { * Delete the stats client whose id you provided.
If no client with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseStatsClient - * @result ResponseEmpty + * @returns ResponseStatsClient + * @returns ResponseEmpty * @throws ApiError */ static statsClientControllerRemove(id: number, force?: boolean): Promise; diff --git a/dist/services/StatsClientService.js b/dist/services/StatsClientService.js index cda7a4b..07fbcb9 100644 --- a/dist/services/StatsClientService.js +++ b/dist/services/StatsClientService.js @@ -6,7 +6,7 @@ class StatsClientService { /** * Get all * Lists all stats clients. Please remember that the key can only be viewed on creation. - * @result ResponseStatsClient + * @returns ResponseStatsClient * @throws ApiError */ static async statsClientControllerGetAll() { @@ -20,7 +20,7 @@ class StatsClientService { * Post * Create a new stats client.
Please remember that the client's key will be generated automaticly and that it can only be viewed on creation. * @param requestBody CreateStatsClient - * @result ResponseStatsClient + * @returns ResponseStatsClient * @throws ApiError */ static async statsClientControllerPost(requestBody) { @@ -35,7 +35,7 @@ class StatsClientService { * 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 - * @result ResponseStatsClient + * @returns ResponseStatsClient * @throws ApiError */ static async statsClientControllerGetOne(id) { @@ -50,8 +50,8 @@ class StatsClientService { * Delete the stats client whose id you provided.
If no client with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseStatsClient - * @result ResponseEmpty + * @returns ResponseStatsClient + * @returns ResponseEmpty * @throws ApiError */ static async statsClientControllerRemove(id, force) { diff --git a/dist/services/StatsService.d.ts b/dist/services/StatsService.d.ts index 57fba52..7b758f0 100644 --- a/dist/services/StatsService.d.ts +++ b/dist/services/StatsService.d.ts @@ -6,21 +6,21 @@ export declare class StatsService { /** * Get * A very basic stats endpoint providing basic counters for a dashboard or simmilar - * @result ResponseStats + * @returns ResponseStats * @throws ApiError */ static statsControllerGet(): Promise; /** * Get top runners by distance * Returns the top ten runners by distance. - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static statsControllerGetTopRunnersByDistance(): Promise>; /** * Get top runners by donations * Returns the top ten runners by donations. - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static statsControllerGetTopRunnersByDonations(): Promise>; @@ -28,42 +28,42 @@ export declare class StatsService { * Get top runners by laptime * Returns the top ten runners by fastest laptime on your selected track (track by id). * @param track - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static statsControllerGetTopRunnersByLaptime(track?: number): Promise>; /** * Get top runners by track time * Returns the top ten fastest track times (with their runner and the runner's group). - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static statsControllerGetTopRunnersByTrackTime(): Promise>; /** * Get top teams by distance * Returns the top ten teams by distance. - * @result ResponseStatsTeam + * @returns ResponseStatsTeam * @throws ApiError */ static statsControllerGetTopTeamsByDistance(): Promise>; /** * Get top teams by donations * Returns the top ten teams by donations. - * @result ResponseStatsTeam + * @returns ResponseStatsTeam * @throws ApiError */ static statsControllerGetTopTeamsByDonations(): Promise>; /** * Get top orgs by distance * Returns the top ten organizations by distance. - * @result ResponseStatsOrgnisation + * @returns ResponseStatsOrgnisation * @throws ApiError */ static statsControllerGetTopOrgsByDistance(): Promise>; /** * Get top orgs by donations * Returns the top ten organizations by donations. - * @result ResponseStatsOrgnisation + * @returns ResponseStatsOrgnisation * @throws ApiError */ static statsControllerGetTopOrgsByDonations(): Promise>; diff --git a/dist/services/StatsService.js b/dist/services/StatsService.js index 1cbf692..d7fc733 100644 --- a/dist/services/StatsService.js +++ b/dist/services/StatsService.js @@ -6,7 +6,7 @@ class StatsService { /** * Get * A very basic stats endpoint providing basic counters for a dashboard or simmilar - * @result ResponseStats + * @returns ResponseStats * @throws ApiError */ static async statsControllerGet() { @@ -19,7 +19,7 @@ class StatsService { /** * Get top runners by distance * Returns the top ten runners by distance. - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static async statsControllerGetTopRunnersByDistance() { @@ -32,7 +32,7 @@ class StatsService { /** * Get top runners by donations * Returns the top ten runners by donations. - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static async statsControllerGetTopRunnersByDonations() { @@ -46,7 +46,7 @@ class StatsService { * Get top runners by laptime * Returns the top ten runners by fastest laptime on your selected track (track by id). * @param track - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static async statsControllerGetTopRunnersByLaptime(track) { @@ -62,7 +62,7 @@ class StatsService { /** * Get top runners by track time * Returns the top ten fastest track times (with their runner and the runner's group). - * @result ResponseStatsRunner + * @returns ResponseStatsRunner * @throws ApiError */ static async statsControllerGetTopRunnersByTrackTime() { @@ -75,7 +75,7 @@ class StatsService { /** * Get top teams by distance * Returns the top ten teams by distance. - * @result ResponseStatsTeam + * @returns ResponseStatsTeam * @throws ApiError */ static async statsControllerGetTopTeamsByDistance() { @@ -88,7 +88,7 @@ class StatsService { /** * Get top teams by donations * Returns the top ten teams by donations. - * @result ResponseStatsTeam + * @returns ResponseStatsTeam * @throws ApiError */ static async statsControllerGetTopTeamsByDonations() { @@ -101,7 +101,7 @@ class StatsService { /** * Get top orgs by distance * Returns the top ten organizations by distance. - * @result ResponseStatsOrgnisation + * @returns ResponseStatsOrgnisation * @throws ApiError */ static async statsControllerGetTopOrgsByDistance() { @@ -114,7 +114,7 @@ class StatsService { /** * Get top orgs by donations * Returns the top ten organizations by donations. - * @result ResponseStatsOrgnisation + * @returns ResponseStatsOrgnisation * @throws ApiError */ static async statsControllerGetTopOrgsByDonations() { diff --git a/dist/services/StatusService.d.ts b/dist/services/StatusService.d.ts index d783578..b923096 100644 --- a/dist/services/StatusService.d.ts +++ b/dist/services/StatusService.d.ts @@ -2,14 +2,14 @@ export declare class StatusService { /** * Get * A very basic status/health endpoint that just checks if the database connection is available.
The available information depth will be expanded later. - * @result any Successful response + * @returns any Successful response * @throws ApiError */ static statusControllerGet(): Promise; /** * Get version * A very basic endpoint that just returns the curent package version. - * @result any Successful response + * @returns any Successful response * @throws ApiError */ static statusControllerGetVersion(): Promise; diff --git a/dist/services/StatusService.js b/dist/services/StatusService.js index 068f207..41b1582 100644 --- a/dist/services/StatusService.js +++ b/dist/services/StatusService.js @@ -9,7 +9,7 @@ class StatusService { /** * Get * A very basic status/health endpoint that just checks if the database connection is available.
The available information depth will be expanded later. - * @result any Successful response + * @returns any Successful response * @throws ApiError */ static async statusControllerGet() { @@ -22,7 +22,7 @@ class StatusService { /** * Get version * A very basic endpoint that just returns the curent package version. - * @result any Successful response + * @returns any Successful response * @throws ApiError */ static async statusControllerGetVersion() { diff --git a/dist/services/TrackService.d.ts b/dist/services/TrackService.d.ts index c974848..e6feb2b 100644 --- a/dist/services/TrackService.d.ts +++ b/dist/services/TrackService.d.ts @@ -6,7 +6,7 @@ export declare class TrackService { /** * Get all * Lists all tracks. - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static trackControllerGetAll(): Promise>; @@ -14,7 +14,7 @@ export declare class TrackService { * Post * Create a new track.
Please remember that the track's distance must be greater than 0. * @param requestBody CreateTrack - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static trackControllerPost(requestBody?: CreateTrack): Promise; @@ -22,7 +22,7 @@ export declare class TrackService { * Get one * Lists all information about the track whose id got provided. * @param id - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static trackControllerGetOne(id: number): Promise; @@ -31,7 +31,7 @@ export declare class TrackService { * Update the track whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateTrack - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static trackControllerPut(id: number, requestBody?: UpdateTrack): Promise; @@ -40,8 +40,8 @@ export declare class TrackService { * Delete the track whose id you provided.
If no track with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseTrack - * @result ResponseEmpty + * @returns ResponseTrack + * @returns ResponseEmpty * @throws ApiError */ static trackControllerRemove(id: number, force?: boolean): Promise; diff --git a/dist/services/TrackService.js b/dist/services/TrackService.js index 76c3658..5ef8d0a 100644 --- a/dist/services/TrackService.js +++ b/dist/services/TrackService.js @@ -6,7 +6,7 @@ class TrackService { /** * Get all * Lists all tracks. - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static async trackControllerGetAll() { @@ -20,7 +20,7 @@ class TrackService { * Post * Create a new track.
Please remember that the track's distance must be greater than 0. * @param requestBody CreateTrack - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static async trackControllerPost(requestBody) { @@ -35,7 +35,7 @@ class TrackService { * Get one * Lists all information about the track whose id got provided. * @param id - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static async trackControllerGetOne(id) { @@ -50,7 +50,7 @@ class TrackService { * Update the track whose id you provided.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateTrack - * @result ResponseTrack + * @returns ResponseTrack * @throws ApiError */ static async trackControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class TrackService { * Delete the track whose id you provided.
If no track with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseTrack - * @result ResponseEmpty + * @returns ResponseTrack + * @returns ResponseEmpty * @throws ApiError */ static async trackControllerRemove(id, force) { diff --git a/dist/services/UserGroupService.d.ts b/dist/services/UserGroupService.d.ts index c343dcb..570ce18 100644 --- a/dist/services/UserGroupService.d.ts +++ b/dist/services/UserGroupService.d.ts @@ -9,7 +9,7 @@ export declare class UserGroupService { /** * Get all * Lists all groups.
The information provided might change while the project continues to evolve. - * @result ResponseUserGroup + * @returns ResponseUserGroup * @throws ApiError */ static userGroupControllerGetAll(): Promise>; @@ -17,7 +17,7 @@ export declare class UserGroupService { * Post * Create a new group.
If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group. * @param requestBody CreateUserGroup - * @result any + * @returns any * @throws ApiError */ static userGroupControllerPost(requestBody?: CreateUserGroup): Promise<(UserGroup | UserGroupNotFoundError)>; @@ -25,7 +25,7 @@ export declare class UserGroupService { * Get one * Lists all information about the group whose id got provided.
The information provided might change while the project continues to evolve. * @param id - * @result ResponseUserGroup + * @returns ResponseUserGroup * @throws ApiError */ static userGroupControllerGetOne(id: number): Promise; @@ -34,7 +34,7 @@ export declare class UserGroupService { * Update the group whose id you provided.
To change the permissions granted to the group please use /api/permissions instead.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateUserGroup - * @result UserGroup + * @returns UserGroup * @throws ApiError */ static userGroupControllerPut(id: number, requestBody?: UpdateUserGroup): Promise; @@ -43,8 +43,8 @@ export declare class UserGroupService { * Delete the group whose id you provided.
If there are any permissions directly granted to the group they will get deleted as well.
Users associated with this group won't get deleted - just deassociated.
If no group with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseUserGroup - * @result ResponseEmpty + * @returns ResponseUserGroup + * @returns ResponseEmpty * @throws ApiError */ static userGroupControllerRemove(id: number, force?: boolean): Promise; @@ -52,7 +52,7 @@ export declare class UserGroupService { * Get permissions * Lists all permissions granted to the group as permission response objects. * @param id - * @result ResponseUserGroupPermissions + * @returns ResponseUserGroupPermissions * @throws ApiError */ static userGroupControllerGetPermissions(id: number): Promise; diff --git a/dist/services/UserGroupService.js b/dist/services/UserGroupService.js index 36d41e6..2c8fa0c 100644 --- a/dist/services/UserGroupService.js +++ b/dist/services/UserGroupService.js @@ -6,7 +6,7 @@ class UserGroupService { /** * Get all * Lists all groups.
The information provided might change while the project continues to evolve. - * @result ResponseUserGroup + * @returns ResponseUserGroup * @throws ApiError */ static async userGroupControllerGetAll() { @@ -20,7 +20,7 @@ class UserGroupService { * Post * Create a new group.
If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group. * @param requestBody CreateUserGroup - * @result any + * @returns any * @throws ApiError */ static async userGroupControllerPost(requestBody) { @@ -35,7 +35,7 @@ class UserGroupService { * Get one * Lists all information about the group whose id got provided.
The information provided might change while the project continues to evolve. * @param id - * @result ResponseUserGroup + * @returns ResponseUserGroup * @throws ApiError */ static async userGroupControllerGetOne(id) { @@ -50,7 +50,7 @@ class UserGroupService { * Update the group whose id you provided.
To change the permissions granted to the group please use /api/permissions instead.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateUserGroup - * @result UserGroup + * @returns UserGroup * @throws ApiError */ static async userGroupControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class UserGroupService { * Delete the group whose id you provided.
If there are any permissions directly granted to the group they will get deleted as well.
Users associated with this group won't get deleted - just deassociated.
If no group with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseUserGroup - * @result ResponseEmpty + * @returns ResponseUserGroup + * @returns ResponseEmpty * @throws ApiError */ static async userGroupControllerRemove(id, force) { @@ -84,7 +84,7 @@ class UserGroupService { * Get permissions * Lists all permissions granted to the group as permission response objects. * @param id - * @result ResponseUserGroupPermissions + * @returns ResponseUserGroupPermissions * @throws ApiError */ static async userGroupControllerGetPermissions(id) { diff --git a/dist/services/UserService.d.ts b/dist/services/UserService.d.ts index 8a8bcb7..2eed7ca 100644 --- a/dist/services/UserService.d.ts +++ b/dist/services/UserService.d.ts @@ -6,7 +6,7 @@ export declare class UserService { /** * Get all * Lists all users.
This includes their groups and permissions granted to them. - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static userControllerGetAll(): Promise>; @@ -14,7 +14,7 @@ export declare class UserService { * Post * Create a new user.
If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user. * @param requestBody CreateUser - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static userControllerPost(requestBody?: CreateUser): Promise; @@ -22,7 +22,7 @@ export declare class UserService { * Get one * Lists all information about the user whose id got provided.
Please remember that all permissions granted to the user will show up here. * @param id - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static userControllerGetOne(id: number): Promise; @@ -31,7 +31,7 @@ export declare class UserService { * Update the user whose id you provided.
To change the permissions directly granted to the user please use /api/permissions instead.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateUser - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static userControllerPut(id: number, requestBody?: UpdateUser): Promise; @@ -40,8 +40,8 @@ export declare class UserService { * Delete the user whose id you provided.
You have to confirm your decision by providing the ?force=true query param.
If there are any permissions directly granted to the user they will get deleted as well.
If no user with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseUser - * @result ResponseEmpty + * @returns ResponseUser + * @returns ResponseEmpty * @throws ApiError */ static userControllerRemove(id: number, force?: boolean): Promise; @@ -49,7 +49,7 @@ export declare class UserService { * Get permissions * Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects. * @param id - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static userControllerGetPermissions(id: number): Promise; diff --git a/dist/services/UserService.js b/dist/services/UserService.js index 3a39c41..663f449 100644 --- a/dist/services/UserService.js +++ b/dist/services/UserService.js @@ -6,7 +6,7 @@ class UserService { /** * Get all * Lists all users.
This includes their groups and permissions granted to them. - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async userControllerGetAll() { @@ -20,7 +20,7 @@ class UserService { * Post * Create a new user.
If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user. * @param requestBody CreateUser - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async userControllerPost(requestBody) { @@ -35,7 +35,7 @@ class UserService { * Get one * Lists all information about the user whose id got provided.
Please remember that all permissions granted to the user will show up here. * @param id - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async userControllerGetOne(id) { @@ -50,7 +50,7 @@ class UserService { * Update the user whose id you provided.
To change the permissions directly granted to the user please use /api/permissions instead.
Please remember that ids can't be changed. * @param id * @param requestBody UpdateUser - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async userControllerPut(id, requestBody) { @@ -66,8 +66,8 @@ class UserService { * Delete the user whose id you provided.
You have to confirm your decision by providing the ?force=true query param.
If there are any permissions directly granted to the user they will get deleted as well.
If no user with this id exists it will just return 204(no content). * @param id * @param force - * @result ResponseUser - * @result ResponseEmpty + * @returns ResponseUser + * @returns ResponseEmpty * @throws ApiError */ static async userControllerRemove(id, force) { @@ -84,7 +84,7 @@ class UserService { * Get permissions * Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects. * @param id - * @result ResponseUser + * @returns ResponseUser * @throws ApiError */ static async userControllerGetPermissions(id) { diff --git a/package.json b/package.json index 1b27022..285c8d7 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ ], "author": "ODIT.Services", "files": [ - "**/dist", + "dist", "package.json", "README.md" ],