@gewis/sudosos-client 0.0.0-develop.efea20e → 0.0.0-develop.f2b7926

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
@@ -1659,7 +1659,7 @@ export interface ContainerWithProductsResponse {
1659
1659
  'products': Array<ProductResponse>;
1660
1660
  }
1661
1661
  /**
1662
- *
1662
+ * API Request for creating a `container` entity.
1663
1663
  * @export
1664
1664
  * @interface CreateContainerRequest
1665
1665
  */
@@ -1856,7 +1856,7 @@ export interface CreatePermissionParams {
1856
1856
  'attributes': Array<string>;
1857
1857
  }
1858
1858
  /**
1859
- *
1859
+ * API Request for creating a `point of sale` entity.
1860
1860
  * @export
1861
1861
  * @interface CreatePointOfSaleRequest
1862
1862
  */
@@ -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
  */
@@ -1893,7 +1893,7 @@ export interface CreatePointOfSaleRequest {
1893
1893
  'cashierRoleIds'?: Array<number>;
1894
1894
  }
1895
1895
  /**
1896
- *
1896
+ * API Request for creating a `product` entity.
1897
1897
  * @export
1898
1898
  * @interface CreateProductRequest
1899
1899
  */
@@ -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
  *
@@ -3268,7 +3304,7 @@ export interface PaginatedBaseTransactionResponse {
3268
3304
  'records': Array<BaseTransactionResponse>;
3269
3305
  }
3270
3306
  /**
3271
- *
3307
+ * Paginated API Response for the `container` entity.
3272
3308
  * @export
3273
3309
  * @interface PaginatedContainerResponse
3274
3310
  */
@@ -3287,7 +3323,7 @@ export interface PaginatedContainerResponse {
3287
3323
  'records': Array<ContainerResponse>;
3288
3324
  }
3289
3325
  /**
3290
- *
3326
+ * Paginated API Response for the `container` entity, with each container\'s products inlined.
3291
3327
  * @export
3292
3328
  * @interface PaginatedContainerWithProductResponse
3293
3329
  */
@@ -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
  *
@@ -3401,7 +3437,7 @@ export interface PaginatedInvoiceResponse {
3401
3437
  'records': Array<InvoiceResponseTypes>;
3402
3438
  }
3403
3439
  /**
3404
- *
3440
+ * Paginated API Response for the `point of sale` entity.
3405
3441
  * @export
3406
3442
  * @interface PaginatedPointOfSaleResponse
3407
3443
  */
@@ -3420,7 +3456,7 @@ export interface PaginatedPointOfSaleResponse {
3420
3456
  'records': Array<PointOfSaleResponse>;
3421
3457
  }
3422
3458
  /**
3423
- *
3459
+ * Paginated API Response for the `product category` entity.
3424
3460
  * @export
3425
3461
  * @interface PaginatedProductCategoryResponse
3426
3462
  */
@@ -3439,7 +3475,7 @@ export interface PaginatedProductCategoryResponse {
3439
3475
  'records': Array<ProductCategoryResponse>;
3440
3476
  }
3441
3477
  /**
3442
- *
3478
+ * Paginated API Response for the `product` entity.
3443
3479
  * @export
3444
3480
  * @interface PaginatedProductResponse
3445
3481
  */
@@ -3534,7 +3570,7 @@ export interface PaginatedUserResponse {
3534
3570
  'records': Array<UserResponse>;
3535
3571
  }
3536
3572
  /**
3537
- *
3573
+ * Paginated API Response for the `vat group` entity.
3538
3574
  * @export
3539
3575
  * @interface PaginatedVatGroupResponse
3540
3576
  */
@@ -3866,7 +3902,7 @@ export interface PermissionResponse {
3866
3902
  'actions': Array<ActionResponse>;
3867
3903
  }
3868
3904
  /**
3869
- *
3905
+ * API Response describing who is associated with a `point of sale`: its owner, the owner\'s organ members, and the cashier users (users holding at least one of the POS\'s cashier roles).
3870
3906
  * @export
3871
3907
  * @interface PointOfSaleAssociateUsersResponse
3872
3908
  */
