@odit/lfk-client-js - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

dist/core/OpenAPI.js

@@ -6,3 +6,3 @@ "use strict";
     BASE: '',
-    VERSION: '0.2.1',
+    VERSION: '0.3.0',
     WITH_CREDENTIALS: false,
@@ -9,0 +9,0 @@ TOKEN: undefined,

dist/index.d.ts

@@ -21,6 +21,8 @@ export { ApiError } from './core/ApiError';
 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';
@@ -78,3 +80,3 @@ export type { CreateTrack } from './models/CreateTrack';
 export type { ResponseRunnerGroup } from './models/ResponseRunnerGroup';
-export type { ResponseRunnerOrganisation } from './models/ResponseRunnerOrganisation';
+export type { ResponseRunnerOrganization } from './models/ResponseRunnerOrganization';
 export type { ResponseRunnerTeam } from './models/ResponseRunnerTeam';
@@ -101,2 +103,3 @@ export type { ResponseScan } from './models/ResponseScan';
 export type { RunnerCardNotFoundError } from './models/RunnerCardNotFoundError';
+export type { RunnerEmailNeededError } from './models/RunnerEmailNeededError';
 export type { RunnerGroup } from './models/RunnerGroup';
@@ -108,8 +111,8 @@ export type { RunnerGroupNeededError } from './models/RunnerGroupNeededError';
 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';
@@ -144,3 +147,3 @@ export type { RunnerTeamHasRunnersError } from './models/RunnerTeamHasRunnersError';
 export type { UpdateRunnerCard } from './models/UpdateRunnerCard';
-export type { UpdateRunnerOrganisation } from './models/UpdateRunnerOrganisation';
+export type { UpdateRunnerOrganization } from './models/UpdateRunnerOrganization';
 export type { UpdateRunnerTeam } from './models/UpdateRunnerTeam';
@@ -175,3 +178,3 @@ export type { UpdateScan } from './models/UpdateScan';
 export { RunnerCardService } from './services/RunnerCardService';
-export { RunnerOrganisationService } from './services/RunnerOrganisationService';
+export { RunnerOrganizationService } from './services/RunnerOrganizationService';
 export { RunnerSelfService } from './services/RunnerSelfService';
@@ -178,0 +181,0 @@ export { RunnerService } from './services/RunnerService';

dist/index.js

 "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 */
@@ -35,4 +35,4 @@ /* tslint:disable */
 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");
@@ -39,0 +39,0 @@ Object.defineProperty(exports, "RunnerSelfService", { enumerable: true, get: function () { return RunnerSelfService_1.RunnerSelfService; } });

dist/models/CreatePermission.d.ts

@@ -9,3 +9,3 @@ export declare type CreatePermission = {
         RUNNER = "RUNNER",
-        ORGANISATION = "ORGANISATION",
+        ORGANIZATION = "ORGANIZATION",
         TEAM = "TEAM",
@@ -12,0 +12,0 @@ TRACK = "TRACK",

dist/models/CreatePermission.js

@@ -12,3 +12,3 @@ "use strict";
         target["RUNNER"] = "RUNNER";
-        target["ORGANISATION"] = "ORGANISATION";
+        target["ORGANIZATION"] = "ORGANIZATION";
         target["TEAM"] = "TEAM";
@@ -15,0 +15,0 @@ target["TRACK"] = "TRACK";

dist/models/Permission.d.ts

@@ -9,3 +9,3 @@ export declare type Permission = {
         RUNNER = "RUNNER",
-        ORGANISATION = "ORGANISATION",
+        ORGANIZATION = "ORGANIZATION",
         TEAM = "TEAM",
@@ -12,0 +12,0 @@ TRACK = "TRACK",

dist/models/Permission.js

@@ -12,3 +12,3 @@ "use strict";
         target["RUNNER"] = "RUNNER";
-        target["ORGANISATION"] = "ORGANISATION";
+        target["ORGANIZATION"] = "ORGANIZATION";
         target["TEAM"] = "TEAM";
@@ -15,0 +15,0 @@ target["TRACK"] = "TRACK";

dist/models/ResponsePermission.d.ts

@@ -10,3 +10,3 @@ export declare type ResponsePermission = {
         RUNNER = "RUNNER",
-        ORGANISATION = "ORGANISATION",
+        ORGANIZATION = "ORGANIZATION",
         TEAM = "TEAM",
@@ -13,0 +13,0 @@ TRACK = "TRACK",

dist/models/ResponsePermission.js

@@ -12,3 +12,3 @@ "use strict";
         target["RUNNER"] = "RUNNER";
-        target["ORGANISATION"] = "ORGANISATION";
+        target["ORGANIZATION"] = "ORGANIZATION";
         target["TEAM"] = "TEAM";
@@ -15,0 +15,0 @@ target["TRACK"] = "TRACK";

dist/models/ResponseSelfServiceRunner.d.ts

@@ -6,2 +6,3 @@ export declare type ResponseSelfServiceRunner = {
     donations: string;
+    token?: string;
     id: number;
@@ -8,0 +9,0 @@ firstname: string;

dist/services/ImportService.js

@@ -36,3 +36,3 @@ "use strict";
             method: 'POST',
-            path: `/api/organisations/${id}/import`,
+            path: `/api/organizations/${id}/import`,
             body: requestBody,
@@ -85,3 +85,3 @@ });
             method: 'POST',
-            path: `/api/organisations/${id}/import/csv`,
+            path: `/api/organizations/${id}/import/csv`,
         });
