@gewis/sudosos-client 0.0.0-develop.dabdc9d → 0.0.0-develop.e4aa3f3

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
  *
@@ -1880,7 +1880,7 @@ export interface CreatePointOfSaleRequest {
1880
1880
  */
1881
1881
  'containers': Array<number>;
1882
1882
  /**
1883
- * ID of the user who will own the POS, if undefined it will default to the token ID.
1883
+ * ID of the user who will own the POS.
1884
1884
  * @type {number}
1885
1885
  * @memberof CreatePointOfSaleRequest
1886
1886
  */
@@ -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
@@ -3183,13 +3219,13 @@ export interface PaginatedBalanceResponse {
3183
3219
  * @type {PaginationResult}
3184
3220
  * @memberof PaginatedBalanceResponse
3185
3221
  */
3186
- '_pagination'?: PaginationResult;
3222
+ '_pagination': PaginationResult;
3187
3223
  /**
3188
3224
  * Returned balance responses
3189
3225
  * @type {Array<BalanceResponse>}
3190
3226
  * @memberof PaginatedBalanceResponse
3191
3227
  */
3192
- 'records'?: Array<BalanceResponse>;
3228
+ 'records': Array<BalanceResponse>;
3193
3229
  }
3194
3230
  /**
3195
3231
  * Paginated API Response for the `banner` entity.
@@ -3202,13 +3238,13 @@ export interface PaginatedBannerResponse {
3202
3238
  * @type {PaginationResult}
3203
3239
  * @memberof PaginatedBannerResponse
3204
3240
  */
3205
- '_pagination'?: PaginationResult;
3241
+ '_pagination': PaginationResult;
3206
3242
  /**
3207
3243
  * Returned banners
3208
3244
  * @type {Array<BannerResponse>}
3209
3245
  * @memberof PaginatedBannerResponse
3210
3246
  */
3211
- 'records'?: Array<BannerResponse>;
3247
+ 'records': Array<BannerResponse>;
3212
3248
  }
3213
3249
  /**
3214
3250
  *
@@ -3373,13 +3409,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
3373
3409
  * @type {PaginationResult}
3374
3410
  * @memberof PaginatedInactiveAdministrativeCostResponse
3375
3411
  */
3376
- '_pagination'?: PaginationResult;
3412
+ '_pagination': PaginationResult;
3377
3413
  /**
3378
3414
  * Returned InactiveAdministrativeCost
3379
3415
  * @type {Array<InactiveAdministrativeCostResponse>}
3380
3416
  * @memberof PaginatedInactiveAdministrativeCostResponse
3381
3417
  */
3382
- 'records'?: Array<InactiveAdministrativeCostResponse>;
3418
+ 'records': Array<InactiveAdministrativeCostResponse>;
3383
3419
  }
3384
3420
  /**
3385
3421
  *
@@ -5084,23 +5120,23 @@ export interface TotalBalanceResponse {
5084
5120
  */
5085
5121
  'date': string;
5086
5122
  /**
5087
- * The total amount of positive balance in SudoSOS
5088
- * @type {number}
5123
+ *
5124
+ * @type {DineroObjectResponse}
5089
5125
  * @memberof TotalBalanceResponse
5090
5126
  */
5091
- 'totalPositive': number;
5127
+ 'totalPositive': DineroObjectResponse;
5092
5128
  /**
5093
- * The total amount of negative balance in SudoSOS
5094
- * @type {number}
5129
+ *
5130
+ * @type {DineroObjectResponse}
5095
5131
  * @memberof TotalBalanceResponse
5096
5132
  */
5097
- 'totalNegative': number;
5133
+ 'totalNegative': DineroObjectResponse;
5098
5134
  /**
5099
- *
5100
- * @type {UserTypeTotalBalanceResponse}
5135
+ * The total balances for the different user types
5136
+ * @type {Array<UserTypeTotalBalanceResponse>}
5101
5137
  * @memberof TotalBalanceResponse
5102
5138
  */
5103
- 'userTypeBalances': UserTypeTotalBalanceResponse;
5139
+ 'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
5104
5140
  }
