🚀New lib version v1.0.0 [CI SKIP]
continuous-integration/drone Build is passing
Details
continuous-integration/drone Build is passing
Details
This commit is contained in:
parent
a014e77edf
commit
f4905b8df6
|
@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|||
exports.OpenAPI = void 0;
|
||||
exports.OpenAPI = {
|
||||
BASE: '',
|
||||
VERSION: '0.15.4',
|
||||
VERSION: '1.0.0',
|
||||
WITH_CREDENTIALS: false,
|
||||
TOKEN: undefined,
|
||||
USERNAME: undefined,
|
||||
|
|
|
@ -9,10 +9,12 @@ export declare class DonationService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all donations (fixed or distance based) from all donors. <br> This includes the donations's runner's distance ran(if distance donation).
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result any
|
||||
* @throws ApiError
|
||||
*/
|
||||
static donationControllerGetAll(): Promise<(Array<ResponseDonation> | Array<ResponseDistanceDonation>)>;
|
||||
static donationControllerGetAll(page?: number, pageSize?: number): Promise<(Array<ResponseDonation> | Array<ResponseDistanceDonation>)>;
|
||||
/**
|
||||
* Get one
|
||||
* Lists all information about the donation whose id got provided. This includes the donation's runner's distance ran (if distance donation).
|
||||
|
|
|
@ -6,13 +6,19 @@ class DonationService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all donations (fixed or distance based) from all donors. <br> This includes the donations's runner's distance ran(if distance donation).
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result any
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async donationControllerGetAll() {
|
||||
static async donationControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/donations`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -6,10 +6,12 @@ export declare class DonorService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all donor. <br> This includes the donor's current donation amount.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseDonor
|
||||
* @throws ApiError
|
||||
*/
|
||||
static donorControllerGetAll(): Promise<Array<ResponseDonor>>;
|
||||
static donorControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseDonor>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new donor.
|
||||
|
|
|
@ -6,13 +6,19 @@ class DonorService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all donor. <br> This includes the donor's current donation amount.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseDonor
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async donorControllerGetAll() {
|
||||
static async donorControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/donors`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -6,10 +6,12 @@ export declare class GroupContactService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all contacts. <br> This includes the contact's associated groups.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseGroupContact
|
||||
* @throws ApiError
|
||||
*/
|
||||
static groupContactControllerGetAll(): Promise<Array<ResponseGroupContact>>;
|
||||
static groupContactControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseGroupContact>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new contact.
|
||||
|
|
|
@ -6,13 +6,19 @@ class GroupContactService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all contacts. <br> This includes the contact's associated groups.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseGroupContact
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async groupContactControllerGetAll() {
|
||||
static async groupContactControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/contacts`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -7,10 +7,12 @@ export declare class PermissionService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all permissions for all users and groups.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponsePermission
|
||||
* @throws ApiError
|
||||
*/
|
||||
static permissionControllerGetAll(): Promise<Array<ResponsePermission>>;
|
||||
static permissionControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponsePermission>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new permission for a existing principal(user/group). <br> If a permission with this target, action and prinicpal already exists that permission will be returned instead of creating a new one.
|
||||
|
|
|
@ -6,13 +6,19 @@ class PermissionService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all permissions for all users and groups.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponsePermission
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async permissionControllerGetAll() {
|
||||
static async permissionControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/permissions`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -6,10 +6,12 @@ export declare class RunnerCardService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all card.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunnerCard
|
||||
* @throws ApiError
|
||||
*/
|
||||
static runnerCardControllerGetAll(): Promise<Array<ResponseRunnerCard>>;
|
||||
static runnerCardControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseRunnerCard>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new card. <br> You can provide a associated runner by id but you don't have to.
|
||||
|
|
|
@ -6,13 +6,19 @@ class RunnerCardService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all card.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunnerCard
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async runnerCardControllerGetAll() {
|
||||
static async runnerCardControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/cards`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -7,10 +7,12 @@ export declare class RunnerOrganizationService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all organizations. <br> This includes their address, contact and teams (if existing/associated).
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunnerOrganization
|
||||
* @throws ApiError
|
||||
*/
|
||||
static runnerOrganizationControllerGetAll(): Promise<Array<ResponseRunnerOrganization>>;
|
||||
static runnerOrganizationControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseRunnerOrganization>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new organsisation.
|
||||
|
|
|
@ -6,13 +6,19 @@ class RunnerOrganizationService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all organizations. <br> This includes their address, contact and teams (if existing/associated).
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunnerOrganization
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async runnerOrganizationControllerGetAll() {
|
||||
static async runnerOrganizationControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/organizations`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -10,10 +10,12 @@ export declare class RunnerService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunner
|
||||
* @throws ApiError
|
||||
*/
|
||||
static runnerControllerGetAll(): Promise<Array<ResponseRunner>>;
|
||||
static runnerControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseRunner>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new runner. <br> Please remeber to provide the runner's group's id.
|
||||
|
|
|
@ -6,13 +6,19 @@ class RunnerService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunner
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async runnerControllerGetAll() {
|
||||
static async runnerControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/runners`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -7,10 +7,12 @@ export declare class RunnerTeamService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all teams. <br> This includes their parent organization and contact (if existing/associated).
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunnerTeam
|
||||
* @throws ApiError
|
||||
*/
|
||||
static runnerTeamControllerGetAll(): Promise<Array<ResponseRunnerTeam>>;
|
||||
static runnerTeamControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseRunnerTeam>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new organsisation. <br> Please remember to provide it's parent group's id.
|
||||
|
|
|
@ -6,13 +6,19 @@ class RunnerTeamService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all teams. <br> This includes their parent organization and contact (if existing/associated).
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseRunnerTeam
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async runnerTeamControllerGetAll() {
|
||||
static async runnerTeamControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/teams`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -9,10 +9,12 @@ export declare class ScanService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all scans (normal or track) from all runners. <br> This includes the scan's runner's distance ran.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result any
|
||||
* @throws ApiError
|
||||
*/
|
||||
static scanControllerGetAll(): Promise<(Array<ResponseScan> | Array<ResponseTrackScan>)>;
|
||||
static scanControllerGetAll(page?: number, pageSize?: number): Promise<(Array<ResponseScan> | Array<ResponseTrackScan>)>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new scan (not track scan - use /scans/trackscans instead). <br> Please rmemember to provide the scan's runner's id and distance.
|
||||
|
|
|
@ -6,13 +6,19 @@ class ScanService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all scans (normal or track) from all runners. <br> This includes the scan's runner's distance ran.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result any
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanControllerGetAll() {
|
||||
static async scanControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/scans`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -6,10 +6,12 @@ export declare class ScanStationService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all stations. <br> This includes their associated tracks.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseScanStation
|
||||
* @throws ApiError
|
||||
*/
|
||||
static scanStationControllerGetAll(): Promise<Array<ResponseScanStation>>;
|
||||
static scanStationControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseScanStation>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new station. <br> Please remeber to provide the station's track's id. <br> Please also remember that the station key is only visibe on creation.
|
||||
|
|
|
@ -6,13 +6,19 @@ class ScanStationService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all stations. <br> This includes their associated tracks.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseScanStation
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanStationControllerGetAll() {
|
||||
static async scanStationControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/stations`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -5,10 +5,12 @@ export declare class StatsClientService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all stats clients. Please remember that the key can only be viewed on creation.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseStatsClient
|
||||
* @throws ApiError
|
||||
*/
|
||||
static statsClientControllerGetAll(): Promise<Array<ResponseStatsClient>>;
|
||||
static statsClientControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseStatsClient>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new stats client. <br> Please remember that the client's key will be generated automaticly and that it can only be viewed on creation.
|
||||
|
|
|
@ -6,13 +6,19 @@ class StatsClientService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all stats clients. Please remember that the key can only be viewed on creation.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseStatsClient
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async statsClientControllerGetAll() {
|
||||
static async statsClientControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/statsclients`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -6,10 +6,12 @@ export declare class TrackService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all tracks.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseTrack
|
||||
* @throws ApiError
|
||||
*/
|
||||
static trackControllerGetAll(): Promise<Array<ResponseTrack>>;
|
||||
static trackControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseTrack>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new track. <br> Please remember that the track's distance must be greater than 0.
|
||||
|
|
|
@ -6,13 +6,19 @@ class TrackService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all tracks.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseTrack
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async trackControllerGetAll() {
|
||||
static async trackControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/tracks`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -9,10 +9,12 @@ export declare class UserGroupService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all groups. <br> The information provided might change while the project continues to evolve.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseUserGroup
|
||||
* @throws ApiError
|
||||
*/
|
||||
static userGroupControllerGetAll(): Promise<Array<ResponseUserGroup>>;
|
||||
static userGroupControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseUserGroup>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new group. <br> If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group.
|
||||
|
|
|
@ -6,13 +6,19 @@ class UserGroupService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all groups. <br> The information provided might change while the project continues to evolve.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseUserGroup
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userGroupControllerGetAll() {
|
||||
static async userGroupControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/usergroups`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
|
@ -6,10 +6,12 @@ export declare class UserService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all users. <br> This includes their groups and permissions granted to them.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static userControllerGetAll(): Promise<Array<ResponseUser>>;
|
||||
static userControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseUser>>;
|
||||
/**
|
||||
* Post
|
||||
* Create a new user. <br> If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user.
|
||||
|
|
|
@ -6,13 +6,19 @@ class UserService {
|
|||
/**
|
||||
* Get all
|
||||
* Lists all users. <br> This includes their groups and permissions granted to them.
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerGetAll() {
|
||||
static async userControllerGetAll(page, pageSize) {
|
||||
const result = await (0, request_1.request)({
|
||||
method: 'GET',
|
||||
path: `/api/users`,
|
||||
query: {
|
||||
'page': page,
|
||||
'page_size': pageSize,
|
||||
},
|
||||
});
|
||||
return result.body;
|
||||
}
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "@odit/lfk-client-js",
|
||||
"description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for native JS applications.",
|
||||
"version": "0.15.4",
|
||||
"version": "1.0.0",
|
||||
"license": "CC-BY-NC-SA-4.0",
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
|
|
Loading…
Reference in New Issue