🚀New lib version v0.3.0 [CI SKIP]
continuous-integration/drone Build is passing Details

This commit is contained in:
Nicolai Ort 2021-01-24 18:01:44 +00:00
parent 232cc74190
commit d4d6b713e2
54 changed files with 238 additions and 143 deletions

View File

@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
exports.OpenAPI = void 0;
exports.OpenAPI = {
BASE: '',
VERSION: '0.2.1',
VERSION: '0.3.0',
WITH_CREDENTIALS: false,
TOKEN: undefined,
USERNAME: undefined,

23
dist/index.d.ts vendored
View File

@ -18,10 +18,12 @@ export type { CreateResetToken } from './models/CreateResetToken';
export type { CreateRunner } from './models/CreateRunner';
export type { CreateRunnerCard } from './models/CreateRunnerCard';
export type { CreateRunnerGroup } from './models/CreateRunnerGroup';
export type { CreateRunnerOrganisation } from './models/CreateRunnerOrganisation';
export type { CreateRunnerOrganization } from './models/CreateRunnerOrganization';
export type { CreateRunnerTeam } from './models/CreateRunnerTeam';
export type { CreateScan } from './models/CreateScan';
export type { CreateScanStation } from './models/CreateScanStation';
export type { CreateSelfServiceCitizenRunner } from './models/CreateSelfServiceCitizenRunner';
export type { CreateSelfServiceRunner } from './models/CreateSelfServiceRunner';
export type { CreateStatsClient } from './models/CreateStatsClient';
export type { CreateTrack } from './models/CreateTrack';
export type { CreateTrackScan } from './models/CreateTrackScan';
@ -74,7 +76,7 @@ export type { ResponsePrincipal } from './models/ResponsePrincipal';
export type { ResponseRunner } from './models/ResponseRunner';
export type { ResponseRunnerCard } from './models/ResponseRunnerCard';
export type { ResponseRunnerGroup } from './models/ResponseRunnerGroup';
export type { ResponseRunnerOrganisation } from './models/ResponseRunnerOrganisation';
export type { ResponseRunnerOrganization } from './models/ResponseRunnerOrganization';
export type { ResponseRunnerTeam } from './models/ResponseRunnerTeam';
export type { ResponseScan } from './models/ResponseScan';
export type { ResponseScanStation } from './models/ResponseScanStation';
@ -96,18 +98,19 @@ export type { RunnerCardHasScansError } from './models/RunnerCardHasScansError';
export type { RunnerCardIdOutOfRangeError } from './models/RunnerCardIdOutOfRangeError';
export type { RunnerCardIdsNotMatchingError } from './models/RunnerCardIdsNotMatchingError';
export type { RunnerCardNotFoundError } from './models/RunnerCardNotFoundError';
export type { RunnerEmailNeededError } from './models/RunnerEmailNeededError';
export type { RunnerGroup } from './models/RunnerGroup';
export type { RunnerGroupNeededError } from './models/RunnerGroupNeededError';
export type { RunnerGroupNotFoundError } from './models/RunnerGroupNotFoundError';
export type { RunnerHasDistanceDonationsError } from './models/RunnerHasDistanceDonationsError';
export type { RunnerIdsNotMatchingError } from './models/RunnerIdsNotMatchingError';
export type { RunnerNotFoundError } from './models/RunnerNotFoundError';
export type { RunnerOrganisation } from './models/RunnerOrganisation';
export type { RunnerOrganisationHasRunnersError } from './models/RunnerOrganisationHasRunnersError';
export type { RunnerOrganisationHasTeamsError } from './models/RunnerOrganisationHasTeamsError';
export type { RunnerOrganisationIdsNotMatchingError } from './models/RunnerOrganisationIdsNotMatchingError';
export type { RunnerOrganisationNotFoundError } from './models/RunnerOrganisationNotFoundError';
export type { RunnerOrganisationWrongTypeError } from './models/RunnerOrganisationWrongTypeError';
export type { RunnerOrganization } from './models/RunnerOrganization';
export type { RunnerOrganizationHasRunnersError } from './models/RunnerOrganizationHasRunnersError';
export type { RunnerOrganizationHasTeamsError } from './models/RunnerOrganizationHasTeamsError';
export type { RunnerOrganizationIdsNotMatchingError } from './models/RunnerOrganizationIdsNotMatchingError';
export type { RunnerOrganizationNotFoundError } from './models/RunnerOrganizationNotFoundError';
export type { RunnerOrganizationWrongTypeError } from './models/RunnerOrganizationWrongTypeError';
export type { RunnerTeam } from './models/RunnerTeam';
export type { RunnerTeamHasRunnersError } from './models/RunnerTeamHasRunnersError';
export type { RunnerTeamIdsNotMatchingError } from './models/RunnerTeamIdsNotMatchingError';
@ -137,7 +140,7 @@ export type { UpdateGroupContact } from './models/UpdateGroupContact';
export type { UpdatePermission } from './models/UpdatePermission';
export type { UpdateRunner } from './models/UpdateRunner';
export type { UpdateRunnerCard } from './models/UpdateRunnerCard';
export type { UpdateRunnerOrganisation } from './models/UpdateRunnerOrganisation';
export type { UpdateRunnerOrganization } from './models/UpdateRunnerOrganization';
export type { UpdateRunnerTeam } from './models/UpdateRunnerTeam';
export type { UpdateScan } from './models/UpdateScan';
export type { UpdateScanStation } from './models/UpdateScanStation';
@ -167,7 +170,7 @@ export { ImportService } from './services/ImportService';
export { MeService } from './services/MeService';
export { PermissionService } from './services/PermissionService';
export { RunnerCardService } from './services/RunnerCardService';
export { RunnerOrganisationService } from './services/RunnerOrganisationService';
export { RunnerOrganizationService } from './services/RunnerOrganizationService';
export { RunnerSelfService } from './services/RunnerSelfService';
export { RunnerService } from './services/RunnerService';
export { RunnerTeamService } from './services/RunnerTeamService';

6
dist/index.js vendored
View File

@ -1,6 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserService = exports.UserGroupService = exports.TrackService = exports.StatusService = exports.StatsService = exports.StatsClientService = exports.ScanStationService = exports.ScanService = exports.RunnerTeamService = exports.RunnerService = exports.RunnerSelfService = exports.RunnerOrganisationService = exports.RunnerCardService = exports.PermissionService = exports.MeService = exports.ImportService = exports.GroupContactService = exports.DonorService = exports.DonationService = exports.AuthService = exports.UserAction = exports.ResponsePermission = exports.Permission = exports.CreatePermission = exports.OpenAPI = exports.ApiError = void 0;
exports.UserService = exports.UserGroupService = exports.TrackService = exports.StatusService = exports.StatsService = exports.StatsClientService = exports.ScanStationService = exports.ScanService = exports.RunnerTeamService = exports.RunnerService = exports.RunnerSelfService = exports.RunnerOrganizationService = exports.RunnerCardService = exports.PermissionService = exports.MeService = exports.ImportService = exports.GroupContactService = exports.DonorService = exports.DonationService = exports.AuthService = exports.UserAction = exports.ResponsePermission = exports.Permission = exports.CreatePermission = exports.OpenAPI = exports.ApiError = void 0;
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
@ -32,8 +32,8 @@ var PermissionService_1 = require("./services/PermissionService");
Object.defineProperty(exports, "PermissionService", { enumerable: true, get: function () { return PermissionService_1.PermissionService; } });
var RunnerCardService_1 = require("./services/RunnerCardService");
Object.defineProperty(exports, "RunnerCardService", { enumerable: true, get: function () { return RunnerCardService_1.RunnerCardService; } });
var RunnerOrganisationService_1 = require("./services/RunnerOrganisationService");
Object.defineProperty(exports, "RunnerOrganisationService", { enumerable: true, get: function () { return RunnerOrganisationService_1.RunnerOrganisationService; } });
var RunnerOrganizationService_1 = require("./services/RunnerOrganizationService");
Object.defineProperty(exports, "RunnerOrganizationService", { enumerable: true, get: function () { return RunnerOrganizationService_1.RunnerOrganizationService; } });
var RunnerSelfService_1 = require("./services/RunnerSelfService");
Object.defineProperty(exports, "RunnerSelfService", { enumerable: true, get: function () { return RunnerSelfService_1.RunnerSelfService; } });
var RunnerService_1 = require("./services/RunnerService");

View File

@ -6,7 +6,7 @@ export declare type CreatePermission = {
export declare namespace CreatePermission {
enum target {
RUNNER = "RUNNER",
ORGANISATION = "ORGANISATION",
ORGANIZATION = "ORGANIZATION",
TEAM = "TEAM",
TRACK = "TRACK",
USER = "USER",

View File

@ -9,7 +9,7 @@ var CreatePermission;
let target;
(function (target) {
target["RUNNER"] = "RUNNER";
target["ORGANISATION"] = "ORGANISATION";
target["ORGANIZATION"] = "ORGANIZATION";
target["TEAM"] = "TEAM";
target["TRACK"] = "TRACK";
target["USER"] = "USER";

View File

@ -1,5 +0,0 @@
export declare type CreateRunnerOrganisation = {
address?: any;
name: string;
contact?: number;
};

View File

@ -0,0 +1,6 @@
export declare type CreateRunnerOrganization = {
address?: any;
registrationEnabled?: boolean;
name: string;
contact?: number;
};

View File

@ -0,0 +1,8 @@
export declare type CreateSelfServiceCitizenRunner = {
email?: string;
firstname: string;
middlename?: string;
lastname: string;
phone?: string;
address?: any;
};

View File

@ -0,0 +1,9 @@
export declare type CreateSelfServiceRunner = {
team?: number;
firstname: string;
middlename?: string;
lastname: string;
phone?: string;
email?: string;
address?: any;
};

View File

@ -6,7 +6,7 @@ export declare type Permission = {
export declare namespace Permission {
enum target {
RUNNER = "RUNNER",
ORGANISATION = "ORGANISATION",
ORGANIZATION = "ORGANIZATION",
TEAM = "TEAM",
TRACK = "TRACK",
USER = "USER",

View File

@ -9,7 +9,7 @@ var Permission;
let target;
(function (target) {
target["RUNNER"] = "RUNNER";
target["ORGANISATION"] = "ORGANISATION";
target["ORGANIZATION"] = "ORGANIZATION";
target["TEAM"] = "TEAM";
target["TRACK"] = "TRACK";
target["USER"] = "USER";

View File

@ -7,7 +7,7 @@ export declare type ResponsePermission = {
export declare namespace ResponsePermission {
enum target {
RUNNER = "RUNNER",
ORGANISATION = "ORGANISATION",
ORGANIZATION = "ORGANIZATION",
TEAM = "TEAM",
TRACK = "TRACK",
USER = "USER",

View File

@ -9,7 +9,7 @@ var ResponsePermission;
let target;
(function (target) {
target["RUNNER"] = "RUNNER";
target["ORGANISATION"] = "ORGANISATION";
target["ORGANIZATION"] = "ORGANIZATION";
target["TEAM"] = "TEAM";
target["TRACK"] = "TRACK";
target["USER"] = "USER";

View File

@ -1,7 +0,0 @@
export declare type ResponseRunnerOrganisation = {
address?: any;
teams: Array<any>;
id: number;
name: string;
contact?: any;
};

View File

@ -0,0 +1,9 @@
export declare type ResponseRunnerOrganization = {
address?: any;
teams: Array<any>;
registrationKey?: string;
registrationEnabled?: boolean;
id: number;
name: string;
contact?: any;
};

View File

@ -3,6 +3,7 @@ export declare type ResponseSelfServiceRunner = {
donationAmount: number;
group: string;
donations: string;
token?: string;
id: number;
firstname: string;
middlename: string;

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,5 +1,6 @@
export declare type RunnerOrganisation = {
export declare type RunnerOrganization = {
address?: any;
key?: string;
distance: number;
distanceDonationAmount: number;
id: number;

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,6 +0,0 @@
export declare type UpdateRunnerOrganisation = {
id: number;
address?: any;
name: string;
contact?: number;
};

View File

@ -0,0 +1,7 @@
export declare type UpdateRunnerOrganization = {
id: number;
address?: any;
registrationEnabled?: boolean;
name: string;
contact?: number;
};

View File

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

View File

@ -33,7 +33,7 @@ class ImportService {
static async importControllerPostOrgsJson(id, requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/organisations/${id}/import`,
path: `/api/organizations/${id}/import`,
body: requestBody,
});
return result.body;
@ -81,7 +81,7 @@ class ImportService {
static async importControllerPostOrgsCsv(id) {
const result = await request_1.request({
method: 'POST',
path: `/api/organisations/${id}/import/csv`,
path: `/api/organizations/${id}/import/csv`,
});
return result.body;
}

View File

@ -1,48 +0,0 @@
import type { CreateRunnerOrganisation } from '../models/CreateRunnerOrganisation';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseRunnerOrganisation } from '../models/ResponseRunnerOrganisation';
import type { UpdateRunnerOrganisation } from '../models/UpdateRunnerOrganisation';
export declare class RunnerOrganisationService {
/**
* Get all
* Lists all organisations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerGetAll(): Promise<Array<ResponseRunnerOrganisation>>;
/**
* Post
* Create a new organsisation.
* @param requestBody CreateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerPost(requestBody?: CreateRunnerOrganisation): Promise<ResponseRunnerOrganisation>;
/**
* Get one
* Lists all information about the organisation whose id got provided.
* @param id
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerGetOne(id: number): Promise<ResponseRunnerOrganisation>;
/**
* Put
* Update the organisation whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerPut(id: number, requestBody?: UpdateRunnerOrganisation): Promise<ResponseRunnerOrganisation>;
/**
* Remove
* Delete the organsisation whose id you provided. <br> If the organisation still has runners and/or teams associated this will fail. <br> To delete the organisation with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> This won't delete the associated contact. <br> If no organisation with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerOrganisation
* @returns ResponseEmpty
* @throws ApiError
*/
static runnerOrganisationControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerOrganisation | ResponseEmpty>;
}

View File

@ -0,0 +1,48 @@
import type { CreateRunnerOrganization } from '../models/CreateRunnerOrganization';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseRunnerOrganization } from '../models/ResponseRunnerOrganization';
import type { UpdateRunnerOrganization } from '../models/UpdateRunnerOrganization';
export declare class RunnerOrganizationService {
/**
* Get all
* Lists all organizations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerGetAll(): Promise<Array<ResponseRunnerOrganization>>;
/**
* Post
* Create a new organsisation.
* @param requestBody CreateRunnerOrganization
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerPost(requestBody?: CreateRunnerOrganization): Promise<ResponseRunnerOrganization>;
/**
* Get one
* Lists all information about the organization whose id got provided.
* @param id
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerGetOne(id: number): Promise<ResponseRunnerOrganization>;
/**
* Put
* Update the organization whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganization
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerPut(id: number, requestBody?: UpdateRunnerOrganization): Promise<ResponseRunnerOrganization>;
/**
* Remove
* Delete the organsisation whose id you provided. <br> If the organization still has runners and/or teams associated this will fail. <br> To delete the organization with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> This won't delete the associated contact. <br> If no organization with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerOrganization
* @returns ResponseEmpty
* @throws ApiError
*/
static runnerOrganizationControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerOrganization | ResponseEmpty>;
}

View File

@ -1,79 +1,79 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RunnerOrganisationService = void 0;
exports.RunnerOrganizationService = void 0;
const request_1 = require("../core/request");
class RunnerOrganisationService {
class RunnerOrganizationService {
/**
* Get all
* Lists all organisations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganisation
* Lists all organizations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganisationControllerGetAll() {
static async runnerOrganizationControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/organisations`,
path: `/api/organizations`,
});
return result.body;
}
/**
* Post
* Create a new organsisation.
* @param requestBody CreateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @param requestBody CreateRunnerOrganization
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganisationControllerPost(requestBody) {
static async runnerOrganizationControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/organisations`,
path: `/api/organizations`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the organisation whose id got provided.
* Lists all information about the organization whose id got provided.
* @param id
* @returns ResponseRunnerOrganisation
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganisationControllerGetOne(id) {
static async runnerOrganizationControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/organisations/${id}`,
path: `/api/organizations/${id}`,
});
return result.body;
}
/**
* Put
* Update the organisation whose id you provided. <br> Please remember that ids can't be changed.
* Update the organization whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @param requestBody UpdateRunnerOrganization
* @returns ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganisationControllerPut(id, requestBody) {
static async runnerOrganizationControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/organisations/${id}`,
path: `/api/organizations/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* Delete the organsisation whose id you provided. <br> If the organisation still has runners and/or teams associated this will fail. <br> To delete the organisation with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> This won't delete the associated contact. <br> If no organisation with this id exists it will just return 204(no content).
* Delete the organsisation whose id you provided. <br> If the organization still has runners and/or teams associated this will fail. <br> To delete the organization with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> This won't delete the associated contact. <br> If no organization with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerOrganisation
* @returns ResponseRunnerOrganization
* @returns ResponseEmpty
* @throws ApiError
*/
static async runnerOrganisationControllerRemove(id, force) {
static async runnerOrganizationControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/organisations/${id}`,
path: `/api/organizations/${id}`,
query: {
'force': force,
},
@ -81,4 +81,4 @@ class RunnerOrganisationService {
return result.body;
}
}
exports.RunnerOrganisationService = RunnerOrganisationService;
exports.RunnerOrganizationService = RunnerOrganizationService;

View File

@ -1,3 +1,5 @@
import type { CreateSelfServiceCitizenRunner } from '../models/CreateSelfServiceCitizenRunner';
import type { CreateSelfServiceRunner } from '../models/CreateSelfServiceRunner';
import type { ResponseSelfServiceRunner } from '../models/ResponseSelfServiceRunner';
export declare class RunnerSelfService {
/**
@ -8,4 +10,21 @@ export declare class RunnerSelfService {
* @throws ApiError
*/
static runnerSelfServiceControllerGet(jwt: string): Promise<ResponseSelfServiceRunner>;
/**
* Register runner
* Create a new selfservice runner in the citizen org. <br> This endpoint shoud be used to allow "everyday citizen" to register themselves. <br> You have to provide a mail address, b/c the future we'll implement email verification.
* @param requestBody CreateSelfServiceCitizenRunner
* @returns ResponseSelfServiceRunner
* @throws ApiError
*/
static runnerSelfServiceControllerRegisterRunner(requestBody?: CreateSelfServiceCitizenRunner): Promise<ResponseSelfServiceRunner>;
/**
* Register organization runner
* Create a new selfservice runner in a provided org. <br> The orgs get provided and authorized via api tokens that can be optained via the /organizations endpoint.
* @param token
* @param requestBody CreateSelfServiceRunner
* @returns ResponseSelfServiceRunner
* @throws ApiError
*/
static runnerSelfServiceControllerRegisterOrganizationRunner(token: string, requestBody?: CreateSelfServiceRunner): Promise<ResponseSelfServiceRunner>;
}

View File

@ -17,5 +17,36 @@ class RunnerSelfService {
});
return result.body;
}
/**
* Register runner
* Create a new selfservice runner in the citizen org. <br> This endpoint shoud be used to allow "everyday citizen" to register themselves. <br> You have to provide a mail address, b/c the future we'll implement email verification.
* @param requestBody CreateSelfServiceCitizenRunner
* @returns ResponseSelfServiceRunner
* @throws ApiError
*/
static async runnerSelfServiceControllerRegisterRunner(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/runners/register`,
body: requestBody,
});
return result.body;
}
/**
* Register organization runner
* Create a new selfservice runner in a provided org. <br> The orgs get provided and authorized via api tokens that can be optained via the /organizations endpoint.
* @param token
* @param requestBody CreateSelfServiceRunner
* @returns ResponseSelfServiceRunner
* @throws ApiError
*/
static async runnerSelfServiceControllerRegisterOrganizationRunner(token, requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/runners/register/${token}`,
body: requestBody,
});
return result.body;
}
}
exports.RunnerSelfService = RunnerSelfService;

View File

@ -5,7 +5,7 @@ import type { UpdateRunnerTeam } from '../models/UpdateRunnerTeam';
export declare class RunnerTeamService {
/**
* Get all
* Lists all teams. <br> This includes their parent organisation and contact (if existing/associated).
* Lists all teams. <br> This includes their parent organization and contact (if existing/associated).
* @returns ResponseRunnerTeam
* @throws ApiError
*/

View File

@ -5,7 +5,7 @@ const request_1 = require("../core/request");
class RunnerTeamService {
/**
* Get all
* Lists all teams. <br> This includes their parent organisation and contact (if existing/associated).
* Lists all teams. <br> This includes their parent organization and contact (if existing/associated).
* @returns ResponseRunnerTeam
* @throws ApiError
*/

View File

@ -47,14 +47,14 @@ export declare class StatsService {
static statsControllerGetTopTeamsByDonations(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top orgs by distance
* Returns the top ten organisations by distance.
* Returns the top ten organizations by distance.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDistance(): Promise<Array<ResponseStatsOrgnisation>>;
/**
* Get top orgs by donations
* Returns the top ten organisations by donations.
* Returns the top ten organizations by donations.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/

View File

@ -83,27 +83,27 @@ class StatsService {
}
/**
* Get top orgs by distance
* Returns the top ten organisations by distance.
* Returns the top ten organizations by distance.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static async statsControllerGetTopOrgsByDistance() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/organisations/distance`,
path: `/api/stats/organizations/distance`,
});
return result.body;
}
/**
* Get top orgs by donations
* Returns the top ten organisations by donations.
* Returns the top ten organizations by donations.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static async statsControllerGetTopOrgsByDonations() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/organisations/donations`,
path: `/api/stats/organizations/donations`,
});
return result.body;
}

File diff suppressed because one or more lines are too long

View File

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