5105
5141
  /**
5106
5142
  *
@@ -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
  */
@@ -10681,7 +10826,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
10681
10826
  * @param {*} [options] Override http request option.
10682
10827
  * @throws {RequiredError}
10683
10828
  */
10684
- handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10829
+ handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
10685
10830
  /**
10686
10831
  *
10687
10832
  * @summary Notify all users which will pay administrative costs within a year
@@ -10759,7 +10904,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
10759
10904
  * @param {*} [options] Override http request option.
10760
10905
  * @throws {RequiredError}
10761
10906
  */
10762
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10907
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
10763
10908
  /**
10764
10909
  *
10765
10910
  * @summary Notify all users which will pay administrative costs within a year
@@ -10982,7 +11127,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
10982
11127
  * @throws {RequiredError}
10983
11128
  * @memberof InactiveAdministrativeCostsApi
10984
11129
  */
10985
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
11130
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
10986
11131
  /**
10987
11132
  *
10988
11133
  * @summary Notify all users which will pay administrative costs within a year
@@ -11027,7 +11172,7 @@ 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)
@@ -11037,7 +11182,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11037
11182
  * @param {*} [options] Override http request option.
11038
11183
  * @throws {RequiredError}
11039
11184
  */
11040
- getAllInvoices: (toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: 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>;
11041
11186
  /**
11042
11187
  *
11043
11188
  * @summary Get eligible transactions for invoice creation.
@@ -11048,6 +11193,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11048
11193
  * @throws {RequiredError}
11049
11194
  */
11050
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>;
11051
11203
  /**
11052
11204
  *
11053
11205
  * @summary Get an invoice pdf.
@@ -11127,7 +11279,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11127
11279
  * @summary Returns all invoices in the system.
11128
11280
  * @param {number} [toId] Filter on Id of the debtor
11129
11281
  * @param {number} [invoiceId] Filter on invoice ID
11130
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11282
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11131
11283
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11132
11284
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11133
11285
  * @param {string} [tillDate] End date for selected invoices (exclusive)
@@ -11137,7 +11289,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11137
11289
  * @param {*} [options] Override http request option.
11138
11290
  * @throws {RequiredError}
11139
11291
  */
11140
- getAllInvoices(toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: 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>>;
11141
11293
  /**
11142
11294
  *
11143
11295
  * @summary Get eligible transactions for invoice creation.
@@ -11148,6 +11300,13 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11148
11300
  * @throws {RequiredError}
11149
11301
  */
11150
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>>>;
11151
11310
  /**
11152
11311
  *
11153
11312
  * @summary Get an invoice pdf.
@@ -11156,7 +11315,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11156
11315
  * @param {*} [options] Override http request option.
11157
11316
  * @throws {RequiredError}
11158
11317
  */
11159
- getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
11318
+ getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
11160
11319
  /**
11161
11320
  *
11162
11321
  * @summary Returns a single invoice in the system.
@@ -11238,6 +11397,13 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11238
11397
  * @throws {RequiredError}
11239
11398
  */
11240
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>>;
11241
11407
  /**
11242
11408
  *
11243
11409
  * @summary Get an invoice pdf.
@@ -11245,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11245
11411
  * @param {*} [options] Override http request option.
11246
11412
  * @throws {RequiredError}
11247
11413
  */
11248
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
11414
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
11249
11415
  /**
11250
11416
  *
11251
11417
  * @summary Returns a single invoice in the system.
@@ -11338,10 +11504,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
11338
11504
  readonly invoiceId?: number;
11339
11505
  /**
11340
11506
  * Filter based on Invoice State.
11341
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
11507
+ * @type {Array<GetAllInvoicesCurrentStateParameterInner>}
11342
11508
  * @memberof InvoicesApiGetAllInvoices
11343
11509
  */
11344
- readonly currentState?: GetAllInvoicesCurrentStateEnum;
11510
+ readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
11345
11511
  /**
11346
11512
  * Boolean if invoice entries should be returned
11347
11513
  * @type {boolean}
@@ -11545,6 +11711,14 @@ export declare class InvoicesApi extends BaseAPI {
11545
11711
  * @memberof InvoicesApi
11546
11712
  */
11547
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, {}>>;
11548
11722
  /**
11549
11723
  *
11550
11724
  * @summary Get an invoice pdf.
@@ -11553,7 +11727,7 @@ export declare class InvoicesApi extends BaseAPI {
11553
11727
  * @throws {RequiredError}
11554
11728
  * @memberof InvoicesApi
11555
11729
  */
11556
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
11730
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
11557
11731
  /**
11558
11732
  *
11559
11733
  * @summary Returns a single invoice in the system.
@@ -11591,11 +11765,6 @@ export declare class InvoicesApi extends BaseAPI {
11591
11765
  */
11592
11766
  updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
11593
11767
  }
11594
- /**
11595
- * @export
11596
- */
11597
- export declare const GetAllInvoicesCurrentStateEnum: {};
11598
- export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
11599
11768
  /**
11600
11769
  * PayoutRequestsApi - axios parameter creator
11601
11770
  * @export
@@ -14150,11 +14319,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
14150
14319
  /**
14151
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.
14152
14321
  * @summary Get dry-run sync results for users
14153
- * @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.
14154
14323
  * @param {*} [options] Override http request option.
14155
14324
  * @throws {RequiredError}
14156
14325
  */
14157
- getUserSyncResults: (service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14326
+ getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14158
14327
  };
14159
14328
  /**
14160
14329
  * SyncApi - functional programming interface
@@ -14164,11 +14333,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
14164
14333
  /**
14165
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.
14166
14335
  * @summary Get dry-run sync results for users
14167
- * @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.
14168
14337
  * @param {*} [options] Override http request option.
14169
14338
  * @throws {RequiredError}
14170
14339
  */
14171
- 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>>;
14172
14341
  };