@@ -4019,7 +4055,7 @@ export interface PointOfSaleWithContainersResponse {
4019
4055
  'containers': Array<ContainerWithProductsResponse>;
4020
4056
  }
4021
4057
  /**
4022
- *
4058
+ * API Request for creating or updating a `product category` entity.
4023
4059
  * @export
4024
4060
  * @interface ProductCategoryRequest
4025
4061
  */
@@ -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
  *
@@ -5685,7 +5721,7 @@ export interface TransferSummaryResponse {
5685
5721
  'manualDeletions': TransferAggregateResponse;
5686
5722
  }
5687
5723
  /**
5688
- *
5724
+ * API Request for updating a `container` entity.
5689
5725
  * @export
5690
5726
  * @interface UpdateContainerRequest
5691
5727
  */
@@ -5935,7 +5971,7 @@ export interface UpdatePinRequest {
5935
5971
  'pin': string;
5936
5972
  }
5937
5973
  /**
5938
- *
5974
+ * API Request for updating a `point of sale` entity.
5939
5975
  * @export
5940
5976
  * @interface UpdatePointOfSaleRequest
5941
5977
  */
@@ -5972,7 +6008,7 @@ export interface UpdatePointOfSaleRequest {
5972
6008
  'cashierRoleIds'?: Array<number>;
5973
6009
  }
5974
6010
  /**
5975
- *
6011
+ * API Request for updating a `product` entity.
5976
6012
  * @export
5977
6013
  * @interface UpdateProductRequest
5978
6014
  */
@@ -6139,7 +6175,7 @@ export interface UpdateUserRequest {
6139
6175
  'inactiveNotificationSend'?: boolean;
6140
6176
  }
6141
6177
  /**
6142
- *
6178
+ * API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
6143
6179
  * @export
6144
6180
  * @interface UpdateVatGroupRequest
6145
6181
  */
@@ -6459,6 +6495,22 @@ export interface UserToInactiveAdministrativeCostResponse {
6459
6495
  */
6460
6496
  'nickname'?: string;
6461
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];
6462
6514
  /**
6463
6515
  *
6464
6516
  * @export
@@ -6485,7 +6537,7 @@ export interface UserTypeTotalBalanceResponse {
6485
6537
  'totalNegative': DineroObjectResponse;
6486
6538
  }
6487
6539
  /**
6488
- *
6540
+ * A `BaseUserResponse` augmented with a stable position index, used to keep ordered user lists (e.g. POS owner members) rendering in a consistent order across requests.
6489
6541
  * @export
6490
6542
  * @interface UserWithIndex
6491
6543
  */
