@gewis/sudosos-client 1.28.2 → 1.29.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,110 @@
1
+ # @gewis/sudosos-client
2
+
3
+ Auto-generated TypeScript-Axios client for the SudoSOS API. Published on npm as [`@gewis/sudosos-client`](https://www.npmjs.com/package/@gewis/sudosos-client).
4
+
5
+ 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.
6
+
7
+ ---
8
+
9
+ ## Installation
10
+
11
+ ```bash
12
+ npm install @gewis/sudosos-client
13
+ # or
14
+ yarn add @gewis/sudosos-client
15
+ ```
16
+
17
+ ---
18
+
19
+ ## Usage
20
+
21
+ ### Unauthorized API usage
22
+
23
+ ```typescript
24
+ import { BannersApi, Configuration } from '@gewis/sudosos-client';
25
+
26
+ const configuration = new Configuration({
27
+ basePath: 'https://sudosos.gewis.nl/api/v1',
28
+ });
29
+
30
+ const bannersApi = new BannersApi(configuration);
31
+ bannersApi.getAllOpenBanners().then((res) => {
32
+ console.log(res.data);
33
+ });
34
+ ```
35
+
36
+ ### Authorized API usage
37
+
38
+ All API methods accept a single object parameter (named properties, no positional `undefined` placeholders needed).
39
+
40
+ ```typescript
41
+ import { AuthenticateApi, BalanceApi, Configuration } from '@gewis/sudosos-client';
42
+
43
+ const basePath = 'https://sudosos.gewis.nl/api/v1';
44
+ const configuration = new Configuration({ basePath });
45
+
46
+ // Authenticate with an API key
47
+ const { data } = await new AuthenticateApi(configuration).keyAuthentication({
48
+ keyAuthenticationRequest: { key: 'API_KEY', userId: 0 },
49
+ });
50
+ const jwtToken = data.token;
51
+
52
+ // Use the token for authenticated requests
53
+ const authedConfig = new Configuration({
54
+ basePath,
55
+ accessToken: () => jwtToken,
56
+ });
57
+
58
+ const balanceApi = new BalanceApi(authedConfig);
59
+ balanceApi.getBalances().then((res) => {
60
+ console.log(res.data);
61
+ });
62
+ ```
63
+
64
+ For a more complete integration example, see [sudosos-frontend-common](https://github.com/GEWIS/sudosos-frontend-common).
65
+
66
+ ---
67
+
68
+ ## How the client is generated
69
+
70
+ 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`.
71
+
72
+ ### Prerequisites
73
+
74
+ - Node.js 22+
75
+ - Java runtime (required by `openapi-generator-cli`)
76
+ - The backend's Swagger output must exist at `../out/swagger.json` — run `npm run swagger` from the backend root first
77
+
78
+ ### Common commands
79
+
80
+ | Command | Description |
81
+ |---|---|
82
+ | `npm run gen` | Generate TypeScript source from `../out/swagger.json` into `src/` |
83
+ | `npm run build` | Compile `src/` to `dist/` |
84
+ | `npm run genbuild` | Run `gen` then `build` (full regeneration) |
85
+ | `npm run clean` | Remove `src/` and `dist/` |
86
+
87
+ ### Regenerating after a backend change
88
+
89
+ ```bash
90
+ # From the backend root — generate the OpenAPI spec first
91
+ npm run swagger # produces out/swagger.json
92
+
93
+ # Then regenerate the client
94
+ cd client
95
+ npm run genbuild
96
+ ```
97
+
98
+ Or use the one-shot helper from the backend root:
99
+
100
+ ```bash
101
+ npm run client:gen # runs npm run swagger, then cd client && npm install && npm run genbuild
102
+ ```
103
+
104
+ ---
105
+
106
+ ## Contributing
107
+
108
+ 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.
109
+
110
+ Issues and contributions go through the [SudoSOS Backend issue tracker](https://github.com/GEWIS/sudosos-backend/issues).
package/dist/api.d.ts CHANGED
@@ -1683,11 +1683,11 @@ export interface CreateContainerRequest {
1683
1683
  */
1684
1684
  'public': boolean;
1685
1685
  /**
1686
- * Id of the user who will own the container, if undefined it will default to the token ID.
1686
+ * Id of the organ that will own the container
1687
1687
  * @type {number}
1688
1688
  * @memberof CreateContainerRequest
1689
1689
  */
1690
- 'ownerId'?: number;
1690
+ 'ownerId': number;
1691
1691
  }
1692
1692
  /**
1693
1693
  *
@@ -2566,10 +2566,15 @@ export interface FineResponse {
2566
2566
  /**
2567
2567
  *
2568
2568
  * @export
2569
- * @interface GetAllBalanceUserTypesParameterInner
2569
+ * @enum {string}
2570
2570
  */
2571
- export interface GetAllBalanceUserTypesParameterInner {
2572
- }
2571
+ export declare const GetAllInvoicesCurrentStateParameterInner: {
2572
+ readonly Created: "CREATED";
2573
+ readonly Sent: "SENT";
2574
+ readonly Paid: "PAID";
2575
+ readonly Deleted: "DELETED";
2576
+ };
2577
+ export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
2573
2578
  /**
2574
2579
  * @type GetAllPayoutRequestsRequestedByIdParameter
2575
2580
  * @export
@@ -2724,6 +2729,37 @@ export interface InactiveAdministrativeCostResponse {
2724
2729
  */
2725
2730
  'transfer': TransferResponse;
2726
2731
  }
2732
+ /**
2733
+ *
2734
+ * @export
2735
+ * @interface InvoiceDriftResponse
2736
+ */
2737
+ export interface InvoiceDriftResponse {
2738
+ /**
2739
+ *
2740
+ * @type {BaseInvoiceResponse}
2741
+ * @memberof InvoiceDriftResponse
2742
+ */
2743
+ 'invoice': BaseInvoiceResponse;
2744
+ /**
2745
+ *
2746
+ * @type {DineroObjectResponse}
2747
+ * @memberof InvoiceDriftResponse
2748
+ */
2749
+ 'actualAmount': DineroObjectResponse;
2750
+ /**
2751
+ *
2752
+ * @type {DineroObjectResponse}
2753
+ * @memberof InvoiceDriftResponse
2754
+ */
2755
+ 'expectedAmount': DineroObjectResponse;
2756
+ /**
2757
+ *
2758
+ * @type {DineroObjectResponse}
2759
+ * @memberof InvoiceDriftResponse
2760
+ */
2761
+ 'deltaAmount': DineroObjectResponse;
2762
+ }
2727
2763
  /**
2728
2764
  *
2729
2765
  * @export
@@ -5605,6 +5641,85 @@ export interface TransferResponse {
5605
5641
  */
5606
5642
  'sellerPayout'?: SellerPayoutResponse;
5607
5643
  }
5644
+ /**
5645
+ *
5646
+ * @export
5647
+ * @interface TransferSummaryResponse
5648
+ */
5649
+ export interface TransferSummaryResponse {
5650
+ /**
5651
+ *
5652
+ * @type {TransferAggregateResponse}
5653
+ * @memberof TransferSummaryResponse
5654
+ */
5655
+ 'total': TransferAggregateResponse;
5656
+ /**
5657
+ *
5658
+ * @type {TransferAggregateResponse}
5659
+ * @memberof TransferSummaryResponse
5660
+ */
5661
+ 'deposits': TransferAggregateResponse;
5662
+ /**
5663
+ *
5664
+ * @type {TransferAggregateResponse}
5665
+ * @memberof TransferSummaryResponse
5666
+ */
5667
+ 'payoutRequests': TransferAggregateResponse;
5668
+ /**
5669
+ *
5670
+ * @type {TransferAggregateResponse}
5671
+ * @memberof TransferSummaryResponse
5672
+ */
5673
+ 'sellerPayouts': TransferAggregateResponse;
5674
+ /**
5675
+ *
5676
+ * @type {TransferAggregateResponse}
5677
+ * @memberof TransferSummaryResponse
5678
+ */
5679
+ 'invoices': TransferAggregateResponse;
5680
+ /**
5681
+ *
5682
+ * @type {TransferAggregateResponse}
5683
+ * @memberof TransferSummaryResponse
5684
+ */
5685
+ 'creditInvoices': TransferAggregateResponse;
5686
+ /**
5687
+ *
5688
+ * @type {TransferAggregateResponse}
5689
+ * @memberof TransferSummaryResponse
5690
+ */
5691
+ 'fines': TransferAggregateResponse;
5692
+ /**
5693
+ *
5694
+ * @type {TransferAggregateResponse}
5695
+ * @memberof TransferSummaryResponse
5696
+ */
5697
+ 'waivedFines': TransferAggregateResponse;
5698
+ /**
5699
+ *
5700
+ * @type {TransferAggregateResponse}
5701
+ * @memberof TransferSummaryResponse
5702
+ */
5703
+ 'writeOffs': TransferAggregateResponse;
5704
+ /**
5705
+ *
5706
+ * @type {TransferAggregateResponse}
5707
+ * @memberof TransferSummaryResponse
5708
+ */
5709
+ 'inactiveAdministrativeCosts': TransferAggregateResponse;
5710
+ /**
5711
+ *
5712
+ * @type {TransferAggregateResponse}
5713
+ * @memberof TransferSummaryResponse
5714
+ */
5715
+ 'manualCreations': TransferAggregateResponse;
5716
+ /**
5717
+ *
5718
+ * @type {TransferAggregateResponse}
5719
+ * @memberof TransferSummaryResponse
5720
+ */
5721
+ 'manualDeletions': TransferAggregateResponse;
5722
+ }
5608
5723
  /**
5609
5724
  *
5610
5725
  * @export
@@ -6380,6 +6495,22 @@ export interface UserToInactiveAdministrativeCostResponse {
6380
6495
  */
6381
6496
  'nickname'?: string;
6382
6497
  }
6498
+ /**
6499
+ * The type of a user
6500
+ * @export
6501
+ * @enum {string}
6502
+ */
6503
+ export declare const UserType: {
6504
+ readonly Member: "MEMBER";
6505
+ readonly Organ: "ORGAN";
6506
+ readonly Voucher: "VOUCHER";
6507
+ readonly LocalUser: "LOCAL_USER";
6508
+ readonly LocalAdmin: "LOCAL_ADMIN";
6509
+ readonly Invoice: "INVOICE";
6510
+ readonly PointOfSale: "POINT_OF_SALE";
6511
+ readonly Integration: "INTEGRATION";
6512
+ };
6513
+ export type UserType = typeof UserType[keyof typeof UserType];
6383
6514
  /**
6384
6515
  *
6385
6516
  * @export
@@ -6418,6 +6549,25 @@ export interface UserWithIndex {
6418
6549
  */
6419
6550
  'index': number;
6420
6551
  }
6552
+ /**
6553
+ *
6554
+ * @export
6555
+ * @interface ValidationResponse
6556
+ */
6557
+ export interface ValidationResponse {
6558
+ /**
6559
+ * Whether the request passed validation.
6560
+ * @type {boolean}
6561
+ * @memberof ValidationResponse
6562
+ */
6563
+ 'valid': boolean;
6564
+ /**
6565
+ * List of validation error messages.
6566
+ * @type {Array<string>}
6567
+ * @memberof ValidationResponse
6568
+ */
6569
+ 'errors': Array<string>;
6570
+ }
6421
6571
  /**
6422
6572
  *
6423
6573
  * @export
@@ -7982,7 +8132,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
7982
8132
  * @param {boolean} [hasFine] Only users with(out) fines
7983
8133
  * @param {number} [minFine] Minimum fine
7984
8134
  * @param {number} [maxFine] Maximum fine
7985
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8135
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
7986
8136
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
7987
8137
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
7988
8138
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -7992,7 +8142,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
7992
8142
  * @param {*} [options] Override http request option.
7993
8143
  * @throws {RequiredError}
7994
8144
  */
7995
- 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>;
8145
+ 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>;
7996
8146
  /**
7997
8147
  *
7998
8148
  * @summary Retrieves the requested balance
@@ -8032,7 +8182,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8032
8182
  * @param {boolean} [hasFine] Only users with(out) fines
8033
8183
  * @param {number} [minFine] Minimum fine
8034
8184
  * @param {number} [maxFine] Maximum fine
8035
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8185
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
8036
8186
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
8037
8187
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
8038
8188
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8042,7 +8192,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8042
8192
  * @param {*} [options] Override http request option.
8043
8193
  * @throws {RequiredError}
8044
8194
  */
8045
- 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>>;
8195
+ 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>>;
8046
8196
  /**
8047
8197
  *
8048
8198
  * @summary Retrieves the requested balance
@@ -8159,10 +8309,10 @@ export interface BalanceApiGetAllBalanceRequest {
8159
8309
  readonly maxFine?: number;
8160
8310
  /**
8161
8311
  * Filter based on user type.
8162
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
8312
+ * @type {Array<UserType>}
8163
8313
  * @memberof BalanceApiGetAllBalance
8164
8314
  */
8165
- readonly userTypes?: GetAllBalanceUserTypesEnum;
8315
+ readonly userTypes?: Array<UserType>;
8166
8316
  /**
8167
8317
  * Column to order balance by - eg: id,amount
8168
8318
  * @type {string}
@@ -8256,11 +8406,6 @@ export declare class BalanceApi extends BaseAPI {
8256
8406
  */
8257
8407
  getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
8258
8408
  }
8259
- /**
8260
- * @export
8261
- */
8262
- export declare const GetAllBalanceUserTypesEnum: {};
8263
- export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
8264
8409
  /**
8265
8410
  * @export
8266
8411
  */
@@ -11027,16 +11172,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11027
11172
  * @summary Returns all invoices in the system.
11028
11173
  * @param {number} [toId] Filter on Id of the debtor
11029
11174
  * @param {number} [invoiceId] Filter on invoice ID
11030
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11175
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11031
11176
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11032
11177
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11033
11178
  * @param {string} [tillDate] End date for selected invoices (exclusive)
11179
+ * @param {string} [description] Filter invoices by description (partial match)
11034
11180
  * @param {number} [take] How many entries the endpoint should return
11035
11181
  * @param {number} [skip] How many entries should be skipped (for pagination)
11036
11182
  * @param {*} [options] Override http request option.
11037
11183
  * @throws {RequiredError}
11038
11184
  */
11039
- getAllInvoices: (toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11185
+ getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11040
11186
  /**
11041
11187
  *
11042
11188
  * @summary Get eligible transactions for invoice creation.
@@ -11047,6 +11193,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11047
11193
  * @throws {RequiredError}
11048
11194
  */
11049
11195
  getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11196
+ /**
11197
+ *
11198
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11199
+ * @param {*} [options] Override http request option.
11200
+ * @throws {RequiredError}
11201
+ */
11202
+ getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11050
11203
  /**
11051
11204
  *
11052
11205
  * @summary Get an invoice pdf.
@@ -11126,16 +11279,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11126
11279
  * @summary Returns all invoices in the system.
11127
11280
  * @param {number} [toId] Filter on Id of the debtor
11128
11281
  * @param {number} [invoiceId] Filter on invoice ID
11129
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11282
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11130
11283
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11131
11284
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11132
11285
  * @param {string} [tillDate] End date for selected invoices (exclusive)
11286
+ * @param {string} [description] Filter invoices by description (partial match)
11133
11287
  * @param {number} [take] How many entries the endpoint should return
11134
11288
  * @param {number} [skip] How many entries should be skipped (for pagination)
11135
11289
  * @param {*} [options] Override http request option.
11136
11290
  * @throws {RequiredError}
11137
11291
  */
11138
- 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>>;
11292
+ 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>>;
11139
11293
  /**
11140
11294
  *
11141
11295
  * @summary Get eligible transactions for invoice creation.
@@ -11146,6 +11300,13 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11146
11300
  * @throws {RequiredError}
11147
11301
  */
11148
11302
  getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse>>;
11303
+ /**
11304
+ *
11305
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11306
+ * @param {*} [options] Override http request option.
11307
+ * @throws {RequiredError}
11308
+ */
11309
+ getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
11149
11310
  /**
11150
11311
  *
11151
11312
  * @summary Get an invoice pdf.
@@ -11236,6 +11397,13 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11236
11397
  * @throws {RequiredError}
11237
11398
  */
11238
11399
  getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse>;
11400
+ /**
11401
+ *
11402
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11403
+ * @param {*} [options] Override http request option.
11404
+ * @throws {RequiredError}
11405
+ */
11406
+ getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
11239
11407
  /**
11240
11408
  *
11241
11409
  * @summary Get an invoice pdf.
@@ -11336,10 +11504,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
11336
11504
  readonly invoiceId?: number;
11337
11505
  /**
11338
11506
  * Filter based on Invoice State.
11339
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
11507
+ * @type {Array<GetAllInvoicesCurrentStateParameterInner>}
11340
11508
  * @memberof InvoicesApiGetAllInvoices
11341
11509
  */
11342
- readonly currentState?: GetAllInvoicesCurrentStateEnum;
11510
+ readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
11343
11511
  /**
11344
11512
  * Boolean if invoice entries should be returned
11345
11513
  * @type {boolean}
@@ -11358,6 +11526,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
11358
11526
  * @memberof InvoicesApiGetAllInvoices
11359
11527
  */
11360
11528
  readonly tillDate?: string;
11529
+ /**
11530
+ * Filter invoices by description (partial match)
11531
+ * @type {string}
11532
+ * @memberof InvoicesApiGetAllInvoices
11533
+ */
11534
+ readonly description?: string;
11361
11535
  /**
11362
11536
  * How many entries the endpoint should return
11363
11537
  * @type {number}
@@ -11537,6 +11711,14 @@ export declare class InvoicesApi extends BaseAPI {
11537
11711
  * @memberof InvoicesApi
11538
11712
  */
11539
11713
  getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
11714
+ /**
11715
+ *
11716
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11717
+ * @param {*} [options] Override http request option.
11718
+ * @throws {RequiredError}
11719
+ * @memberof InvoicesApi
11720
+ */
11721
+ getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
11540
11722
  /**
11541
11723
  *
11542
11724
  * @summary Get an invoice pdf.
@@ -11583,11 +11765,6 @@ export declare class InvoicesApi extends BaseAPI {
11583
11765
  */
11584
11766
  updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
11585
11767
  }
11586
- /**
11587
- * @export
11588
- */
11589
- export declare const GetAllInvoicesCurrentStateEnum: {};
11590
- export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
11591
11768
  /**
11592
11769
  * PayoutRequestsApi - axios parameter creator
11593
11770
  * @export
@@ -14142,11 +14319,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
14142
14319
  /**
14143
14320
  * 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.
14144
14321
  * @summary Get dry-run sync results for users
14145
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14322
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14146
14323
  * @param {*} [options] Override http request option.
14147
14324
  * @throws {RequiredError}
14148
14325
  */
14149
- getUserSyncResults: (service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14326
+ getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14150
14327
  };
14151
14328
  /**
14152
14329
  * SyncApi - functional programming interface
@@ -14156,11 +14333,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
14156
14333
  /**
14157
14334
  * 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.
14158
14335
  * @summary Get dry-run sync results for users
14159
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14336
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14160
14337
  * @param {*} [options] Override http request option.
14161
14338
  * @throws {RequiredError}
14162
14339
  */
14163
- getUserSyncResults(service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
14340
+ getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
14164
14341
  };
14165
14342
  /**
14166
14343
  * SyncApi - factory interface
@@ -14184,10 +14361,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
14184
14361
  export interface SyncApiGetUserSyncResultsRequest {
14185
14362
  /**
14186
14363
  * Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14187
- * @type {Array<string>}
14364
+ * @type {Array<'LDAP' | 'GEWISDB'>}
14188
14365
  * @memberof SyncApiGetUserSyncResults
14189
14366
  */
14190
- readonly service?: GetUserSyncResultsServiceEnum;
14367
+ readonly service?: Array<GetUserSyncResultsServiceEnum>;
14191
14368
  }
14192
14369
  /**
14193
14370
  * SyncApi - object-oriented interface
@@ -14209,7 +14386,10 @@ export declare class SyncApi extends BaseAPI {
14209
14386
  /**
14210
14387
  * @export
14211
14388
  */
14212
- export declare const GetUserSyncResultsServiceEnum: {};
14389
+ export declare const GetUserSyncResultsServiceEnum: {
14390
+ readonly Ldap: "LDAP";
14391
+ readonly Gewisdb: "GEWISDB";
14392
+ };
14213
14393
  export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
14214
14394
  /**
14215
14395
  * TermsOfServiceApi - axios parameter creator
@@ -14980,7 +15160,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14980
15160
  * @param {string} [tillDate] End date for selected transfers (exclusive)
14981
15161
  * @param {number} [fromId] Filter transfers from this user ID
14982
15162
  * @param {number} [toId] Filter transfers to this user ID
14983
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15163
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
14984
15164
  * @param {*} [options] Override http request option.
14985
15165
  * @throws {RequiredError}
14986
15166
  */
@@ -14993,6 +15173,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14993
15173
  * @throws {RequiredError}
14994
15174
  */
14995
15175
  getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15176
+ /**
15177
+ *
15178
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15179
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15180
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15181
+ * @param {number} [fromId] Filter transfers from this user ID
15182
+ * @param {number} [toId] Filter transfers to this user ID
15183
+ * @param {*} [options] Override http request option.
15184
+ * @throws {RequiredError}
15185
+ */
15186
+ getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14996
15187
  };
14997
15188
  /**
14998
15189
  * TransfersApi - functional programming interface
@@ -15041,7 +15232,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15041
15232
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15042
15233
  * @param {number} [fromId] Filter transfers from this user ID
15043
15234
  * @param {number} [toId] Filter transfers to this user ID
15044
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15235
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15045
15236
  * @param {*} [options] Override http request option.
15046
15237
  * @throws {RequiredError}
15047
15238
  */
@@ -15054,6 +15245,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15054
15245
  * @throws {RequiredError}
15055
15246
  */
15056
15247
  getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
15248
+ /**
15249
+ *
15250
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15251
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15252
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15253
+ * @param {number} [fromId] Filter transfers from this user ID
15254
+ * @param {number} [toId] Filter transfers to this user ID
15255
+ * @param {*} [options] Override http request option.
15256
+ * @throws {RequiredError}
15257
+ */
15258
+ getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
15057
15259
  };
15058
15260
  /**
15059
15261
  * TransfersApi - factory interface
@@ -15108,6 +15310,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
15108
15310
  * @throws {RequiredError}
15109
15311
  */
15110
15312
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
15313
+ /**
15314
+ *
15315
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15316
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15317
+ * @param {*} [options] Override http request option.
15318
+ * @throws {RequiredError}
15319
+ */
15320
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
15111
15321
  };
15112
15322
  /**
15113
15323
  * Request parameters for createTransfer operation in TransfersApi.
@@ -15210,7 +15420,7 @@ export interface TransfersApiGetTransferAggregateRequest {
15210
15420
  */
15211
15421
  readonly toId?: number;
15212
15422
  /**
15213
- * Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15423
+ * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15214
15424
  * @type {string}
15215
15425
  * @memberof TransfersApiGetTransferAggregate
15216
15426
  */
@@ -15229,6 +15439,37 @@ export interface TransfersApiGetTransferPdfRequest {
15229
15439
  */
15230
15440
  readonly id: number;
15231
15441
  }
15442
+ /**
15443
+ * Request parameters for getTransferSummary operation in TransfersApi.
15444
+ * @export
15445
+ * @interface TransfersApiGetTransferSummaryRequest
15446
+ */
15447
+ export interface TransfersApiGetTransferSummaryRequest {
15448
+ /**
15449
+ * Start date for selected transfers (inclusive)
15450
+ * @type {string}
15451
+ * @memberof TransfersApiGetTransferSummary
15452
+ */
15453
+ readonly fromDate?: string;
15454
+ /**
15455
+ * End date for selected transfers (exclusive)
15456
+ * @type {string}
15457
+ * @memberof TransfersApiGetTransferSummary
15458
+ */
15459
+ readonly tillDate?: string;
15460
+ /**
15461
+ * Filter transfers from this user ID
15462
+ * @type {number}
15463
+ * @memberof TransfersApiGetTransferSummary
15464
+ */
15465
+ readonly fromId?: number;
15466
+ /**
15467
+ * Filter transfers to this user ID
15468
+ * @type {number}
15469
+ * @memberof TransfersApiGetTransferSummary
15470
+ */
15471
+ readonly toId?: number;
15472
+ }
15232
15473
  /**
15233
15474
  * TransfersApi - object-oriented interface
15234
15475
  * @export
@@ -15290,6 +15531,15 @@ export declare class TransfersApi extends BaseAPI {
15290
15531
  * @memberof TransfersApi
15291
15532
  */
15292
15533
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
15534
+ /**
15535
+ *
15536
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15537
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15538
+ * @param {*} [options] Override http request option.
15539
+ * @throws {RequiredError}
15540
+ * @memberof TransfersApi
15541
+ */
15542
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
15293
15543
  }
15294
15544
  /**
15295
15545
  * UserNotificationPreferencesApi - axios parameter creator
package/dist/api.js CHANGED
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- 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;
16
+ 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;
17
17
  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;
18
18
  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;
19
19
  const axios_1 = require("axios");
@@ -32,6 +32,17 @@ exports.FinancialMutationResponseTypeEnum = {
32
32
  Transfer: 'transfer',
33
33
  Transaction: 'transaction'
34
34
  };
35
+ /**
36
+ *
37
+ * @export
38
+ * @enum {string}
39
+ */
40
+ exports.GetAllInvoicesCurrentStateParameterInner = {
41
+ Created: 'CREATED',
42
+ Sent: 'SENT',
43
+ Paid: 'PAID',
44
+ Deleted: 'DELETED'
45
+ };
35
46
  exports.InvoiceStatusResponseStateEnum = {
36
47
  Created: 'CREATED',
37
48
  Sent: 'SENT',
@@ -72,6 +83,21 @@ exports.UserSettingsResponseLanguageEnum = {
72
83
  EnUs: 'en-US',
73
84
  PlPl: 'pl-PL'
74
85
  };
86
+ /**
87
+ * The type of a user
88
+ * @export
89
+ * @enum {string}
90
+ */
91
+ exports.UserType = {
92
+ Member: 'MEMBER',
93
+ Organ: 'ORGAN',
94
+ Voucher: 'VOUCHER',
95
+ LocalUser: 'LOCAL_USER',
96
+ LocalAdmin: 'LOCAL_ADMIN',
97
+ Invoice: 'INVOICE',
98
+ PointOfSale: 'POINT_OF_SALE',
99
+ Integration: 'INTEGRATION'
100
+ };
75
101
  /**
76
102
  * AuthenticateApi - axios parameter creator
77
103
  * @export
@@ -1703,7 +1729,7 @@ const BalanceApiAxiosParamCreator = function (configuration) {
1703
1729
  * @param {boolean} [hasFine] Only users with(out) fines
1704
1730
  * @param {number} [minFine] Minimum fine
1705
1731
  * @param {number} [maxFine] Maximum fine
1706
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
1732
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
1707
1733
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
1708
1734
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
1709
1735
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -1867,7 +1893,7 @@ const BalanceApiFp = function (configuration) {
1867
1893
  * @param {boolean} [hasFine] Only users with(out) fines
1868
1894
  * @param {number} [minFine] Minimum fine
1869
1895
  * @param {number} [maxFine] Maximum fine
1870
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
1896
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
1871
1897
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
1872
1898
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
1873
1899
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -2012,10 +2038,6 @@ class BalanceApi extends base_1.BaseAPI {
2012
2038
  }
2013
2039
  }
2014
2040
  exports.BalanceApi = BalanceApi;
2015
- /**
2016
- * @export
2017
- */
2018
- exports.GetAllBalanceUserTypesEnum = {};
2019
2041
  /**
2020
2042
  * @export
2021
2043
  */
@@ -5804,16 +5826,17 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
5804
5826
  * @summary Returns all invoices in the system.
5805
5827
  * @param {number} [toId] Filter on Id of the debtor
5806
5828
  * @param {number} [invoiceId] Filter on invoice ID
5807
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
5829
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
5808
5830
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
5809
5831
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
5810
5832
  * @param {string} [tillDate] End date for selected invoices (exclusive)
5833
+ * @param {string} [description] Filter invoices by description (partial match)
5811
5834
  * @param {number} [take] How many entries the endpoint should return
5812
5835
  * @param {number} [skip] How many entries should be skipped (for pagination)
5813
5836
  * @param {*} [options] Override http request option.
5814
5837
  * @throws {RequiredError}
5815
5838
  */
5816
- getAllInvoices: async (toId, invoiceId, currentState, returnEntries, fromDate, tillDate, take, skip, options = {}) => {
5839
+ getAllInvoices: async (toId, invoiceId, currentState, returnEntries, fromDate, tillDate, description, take, skip, options = {}) => {
5817
5840
  const localVarPath = `/invoices`;
5818
5841
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5819
5842
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -5845,6 +5868,9 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
5845
5868
  if (tillDate !== undefined) {
5846
5869
  localVarQueryParameter['tillDate'] = tillDate;
5847
5870
  }
5871
+ if (description !== undefined) {
5872
+ localVarQueryParameter['description'] = description;
5873
+ }
5848
5874
  if (take !== undefined) {
5849
5875
  localVarQueryParameter['take'] = take;
5850
5876
  }
@@ -5903,6 +5929,34 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
5903
5929
  options: localVarRequestOptions,
5904
5930
  };
5905
5931
  },
5932
+ /**
5933
+ *
5934
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
5935
+ * @param {*} [options] Override http request option.
5936
+ * @throws {RequiredError}
5937
+ */
5938
+ getInvoiceDrift: async (options = {}) => {
5939
+ const localVarPath = `/invoices/drift`;
5940
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5941
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
5942
+ let baseOptions;
5943
+ if (configuration) {
5944
+ baseOptions = configuration.baseOptions;
5945
+ }
5946
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
5947
+ const localVarHeaderParameter = {};
5948
+ const localVarQueryParameter = {};
5949
+ // authentication JWT required
5950
+ // http bearer authentication required
5951
+ await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
5952
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5953
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5954
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5955
+ return {
5956
+ url: (0, common_1.toPathString)(localVarUrlObj),
5957
+ options: localVarRequestOptions,
5958
+ };
5959
+ },
5906
5960
  /**
5907
5961
  *
5908
5962
  * @summary Get an invoice pdf.
@@ -6135,17 +6189,18 @@ const InvoicesApiFp = function (configuration) {
6135
6189
  * @summary Returns all invoices in the system.
6136
6190
  * @param {number} [toId] Filter on Id of the debtor
6137
6191
  * @param {number} [invoiceId] Filter on invoice ID
6138
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
6192
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
6139
6193
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
6140
6194
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
6141
6195
  * @param {string} [tillDate] End date for selected invoices (exclusive)
6196
+ * @param {string} [description] Filter invoices by description (partial match)
6142
6197
  * @param {number} [take] How many entries the endpoint should return
6143
6198
  * @param {number} [skip] How many entries should be skipped (for pagination)
6144
6199
  * @param {*} [options] Override http request option.
6145
6200
  * @throws {RequiredError}
6146
6201
  */
6147
- async getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, take, skip, options) {
6148
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, take, skip, options);
6202
+ async getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, description, take, skip, options) {
6203
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAllInvoices(toId, invoiceId, currentState, returnEntries, fromDate, tillDate, description, take, skip, options);
6149
6204
  const index = configuration?.serverIndex ?? 0;
6150
6205
  const operationBasePath = base_1.operationServerMap['InvoicesApi.getAllInvoices']?.[index]?.url;
6151
6206
  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) {
6165
6220
  const operationBasePath = base_1.operationServerMap['InvoicesApi.getEligibleTransactions']?.[index]?.url;
6166
6221
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
6167
6222
  },
6223
+ /**
6224
+ *
6225
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
6226
+ * @param {*} [options] Override http request option.
6227
+ * @throws {RequiredError}
6228
+ */
6229
+ async getInvoiceDrift(options) {
6230
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInvoiceDrift(options);
6231
+ const index = configuration?.serverIndex ?? 0;
6232
+ const operationBasePath = base_1.operationServerMap['InvoicesApi.getInvoiceDrift']?.[index]?.url;
6233
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
6234
+ },
6168
6235
  /**
6169
6236
  *
6170
6237
  * @summary Get an invoice pdf.
@@ -6282,7 +6349,7 @@ const InvoicesApiFactory = function (configuration, basePath, axios) {
6282
6349
  * @throws {RequiredError}
6283
6350
  */
6284
6351
  getAllInvoices(requestParameters = {}, options) {
6285
- 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));
6352
+ 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));
6286
6353
  },
6287
6354
  /**
6288
6355
  *
@@ -6294,6 +6361,15 @@ const InvoicesApiFactory = function (configuration, basePath, axios) {
6294
6361
  getEligibleTransactions(requestParameters, options) {
6295
6362
  return localVarFp.getEligibleTransactions(requestParameters.forId, requestParameters.fromDate, requestParameters.tillDate, options).then((request) => request(axios, basePath));
6296
6363
  },
6364
+ /**
6365
+ *
6366
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
6367
+ * @param {*} [options] Override http request option.
6368
+ * @throws {RequiredError}
6369
+ */
6370
+ getInvoiceDrift(options) {
6371
+ return localVarFp.getInvoiceDrift(options).then((request) => request(axios, basePath));
6372
+ },
6297
6373
  /**
6298
6374
  *
6299
6375
  * @summary Get an invoice pdf.
@@ -6396,7 +6472,7 @@ class InvoicesApi extends base_1.BaseAPI {
6396
6472
  * @memberof InvoicesApi
6397
6473
  */
6398
6474
  getAllInvoices(requestParameters = {}, options) {
6399
- 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));
6475
+ 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));
6400
6476
  }
6401
6477
  /**
6402
6478
  *
@@ -6409,6 +6485,16 @@ class InvoicesApi extends base_1.BaseAPI {
6409
6485
  getEligibleTransactions(requestParameters, options) {
6410
6486
  return (0, exports.InvoicesApiFp)(this.configuration).getEligibleTransactions(requestParameters.forId, requestParameters.fromDate, requestParameters.tillDate, options).then((request) => request(this.axios, this.basePath));
6411
6487
  }
6488
+ /**
6489
+ *
6490
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
6491
+ * @param {*} [options] Override http request option.
6492
+ * @throws {RequiredError}
6493
+ * @memberof InvoicesApi
6494
+ */
6495
+ getInvoiceDrift(options) {
6496
+ return (0, exports.InvoicesApiFp)(this.configuration).getInvoiceDrift(options).then((request) => request(this.axios, this.basePath));
6497
+ }
6412
6498
  /**
6413
6499
  *
6414
6500
  * @summary Get an invoice pdf.
@@ -6466,10 +6552,6 @@ class InvoicesApi extends base_1.BaseAPI {
6466
6552
  }
6467
6553
  }
6468
6554
  exports.InvoicesApi = InvoicesApi;
6469
- /**
6470
- * @export
6471
- */
6472
- exports.GetAllInvoicesCurrentStateEnum = {};
6473
6555
  /**
6474
6556
  * PayoutRequestsApi - axios parameter creator
6475
6557
  * @export
@@ -10011,7 +10093,7 @@ const SyncApiAxiosParamCreator = function (configuration) {
10011
10093
  /**
10012
10094
  * 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.
10013
10095
  * @summary Get dry-run sync results for users
10014
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
10096
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
10015
10097
  * @param {*} [options] Override http request option.
10016
10098
  * @throws {RequiredError}
10017
10099
  */
@@ -10053,7 +10135,7 @@ const SyncApiFp = function (configuration) {
10053
10135
  /**
10054
10136
  * 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.
10055
10137
  * @summary Get dry-run sync results for users
10056
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
10138
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
10057
10139
  * @param {*} [options] Override http request option.
10058
10140
  * @throws {RequiredError}
10059
10141
  */
@@ -10109,7 +10191,10 @@ exports.SyncApi = SyncApi;
10109
10191
  /**
10110
10192
  * @export
10111
10193
  */
10112
- exports.GetUserSyncResultsServiceEnum = {};
10194
+ exports.GetUserSyncResultsServiceEnum = {
10195
+ Ldap: 'LDAP',
10196
+ Gewisdb: 'GEWISDB'
10197
+ };
10113
10198
  /**
10114
10199
  * TermsOfServiceApi - axios parameter creator
10115
10200
  * @export
@@ -11260,7 +11345,7 @@ const TransfersApiAxiosParamCreator = function (configuration) {
11260
11345
  * @param {string} [tillDate] End date for selected transfers (exclusive)
11261
11346
  * @param {number} [fromId] Filter transfers from this user ID
11262
11347
  * @param {number} [toId] Filter transfers to this user ID
11263
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11348
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11264
11349
  * @param {*} [options] Override http request option.
11265
11350
  * @throws {RequiredError}
11266
11351
  */
@@ -11333,6 +11418,50 @@ const TransfersApiAxiosParamCreator = function (configuration) {
11333
11418
  options: localVarRequestOptions,
11334
11419
  };
11335
11420
  },
11421
+ /**
11422
+ *
11423
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11424
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
11425
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
11426
+ * @param {number} [fromId] Filter transfers from this user ID
11427
+ * @param {number} [toId] Filter transfers to this user ID
11428
+ * @param {*} [options] Override http request option.
11429
+ * @throws {RequiredError}
11430
+ */
11431
+ getTransferSummary: async (fromDate, tillDate, fromId, toId, options = {}) => {
11432
+ const localVarPath = `/transfers/summary`;
11433
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11434
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
11435
+ let baseOptions;
11436
+ if (configuration) {
11437
+ baseOptions = configuration.baseOptions;
11438
+ }
11439
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
11440
+ const localVarHeaderParameter = {};
11441
+ const localVarQueryParameter = {};
11442
+ // authentication JWT required
11443
+ // http bearer authentication required
11444
+ await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
11445
+ if (fromDate !== undefined) {
11446
+ localVarQueryParameter['fromDate'] = fromDate;
11447
+ }
11448
+ if (tillDate !== undefined) {
11449
+ localVarQueryParameter['tillDate'] = tillDate;
11450
+ }
11451
+ if (fromId !== undefined) {
11452
+ localVarQueryParameter['fromId'] = fromId;
11453
+ }
11454
+ if (toId !== undefined) {
11455
+ localVarQueryParameter['toId'] = toId;
11456
+ }
11457
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
11458
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11459
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
11460
+ return {
11461
+ url: (0, common_1.toPathString)(localVarUrlObj),
11462
+ options: localVarRequestOptions,
11463
+ };
11464
+ },
11336
11465
  };
11337
11466
  };
11338
11467
  exports.TransfersApiAxiosParamCreator = TransfersApiAxiosParamCreator;
@@ -11405,7 +11534,7 @@ const TransfersApiFp = function (configuration) {
11405
11534
  * @param {string} [tillDate] End date for selected transfers (exclusive)
11406
11535
  * @param {number} [fromId] Filter transfers from this user ID
11407
11536
  * @param {number} [toId] Filter transfers to this user ID
11408
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11537
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11409
11538
  * @param {*} [options] Override http request option.
11410
11539
  * @throws {RequiredError}
11411
11540
  */
@@ -11428,6 +11557,22 @@ const TransfersApiFp = function (configuration) {
11428
11557
  const operationBasePath = base_1.operationServerMap['TransfersApi.getTransferPdf']?.[index]?.url;
11429
11558
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
11430
11559
  },
11560
+ /**
11561
+ *
11562
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11563
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
11564
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
11565
+ * @param {number} [fromId] Filter transfers from this user ID
11566
+ * @param {number} [toId] Filter transfers to this user ID
11567
+ * @param {*} [options] Override http request option.
11568
+ * @throws {RequiredError}
11569
+ */
11570
+ async getTransferSummary(fromDate, tillDate, fromId, toId, options) {
11571
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTransferSummary(fromDate, tillDate, fromId, toId, options);
11572
+ const index = configuration?.serverIndex ?? 0;
11573
+ const operationBasePath = base_1.operationServerMap['TransfersApi.getTransferSummary']?.[index]?.url;
11574
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
11575
+ },
11431
11576
  };
11432
11577
  };
11433
11578
  exports.TransfersApiFp = TransfersApiFp;
@@ -11498,6 +11643,16 @@ const TransfersApiFactory = function (configuration, basePath, axios) {
11498
11643
  getTransferPdf(requestParameters, options) {
11499
11644
  return localVarFp.getTransferPdf(requestParameters.id, options).then((request) => request(axios, basePath));
11500
11645
  },
11646
+ /**
11647
+ *
11648
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11649
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
11650
+ * @param {*} [options] Override http request option.
11651
+ * @throws {RequiredError}
11652
+ */
11653
+ getTransferSummary(requestParameters = {}, options) {
11654
+ return localVarFp.getTransferSummary(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, options).then((request) => request(axios, basePath));
11655
+ },
11501
11656
  };
11502
11657
  };
11503
11658
  exports.TransfersApiFactory = TransfersApiFactory;
@@ -11574,6 +11729,17 @@ class TransfersApi extends base_1.BaseAPI {
11574
11729
  getTransferPdf(requestParameters, options) {
11575
11730
  return (0, exports.TransfersApiFp)(this.configuration).getTransferPdf(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
11576
11731
  }
11732
+ /**
11733
+ *
11734
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11735
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
11736
+ * @param {*} [options] Override http request option.
11737
+ * @throws {RequiredError}
11738
+ * @memberof TransfersApi
11739
+ */
11740
+ getTransferSummary(requestParameters = {}, options) {
11741
+ return (0, exports.TransfersApiFp)(this.configuration).getTransferSummary(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, options).then((request) => request(this.axios, this.basePath));
11742
+ }
11577
11743
  }
11578
11744
  exports.TransfersApi = TransfersApi;
11579
11745
  /**
package/dist/base.js CHANGED
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
17
17
  const axios_1 = require("axios");
18
- exports.BASE_PATH = "http://undefinedundefined".replace(/\/+$/, "");
18
+ exports.BASE_PATH = "http://localhost:3000/api/v1".replace(/\/+$/, "");
19
19
  /**
20
20
  *
21
21
  * @export
package/dist/common.d.ts CHANGED
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
62
62
  *
63
63
  * @export
64
64
  */
65
- 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>;
65
+ 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gewis/sudosos-client",
3
- "version": "1.28.2",
3
+ "version": "1.29.1",
4
4
  "description": "Auto-generated TypeScript-Axios client for the SudoSOS API",
5
5
  "license": "AGPL-3.0-or-later",
6
6
  "main": "dist/index.js",
@@ -20,7 +20,7 @@
20
20
  },
21
21
  "devDependencies": {
22
22
  "@openapitools/openapi-generator-cli": "^2.7.0",
23
- "typescript": "~5.5.3"
23
+ "typescript": "~5.9.3"
24
24
  },
25
25
  "repository": {
26
26
  "type": "git",