14173
14342
  /**
14174
14343
  * SyncApi - factory interface
@@ -14192,10 +14361,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
14192
14361
  export interface SyncApiGetUserSyncResultsRequest {
14193
14362
  /**
14194
14363
  * Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14195
- * @type {Array<string>}
14364
+ * @type {Array<'LDAP' | 'GEWISDB'>}
14196
14365
  * @memberof SyncApiGetUserSyncResults
14197
14366
  */
14198
- readonly service?: GetUserSyncResultsServiceEnum;
14367
+ readonly service?: Array<GetUserSyncResultsServiceEnum>;
14199
14368
  }
14200
14369
  /**
14201
14370
  * SyncApi - object-oriented interface
@@ -14217,7 +14386,10 @@ export declare class SyncApi extends BaseAPI {
14217
14386
  /**
14218
14387
  * @export
14219
14388
  */
14220
- export declare const GetUserSyncResultsServiceEnum: {};
14389
+ export declare const GetUserSyncResultsServiceEnum: {
14390
+ readonly Ldap: "LDAP";
14391
+ readonly Gewisdb: "GEWISDB";
14392
+ };
14221
14393
  export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
14222
14394
  /**
14223
14395
  * TermsOfServiceApi - axios parameter creator
@@ -14967,12 +15139,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14967
15139
  * @summary Returns all existing transfers
14968
15140
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
14969
15141
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15142
+ * @param {number} [fromId] Filter transfers from this user ID
15143
+ * @param {number} [toId] Filter transfers to this user ID
15144
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
14970
15145
  * @param {number} [take] How many transfers the endpoint should return
14971
15146
  * @param {number} [skip] How many transfers should be skipped (for pagination)
14972
15147
  * @param {*} [options] Override http request option.
14973
15148
  * @throws {RequiredError}
14974
15149
  */
14975
- getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15150
+ getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14976
15151
  /**
14977
15152
  *
14978
15153
  * @summary Returns the requested transfer
@@ -14988,7 +15163,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14988
15163
  * @param {string} [tillDate] End date for selected transfers (exclusive)
14989
15164
  * @param {number} [fromId] Filter transfers from this user ID
14990
15165
  * @param {number} [toId] Filter transfers to this user ID
14991
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15166
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
14992
15167
  * @param {*} [options] Override http request option.
14993
15168
  * @throws {RequiredError}
14994
15169
  */