@@ -6500,6 +6552,25 @@ export interface UserWithIndex {
6500
6552
  /**
6501
6553
  *
6502
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
+ }
6571
+ /**
6572
+ * API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
6573
+ * @export
6503
6574
  * @interface VatDeclarationResponse
6504
6575
  */
6505
6576
  export interface VatDeclarationResponse {
@@ -6523,7 +6594,7 @@ export interface VatDeclarationResponse {
6523
6594
  'rows': Array<VatDeclarationRow>;
6524
6595
  }
6525
6596
  /**
6526
- *
6597
+ * One row of a VAT declaration — the VAT collected for a single group, broken down by period.
6527
6598
  * @export
6528
6599
  * @interface VatDeclarationRow
6529
6600
  */
@@ -8061,7 +8132,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
8061
8132
  * @param {boolean} [hasFine] Only users with(out) fines
8062
8133
  * @param {number} [minFine] Minimum fine
8063
8134
  * @param {number} [maxFine] Maximum fine
8064
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8135
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
8065
8136
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
8066
8137
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
8067
8138
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8071,7 +8142,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
8071
8142
  * @param {*} [options] Override http request option.
8072
8143
  * @throws {RequiredError}
8073
8144
  */
8074
- 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>;
8075
8146
  /**
8076
8147
  *
8077
8148
  * @summary Retrieves the requested balance
@@ -8111,7 +8182,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8111
8182
  * @param {boolean} [hasFine] Only users with(out) fines
8112
8183
  * @param {number} [minFine] Minimum fine
8113
8184
  * @param {number} [maxFine] Maximum fine
8114
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8185
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
8115
8186
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
8116
8187
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
8117
8188
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8121,7 +8192,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8121
8192
  * @param {*} [options] Override http request option.
8122
8193
  * @throws {RequiredError}
8123
8194
  */
8124
- 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>>;
8125
8196
  /**
8126
8197
  *
8127
8198
  * @summary Retrieves the requested balance
@@ -8238,10 +8309,10 @@ export interface BalanceApiGetAllBalanceRequest {
8238
8309
  readonly maxFine?: number;
8239
8310
  /**
8240
8311
  * Filter based on user type.
8241
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
8312
+ * @type {Array<UserType>}
8242
8313
  * @memberof BalanceApiGetAllBalance
8243
8314
  */
8244
- readonly userTypes?: GetAllBalanceUserTypesEnum;
8315
+ readonly userTypes?: Array<UserType>;
8245
8316
  /**
8246
8317
  * Column to order balance by - eg: id,amount
8247
8318
  * @type {string}
@@ -8335,11 +8406,6 @@ export declare class BalanceApi extends BaseAPI {
8335
8406
  */
8336
8407
  getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
8337
8408
  }
8338
- /**
8339
- * @export
8340
- */
8341
- export declare const GetAllBalanceUserTypesEnum: {};
8342
- export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
8343
8409
  /**
8344
8410
  * @export
8345
8411
  */
@@ -10760,7 +10826,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
10760
10826
  * @param {*} [options] Override http request option.
10761
10827
  * @throws {RequiredError}
10762
10828
  */
10763
- 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>>>;
10764
10830
  /**
10765
10831
  *
10766
10832
  * @summary Notify all users which will pay administrative costs within a year
@@ -10838,7 +10904,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
10838
10904
  * @param {*} [options] Override http request option.
10839
10905
  * @throws {RequiredError}
10840
10906
  */
10841
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10907
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
10842
10908
  /**
10843
10909
  *
10844
10910
  * @summary Notify all users which will pay administrative costs within a year
@@ -11061,7 +11127,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
11061
11127
  * @throws {RequiredError}
11062
11128
  * @memberof InactiveAdministrativeCostsApi
11063
11129
  */
11064
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
11130
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
11065
11131
  /**
11066
11132
  *
11067
11133
  * @summary Notify all users which will pay administrative costs within a year
@@ -11106,7 +11172,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11106
11172
  * @summary Returns all invoices in the system.
11107
11173
  * @param {number} [toId] Filter on Id of the debtor
11108
11174
  * @param {number} [invoiceId] Filter on invoice ID
11109
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11175
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11110
11176
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11111
11177
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11112
11178
  * @param {string} [tillDate] End date for selected invoices (exclusive)
@@ -11116,7 +11182,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11116
11182
  * @param {*} [options] Override http request option.
11117
11183
  * @throws {RequiredError}
11118
11184
  */
11119
- 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>;
11120
11186
  /**
11121
11187
  *
11122
11188
  * @summary Get eligible transactions for invoice creation.
@@ -11127,6 +11193,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11127
11193
  * @throws {RequiredError}
11128
11194
  */
11129
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>;
11130
11203
  /**
11131
11204
  *
11132
11205
  * @summary Get an invoice pdf.
@@ -11206,7 +11279,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11206
11279
  * @summary Returns all invoices in the system.
11207
11280
  * @param {number} [toId] Filter on Id of the debtor
11208
11281
  * @param {number} [invoiceId] Filter on invoice ID
11209
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11282
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11210
11283
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11211
11284
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11212
11285
  * @param {string} [tillDate] End date for selected invoices (exclusive)
@@ -11216,7 +11289,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11216
11289
  * @param {*} [options] Override http request option.
11217
11290
  * @throws {RequiredError}
11218
11291
  */
11219
- 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>>;
11220
11293
  /**
11221
11294
  *
11222
11295
  * @summary Get eligible transactions for invoice creation.
@@ -11227,6 +11300,13 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11227
11300
  * @throws {RequiredError}
11228
11301
  */
11229
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>>>;
11230
11310
  /**
11231
11311
  *
11232
11312
  * @summary Get an invoice pdf.
@@ -11235,7 +11315,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11235
11315
  * @param {*} [options] Override http request option.
11236
11316
  * @throws {RequiredError}
11237
11317
  */
11238
- 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>>;
11239
11319
  /**
11240
11320
  *
11241
11321
  * @summary Returns a single invoice in the system.
@@ -11317,6 +11397,13 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11317
11397
  * @throws {RequiredError}
11318
11398
  */
11319
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>>;
11320
11407
  /**
11321
11408
  *
11322
11409
  * @summary Get an invoice pdf.
@@ -11324,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11324
11411
  * @param {*} [options] Override http request option.
11325
11412
  * @throws {RequiredError}
11326
11413
  */
11327
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
11414
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
11328
11415
  /**
11329
11416
  *
11330
11417
  * @summary Returns a single invoice in the system.
@@ -11417,10 +11504,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
11417
11504
  readonly invoiceId?: number;
11418
11505
  /**
11419
11506
  * Filter based on Invoice State.
11420
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
11507
+ * @type {Array<GetAllInvoicesCurrentStateParameterInner>}
11421
11508
  * @memberof InvoicesApiGetAllInvoices
11422
11509
  */
11423
- readonly currentState?: GetAllInvoicesCurrentStateEnum;
11510
+ readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
11424
11511
  /**
11425
11512
  * Boolean if invoice entries should be returned
11426
11513
  * @type {boolean}
@@ -11624,6 +11711,14 @@ export declare class InvoicesApi extends BaseAPI {
11624
11711
  * @memberof InvoicesApi
11625
11712
  */
11626
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, {}>>;
11627
11722
  /**
11628
11723
  *
11629
11724
  * @summary Get an invoice pdf.
@@ -11632,7 +11727,7 @@ export declare class InvoicesApi extends BaseAPI {
11632
11727
  * @throws {RequiredError}
11633
11728
  * @memberof InvoicesApi
11634
11729
  */
11635
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
11730
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
11636
11731
  /**
11637
11732
  *
11638
11733
  * @summary Returns a single invoice in the system.
@@ -11670,11 +11765,6 @@ export declare class InvoicesApi extends BaseAPI {
11670
11765
  */
11671
11766
  updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
11672
11767
  }