@@ -88,0 +88,0 @@ return result.body;

dist/services/RunnerSelfService.d.ts

@@ -0,1 +1,3 @@
+import type { CreateSelfServiceCitizenRunner } from '../models/CreateSelfServiceCitizenRunner';
+import type { CreateSelfServiceRunner } from '../models/CreateSelfServiceRunner';
 import type { ResponseSelfServiceRunner } from '../models/ResponseSelfServiceRunner';
@@ -11,2 +13,19 @@ export declare class RunnerSelfService {
     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>;
 }

dist/services/RunnerSelfService.js

@@ -20,3 +20,34 @@ "use strict";
     }
+    /**
+     * 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;

dist/services/RunnerTeamService.d.ts

@@ -8,3 +8,3 @@ import type { CreateRunnerTeam } from '../models/CreateRunnerTeam';
      * 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
@@ -11,0 +11,0 @@ * @throws ApiError

dist/services/RunnerTeamService.js

@@ -8,3 +8,3 @@ "use strict";
      * 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
@@ -11,0 +11,0 @@ * @throws ApiError

dist/services/StatsService.d.ts

@@ -50,3 +50,3 @@ import type { ResponseStats } from '../models/ResponseStats';
      * Get top orgs by distance
-     * Returns the top ten organisations by distance.
+     * Returns the top ten organizations by distance.
      * @returns ResponseStatsOrgnisation
@@ -58,3 +58,3 @@ * @throws ApiError
      * Get top orgs by donations
-     * Returns the top ten organisations by donations.
+     * Returns the top ten organizations by donations.
      * @returns ResponseStatsOrgnisation
@@ -61,0 +61,0 @@ * @throws ApiError

dist/services/StatsService.js

@@ -86,3 +86,3 @@ "use strict";
      * Get top orgs by distance
-     * Returns the top ten organisations by distance.
+     * Returns the top ten organizations by distance.
      * @returns ResponseStatsOrgnisation
@@ -94,3 +94,3 @@ * @throws ApiError
             method: 'GET',
-            path: `/api/stats/organisations/distance`,
+            path: `/api/stats/organizations/distance`,
         });
@@ -101,3 +101,3 @@ return result.body;
      * Get top orgs by donations
-     * Returns the top ten organisations by donations.
+     * Returns the top ten organizations by donations.
      * @returns ResponseStatsOrgnisation
@@ -109,3 +109,3 @@ * @throws ApiError
             method: 'GET',
-            path: `/api/stats/organisations/donations`,
+            path: `/api/stats/organizations/donations`,
         });
@@ -112,0 +112,0 @@ return result.body;

package.json

 {
 	"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.2.1",
+	"version": "0.3.0",
 	"license": "CC-BY-NC-SA-4.0",
@@ -6,0 +6,0 @@ "main": "./dist/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

197689

increased by2.01%

Number of package files

379

increased by1.61%

Lines of code

5093

increased by1.9%

No dependency changes