@gewis/sudosos-client 0.0.0-develop.e05135a → 0.0.0-develop.eaad44e

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

@@ -1683,11 +1683,11 @@ export interface CreateContainerRequest {
      */
     'public': boolean;
     /**
-     * Id of the user who will own the container, if undefined it will    default to the token ID.
+     * Id of the organ that will own the container
      * @type {number}
      * @memberof CreateContainerRequest
      */
-    'ownerId'?: number;
+    'ownerId': number;
 }
 /**
  *
@@ -2566,10 +2566,15 @@ export interface FineResponse {
 /**
  *
  * @export
- * @interface GetAllBalanceUserTypesParameterInner
+ * @enum {string}
  */
-export interface GetAllBalanceUserTypesParameterInner {
-}
+export declare const GetAllInvoicesCurrentStateParameterInner: {
+    readonly Created: "CREATED";
+    readonly Sent: "SENT";
+    readonly Paid: "PAID";
+    readonly Deleted: "DELETED";
+};
+export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
 /**
  * @type GetAllPayoutRequestsRequestedByIdParameter
  * @export
@@ -2724,6 +2729,37 @@ export interface InactiveAdministrativeCostResponse {
      */
     'transfer': TransferResponse;
 }
+/**
+ *
+ * @export
+ * @interface InvoiceDriftResponse
+ */
+export interface InvoiceDriftResponse {
+    /**
+     *
+     * @type {BaseInvoiceResponse}
+     * @memberof InvoiceDriftResponse
+     */
+    'invoice': BaseInvoiceResponse;
+    /**
+     *
+     * @type {DineroObjectResponse}
+     * @memberof InvoiceDriftResponse
+     */
+    'actualAmount': DineroObjectResponse;
+    /**
+     *
+     * @type {DineroObjectResponse}
+     * @memberof InvoiceDriftResponse
+     */
+    'expectedAmount': DineroObjectResponse;
+    /**
+     *
+     * @type {DineroObjectResponse}
+     * @memberof InvoiceDriftResponse
+     */
+    'deltaAmount': DineroObjectResponse;
+}
 /**
  *
  * @export
@@ -5671,6 +5707,18 @@ export interface TransferSummaryResponse {
      * @memberof TransferSummaryResponse
      */
     'inactiveAdministrativeCosts': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'manualCreations': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'manualDeletions': TransferAggregateResponse;
 }
 /**
  *
@@ -6447,6 +6495,22 @@ export interface UserToInactiveAdministrativeCostResponse {
      */
     'nickname'?: string;
 }
+/**
+ * The type of a user
+ * @export
+ * @enum {string}
+ */
+export declare const UserType: {
+    readonly Member: "MEMBER";
+    readonly Organ: "ORGAN";
+    readonly Voucher: "VOUCHER";
+    readonly LocalUser: "LOCAL_USER";
+    readonly LocalAdmin: "LOCAL_ADMIN";
+    readonly Invoice: "INVOICE";
+    readonly PointOfSale: "POINT_OF_SALE";
+    readonly Integration: "INTEGRATION";
+};
+export type UserType = typeof UserType[keyof typeof UserType];
 /**
  *
  * @export
@@ -6485,6 +6549,25 @@ export interface UserWithIndex {
      */
     'index': number;
 }
+/**
+ *
+ * @export
+ * @interface ValidationResponse
+ */
+export interface ValidationResponse {
+    /**
+     * Whether the request passed validation.
+     * @type {boolean}
+     * @memberof ValidationResponse
+     */
+    'valid': boolean;
+    /**
+     * List of validation error messages.
+     * @type {Array<string>}
+     * @memberof ValidationResponse
+     */
+    'errors': Array<string>;
+}
 /**
  *
  * @export
@@ -8049,7 +8132,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
      * @param {boolean} [hasFine] Only users with(out) fines
      * @param {number} [minFine] Minimum fine
      * @param {number} [maxFine] Maximum fine
-     * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
+     * @param {Array<UserType>} [userTypes] Filter based on user type.
      * @param {string} [orderBy] Column to order balance by - eg: id,amount
      * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
      * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8059,7 +8142,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: GetAllBalanceUserTypesEnum, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Retrieves the requested balance
@@ -8099,7 +8182,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
      * @param {boolean} [hasFine] Only users with(out) fines
      * @param {number} [minFine] Minimum fine
      * @param {number} [maxFine] Maximum fine
-     * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
+     * @param {Array<UserType>} [userTypes] Filter based on user type.
      * @param {string} [orderBy] Column to order balance by - eg: id,amount
      * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
      * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8109,7 +8192,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: GetAllBalanceUserTypesEnum, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBalanceResponse>>;
+    getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBalanceResponse>>;
     /**
      *
      * @summary Retrieves the requested balance
@@ -8226,10 +8309,10 @@ export interface BalanceApiGetAllBalanceRequest {
     readonly maxFine?: number;
     /**
      * Filter based on user type.
-     * @type {Array<GetAllBalanceUserTypesParameterInner>}
+     * @type {Array<UserType>}
      * @memberof BalanceApiGetAllBalance
      */