11673
- /**
11674
- * @export
11675
- */
11676
- export declare const GetAllInvoicesCurrentStateEnum: {};
11677
- export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
11678
11768
  /**
11679
11769
  * PayoutRequestsApi - axios parameter creator
11680
11770
  * @export
@@ -14229,11 +14319,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
14229
14319
  /**
14230
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.
14231
14321
  * @summary Get dry-run sync results for users
14232
- * @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.
14233
14323
  * @param {*} [options] Override http request option.
14234
14324
  * @throws {RequiredError}
14235
14325
  */
14236
- getUserSyncResults: (service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14326
+ getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14237
14327
  };
14238
14328
  /**
14239
14329
  * SyncApi - functional programming interface
@@ -14243,11 +14333,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
14243
14333
  /**
14244
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.
14245
14335
  * @summary Get dry-run sync results for users
14246
- * @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.
14247
14337
  * @param {*} [options] Override http request option.
14248
14338
  * @throws {RequiredError}
14249
14339
  */
14250
- 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>>;
14251
14341
  };
14252
14342
  /**
14253
14343
  * SyncApi - factory interface
@@ -14271,10 +14361,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
14271
14361
  export interface SyncApiGetUserSyncResultsRequest {
14272
14362
  /**
14273
14363
  * Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14274
- * @type {Array<string>}
14364
+ * @type {Array<'LDAP' | 'GEWISDB'>}
14275
14365
  * @memberof SyncApiGetUserSyncResults
14276
14366
  */
