@gewis/sudosos-client 0.0.0-develop.884f35f → 0.0.0-develop.88ba611

package/README.md

@@ -0,0 +1,110 @@
+# @gewis/sudosos-client
+
+Auto-generated TypeScript-Axios client for the SudoSOS API. Published on npm as [`@gewis/sudosos-client`](https://www.npmjs.com/package/@gewis/sudosos-client).
+
+This package lives inside the [SudoSOS Backend](https://github.com/GEWIS/sudosos-backend/tree/develop/client) monorepo (`client/`) and is generated from the backend's Swagger/OpenAPI spec.
+
+---
+
+## Installation
+
+```bash
+npm install @gewis/sudosos-client
+# or
+yarn add @gewis/sudosos-client
+```
+
+---
+
+## Usage
+
+### Unauthorized API usage
+
+```typescript
+import { BannersApi, Configuration } from '@gewis/sudosos-client';
+
+const configuration = new Configuration({
+  basePath: 'https://sudosos.gewis.nl/api/v1',
+});
+
+const bannersApi = new BannersApi(configuration);
+bannersApi.getAllOpenBanners().then((res) => {
+  console.log(res.data);
+});
+```
+
+### Authorized API usage
+
+All API methods accept a single object parameter (named properties, no positional `undefined` placeholders needed).
+
+```typescript
+import { AuthenticateApi, BalanceApi, Configuration } from '@gewis/sudosos-client';
+
+const basePath = 'https://sudosos.gewis.nl/api/v1';
+const configuration = new Configuration({ basePath });
+
+// Authenticate with an API key
+const { data } = await new AuthenticateApi(configuration).keyAuthentication({
+  keyAuthenticationRequest: { key: 'API_KEY', userId: 0 },
+});
+const jwtToken = data.token;
+
+// Use the token for authenticated requests
+const authedConfig = new Configuration({
+  basePath,
+  accessToken: () => jwtToken,
+});
+
+const balanceApi = new BalanceApi(authedConfig);
+balanceApi.getBalances().then((res) => {
+  console.log(res.data);
+});
+```
+
+For a more complete integration example, see [sudosos-frontend-common](https://github.com/GEWIS/sudosos-frontend-common).
+
+---
+
+## How the client is generated
+
+The client is generated from the OpenAPI spec that the backend emits at build time (`out/swagger.json`). The generator is [`openapi-generator-cli`](https://openapi-generator.tech/) using the `typescript-axios` template with `useSingleRequestParameter=true`.
+
+### Prerequisites
+
+- Node.js 22+
+- Java runtime (required by `openapi-generator-cli`)
+- The backend's Swagger output must exist at `../out/swagger.json` — run `npm run swagger` from the backend root first
+
+### Common commands
+
+| Command | Description |
+|---|---|
+| `npm run gen` | Generate TypeScript source from `../out/swagger.json` into `src/` |
+| `npm run build` | Compile `src/` to `dist/` |
+| `npm run genbuild` | Run `gen` then `build` (full regeneration) |
+| `npm run clean` | Remove `src/` and `dist/` |
+
+### Regenerating after a backend change
+
+```bash
+# From the backend root — generate the OpenAPI spec first
+npm run swagger      # produces out/swagger.json
+
+# Then regenerate the client
+cd client
+npm run genbuild
+```
+
+Or use the one-shot helper from the backend root:
+
+```bash
+npm run client:gen   # runs npm run swagger, then cd client && npm install && npm run genbuild
+```
+
+---
+
+## Contributing
+
+This package is generated — do not edit files under `src/` by hand; they will be overwritten on the next `npm run gen`. To change the client's output, update the backend API and regenerate.
+
+Issues and contributions go through the [SudoSOS Backend issue tracker](https://github.com/GEWIS/sudosos-backend/issues).

package/dist/api.d.ts

@@ -1880,7 +1880,7 @@ export interface CreatePointOfSaleRequest {
      */
     'containers': Array<number>;
     /**
-     * ID of the user who will own the POS, if undefined it will    default to the token ID.
+     * ID of the user who will own the POS.
      * @type {number}
      * @memberof CreatePointOfSaleRequest
      */
@@ -3219,13 +3219,13 @@ export interface PaginatedBalanceResponse {
      * @type {PaginationResult}
      * @memberof PaginatedBalanceResponse
      */
-    '_pagination'?: PaginationResult;
+    '_pagination': PaginationResult;
     /**
      * Returned balance responses
      * @type {Array<BalanceResponse>}
      * @memberof PaginatedBalanceResponse
      */
-    'records'?: Array<BalanceResponse>;
+    'records': Array<BalanceResponse>;
 }
 /**
  * Paginated API Response for the `banner` entity.
@@ -3238,13 +3238,13 @@ export interface PaginatedBannerResponse {
      * @type {PaginationResult}
      * @memberof PaginatedBannerResponse
      */
-    '_pagination'?: PaginationResult;
+    '_pagination': PaginationResult;
     /**
      * Returned banners
      * @type {Array<BannerResponse>}
      * @memberof PaginatedBannerResponse
      */
-    'records'?: Array<BannerResponse>;
+    'records': Array<BannerResponse>;
 }
 /**
  *
@@ -3409,13 +3409,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
      * @type {PaginationResult}
      * @memberof PaginatedInactiveAdministrativeCostResponse
      */
-    '_pagination'?: PaginationResult;
+    '_pagination': PaginationResult;
     /**
      * Returned InactiveAdministrativeCost
      * @type {Array<InactiveAdministrativeCostResponse>}
      * @memberof PaginatedInactiveAdministrativeCostResponse
      */
-    'records'?: Array<InactiveAdministrativeCostResponse>;
+    'records': Array<InactiveAdministrativeCostResponse>;
 }
 /**
  *
@@ -5120,23 +5120,23 @@ export interface TotalBalanceResponse {
      */
     'date': string;
     /**
-     * The total amount of positive balance in SudoSOS
-     * @type {number}
+     *
+     * @type {DineroObjectResponse}
      * @memberof TotalBalanceResponse
      */
-    'totalPositive': number;
+    'totalPositive': DineroObjectResponse;
     /**
-     * The total amount of negative balance in SudoSOS
-     * @type {number}
+     *
+     * @type {DineroObjectResponse}
      * @memberof TotalBalanceResponse
      */
-    'totalNegative': number;
+    'totalNegative': DineroObjectResponse;
     /**
-     *
-     * @type {UserTypeTotalBalanceResponse}
+     * The total balances for the different user types
+     * @type {Array<UserTypeTotalBalanceResponse>}
      * @memberof TotalBalanceResponse
      */
-    'userTypeBalances': UserTypeTotalBalanceResponse;
+    'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
 }
 /**
  *
@@ -10826,7 +10826,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
     /**
      *
      * @summary Notify all users which will pay administrative costs within a year
@@ -10904,7 +10904,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
     /**
      *
      * @summary Notify all users which will pay administrative costs within a year
@@ -11127,7 +11127,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof InactiveAdministrativeCostsApi
      */
-    handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
     /**
      *
      * @summary Notify all users which will pay administrative costs within a year
@@ -11315,7 +11315,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
     /**
      *
      * @summary Returns a single invoice in the system.
@@ -11411,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
     /**
      *
      * @summary Returns a single invoice in the system.
@@ -11727,7 +11727,7 @@ export declare class InvoicesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof InvoicesApi
      */
-    getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
     /**
      *
      * @summary Returns a single invoice in the system.
@@ -15139,12 +15139,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
      * @summary Returns all existing transfers
      * @param {string} [fromDate] Start date for selected transfers (inclusive)
      * @param {string} [tillDate] End date for selected transfers (exclusive)
+     * @param {number} [fromId] Filter transfers from this user ID
+     * @param {number} [toId] Filter transfers to this user ID
+     * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
      * @param {number} [take] How many transfers the endpoint should return
      * @param {number} [skip] How many transfers should be skipped (for pagination)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Returns the requested transfer
@@ -15211,12 +15214,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
      * @summary Returns all existing transfers
      * @param {string} [fromDate] Start date for selected transfers (inclusive)
      * @param {string} [tillDate] End date for selected transfers (exclusive)
+     * @param {number} [fromId] Filter transfers from this user ID
+     * @param {number} [toId] Filter transfers to this user ID
+     * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
      * @param {number} [take] How many transfers the endpoint should return
      * @param {number} [skip] How many transfers should be skipped (for pagination)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransferResponse>>>;
+    getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransferResponse>>>;
     /**
      *
      * @summary Returns the requested transfer
@@ -15363,6 +15369,24 @@ export interface TransfersApiGetAllTransfersRequest {
      * @memberof TransfersApiGetAllTransfers
      */
     readonly tillDate?: string;
+    /**
+     * Filter transfers from this user ID
+     * @type {number}
+     * @memberof TransfersApiGetAllTransfers
+     */
+    readonly fromId?: number;
+    /**
+     * Filter transfers to this user ID
+     * @type {number}
+     * @memberof TransfersApiGetAllTransfers
+     */
+    readonly toId?: number;
+    /**
+     * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
+     * @type {string}
+     * @memberof TransfersApiGetAllTransfers
+     */
+    readonly category?: string;
     /**
      * How many transfers the endpoint should return
      * @type {number}

package/dist/api.js

@@ -11267,12 +11267,15 @@ const TransfersApiAxiosParamCreator = function (configuration) {
          * @summary Returns all existing transfers
          * @param {string} [fromDate] Start date for selected transfers (inclusive)
          * @param {string} [tillDate] End date for selected transfers (exclusive)
+         * @param {number} [fromId] Filter transfers from this user ID
+         * @param {number} [toId] Filter transfers to this user ID
+         * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
          * @param {number} [take] How many transfers the endpoint should return
          * @param {number} [skip] How many transfers should be skipped (for pagination)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getAllTransfers: async (fromDate, tillDate, take, skip, options = {}) => {
+        getAllTransfers: async (fromDate, tillDate, fromId, toId, category, take, skip, options = {}) => {
             const localVarPath = `/transfers`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -11292,6 +11295,15 @@ const TransfersApiAxiosParamCreator = function (configuration) {
             if (tillDate !== undefined) {
                 localVarQueryParameter['tillDate'] = tillDate;
             }
+            if (fromId !== undefined) {
+                localVarQueryParameter['fromId'] = fromId;
+            }
+            if (toId !== undefined) {
+                localVarQueryParameter['toId'] = toId;
+            }
+            if (category !== undefined) {
+                localVarQueryParameter['category'] = category;
+            }
             if (take !== undefined) {
                 localVarQueryParameter['take'] = take;
             }
@@ -11503,13 +11515,16 @@ const TransfersApiFp = function (configuration) {
          * @summary Returns all existing transfers
          * @param {string} [fromDate] Start date for selected transfers (inclusive)
          * @param {string} [tillDate] End date for selected transfers (exclusive)
+         * @param {number} [fromId] Filter transfers from this user ID
+         * @param {number} [toId] Filter transfers to this user ID
+         * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
          * @param {number} [take] How many transfers the endpoint should return
          * @param {number} [skip] How many transfers should be skipped (for pagination)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getAllTransfers(fromDate, tillDate, take, skip, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getAllTransfers(fromDate, tillDate, take, skip, options);
+        async getAllTransfers(fromDate, tillDate, fromId, toId, category, take, skip, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getAllTransfers(fromDate, tillDate, fromId, toId, category, take, skip, options);
             const index = configuration?.serverIndex ?? 0;
             const operationBasePath = base_1.operationServerMap['TransfersApi.getAllTransfers']?.[index]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
@@ -11611,7 +11626,7 @@ const TransfersApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getAllTransfers(requestParameters = {}, options) {
-            return localVarFp.getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.take, requestParameters.skip, options).then((request) => request(axios, basePath));
+            return localVarFp.getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, requestParameters.category, requestParameters.take, requestParameters.skip, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -11694,7 +11709,7 @@ class TransfersApi extends base_1.BaseAPI {
      * @memberof TransfersApi
      */
     getAllTransfers(requestParameters = {}, options) {
-        return (0, exports.TransfersApiFp)(this.configuration).getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.take, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.TransfersApiFp)(this.configuration).getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, requestParameters.category, requestParameters.take, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *

package/dist/base.js

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = require("axios");
-exports.BASE_PATH = "http://undefinedundefined".replace(/\/+$/, "");
+exports.BASE_PATH = "http://localhost:3000/api/v1".replace(/\/+$/, "");
 /**
  *
  * @export

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gewis/sudosos-client",
-  "version": "0.0.0-develop.884f35f",
+  "version": "0.0.0-develop.88ba611",
   "description": "Auto-generated TypeScript-Axios client for the SudoSOS API",
   "license": "AGPL-3.0-or-later",
   "main": "dist/index.js",
@@ -16,11 +16,11 @@
     "clean": "rm -rf src dist"
   },
   "dependencies": {
-    "axios": "^1.6.3"
+    "axios": "1.15.0"
   },
   "devDependencies": {
-    "@openapitools/openapi-generator-cli": "^2.7.0",
-    "typescript": "~5.9.3"
+    "@openapitools/openapi-generator-cli": "2.31.1",
+    "typescript": "5.9.3"
   },
   "repository": {
     "type": "git",