@@ -15001,6 +15176,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
15001
15176
  * @throws {RequiredError}
15002
15177
  */
15003
15178
  getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15179
+ /**
15180
+ *
15181
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15182
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15183
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15184
+ * @param {number} [fromId] Filter transfers from this user ID
15185
+ * @param {number} [toId] Filter transfers to this user ID
15186
+ * @param {*} [options] Override http request option.
15187
+ * @throws {RequiredError}
15188
+ */
15189
+ getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15004
15190
  };
15005
15191
  /**
15006
15192
  * TransfersApi - functional programming interface
@@ -15028,12 +15214,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15028
15214
  * @summary Returns all existing transfers
15029
15215
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
15030
15216
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15217
+ * @param {number} [fromId] Filter transfers from this user ID
15218
+ * @param {number} [toId] Filter transfers to this user ID
15219
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
15031
15220
  * @param {number} [take] How many transfers the endpoint should return
15032
15221
  * @param {number} [skip] How many transfers should be skipped (for pagination)
15033
15222
  * @param {*} [options] Override http request option.
15034
15223
  * @throws {RequiredError}
15035
15224
  */
15036
- getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransferResponse>>>;
15225
+ getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransferResponse>>>;
15037
15226
  /**
15038
15227
  *
15039
15228
  * @summary Returns the requested transfer
@@ -15049,7 +15238,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15049
15238
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15050
15239
  * @param {number} [fromId] Filter transfers from this user ID
15051
15240
  * @param {number} [toId] Filter transfers to this user ID
15052
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15241
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15053
15242
  * @param {*} [options] Override http request option.
15054
15243
  * @throws {RequiredError}
15055
15244
  */
@@ -15062,6 +15251,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15062
15251
  * @throws {RequiredError}
15063
15252
  */
15064
15253
  getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
15254
+ /**
15255
+ *
15256
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15257
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15258
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15259
+ * @param {number} [fromId] Filter transfers from this user ID
15260
+ * @param {number} [toId] Filter transfers to this user ID
15261
+ * @param {*} [options] Override http request option.
15262
+ * @throws {RequiredError}
15263
+ */
15264
+ getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
15065
15265
  };
15066
15266
  /**
15067
15267
  * TransfersApi - factory interface
@@ -15116,6 +15316,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
15116
15316
  * @throws {RequiredError}
15117
15317
  */
15118
15318
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
15319
+ /**
15320
+ *
15321
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15322
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15323
+ * @param {*} [options] Override http request option.
15324
+ * @throws {RequiredError}
15325
+ */
15326
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
15119
15327
  };
15120
15328
  /**
15121
15329
  * Request parameters for createTransfer operation in TransfersApi.
@@ -15161,6 +15369,24 @@ export interface TransfersApiGetAllTransfersRequest {
15161
15369
  * @memberof TransfersApiGetAllTransfers
15162
15370
  */
15163
15371
  readonly tillDate?: string;
15372
+ /**
15373
+ * Filter transfers from this user ID
15374
+ * @type {number}
15375
+ * @memberof TransfersApiGetAllTransfers
15376
+ */
15377
+ readonly fromId?: number;
15378
+ /**
15379
+ * Filter transfers to this user ID
15380
+ * @type {number}
15381
+ * @memberof TransfersApiGetAllTransfers
15382
+ */
15383
+ readonly toId?: number;
15384
+ /**
15385
+ * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
15386
+ * @type {string}
15387
+ * @memberof TransfersApiGetAllTransfers
15388
+ */
15389
+ readonly category?: string;
15164
15390
  /**
15165
15391
  * How many transfers the endpoint should return
15166
15392
  * @type {number}
@@ -15218,7 +15444,7 @@ export interface TransfersApiGetTransferAggregateRequest {
15218
15444
  */
15219
15445
  readonly toId?: number;
15220
15446
  /**
15221
- * Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15447
+ * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15222
15448
  * @type {string}
15223
15449
  * @memberof TransfersApiGetTransferAggregate
15224
15450
  */
