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

Comparing version 0.0.11 to 0.0.12

dist/core/OpenAPI.js

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

dist/index.d.ts

@@ -7,3 +7,6 @@ export { ApiError } from './core/ApiError';
 export type { CreateAuth } from './models/CreateAuth';
+export type { CreateDistanceDonation } from './models/CreateDistanceDonation';
+export type { CreateDonation } from './models/CreateDonation';
 export type { CreateDonor } from './models/CreateDonor';
+export type { CreateFixedDonation } from './models/CreateFixedDonation';
 export type { CreateParticipant } from './models/CreateParticipant';
@@ -26,6 +29,10 @@ export { CreatePermission } from './models/CreatePermission';
 export type { Donation } from './models/Donation';
+export type { DonationIdsNotMatchingError } from './models/DonationIdsNotMatchingError';
+export type { DonationNotFoundError } from './models/DonationNotFoundError';
 export type { Donor } from './models/Donor';
+export type { DonorHasDonationsError } from './models/DonorHasDonationsError';
 export type { DonorIdsNotMatchingError } from './models/DonorIdsNotMatchingError';
 export type { DonorNotFoundError } from './models/DonorNotFoundError';
 export type { DonorReceiptAddressNeededError } from './models/DonorReceiptAddressNeededError';
+export type { FixedDonation } from './models/FixedDonation';
 export type { GroupContact } from './models/GroupContact';
@@ -57,2 +64,4 @@ export type { GroupContactNotFoundError } from './models/GroupContactNotFoundError';
 export type { ResponseAuth } from './models/ResponseAuth';
+export type { ResponseDistanceDonation } from './models/ResponseDistanceDonation';
+export type { ResponseDonation } from './models/ResponseDonation';
 export type { ResponseDonor } from './models/ResponseDonor';
@@ -79,2 +88,3 @@ export type { ResponseEmpty } from './models/ResponseEmpty';
 export type { ResponseUserGroup } from './models/ResponseUserGroup';
+export type { ResponseUserPermissions } from './models/ResponseUserPermissions';
 export type { Runner } from './models/Runner';
@@ -89,2 +99,3 @@ export type { RunnerCard } from './models/RunnerCard';
 export type { RunnerGroupNotFoundError } from './models/RunnerGroupNotFoundError';
+export type { RunnerHasDistanceDonationsError } from './models/RunnerHasDistanceDonationsError';
 export type { RunnerIdsNotMatchingError } from './models/RunnerIdsNotMatchingError';
@@ -119,3 +130,6 @@ export type { RunnerNotFoundError } from './models/RunnerNotFoundError';
 export type { TrackScan } from './models/TrackScan';
+export type { UpdateDistanceDonation } from './models/UpdateDistanceDonation';
+export type { UpdateDonation } from './models/UpdateDonation';
 export type { UpdateDonor } from './models/UpdateDonor';
+export type { UpdateFixedDonation } from './models/UpdateFixedDonation';
 export type { UpdatePermission } from './models/UpdatePermission';
@@ -135,2 +149,3 @@ export type { UpdateRunner } from './models/UpdateRunner';
 export type { UserDisabledError } from './models/UserDisabledError';
+export type { UserEmailNeededError } from './models/UserEmailNeededError';
 export type { UserGroup } from './models/UserGroup';
@@ -140,2 +155,3 @@ export type { UserGroupIdsNotMatchingError } from './models/UserGroupIdsNotMatchingError';
 export type { UserIdsNotMatchingError } from './models/UserIdsNotMatchingError';
+export type { UsernameContainsIllegalCharacterError } from './models/UsernameContainsIllegalCharacterError';
 export type { UsernameOrEmailNeededError } from './models/UsernameOrEmailNeededError';
@@ -146,2 +162,3 @@ export type { UserNonexistantOrRefreshtokenInvalidError } from './models/UserNonexistantOrRefreshtokenInvalidError';
 export { AuthService } from './services/AuthService';
+export { DonationService } from './services/DonationService';
 export { DonorService } from './services/DonorService';
@@ -148,0 +165,0 @@ export { ImportService } from './services/ImportService';

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.RunnerOrganisationService = exports.RunnerCardService = exports.PermissionService = exports.ImportService = exports.DonorService = 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.RunnerOrganisationService = exports.RunnerCardService = exports.PermissionService = exports.ImportService = exports.DonorService = exports.DonationService = exports.AuthService = exports.UserAction = exports.ResponsePermission = exports.Permission = exports.CreatePermission = exports.OpenAPI = exports.ApiError = void 0;
 /* istanbul ignore file */