14277
- readonly service?: GetUserSyncResultsServiceEnum;
14367
+ readonly service?: Array<GetUserSyncResultsServiceEnum>;
14278
14368
  }
14279
14369
  /**
14280
14370
  * SyncApi - object-oriented interface
@@ -14296,7 +14386,10 @@ export declare class SyncApi extends BaseAPI {
14296
14386
  /**
14297
14387
  * @export
14298
14388
  */
14299
- export declare const GetUserSyncResultsServiceEnum: {};
14389
+ export declare const GetUserSyncResultsServiceEnum: {
14390
+ readonly Ldap: "LDAP";
14391
+ readonly Gewisdb: "GEWISDB";
14392
+ };
14300
14393
  export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
14301
14394
  /**
14302
14395
  * TermsOfServiceApi - axios parameter creator
@@ -15046,12 +15139,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
15046
15139
  * @summary Returns all existing transfers
15047
15140
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
15048
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
15049
15145
  * @param {number} [take] How many transfers the endpoint should return
15050
15146
  * @param {number} [skip] How many transfers should be skipped (for pagination)
15051
15147
  * @param {*} [options] Override http request option.
15052
15148
  * @throws {RequiredError}
15053
15149
  */
15054
- 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>;
15055
15151
  /**
15056
15152
  *
15057
15153
  * @summary Returns the requested transfer
@@ -15118,12 +15214,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15118
15214
  * @summary Returns all existing transfers
15119
15215
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
15120
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
15121
15220
  * @param {number} [take] How many transfers the endpoint should return
15122
15221
  * @param {number} [skip] How many transfers should be skipped (for pagination)
15123
15222
  * @param {*} [options] Override http request option.
15124
15223
  * @throws {RequiredError}
15125
15224
  */
15126
- 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>>>;
15127
15226
  /**
15128
15227
  *
15129
15228
  * @summary Returns the requested transfer
@@ -15270,6 +15369,24 @@ export interface TransfersApiGetAllTransfersRequest {
15270
15369
  * @memberof TransfersApiGetAllTransfers
15271
15370
  */
15272
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;
15273
15390
  /**
15274
15391
  * How many transfers the endpoint should return
15275
15392
  * @type {number}
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
  }
@@ -11423,13 +11515,16 @@ const TransfersApiFp = function (configuration) {
11423
11515
  * @summary Returns all existing transfers
11424
11516
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
11425
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
11426
11521
  * @param {number} [take] How many transfers the endpoint should return
11427
11522
  * @param {number} [skip] How many transfers should be skipped (for pagination)
11428
11523
  * @param {*} [options] Override http request option.
11429
11524
  * @throws {RequiredError}
11430
11525
  */
11431
- async getAllTransfers(fromDate, tillDate, take, skip, options) {
11432
- 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);
11433
11528
  const index = configuration?.serverIndex ?? 0;
11434
11529
  const operationBasePath = base_1.operationServerMap['TransfersApi.getAllTransfers']?.[index]?.url;
11435
11530
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
@@ -11531,7 +11626,7 @@ const TransfersApiFactory = function (configuration, basePath, axios) {
11531
11626
  * @throws {RequiredError}
11532
11627
  */
11533
11628
  getAllTransfers(requestParameters = {}, options) {
11534
- 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));
11535
11630
  },
11536
11631
  /**
11537
11632
  *
@@ -11614,7 +11709,7 @@ class TransfersApi extends base_1.BaseAPI {
11614
11709
  * @memberof TransfersApi
11615
11710
  */
11616
11711
  getAllTransfers(requestParameters = {}, options) {
11617
- 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));
11618
11713
  }
11619
11714
  /**
11620
11715
  *
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.efea20e",
3
+ "version": "0.0.0-develop.f2b7926",
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.2"
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",