@@ -15237,6 +15463,37 @@ export interface TransfersApiGetTransferPdfRequest {
15237
15463
  */
15238
15464
  readonly id: number;
15239
15465
  }
15466
+ /**
15467
+ * Request parameters for getTransferSummary operation in TransfersApi.
15468
+ * @export
15469
+ * @interface TransfersApiGetTransferSummaryRequest
15470
+ */
15471
+ export interface TransfersApiGetTransferSummaryRequest {
15472
+ /**
15473
+ * Start date for selected transfers (inclusive)
15474
+ * @type {string}
15475
+ * @memberof TransfersApiGetTransferSummary
15476
+ */
15477
+ readonly fromDate?: string;
15478
+ /**
15479
+ * End date for selected transfers (exclusive)
15480
+ * @type {string}
15481
+ * @memberof TransfersApiGetTransferSummary
15482
+ */
15483
+ readonly tillDate?: string;
15484
+ /**
15485
+ * Filter transfers from this user ID
15486
+ * @type {number}
15487
+ * @memberof TransfersApiGetTransferSummary
15488
+ */
15489
+ readonly fromId?: number;
15490
+ /**
15491
+ * Filter transfers to this user ID
15492
+ * @type {number}
15493
+ * @memberof TransfersApiGetTransferSummary
15494
+ */
15495
+ readonly toId?: number;
15496
+ }
15240
15497
  /**
15241
15498
  * TransfersApi - object-oriented interface
15242
15499
  * @export
@@ -15298,6 +15555,15 @@ export declare class TransfersApi extends BaseAPI {
15298
15555
  * @memberof TransfersApi
15299
15556
  */
15300
15557
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
15558
+ /**
15559
+ *
15560
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15561
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15562
+ * @param {*} [options] Override http request option.
15563
+ * @throws {RequiredError}
15564
+ * @memberof TransfersApi
15565
+ */
15566
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
15301
15567
  }
15302
15568
  /**
15303
15569
  * 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,7 +5826,7 @@ 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)
@@ -5907,6 +5929,34 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
5907
5929
  options: localVarRequestOptions,
5908
5930
  };
5909
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
+ },
5910
5960
  /**
5911
5961
  *
5912
5962
  * @summary Get an invoice pdf.
@@ -6139,7 +6189,7 @@ const InvoicesApiFp = function (configuration) {
6139
6189
  * @summary Returns all invoices in the system.
6140
6190
  * @param {number} [toId] Filter on Id of the debtor
6141
6191
  * @param {number} [invoiceId] Filter on invoice ID
6142
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
6192
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
6143
6193
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
6144
6194
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
6145
6195
  * @param {string} [tillDate] End date for selected invoices (exclusive)
@@ -6170,6 +6220,18 @@ const InvoicesApiFp = function (configuration) {
6170
6220
  const operationBasePath = base_1.operationServerMap['InvoicesApi.getEligibleTransactions']?.[index]?.url;
6171
6221
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
6172
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
+ },
6173
6235
  /**
6174
6236
  *
6175
6237
  * @summary Get an invoice pdf.
@@ -6299,6 +6361,15 @@ const InvoicesApiFactory = function (configuration, basePath, axios) {
6299
6361
  getEligibleTransactions(requestParameters, options) {
6300
6362
  return localVarFp.getEligibleTransactions(requestParameters.forId, requestParameters.fromDate, requestParameters.tillDate, options).then((request) => request(axios, basePath));
6301
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
+ },
6302
6373
  /**
6303
6374
  *
6304
6375
  * @summary Get an invoice pdf.
@@ -6414,6 +6485,16 @@ class InvoicesApi extends base_1.BaseAPI {
6414
6485
  getEligibleTransactions(requestParameters, options) {
6415
6486
  return (0, exports.InvoicesApiFp)(this.configuration).getEligibleTransactions(requestParameters.forId, requestParameters.fromDate, requestParameters.tillDate, options).then((request) => request(this.axios, this.basePath));
6416
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
+ }
6417
6498
  /**
6418
6499
  *
6419
6500
  * @summary Get an invoice pdf.
@@ -6471,10 +6552,6 @@ class InvoicesApi extends base_1.BaseAPI {
6471
6552
  }
6472
6553
  }
6473
6554
  exports.InvoicesApi = InvoicesApi;
6474
- /**
6475
- * @export
6476
- */
6477
- exports.GetAllInvoicesCurrentStateEnum = {};
6478
6555
  /**
6479
6556
  * PayoutRequestsApi - axios parameter creator
6480
6557
  * @export
@@ -10016,7 +10093,7 @@ const SyncApiAxiosParamCreator = function (configuration) {
10016
10093
  /**
10017
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.
10018
10095
  * @summary Get dry-run sync results for users
10019
- * @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.
10020
10097
  * @param {*} [options] Override http request option.
10021
10098
  * @throws {RequiredError}
10022
10099
  */