-    readonly userTypes?: GetAllBalanceUserTypesEnum;
+    readonly userTypes?: Array<UserType>;
     /**
      * Column to order balance by - eg: id,amount
      * @type {string}
@@ -8323,11 +8406,6 @@ export declare class BalanceApi extends BaseAPI {
      */
     getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
 }
-/**
- * @export
- */
-export declare const GetAllBalanceUserTypesEnum: {};
-export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
 /**
  * @export
  */
@@ -11094,16 +11172,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
      * @summary Returns all invoices in the system.
      * @param {number} [toId] Filter on Id of the debtor
      * @param {number} [invoiceId] Filter on invoice ID
-     * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
+     * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
      * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
      * @param {string} [fromDate] Start date for selected invoices (inclusive)
      * @param {string} [tillDate] End date for selected invoices (exclusive)
+     * @param {string} [description] Filter invoices by description (partial match)
      * @param {number} [take] How many entries the endpoint should return
      * @param {number} [skip] How many entries should be skipped (for pagination)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAllInvoices: (toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get eligible transactions for invoice creation.
@@ -11114,6 +11193,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get an invoice pdf.
@@ -11193,16 +11279,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
      * @summary Returns all invoices in the system.
      * @param {number} [toId] Filter on Id of the debtor
      * @param {number} [invoiceId] Filter on invoice ID
-     * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
+     * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
      * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
      * @param {string} [fromDate] Start date for selected invoices (inclusive)
      * @param {string} [tillDate] End date for selected invoices (exclusive)
+     * @param {string} [description] Filter invoices by description (partial match)
      * @param {number} [take] How many entries the endpoint should return
      * @param {number} [skip] How many entries should be skipped (for pagination)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAllInvoices(toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
+    getAllInvoices(toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
     /**
      *
      * @summary Get eligible transactions for invoice creation.
@@ -11213,6 +11300,13 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse>>;
+    /**
+     *
+     * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
     /**
      *
      * @summary Get an invoice pdf.
@@ -11303,6 +11397,13 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse>;
+    /**
+     *
+     * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
     /**
      *
      * @summary Get an invoice pdf.
@@ -11403,10 +11504,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
     readonly invoiceId?: number;
     /**
      * Filter based on Invoice State.
-     * @type {Array<GetAllBalanceUserTypesParameterInner>}
+     * @type {Array<GetAllInvoicesCurrentStateParameterInner>}
      * @memberof InvoicesApiGetAllInvoices
      */
-    readonly currentState?: GetAllInvoicesCurrentStateEnum;
+    readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
     /**
      * Boolean if invoice entries should be returned
      * @type {boolean}
@@ -11425,6 +11526,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
      * @memberof InvoicesApiGetAllInvoices
      */
     readonly tillDate?: string;
+    /**
+     * Filter invoices by description (partial match)
+     * @type {string}
+     * @memberof InvoicesApiGetAllInvoices
+     */
+    readonly description?: string;
     /**
      * How many entries the endpoint should return
      * @type {number}
@@ -11604,6 +11711,14 @@ export declare class InvoicesApi extends BaseAPI {
      * @memberof InvoicesApi
      */
     getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
+    /**
+     *
+     * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvoicesApi
+     */
+    getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
     /**
      *
      * @summary Get an invoice pdf.
@@ -11650,11 +11765,6 @@ export declare class InvoicesApi extends BaseAPI {
      */
     updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
 }
-/**
- * @export
- */
-export declare const GetAllInvoicesCurrentStateEnum: {};
-export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
 /**
  * PayoutRequestsApi - axios parameter creator
  * @export
@@ -14209,11 +14319,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
     /**
      * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
      * @summary Get dry-run sync results for users
-     * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
+     * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUserSyncResults: (service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * SyncApi - functional programming interface
@@ -14223,11 +14333,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
     /**
      * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
      * @summary Get dry-run sync results for users
-     * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
+     * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUserSyncResults(service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
 };
 /**
  * SyncApi - factory interface
@@ -14251,10 +14361,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
 export interface SyncApiGetUserSyncResultsRequest {
     /**
      * Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
-     * @type {Array<string>}
+     * @type {Array<'LDAP' | 'GEWISDB'>}
      * @memberof SyncApiGetUserSyncResults
      */
-    readonly service?: GetUserSyncResultsServiceEnum;
+    readonly service?: Array<GetUserSyncResultsServiceEnum>;
 }
 /**
  * SyncApi - object-oriented interface
@@ -14276,7 +14386,10 @@ export declare class SyncApi extends BaseAPI {
 /**
  * @export
  */
-export declare const GetUserSyncResultsServiceEnum: {};
+export declare const GetUserSyncResultsServiceEnum: {
+    readonly Ldap: "LDAP";
+    readonly Gewisdb: "GEWISDB";
+};
 export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
 /**
  * TermsOfServiceApi - axios parameter creator

package/dist/api.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayoutRequestsApiAxiosParamCreator = exports.GetAllInvoicesCurrentStateEnum = exports.InvoicesApi = exports.InvoicesApiFactory = exports.InvoicesApiFp = exports.InvoicesApiAxiosParamCreator = exports.InactiveAdministrativeCostsApi = exports.InactiveAdministrativeCostsApiFactory = exports.InactiveAdministrativeCostsApiFp = exports.InactiveAdministrativeCostsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.EventsApi = exports.EventsApiFactory = exports.EventsApiFp = exports.EventsApiAxiosParamCreator = exports.GetFineReportPdfFileTypeEnum = exports.DebtorsApi = exports.DebtorsApiFactory = exports.DebtorsApiFp = exports.DebtorsApiAxiosParamCreator = exports.ContainersApi = exports.ContainersApiFactory = exports.ContainersApiFp = exports.ContainersApiAxiosParamCreator = exports.BannersApi = exports.BannersApiFactory = exports.BannersApiFp = exports.BannersApiAxiosParamCreator = exports.GetAllBalanceOrderDirectionEnum = exports.GetAllBalanceUserTypesEnum = exports.BalanceApi = exports.BalanceApiFactory = exports.BalanceApiFp = exports.BalanceApiAxiosParamCreator = exports.AuthenticateApi = exports.AuthenticateApiFactory = exports.AuthenticateApiFp = exports.AuthenticateApiAxiosParamCreator = exports.UserSettingsResponseLanguageEnum = exports.UpdateInvoiceRequestStateEnum = exports.QRStatusResponseStatusEnum = exports.PayoutRequestStatusRequestStateEnum = exports.PayoutRequestResponseStatusEnum = exports.PatchUserSettingsRequestLanguageEnum = exports.InvoiceStatusResponseStateEnum = exports.FinancialMutationResponseTypeEnum = exports.BasePayoutRequestResponseStatusEnum = void 0;
+exports.PayoutRequestsApiAxiosParamCreator = exports.InvoicesApi = exports.InvoicesApiFactory = exports.InvoicesApiFp = exports.InvoicesApiAxiosParamCreator = exports.InactiveAdministrativeCostsApi = exports.InactiveAdministrativeCostsApiFactory = exports.InactiveAdministrativeCostsApiFp = exports.InactiveAdministrativeCostsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.EventsApi = exports.EventsApiFactory = exports.EventsApiFp = exports.EventsApiAxiosParamCreator = exports.GetFineReportPdfFileTypeEnum = exports.DebtorsApi = exports.DebtorsApiFactory = exports.DebtorsApiFp = exports.DebtorsApiAxiosParamCreator = exports.ContainersApi = exports.ContainersApiFactory = exports.ContainersApiFp = exports.ContainersApiAxiosParamCreator = exports.BannersApi = exports.BannersApiFactory = exports.BannersApiFp = exports.BannersApiAxiosParamCreator = exports.GetAllBalanceOrderDirectionEnum = exports.BalanceApi = exports.BalanceApiFactory = exports.BalanceApiFp = exports.BalanceApiAxiosParamCreator = exports.AuthenticateApi = exports.AuthenticateApiFactory = exports.AuthenticateApiFp = exports.AuthenticateApiAxiosParamCreator = exports.UserType = exports.UserSettingsResponseLanguageEnum = exports.UpdateInvoiceRequestStateEnum = exports.QRStatusResponseStatusEnum = exports.PayoutRequestStatusRequestStateEnum = exports.PayoutRequestResponseStatusEnum = exports.PatchUserSettingsRequestLanguageEnum = exports.InvoiceStatusResponseStateEnum = exports.GetAllInvoicesCurrentStateParameterInner = exports.FinancialMutationResponseTypeEnum = exports.BasePayoutRequestResponseStatusEnum = void 0;
 exports.TransactionSummariesApiFp = exports.TransactionSummariesApiAxiosParamCreator = exports.TestOperationsOfTheTestControllerApi = exports.TestOperationsOfTheTestControllerApiFactory = exports.TestOperationsOfTheTestControllerApiFp = exports.TestOperationsOfTheTestControllerApiAxiosParamCreator = exports.TermsOfServiceApi = exports.TermsOfServiceApiFactory = exports.TermsOfServiceApiFp = exports.TermsOfServiceApiAxiosParamCreator = exports.GetUserSyncResultsServiceEnum = exports.SyncApi = exports.SyncApiFactory = exports.SyncApiFp = exports.SyncApiAxiosParamCreator = exports.StripeApi = exports.StripeApiFactory = exports.StripeApiFp = exports.StripeApiAxiosParamCreator = exports.ServerSettingsApi = exports.ServerSettingsApiFactory = exports.ServerSettingsApiFp = exports.ServerSettingsApiAxiosParamCreator = exports.SellerPayoutsApi = exports.SellerPayoutsApiFactory = exports.SellerPayoutsApiFp = exports.SellerPayoutsApiAxiosParamCreator = exports.RootApi = exports.RootApiFactory = exports.RootApiFp = exports.RootApiAxiosParamCreator = exports.RbacApi = exports.RbacApiFactory = exports.RbacApiFp = exports.RbacApiAxiosParamCreator = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductCategoriesApi = exports.ProductCategoriesApiFactory = exports.ProductCategoriesApiFp = exports.ProductCategoriesApiAxiosParamCreator = exports.PointofsaleApi = exports.PointofsaleApiFactory = exports.PointofsaleApiFp = exports.PointofsaleApiAxiosParamCreator = exports.PayoutRequestsApi = exports.PayoutRequestsApiFactory = exports.PayoutRequestsApiFp = void 0;
 exports.WriteoffsApi = exports.WriteoffsApiFactory = exports.WriteoffsApiFp = exports.WriteoffsApiAxiosParamCreator = exports.VouchergroupsApi = exports.VouchergroupsApiFactory = exports.VouchergroupsApiFp = exports.VouchergroupsApiAxiosParamCreator = exports.VatGroupsApi = exports.VatGroupsApiFactory = exports.VatGroupsApiFp = exports.VatGroupsApiAxiosParamCreator = exports.GetUsersSalesReportPdfFileTypeEnum = exports.GetUsersPurchaseReportPdfFileTypeEnum = exports.GetAllUsersTypeEnum = exports.UsersApi = exports.UsersApiFactory = exports.UsersApiFp = exports.UsersApiAxiosParamCreator = exports.UserNotificationPreferencesApi = exports.UserNotificationPreferencesApiFactory = exports.UserNotificationPreferencesApiFp = exports.UserNotificationPreferencesApiAxiosParamCreator = exports.TransfersApi = exports.TransfersApiFactory = exports.TransfersApiFp = exports.TransfersApiAxiosParamCreator = exports.TransactionsApi = exports.TransactionsApiFactory = exports.TransactionsApiFp = exports.TransactionsApiAxiosParamCreator = exports.TransactionSummariesApi = exports.TransactionSummariesApiFactory = void 0;
 const axios_1 = require("axios");
@@ -32,6 +32,17 @@ exports.FinancialMutationResponseTypeEnum = {
     Transfer: 'transfer',
     Transaction: 'transaction'
 };
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+exports.GetAllInvoicesCurrentStateParameterInner = {
+    Created: 'CREATED',
+    Sent: 'SENT',
+    Paid: 'PAID',
+    Deleted: 'DELETED'
+};
 exports.InvoiceStatusResponseStateEnum = {
     Created: 'CREATED',
     Sent: 'SENT',
@@ -72,6 +83,21 @@ exports.UserSettingsResponseLanguageEnum = {
     EnUs: 'en-US',
     PlPl: 'pl-PL'
 };
+/**
+ * The type of a user
+ * @export
+ * @enum {string}
+ */
+exports.UserType = {
+    Member: 'MEMBER',
+    Organ: 'ORGAN',
+    Voucher: 'VOUCHER',
+    LocalUser: 'LOCAL_USER',
+    LocalAdmin: 'LOCAL_ADMIN',
+    Invoice: 'INVOICE',
+    PointOfSale: 'POINT_OF_SALE',
+    Integration: 'INTEGRATION'
+};
 /**
  * AuthenticateApi - axios parameter creator
  * @export
@@ -1703,7 +1729,7 @@ const BalanceApiAxiosParamCreator = function (configuration) {
          * @param {boolean} [hasFine] Only users with(out) fines
          * @param {number} [minFine] Minimum fine
          * @param {number} [maxFine] Maximum fine
-         * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
+         * @param {Array<UserType>} [userTypes] Filter based on user type.
          * @param {string} [orderBy] Column to order balance by - eg: id,amount
          * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
          * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -1867,7 +1893,7 @@ const BalanceApiFp = function (configuration) {
          * @param {boolean} [hasFine] Only users with(out) fines
          * @param {number} [minFine] Minimum fine
          * @param {number} [maxFine] Maximum fine
-         * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
+         * @param {Array<UserType>} [userTypes] Filter based on user type.
          * @param {string} [orderBy] Column to order balance by - eg: id,amount
          * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
          * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -2012,10 +2038,6 @@ class BalanceApi extends base_1.BaseAPI {
     }
 }
 exports.BalanceApi = BalanceApi;
-/**
- * @export
- */
-exports.GetAllBalanceUserTypesEnum = {};
 /**
  * @export
  */
@@ -5804,16 +5826,17 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
          * @summary Returns all invoices in the system.
          * @param {number} [toId] Filter on Id of the debtor
          * @param {number} [invoiceId] Filter on invoice ID
-         * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
+         * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
          * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
          * @param {string} [fromDate] Start date for selected invoices (inclusive)
          * @param {string} [tillDate] End date for selected invoices (exclusive)
+         * @param {string} [description] Filter invoices by description (partial match)
          * @param {number} [take] How many entries the endpoint should return
          * @param {number} [skip] How many entries should be skipped (for pagination)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getAllInvoices: async (toId, invoiceId, currentState, returnEntries, fromDate, tillDate, take, skip, options = {}) => {
+        getAllInvoices: async (toId, invoiceId, currentState, returnEntries, fromDate, tillDate, description, take, skip, options = {}) => {
             const localVarPath = `/invoices`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -5845,6 +5868,9 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
             if (tillDate !== undefined) {
                 localVarQueryParameter['tillDate'] = tillDate;
             }
+            if (description !== undefined) {
+                localVarQueryParameter['description'] = description;
+            }
             if (take !== undefined) {
                 localVarQueryParameter['take'] = take;
             }
@@ -5903,6 +5929,34 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvoiceDrift: async (options = {}) => {
+            const localVarPath = `/invoices/drift`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication JWT required
+            // http bearer authentication required
+            await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Get an invoice pdf.
@@ -6135,17 +6189,18 @@ const InvoicesApiFp = function (configuration) {
          * @summary Returns all invoices in the system.
          * @param {number} [toId] Filter on Id of the debtor
          * @param {number} [invoiceId] Filter on invoice ID
-         * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
+         * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
          * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
          * @param {string} [fromDate] Start date for selected invoices (inclusive)
          * @param {string} [tillDate] End date for selected invoices (exclusive)
+         * @param {string} [description] Filter invoices by description (partial match)
          * @param {number} [take] How many entries the endpoint should return
          * @param {number} [skip] How many entries should be skipped (for pagination)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, take, skip, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, take, skip, options);
+        async getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, description, take, skip, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, description, take, skip, options);
             const index = configuration?.serverIndex ?? 0;
             const operationBasePath = base_1.operationServerMap['InvoicesApi.getAllInvoices']?.[index]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
@@ -6165,6 +6220,18 @@ const InvoicesApiFp = function (configuration) {
             const operationBasePath = base_1.operationServerMap['InvoicesApi.getEligibleTransactions']?.[index]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
         },
+        /**
+         *
+         * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getInvoiceDrift(options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getInvoiceDrift(options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = base_1.operationServerMap['InvoicesApi.getInvoiceDrift']?.[index]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
         /**
          *
          * @summary Get an invoice pdf.
@@ -6282,7 +6349,7 @@ const InvoicesApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getAllInvoices(requestParameters = {}, options) {
-            return localVarFp.getAllInvoices(requestParameters.toId, requestParameters.invoiceId, requestParameters.currentState, requestParameters.returnEntries, requestParameters.fromDate, requestParameters.tillDate, requestParameters.take, requestParameters.skip, options).then((request) => request(axios, basePath));
+            return localVarFp.getAllInvoices(requestParameters.toId, requestParameters.invoiceId, requestParameters.currentState, requestParameters.returnEntries, requestParameters.fromDate, requestParameters.tillDate, requestParameters.description, requestParameters.take, requestParameters.skip, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -6294,6 +6361,15 @@ const InvoicesApiFactory = function (configuration, basePath, axios) {
         getEligibleTransactions(requestParameters, options) {
             return localVarFp.getEligibleTransactions(requestParameters.forId, requestParameters.fromDate, requestParameters.tillDate, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvoiceDrift(options) {
+            return localVarFp.getInvoiceDrift(options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Get an invoice pdf.
@@ -6396,7 +6472,7 @@ class InvoicesApi extends base_1.BaseAPI {
      * @memberof InvoicesApi
      */
     getAllInvoices(requestParameters = {}, options) {
-        return (0, exports.InvoicesApiFp)(this.configuration).getAllInvoices(requestParameters.toId, requestParameters.invoiceId, requestParameters.currentState, requestParameters.returnEntries, requestParameters.fromDate, requestParameters.tillDate, requestParameters.take, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.InvoicesApiFp)(this.configuration).getAllInvoices(requestParameters.toId, requestParameters.invoiceId, requestParameters.currentState, requestParameters.returnEntries, requestParameters.fromDate, requestParameters.tillDate, requestParameters.description, requestParameters.take, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *
@@ -6409,6 +6485,16 @@ class InvoicesApi extends base_1.BaseAPI {
     getEligibleTransactions(requestParameters, options) {
         return (0, exports.InvoicesApiFp)(this.configuration).getEligibleTransactions(requestParameters.forId, requestParameters.fromDate, requestParameters.tillDate, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvoicesApi
+     */
+    getInvoiceDrift(options) {
+        return (0, exports.InvoicesApiFp)(this.configuration).getInvoiceDrift(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Get an invoice pdf.
@@ -6466,10 +6552,6 @@ class InvoicesApi extends base_1.BaseAPI {
     }
 }
 exports.InvoicesApi = InvoicesApi;
-/**
- * @export
- */
-exports.GetAllInvoicesCurrentStateEnum = {};
 /**
  * PayoutRequestsApi - axios parameter creator
  * @export
@@ -10011,7 +10093,7 @@ const SyncApiAxiosParamCreator = function (configuration) {
         /**
          * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
          * @summary Get dry-run sync results for users
-         * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
+         * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -10053,7 +10135,7 @@ const SyncApiFp = function (configuration) {
         /**
          * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
          * @summary Get dry-run sync results for users
-         * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
+         * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -10109,7 +10191,10 @@ exports.SyncApi = SyncApi;
 /**
  * @export
  */
-exports.GetUserSyncResultsServiceEnum = {};
+exports.GetUserSyncResultsServiceEnum = {
+    Ldap: 'LDAP',
+    Gewisdb: 'GEWISDB'
+};
 /**
  * TermsOfServiceApi - axios parameter creator
  * @export

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/dist/common.d.ts

@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any, {}>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gewis/sudosos-client",
-  "version": "0.0.0-develop.e05135a",
+  "version": "0.0.0-develop.eaad44e",
   "description": "Auto-generated TypeScript-Axios client for the SudoSOS API",
   "license": "AGPL-3.0-or-later",
   "main": "dist/index.js",
@@ -20,7 +20,7 @@
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.7.0",
-    "typescript": "~5.5.3"
+    "typescript": "~5.9.3"
   },
   "repository": {
     "type": "git",