@@ -21,2 +21,4 @@ /* tslint:disable */
 Object.defineProperty(exports, "AuthService", { enumerable: true, get: function () { return AuthService_1.AuthService; } });
+var DonationService_1 = require("./services/DonationService");
+Object.defineProperty(exports, "DonationService", { enumerable: true, get: function () { return DonationService_1.DonationService; } });
 var DonorService_1 = require("./services/DonorService");
@@ -23,0 +25,0 @@ Object.defineProperty(exports, "DonorService", { enumerable: true, get: function () { return DonorService_1.DonorService; } });

dist/models/CreatePermission.d.ts

@@ -19,3 +19,4 @@ export declare type CreatePermission = {
         STATION = "STATION",
-        CARD = "CARD"
+        CARD = "CARD",
+        DONATION = "DONATION"
     }
@@ -22,0 +23,0 @@ enum action {

dist/models/CreatePermission.js

@@ -23,2 +23,3 @@ "use strict";
         target["CARD"] = "CARD";
+        target["DONATION"] = "DONATION";
     })(target = CreatePermission.target || (CreatePermission.target = {}));
@@ -25,0 +26,0 @@ let action;

dist/models/CreateUser.d.ts

@@ -6,3 +6,3 @@ export declare type CreateUser = {
     username?: string;
-    email?: string;
+    email: string;
     phone?: string;
@@ -9,0 +9,0 @@ password: string;

dist/models/Donor.d.ts

 export declare type Donor = {
     receiptNeeded: boolean;
+    donationAmount: number;
     id: number;
@@ -4,0 +5,0 @@ firstname: string;

dist/models/Permission.d.ts

@@ -19,3 +19,4 @@ export declare type Permission = {
         STATION = "STATION",
-        CARD = "CARD"
+        CARD = "CARD",
+        DONATION = "DONATION"
     }
@@ -22,0 +23,0 @@ enum action {

dist/models/Permission.js

@@ -23,2 +23,3 @@ "use strict";
         target["CARD"] = "CARD";
+        target["DONATION"] = "DONATION";
     })(target = Permission.target || (Permission.target = {}));
@@ -25,0 +26,0 @@ let action;

dist/models/ResponseDonor.d.ts

 export declare type ResponseDonor = {
     receiptNeeded: boolean;
+    donationAmount: number;
     id: number;
@@ -4,0 +5,0 @@ firstname: string;

dist/models/ResponsePermission.d.ts

@@ -20,3 +20,4 @@ export declare type ResponsePermission = {
         STATION = "STATION",
-        CARD = "CARD"
+        CARD = "CARD",
+        DONATION = "DONATION"
     }
@@ -23,0 +24,0 @@ enum action {

dist/models/ResponsePermission.js

@@ -23,2 +23,3 @@ "use strict";
         target["CARD"] = "CARD";
+        target["DONATION"] = "DONATION";
     })(target = ResponsePermission.target || (ResponsePermission.target = {}));
@@ -25,0 +26,0 @@ let action;

dist/models/UpdateUser.d.ts

@@ -7,3 +7,3 @@ export declare type UpdateUser = {
     username?: string;
-    email?: string;
+    email: string;
     phone?: string;
@@ -10,0 +10,0 @@ password?: string;

dist/services/DonorService.d.ts

@@ -8,3 +8,3 @@ import type { CreateDonor } from '../models/CreateDonor';
      * Get all
-     * Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
+     * Lists all donor. <br> This includes the donor's current donation amount.
      * @returns ResponseDonor
@@ -16,3 +16,3 @@ * @throws ApiError
      * Post
-     * Create a new runner. <br> Please remeber to provide the runner's group's id.
+     * Create a new donor.
      * @param requestBody CreateDonor
@@ -25,3 +25,3 @@ * @returns ResponseDonor
      * Get one
-     * Lists all information about the runner whose id got provided.
+     * Lists all information about the donor whose id got provided. <br> This includes the donor's current donation amount.
      * @param id
@@ -34,3 +34,3 @@ * @returns ResponseDonor
      * Put
-     * Update the runner whose id you provided. <br> Please remember that ids can't be changed.
+     * Update the donor whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
@@ -44,3 +44,3 @@ * @param requestBody UpdateDonor
      * Remove
-     * Delete the runner whose id you provided. <br> If no runner with this id exists it will just return 204(no content).
+     * Delete the donor whose id you provided. <br> If no donor with this id exists it will just return 204(no content). <br> 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
@@ -47,0 +47,0 @@ * @param force

dist/services/DonorService.js

@@ -8,3 +8,3 @@ "use strict";
      * Get all
-     * Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
+     * Lists all donor. <br> This includes the donor's current donation amount.
      * @returns ResponseDonor
@@ -22,3 +22,3 @@ * @throws ApiError
      * Post
-     * Create a new runner. <br> Please remeber to provide the runner's group's id.
+     * Create a new donor.
      * @param requestBody CreateDonor
@@ -38,3 +38,3 @@ * @returns ResponseDonor
      * Get one
-     * Lists all information about the runner whose id got provided.
+     * Lists all information about the donor whose id got provided. <br> This includes the donor's current donation amount.
      * @param id
@@ -53,3 +53,3 @@ * @returns ResponseDonor
      * Put
-     * Update the runner whose id you provided. <br> Please remember that ids can't be changed.
+     * Update the donor whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
@@ -70,3 +70,3 @@ * @param requestBody UpdateDonor
      * Remove
-     * Delete the runner whose id you provided. <br> If no runner with this id exists it will just return 204(no content).
+     * Delete the donor whose id you provided. <br> If no donor with this id exists it will just return 204(no content). <br> 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
@@ -73,0 +73,0 @@ * @param force

dist/services/StatusService.d.ts

@@ -9,2 +9,9 @@ export declare class StatusService {
     static statusControllerGet(): Promise<any>;
+    /**
+     * Get version
+     * A very basic endpoint that just returns the curent package version.
+     * @returns any Successful response
+     * @throws ApiError
+     */
+    static statusControllerGetVersion(): Promise<any>;
 }

dist/services/StatusService.js

@@ -22,3 +22,16 @@ "use strict";
     }
+    /**
+     * Get version
+     * A very basic endpoint that just returns the curent package version.
+     * @returns any Successful response
+     * @throws ApiError
+     */
+    static async statusControllerGetVersion() {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/version`,
+        });
+        return result.body;
+    }
 }
 exports.StatusService = StatusService;

dist/services/UserService.d.ts

@@ -5,7 +5,6 @@ import type { CreateUser } from '../models/CreateUser';
 import type { UpdateUser } from '../models/UpdateUser';
-import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
 export declare class UserService {
     /**
      * Get all
-     * Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
+     * Lists all users. <br> This includes their groups and permissions granted to them.
      * @returns ResponseUser
@@ -19,9 +18,9 @@ * @throws ApiError
      * @param requestBody CreateUser
-     * @returns any
+     * @returns ResponseUser
      * @throws ApiError
      */
-    static userControllerPost(requestBody?: CreateUser): Promise<(ResponseUser | UserGroupNotFoundError)>;
+    static userControllerPost(requestBody?: CreateUser): Promise<ResponseUser>;
     /**
      * Get one
-     * Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
+     * Lists all information about the user whose id got provided. <br> Please remember that all permissions granted to the user will show up here.
      * @param id
@@ -51,2 +50,10 @@ * @returns ResponseUser
     static userControllerRemove(id: number, force?: boolean): Promise<ResponseUser | ResponseEmpty>;
+    /**
+     * Get permissions
+     * Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects.
+     * @param id
+     * @returns ResponseUser
+     * @throws ApiError
+     */
+    static userControllerGetPermissions(id: number): Promise<ResponseUser>;
 }

dist/services/UserService.js

@@ -8,3 +8,3 @@ "use strict";
      * Get all
-     * Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
+     * Lists all users. <br> This includes their groups and permissions granted to them.
      * @returns ResponseUser
@@ -24,3 +24,3 @@ * @throws ApiError
      * @param requestBody CreateUser
-     * @returns any
+     * @returns ResponseUser
      * @throws ApiError
@@ -38,3 +38,3 @@ */
      * Get one
-     * Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
+     * Lists all information about the user whose id got provided. <br> Please remember that all permissions granted to the user will show up here.
      * @param id
@@ -86,3 +86,17 @@ * @returns ResponseUser
     }
+    /**
+     * Get permissions
+     * Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects.
+     * @param id
+     * @returns ResponseUser
+     * @throws ApiError
+     */
+    static async userControllerGetPermissions(id) {
+        const result = await request_1.request({
+            method: 'GET',
+            path: `/api/users/${id}/permissions`,
+        });
+        return result.body;
+    }
 }
 exports.UserService = UserService;

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.0.11",
+	"version": "0.0.12",
 	"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

179041

increased by8.92%

Number of package files

349

increased by10.79%

Lines of code

4596

increased by9.66%

No dependency changes