@@ -10058,7 +10135,7 @@ const SyncApiFp = function (configuration) {
10058
10135
  /**
10059
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.
10060
10137
  * @summary Get dry-run sync results for users
10061
- * @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.
10062
10139
  * @param {*} [options] Override http request option.
10063
10140
  * @throws {RequiredError}
10064
10141
  */
@@ -10114,7 +10191,10 @@ exports.SyncApi = SyncApi;
10114
10191
  /**
10115
10192
  * @export
10116
10193
  */
10117
- exports.GetUserSyncResultsServiceEnum = {};
10194
+ exports.GetUserSyncResultsServiceEnum = {
10195
+ Ldap: 'LDAP',
10196
+ Gewisdb: 'GEWISDB'
10197
+ };
10118
10198
  /**
10119
10199
  * TermsOfServiceApi - axios parameter creator
10120
10200
  * @export
@@ -11187,12 +11267,15 @@ const TransfersApiAxiosParamCreator = function (configuration) {
11187
11267
  * @summary Returns all existing transfers
11188
11268
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
11189
11269
  * @param {string} [tillDate] End date for selected transfers (exclusive)
11270
+ * @param {number} [fromId] Filter transfers from this user ID
11271
+ * @param {number} [toId] Filter transfers to this user ID
11272
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
11190
11273
  * @param {number} [take] How many transfers the endpoint should return
11191
11274
  * @param {number} [skip] How many transfers should be skipped (for pagination)
11192
11275
  * @param {*} [options] Override http request option.
11193
11276
  * @throws {RequiredError}
11194
11277
  */
11195
- getAllTransfers: async (fromDate, tillDate, take, skip, options = {}) => {
11278
+ getAllTransfers: async (fromDate, tillDate, fromId, toId, category, take, skip, options = {}) => {
11196
11279
  const localVarPath = `/transfers`;
11197
11280
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11198
11281
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -11212,6 +11295,15 @@ const TransfersApiAxiosParamCreator = function (configuration) {
11212
11295
  if (tillDate !== undefined) {
11213
11296
  localVarQueryParameter['tillDate'] = tillDate;
11214
11297
  }
11298
+ if (fromId !== undefined) {
11299
+ localVarQueryParameter['fromId'] = fromId;
11300
+ }
11301
+ if (toId !== undefined) {
11302
+ localVarQueryParameter['toId'] = toId;
11303
+ }
11304
+ if (category !== undefined) {
11305
+ localVarQueryParameter['category'] = category;
11306
+ }
11215
11307
  if (take !== undefined) {
11216
11308
  localVarQueryParameter['take'] = take;
11217
11309
  }
@@ -11265,7 +11357,7 @@ const TransfersApiAxiosParamCreator = function (configuration) {
11265
11357
  * @param {string} [tillDate] End date for selected transfers (exclusive)
11266
11358
  * @param {number} [fromId] Filter transfers from this user ID
11267
11359
  * @param {number} [toId] Filter transfers to this user ID
11268
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11360
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11269
11361
  * @param {*} [options] Override http request option.
11270
11362
  * @throws {RequiredError}
11271
11363
  */
@@ -11338,6 +11430,50 @@ const TransfersApiAxiosParamCreator = function (configuration) {
11338
11430
  options: localVarRequestOptions,
11339
11431
  };
11340
11432
  },
11433
+ /**
11434
+ *
11435
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11436
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
11437
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
11438
+ * @param {number} [fromId] Filter transfers from this user ID
11439
+ * @param {number} [toId] Filter transfers to this user ID
11440
+ * @param {*} [options] Override http request option.
11441
+ * @throws {RequiredError}
11442
+ */
11443
+ getTransferSummary: async (fromDate, tillDate, fromId, toId, options = {}) => {
11444
+ const localVarPath = `/transfers/summary`;
11445
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11446
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
11447
+ let baseOptions;
11448
+ if (configuration) {
11449
+ baseOptions = configuration.baseOptions;
11450
+ }
11451
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
11452
+ const localVarHeaderParameter = {};
11453
+ const localVarQueryParameter = {};
11454
+ // authentication JWT required
11455
+ // http bearer authentication required
11456
+ await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
11457
+ if (fromDate !== undefined) {
11458
+ localVarQueryParameter['fromDate'] = fromDate;
11459
+ }
11460
+ if (tillDate !== undefined) {
11461
+ localVarQueryParameter['tillDate'] = tillDate;
11462
+ }
11463
+ if (fromId !== undefined) {
11464
+ localVarQueryParameter['fromId'] = fromId;
11465
+ }
11466
+ if (toId !== undefined) {
11467
+ localVarQueryParameter['toId'] = toId;
11468
+ }
11469
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
11470
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11471
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
11472
+ return {
11473
+ url: (0, common_1.toPathString)(localVarUrlObj),
11474
+ options: localVarRequestOptions,
11475
+ };
11476
+ },
11341
11477
  };
11342
11478
  };
11343
11479
  exports.TransfersApiAxiosParamCreator = TransfersApiAxiosParamCreator;
@@ -11379,13 +11515,16 @@ const TransfersApiFp = function (configuration) {
11379
11515
  * @summary Returns all existing transfers
11380
11516
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
11381
11517
  * @param {string} [tillDate] End date for selected transfers (exclusive)
11518
+ * @param {number} [fromId] Filter transfers from this user ID
11519
+ * @param {number} [toId] Filter transfers to this user ID
11520
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
11382
11521
  * @param {number} [take] How many transfers the endpoint should return
11383
11522
  * @param {number} [skip] How many transfers should be skipped (for pagination)
11384
11523
  * @param {*} [options] Override http request option.
11385
11524
  * @throws {RequiredError}
11386
11525
  */
11387
- async getAllTransfers(fromDate, tillDate, take, skip, options) {
11388
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAllTransfers(fromDate, tillDate, take, skip, options);
11526
+ async getAllTransfers(fromDate, tillDate, fromId, toId, category, take, skip, options) {
11527
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAllTransfers(fromDate, tillDate, fromId, toId, category, take, skip, options);
11389
11528
  const index = configuration?.serverIndex ?? 0;
11390
11529
  const operationBasePath = base_1.operationServerMap['TransfersApi.getAllTransfers']?.[index]?.url;
11391
11530
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
@@ -11410,7 +11549,7 @@ const TransfersApiFp = function (configuration) {
11410
11549
  * @param {string} [tillDate] End date for selected transfers (exclusive)
11411
11550
  * @param {number} [fromId] Filter transfers from this user ID
11412
11551
  * @param {number} [toId] Filter transfers to this user ID
11413
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11552
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
11414
11553
  * @param {*} [options] Override http request option.
11415
11554
  * @throws {RequiredError}
11416
11555
  */
@@ -11433,6 +11572,22 @@ const TransfersApiFp = function (configuration) {
11433
11572
  const operationBasePath = base_1.operationServerMap['TransfersApi.getTransferPdf']?.[index]?.url;
11434
11573
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
11435
11574
  },
11575
+ /**
11576
+ *
11577
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11578
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
11579
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
11580
+ * @param {number} [fromId] Filter transfers from this user ID
11581
+ * @param {number} [toId] Filter transfers to this user ID
11582
+ * @param {*} [options] Override http request option.
11583
+ * @throws {RequiredError}
11584
+ */
11585
+ async getTransferSummary(fromDate, tillDate, fromId, toId, options) {
11586
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTransferSummary(fromDate, tillDate, fromId, toId, options);
11587
+ const index = configuration?.serverIndex ?? 0;
11588
+ const operationBasePath = base_1.operationServerMap['TransfersApi.getTransferSummary']?.[index]?.url;
11589
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
11590
+ },
11436
11591
  };
11437
11592
  };
11438
11593
  exports.TransfersApiFp = TransfersApiFp;
@@ -11471,7 +11626,7 @@ const TransfersApiFactory = function (configuration, basePath, axios) {
11471
11626
  * @throws {RequiredError}
11472
11627
  */
11473
11628
  getAllTransfers(requestParameters = {}, options) {
11474
- return localVarFp.getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.take, requestParameters.skip, options).then((request) => request(axios, basePath));
11629
+ return localVarFp.getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, requestParameters.category, requestParameters.take, requestParameters.skip, options).then((request) => request(axios, basePath));
11475
11630
  },
11476
11631
  /**
11477
11632
  *
@@ -11503,6 +11658,16 @@ const TransfersApiFactory = function (configuration, basePath, axios) {
11503
11658
  getTransferPdf(requestParameters, options) {
11504
11659
  return localVarFp.getTransferPdf(requestParameters.id, options).then((request) => request(axios, basePath));
11505
11660
  },
11661
+ /**
11662
+ *
11663
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11664
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
11665
+ * @param {*} [options] Override http request option.
11666
+ * @throws {RequiredError}
11667
+ */
11668
+ getTransferSummary(requestParameters = {}, options) {
11669
+ return localVarFp.getTransferSummary(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, options).then((request) => request(axios, basePath));
11670
+ },
11506
11671
  };
11507
11672
  };
11508
11673
  exports.TransfersApiFactory = TransfersApiFactory;
@@ -11544,7 +11709,7 @@ class TransfersApi extends base_1.BaseAPI {
11544
11709
  * @memberof TransfersApi
11545
11710
  */
11546
11711
  getAllTransfers(requestParameters = {}, options) {
11547
- return (0, exports.TransfersApiFp)(this.configuration).getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.take, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
11712
+ return (0, exports.TransfersApiFp)(this.configuration).getAllTransfers(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, requestParameters.category, requestParameters.take, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
11548
11713
  }
11549
11714
  /**
11550
11715
  *
@@ -11579,6 +11744,17 @@ class TransfersApi extends base_1.BaseAPI {
11579
11744
  getTransferPdf(requestParameters, options) {
11580
11745
  return (0, exports.TransfersApiFp)(this.configuration).getTransferPdf(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
11581
11746
  }
11747
+ /**
11748
+ *
11749
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
11750
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
11751
+ * @param {*} [options] Override http request option.
11752
+ * @throws {RequiredError}
11753
+ * @memberof TransfersApi
11754
+ */
11755
+ getTransferSummary(requestParameters = {}, options) {
11756
+ return (0, exports.TransfersApiFp)(this.configuration).getTransferSummary(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, options).then((request) => request(this.axios, this.basePath));
11757
+ }
11582
11758
  }
11583
11759
  exports.TransfersApi = TransfersApi;
11584
11760
  /**
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gewis/sudosos-client",
3
- "version": "0.0.0-develop.dabdc9d",
3
+ "version": "0.0.0-develop.e4aa3f3",
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",
@@ -16,11 +16,11 @@
16
16
  "clean": "rm -rf src dist"
17
17
  },
18
18
  "dependencies": {
19
- "axios": "^1.6.3"
19
+ "axios": "1.15.0"
20
20
  },
21
21
  "devDependencies": {
22
- "@openapitools/openapi-generator-cli": "^2.7.0",
23
- "typescript": "~5.9.3"
22
+ "@openapitools/openapi-generator-cli": "2.31.1",
23
+ "typescript": "5.9.3"
24
24
  },
25
25
  "repository": {
26
26
  "type": "git",