@gewis/sudosos-client 0.0.0-develop.d892faf → 0.0.0-develop.da5f142

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/dist/api.d.ts CHANGED
@@ -58,19 +58,6 @@ export interface AddRoleRequest {
58
58
  */
59
59
  'roleId': number;
60
60
  }
61
- /**
62
- *
63
- * @export
64
- * @interface AuthenticationEanRequest
65
- */
66
- export interface AuthenticationEanRequest {
67
- /**
68
- *
69
- * @type {string}
70
- * @memberof AuthenticationEanRequest
71
- */
72
- 'eanCode': string;
73
- }
74
61
  /**
75
62
  *
76
63
  * @export
@@ -147,38 +134,6 @@ export interface AuthenticationMockRequest {
147
134
  */
148
135
  'nonce': string;
149
136
  }
150
- /**
151
- *
152
- * @export
153
- * @interface AuthenticationNfcRequest
154
- */
155
- export interface AuthenticationNfcRequest {
156
- /**
157
- *
158
- * @type {string}
159
- * @memberof AuthenticationNfcRequest
160
- */
161
- 'nfcCode': string;
162
- }
163
- /**
164
- *
165
- * @export
166
- * @interface AuthenticationPinRequest
167
- */
168
- export interface AuthenticationPinRequest {
169
- /**
170
- *
171
- * @type {number}
172
- * @memberof AuthenticationPinRequest
173
- */
174
- 'userId': number;
175
- /**
176
- *
177
- * @type {string}
178
- * @memberof AuthenticationPinRequest
179
- */
180
- 'pin': string;
181
- }
182
137
  /**
183
138
  *
184
139
  * @export
@@ -946,6 +901,104 @@ export interface BaseInvoiceResponse {
946
901
  */
947
902
  'totalInclVat': DineroObjectResponse;
948
903
  }
904
+ /**
905
+ * PaymentRequest is UUID-keyed. To avoid overloading the `id` slot (which on other responses is the numeric DB id), the UUID is exposed under a semantically named field, mirroring how `QRAuthenticator` exposes its UUID as `sessionId`. The response therefore extends `BaseResponseWithoutId` (timestamps + version, no `id`) and declares a `uuid` of its own.
906
+ * @export
907
+ * @interface BasePaymentRequestResponse
908
+ */
909
+ export interface BasePaymentRequestResponse {
910
+ /**
911
+ * UUID v4 identifier (also the public share-link id).
912
+ * @type {string}
913
+ * @memberof BasePaymentRequestResponse
914
+ */
915
+ 'uuid': string;
916
+ /**
917
+ * ISO-8601 creation timestamp.
918
+ * @type {string}
919
+ * @memberof BasePaymentRequestResponse
920
+ */
921
+ 'createdAt'?: string;
922
+ /**
923
+ * ISO-8601 last update timestamp.
924
+ * @type {string}
925
+ * @memberof BasePaymentRequestResponse
926
+ */
927
+ 'updatedAt'?: string;
928
+ /**
929
+ * Optimistic-locking version.
930
+ * @type {number}
931
+ * @memberof BasePaymentRequestResponse
932
+ */
933
+ 'version'?: number;
934
+ /**
935
+ *
936
+ * @type {BaseUserResponse}
937
+ * @memberof BasePaymentRequestResponse
938
+ */
939
+ 'for': BaseUserResponse;
940
+ /**
941
+ *
942
+ * @type {BaseUserResponse}
943
+ * @memberof BasePaymentRequestResponse
944
+ */
945
+ 'createdBy': BaseUserResponse;
946
+ /**
947
+ *
948
+ * @type {DineroObjectResponse}
949
+ * @memberof BasePaymentRequestResponse
950
+ */
951
+ 'amount': DineroObjectResponse;
952
+ /**
953
+ * ISO-8601 timestamp after which payments stop being accepted.
954
+ * @type {string}
955
+ * @memberof BasePaymentRequestResponse
956
+ */
957
+ 'expiresAt': string;
958
+ /**
959
+ * ISO-8601 timestamp the request was marked paid (null if not paid).
960
+ * @type {string}
961
+ * @memberof BasePaymentRequestResponse
962
+ */
963
+ 'paidAt'?: string;
964
+ /**
965
+ * ISO-8601 timestamp the request was cancelled (null if not cancelled).
966
+ * @type {string}
967
+ * @memberof BasePaymentRequestResponse
968
+ */
969
+ 'cancelledAt'?: string;
970
+ /**
971
+ *
972
+ * @type {BaseUserResponse}
973
+ * @memberof BasePaymentRequestResponse
974
+ */
975
+ 'cancelledBy'?: BaseUserResponse;
976
+ /**
977
+ *
978
+ * @type {BaseUserResponse}
979
+ * @memberof BasePaymentRequestResponse
980
+ */
981
+ 'fulfilledBy'?: BaseUserResponse;
982
+ /**
983
+ * Optional human-readable description.
984
+ * @type {string}
985
+ * @memberof BasePaymentRequestResponse
986
+ */
987
+ 'description'?: string;
988
+ /**
989
+ * Derived lifecycle status.
990
+ * @type {string}
991
+ * @memberof BasePaymentRequestResponse
992
+ */
993
+ 'status': BasePaymentRequestResponseStatusEnum;
994
+ }
995
+ export declare const BasePaymentRequestResponseStatusEnum: {
996
+ readonly Pending: "PENDING";
997
+ readonly Paid: "PAID";
998
+ readonly Expired: "EXPIRED";
999
+ readonly Cancelled: "CANCELLED";
1000
+ };
1001
+ export type BasePaymentRequestResponseStatusEnum = typeof BasePaymentRequestResponseStatusEnum[keyof typeof BasePaymentRequestResponseStatusEnum];
949
1002
  /**
950
1003
  *
951
1004
  * @export
@@ -1186,6 +1239,31 @@ export interface BaseResponse {
1186
1239
  */
1187
1240
  'version'?: number;
1188
1241
  }
1242
+ /**
1243
+ * Standard timestamp/version fields every response shares, without an `id`. Responses that key on a UUID (or any non-integer identifier) extend this and add their own `id` field. Responses keyed on an integer id extend `BaseResponse` instead, which adds `id: number`. Parallel to `BaseEntityWithoutId` on the entity side.
1244
+ * @export
1245
+ * @interface BaseResponseWithoutId
1246
+ */
1247
+ export interface BaseResponseWithoutId {
1248
+ /**
1249
+ * The creation Date of the entity.
1250
+ * @type {string}
1251
+ * @memberof BaseResponseWithoutId
1252
+ */
1253
+ 'createdAt'?: string;
1254
+ /**
1255
+ * The last update Date of the entity.
1256
+ * @type {string}
1257
+ * @memberof BaseResponseWithoutId
1258
+ */
1259
+ 'updatedAt'?: string;
1260
+ /**
1261
+ * The version of the entity.
1262
+ * @type {number}
1263
+ * @memberof BaseResponseWithoutId
1264
+ */
1265
+ 'version'?: number;
1266
+ }
1189
1267
  /**
1190
1268
  *
1191
1269
  * @export
@@ -1659,7 +1737,7 @@ export interface ContainerWithProductsResponse {
1659
1737
  'products': Array<ProductResponse>;
1660
1738
  }
1661
1739
  /**
1662
- *
1740
+ * API Request for creating a `container` entity.
1663
1741
  * @export
1664
1742
  * @interface CreateContainerRequest
1665
1743
  */
@@ -1683,11 +1761,11 @@ export interface CreateContainerRequest {
1683
1761
  */
1684
1762
  'public': boolean;
1685
1763
  /**
1686
- * Id of the user who will own the container, if undefined it will default to the token ID.
1764
+ * Id of the organ that will own the container
1687
1765
  * @type {number}
1688
1766
  * @memberof CreateContainerRequest
1689
1767
  */
1690
- 'ownerId'?: number;
1768
+ 'ownerId': number;
1691
1769
  }
1692
1770
  /**
1693
1771
  *
@@ -1856,7 +1934,7 @@ export interface CreatePermissionParams {
1856
1934
  'attributes': Array<string>;
1857
1935
  }
1858
1936
  /**
1859
- *
1937
+ * API Request for creating a `point of sale` entity.
1860
1938
  * @export
1861
1939
  * @interface CreatePointOfSaleRequest
1862
1940
  */
@@ -1880,7 +1958,7 @@ export interface CreatePointOfSaleRequest {
1880
1958
  */
1881
1959
  'containers': Array<number>;
1882
1960
  /**
1883
- * ID of the user who will own the POS, if undefined it will default to the token ID.
1961
+ * ID of the user who will own the POS.
1884
1962
  * @type {number}
1885
1963
  * @memberof CreatePointOfSaleRequest
1886
1964
  */
@@ -1893,7 +1971,7 @@ export interface CreatePointOfSaleRequest {
1893
1971
  'cashierRoleIds'?: Array<number>;
1894
1972
  }
1895
1973
  /**
1896
- *
1974
+ * API Request for creating a `product` entity.
1897
1975
  * @export
1898
1976
  * @interface CreateProductRequest
1899
1977
  */
@@ -2566,10 +2644,15 @@ export interface FineResponse {
2566
2644
  /**
2567
2645
  *
2568
2646
  * @export
2569
- * @interface GetAllBalanceUserTypesParameterInner
2647
+ * @enum {string}
2570
2648
  */
2571
- export interface GetAllBalanceUserTypesParameterInner {
2572
- }
2649
+ export declare const GetAllInvoicesCurrentStateParameterInner: {
2650
+ readonly Created: "CREATED";
2651
+ readonly Sent: "SENT";
2652
+ readonly Paid: "PAID";
2653
+ readonly Deleted: "DELETED";
2654
+ };
2655
+ export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
2573
2656
  /**
2574
2657
  * @type GetAllPayoutRequestsRequestedByIdParameter
2575
2658
  * @export
@@ -2724,6 +2807,37 @@ export interface InactiveAdministrativeCostResponse {
2724
2807
  */
2725
2808
  'transfer': TransferResponse;
2726
2809
  }
2810
+ /**
2811
+ *
2812
+ * @export
2813
+ * @interface InvoiceDriftResponse
2814
+ */
2815
+ export interface InvoiceDriftResponse {
2816
+ /**
2817
+ *
2818
+ * @type {BaseInvoiceResponse}
2819
+ * @memberof InvoiceDriftResponse
2820
+ */
2821
+ 'invoice': BaseInvoiceResponse;
2822
+ /**
2823
+ *
2824
+ * @type {DineroObjectResponse}
2825
+ * @memberof InvoiceDriftResponse
2826
+ */
2827
+ 'actualAmount': DineroObjectResponse;
2828
+ /**
2829
+ *
2830
+ * @type {DineroObjectResponse}
2831
+ * @memberof InvoiceDriftResponse
2832
+ */
2833
+ 'expectedAmount': DineroObjectResponse;
2834
+ /**
2835
+ *
2836
+ * @type {DineroObjectResponse}
2837
+ * @memberof InvoiceDriftResponse
2838
+ */
2839
+ 'deltaAmount': DineroObjectResponse;
2840
+ }
2727
2841
  /**
2728
2842
  *
2729
2843
  * @export
@@ -3115,25 +3229,6 @@ export interface InvoiceUserResponse {
3115
3229
  */
3116
3230
  'automatic': boolean;
3117
3231
  }
3118
- /**
3119
- *
3120
- * @export
3121
- * @interface MemberAuthenticationPinRequest
3122
- */
3123
- export interface MemberAuthenticationPinRequest {
3124
- /**
3125
- *
3126
- * @type {number}
3127
- * @memberof MemberAuthenticationPinRequest
3128
- */
3129
- 'memberId': number;
3130
- /**
3131
- *
3132
- * @type {string}
3133
- * @memberof MemberAuthenticationPinRequest
3134
- */
3135
- 'pin': string;
3136
- }
3137
3232
  /**
3138
3233
  *
3139
3234
  * @export
@@ -3183,13 +3278,13 @@ export interface PaginatedBalanceResponse {
3183
3278
  * @type {PaginationResult}
3184
3279
  * @memberof PaginatedBalanceResponse
3185
3280
  */
3186
- '_pagination'?: PaginationResult;
3281
+ '_pagination': PaginationResult;
3187
3282
  /**
3188
3283
  * Returned balance responses
3189
3284
  * @type {Array<BalanceResponse>}
3190
3285
  * @memberof PaginatedBalanceResponse
3191
3286
  */
3192
- 'records'?: Array<BalanceResponse>;
3287
+ 'records': Array<BalanceResponse>;
3193
3288
  }
3194
3289
  /**
3195
3290
  * Paginated API Response for the `banner` entity.
@@ -3202,13 +3297,13 @@ export interface PaginatedBannerResponse {
3202
3297
  * @type {PaginationResult}
3203
3298
  * @memberof PaginatedBannerResponse
3204
3299
  */
3205
- '_pagination'?: PaginationResult;
3300
+ '_pagination': PaginationResult;
3206
3301
  /**
3207
3302
  * Returned banners
3208
3303
  * @type {Array<BannerResponse>}
3209
3304
  * @memberof PaginatedBannerResponse
3210
3305
  */
3211
- 'records'?: Array<BannerResponse>;
3306
+ 'records': Array<BannerResponse>;
3212
3307
  }
3213
3308
  /**
3214
3309
  *
@@ -3229,6 +3324,25 @@ export interface PaginatedBaseEventResponse {
3229
3324
  */
3230
3325
  'records': Array<BaseEventResponse>;
3231
3326
  }
3327
+ /**
3328
+ *
3329
+ * @export
3330
+ * @interface PaginatedBasePaymentRequestResponse
3331
+ */
3332
+ export interface PaginatedBasePaymentRequestResponse {
3333
+ /**
3334
+ *
3335
+ * @type {PaginationResult}
3336
+ * @memberof PaginatedBasePaymentRequestResponse
3337
+ */
3338
+ '_pagination': PaginationResult;
3339
+ /**
3340
+ * Returned payment requests
3341
+ * @type {Array<BasePaymentRequestResponse>}
3342
+ * @memberof PaginatedBasePaymentRequestResponse
3343
+ */
3344
+ 'records': Array<BasePaymentRequestResponse>;
3345
+ }
3232
3346
  /**
3233
3347
  *
3234
3348
  * @export
@@ -3268,7 +3382,7 @@ export interface PaginatedBaseTransactionResponse {
3268
3382
  'records': Array<BaseTransactionResponse>;
3269
3383
  }
3270
3384
  /**
3271
- *
3385
+ * Paginated API Response for the `container` entity.
3272
3386
  * @export
3273
3387
  * @interface PaginatedContainerResponse
3274
3388
  */
@@ -3287,7 +3401,7 @@ export interface PaginatedContainerResponse {
3287
3401
  'records': Array<ContainerResponse>;
3288
3402
  }
3289
3403
  /**
3290
- *
3404
+ * Paginated API Response for the `container` entity, with each container\'s products inlined.
3291
3405
  * @export
3292
3406
  * @interface PaginatedContainerWithProductResponse
3293
3407
  */
@@ -3373,13 +3487,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
3373
3487
  * @type {PaginationResult}
3374
3488
  * @memberof PaginatedInactiveAdministrativeCostResponse
3375
3489
  */
3376
- '_pagination'?: PaginationResult;
3490
+ '_pagination': PaginationResult;
3377
3491
  /**
3378
3492
  * Returned InactiveAdministrativeCost
3379
3493
  * @type {Array<InactiveAdministrativeCostResponse>}
3380
3494
  * @memberof PaginatedInactiveAdministrativeCostResponse
3381
3495
  */
3382
- 'records'?: Array<InactiveAdministrativeCostResponse>;
3496
+ 'records': Array<InactiveAdministrativeCostResponse>;
3383
3497
  }
3384
3498
  /**
3385
3499
  *
@@ -3401,7 +3515,7 @@ export interface PaginatedInvoiceResponse {
3401
3515
  'records': Array<InvoiceResponseTypes>;
3402
3516
  }
3403
3517
  /**
3404
- *
3518
+ * Paginated API Response for the `point of sale` entity.
3405
3519
  * @export
3406
3520
  * @interface PaginatedPointOfSaleResponse
3407
3521
  */
@@ -3420,7 +3534,7 @@ export interface PaginatedPointOfSaleResponse {
3420
3534
  'records': Array<PointOfSaleResponse>;
3421
3535
  }
3422
3536
  /**
3423
- *
3537
+ * Paginated API Response for the `product category` entity.
3424
3538
  * @export
3425
3539
  * @interface PaginatedProductCategoryResponse
3426
3540
  */
@@ -3439,7 +3553,7 @@ export interface PaginatedProductCategoryResponse {
3439
3553
  'records': Array<ProductCategoryResponse>;
3440
3554
  }
3441
3555
  /**
3442
- *
3556
+ * Paginated API Response for the `product` entity.
3443
3557
  * @export
3444
3558
  * @interface PaginatedProductResponse
3445
3559
  */
@@ -3534,7 +3648,7 @@ export interface PaginatedUserResponse {
3534
3648
  'records': Array<UserResponse>;
3535
3649
  }
3536
3650
  /**
3537
- *
3651
+ * Paginated API Response for the `vat group` entity.
3538
3652
  * @export
3539
3653
  * @interface PaginatedVatGroupResponse
3540
3654
  */
@@ -3659,6 +3773,31 @@ export interface PatchUserTypeRequest {
3659
3773
  */
3660
3774
  'userType': string;
3661
3775
  }
3776
+ /**
3777
+ * Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
3778
+ * @export
3779
+ * @interface PaymentRequestStartResponse
3780
+ */
3781
+ export interface PaymentRequestStartResponse {
3782
+ /**
3783
+ * The PaymentRequest id the intent is linked to.
3784
+ * @type {string}
3785
+ * @memberof PaymentRequestStartResponse
3786
+ */
3787
+ 'paymentRequestId': string;
3788
+ /**
3789
+ * Stripe payment intent id.
3790
+ * @type {string}
3791
+ * @memberof PaymentRequestStartResponse
3792
+ */
3793
+ 'stripeId': string;
3794
+ /**
3795
+ * Stripe client secret for the intent.
3796
+ * @type {string}
3797
+ * @memberof PaymentRequestStartResponse
3798
+ */
3799
+ 'clientSecret': string;
3800
+ }
3662
3801
  /**
3663
3802
  *
3664
3803
  * @export
@@ -3866,7 +4005,7 @@ export interface PermissionResponse {
3866
4005
  'actions': Array<ActionResponse>;
3867
4006
  }
3868
4007
  /**
3869
- *
4008
+ * 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
4009
  * @export
3871
4010
  * @interface PointOfSaleAssociateUsersResponse
3872
4011
  */
@@ -4019,7 +4158,7 @@ export interface PointOfSaleWithContainersResponse {
4019
4158
  'containers': Array<ContainerWithProductsResponse>;
4020
4159
  }
4021
4160
  /**
4022
- *
4161
+ * API Request for creating or updating a `product category` entity.
4023
4162
  * @export
4024
4163
  * @interface ProductCategoryRequest
4025
4164
  */
@@ -4183,6 +4322,56 @@ export interface ProductResponse {
4183
4322
  */
4184
4323
  'priceList': boolean;
4185
4324
  }
4325
+ /**
4326
+ * Minimal response returned to unauthenticated callers of the public share link endpoint. It deliberately omits `createdBy`, `cancelledBy`, and other internal audit fields — anyone with the link can see it, so we leak as little user info as possible.
4327
+ * @export
4328
+ * @interface PublicPaymentRequestResponse
4329
+ */
4330
+ export interface PublicPaymentRequestResponse {
4331
+ /**
4332
+ * UUID v4 identifier.
4333
+ * @type {string}
4334
+ * @memberof PublicPaymentRequestResponse
4335
+ */
4336
+ 'uuid': string;
4337
+ /**
4338
+ * Recipient display name (e.g. \"John D.\").
4339
+ * @type {string}
4340
+ * @memberof PublicPaymentRequestResponse
4341
+ */
4342
+ 'forDisplayName': string;
4343
+ /**
4344
+ *
4345
+ * @type {DineroObjectResponse}
4346
+ * @memberof PublicPaymentRequestResponse
4347
+ */
4348
+ 'amount': DineroObjectResponse;
4349
+ /**
4350
+ * ISO-8601 timestamp after which payments stop being accepted.
4351
+ * @type {string}
4352
+ * @memberof PublicPaymentRequestResponse
4353
+ */
4354
+ 'expiresAt': string;
4355
+ /**
4356
+ * Optional human-readable description.
4357
+ * @type {string}
4358
+ * @memberof PublicPaymentRequestResponse
4359
+ */
4360
+ 'description'?: string;
4361
+ /**
4362
+ * Derived lifecycle status.
4363
+ * @type {string}
4364
+ * @memberof PublicPaymentRequestResponse
4365
+ */
4366
+ 'status': PublicPaymentRequestResponseStatusEnum;
4367
+ }
4368
+ export declare const PublicPaymentRequestResponseStatusEnum: {
4369
+ readonly Pending: "PENDING";
4370
+ readonly Paid: "PAID";
4371
+ readonly Expired: "EXPIRED";
4372
+ readonly Cancelled: "CANCELLED";
4373
+ };
4374
+ export type PublicPaymentRequestResponseStatusEnum = typeof PublicPaymentRequestResponseStatusEnum[keyof typeof PublicPaymentRequestResponseStatusEnum];
4186
4375
  /**
4187
4376
  *
4188
4377
  * @export
@@ -5084,23 +5273,23 @@ export interface TotalBalanceResponse {
5084
5273
  */
5085
5274
  'date': string;
5086
5275
  /**
5087
- * The total amount of positive balance in SudoSOS
5088
- * @type {number}
5276
+ *
5277
+ * @type {DineroObjectResponse}
5089
5278
  * @memberof TotalBalanceResponse
5090
5279
  */
5091
- 'totalPositive': number;
5280
+ 'totalPositive': DineroObjectResponse;
5092
5281
  /**
5093
- * The total amount of negative balance in SudoSOS
5094
- * @type {number}
5282
+ *
5283
+ * @type {DineroObjectResponse}
5095
5284
  * @memberof TotalBalanceResponse
5096
5285
  */
5097
- 'totalNegative': number;
5286
+ 'totalNegative': DineroObjectResponse;
5098
5287
  /**
5099
- *
5100
- * @type {UserTypeTotalBalanceResponse}
5288
+ * The total balances for the different user types
5289
+ * @type {Array<UserTypeTotalBalanceResponse>}
5101
5290
  * @memberof TotalBalanceResponse
5102
5291
  */
5103
- 'userTypeBalances': UserTypeTotalBalanceResponse;
5292
+ 'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
5104
5293
  }
5105
5294
  /**
5106
5295
  *
@@ -5608,6 +5797,85 @@ export interface TransferResponse {
5608
5797
  /**
5609
5798
  *
5610
5799
  * @export
5800
+ * @interface TransferSummaryResponse
5801
+ */
5802
+ export interface TransferSummaryResponse {
5803
+ /**
5804
+ *
5805
+ * @type {TransferAggregateResponse}
5806
+ * @memberof TransferSummaryResponse
5807
+ */
5808
+ 'total': TransferAggregateResponse;
5809
+ /**
5810
+ *
5811
+ * @type {TransferAggregateResponse}
5812
+ * @memberof TransferSummaryResponse
5813
+ */
5814
+ 'deposits': TransferAggregateResponse;
5815
+ /**
5816
+ *
5817
+ * @type {TransferAggregateResponse}
5818
+ * @memberof TransferSummaryResponse
5819
+ */
5820
+ 'payoutRequests': TransferAggregateResponse;
5821
+ /**
5822
+ *
5823
+ * @type {TransferAggregateResponse}
5824
+ * @memberof TransferSummaryResponse
5825
+ */
5826
+ 'sellerPayouts': TransferAggregateResponse;
5827
+ /**
5828
+ *
5829
+ * @type {TransferAggregateResponse}
5830
+ * @memberof TransferSummaryResponse
5831
+ */
5832
+ 'invoices': TransferAggregateResponse;
5833
+ /**
5834
+ *
5835
+ * @type {TransferAggregateResponse}
5836
+ * @memberof TransferSummaryResponse
5837
+ */
5838
+ 'creditInvoices': TransferAggregateResponse;
5839
+ /**
5840
+ *
5841
+ * @type {TransferAggregateResponse}
5842
+ * @memberof TransferSummaryResponse
5843
+ */
5844
+ 'fines': TransferAggregateResponse;
5845
+ /**
5846
+ *
5847
+ * @type {TransferAggregateResponse}
5848
+ * @memberof TransferSummaryResponse
5849
+ */
5850
+ 'waivedFines': TransferAggregateResponse;
5851
+ /**
5852
+ *
5853
+ * @type {TransferAggregateResponse}
5854
+ * @memberof TransferSummaryResponse
5855
+ */
5856
+ 'writeOffs': TransferAggregateResponse;
5857
+ /**
5858
+ *
5859
+ * @type {TransferAggregateResponse}
5860
+ * @memberof TransferSummaryResponse
5861
+ */
5862
+ 'inactiveAdministrativeCosts': TransferAggregateResponse;
5863
+ /**
5864
+ *
5865
+ * @type {TransferAggregateResponse}
5866
+ * @memberof TransferSummaryResponse
5867
+ */
5868
+ 'manualCreations': TransferAggregateResponse;
5869
+ /**
5870
+ *
5871
+ * @type {TransferAggregateResponse}
5872
+ * @memberof TransferSummaryResponse
5873
+ */
5874
+ 'manualDeletions': TransferAggregateResponse;
5875
+ }
5876
+ /**
5877
+ * API Request for updating a `container` entity.
5878
+ * @export
5611
5879
  * @interface UpdateContainerRequest
5612
5880
  */
5613
5881
  export interface UpdateContainerRequest {
@@ -5856,7 +6124,7 @@ export interface UpdatePinRequest {
5856
6124
  'pin': string;
5857
6125
  }
5858
6126
  /**
5859
- *
6127
+ * API Request for updating a `point of sale` entity.
5860
6128
  * @export
5861
6129
  * @interface UpdatePointOfSaleRequest
5862
6130
  */
@@ -5893,7 +6161,7 @@ export interface UpdatePointOfSaleRequest {
5893
6161
  'cashierRoleIds'?: Array<number>;
5894
6162
  }
5895
6163
  /**
5896
- *
6164
+ * API Request for updating a `product` entity.
5897
6165
  * @export
5898
6166
  * @interface UpdateProductRequest
5899
6167
  */
@@ -6058,9 +6326,15 @@ export interface UpdateUserRequest {
6058
6326
  * @memberof UpdateUserRequest
6059
6327
  */
6060
6328
  'inactiveNotificationSend'?: boolean;
6329
+ /**
6330
+ * ISO date at which the account expires; pass null to clear
6331
+ * @type {string}
6332
+ * @memberof UpdateUserRequest
6333
+ */
6334
+ 'expiryDate'?: string | null;
6061
6335
  }
6062
6336
  /**
6063
- *
6337
+ * API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
6064
6338
  * @export
6065
6339
  * @interface UpdateVatGroupRequest
6066
6340
  */
@@ -6273,7 +6547,13 @@ export interface UserResponse {
6273
6547
  * @type {BasePointOfSaleInfoResponse}
6274
6548
  * @memberof UserResponse
6275
6549
  */
6276
- 'pos'?: BasePointOfSaleInfoResponse;
6550
+ 'pos'?: BasePointOfSaleInfoResponse;
6551
+ /**
6552
+ * ISO date at which the account expires (null for accounts without expiry)
6553
+ * @type {string}
6554
+ * @memberof UserResponse
6555
+ */
6556
+ 'expiryDate'?: string | null;
6277
6557
  }
6278
6558
  /**
6279
6559
  *
@@ -6380,6 +6660,22 @@ export interface UserToInactiveAdministrativeCostResponse {
6380
6660
  */
6381
6661
  'nickname'?: string;
6382
6662
  }
6663
+ /**
6664
+ * The type of a user
6665
+ * @export
6666
+ * @enum {string}
6667
+ */
6668
+ export declare const UserType: {
6669
+ readonly Member: "MEMBER";
6670
+ readonly Organ: "ORGAN";
6671
+ readonly Voucher: "VOUCHER";
6672
+ readonly LocalUser: "LOCAL_USER";
6673
+ readonly LocalAdmin: "LOCAL_ADMIN";
6674
+ readonly Invoice: "INVOICE";
6675
+ readonly PointOfSale: "POINT_OF_SALE";
6676
+ readonly Integration: "INTEGRATION";
6677
+ };
6678
+ export type UserType = typeof UserType[keyof typeof UserType];
6383
6679
  /**
6384
6680
  *
6385
6681
  * @export
@@ -6406,7 +6702,7 @@ export interface UserTypeTotalBalanceResponse {
6406
6702
  'totalNegative': DineroObjectResponse;
6407
6703
  }
6408
6704
  /**
6409
- *
6705
+ * 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.
6410
6706
  * @export
6411
6707
  * @interface UserWithIndex
6412
6708
  */
@@ -6421,6 +6717,25 @@ export interface UserWithIndex {
6421
6717
  /**
6422
6718
  *
6423
6719
  * @export
6720
+ * @interface ValidationResponse
6721
+ */
6722
+ export interface ValidationResponse {
6723
+ /**
6724
+ * Whether the request passed validation.
6725
+ * @type {boolean}
6726
+ * @memberof ValidationResponse
6727
+ */
6728
+ 'valid': boolean;
6729
+ /**
6730
+ * List of validation error messages.
6731
+ * @type {Array<string>}
6732
+ * @memberof ValidationResponse
6733
+ */
6734
+ 'errors': Array<string>;
6735
+ }
6736
+ /**
6737
+ * API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
6738
+ * @export
6424
6739
  * @interface VatDeclarationResponse
6425
6740
  */
6426
6741
  export interface VatDeclarationResponse {
@@ -6444,7 +6759,7 @@ export interface VatDeclarationResponse {
6444
6759
  'rows': Array<VatDeclarationRow>;
6445
6760
  }
6446
6761
  /**
6447
- *
6762
+ * One row of a VAT declaration — the VAT collected for a single group, broken down by period.
6448
6763
  * @export
6449
6764
  * @interface VatDeclarationRow
6450
6765
  */
@@ -6910,15 +7225,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
6910
7225
  * @throws {RequiredError}
6911
7226
  */
6912
7227
  confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6913
- /**
6914
- *
6915
- * @summary EAN login and hand out token
6916
- * @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
6917
- * @param {*} [options] Override http request option.
6918
- * @deprecated
6919
- * @throws {RequiredError}
6920
- */
6921
- eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6922
7228
  /**
6923
7229
  *
6924
7230
  * @summary Generate a QR code for authentication
@@ -6988,15 +7294,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
6988
7294
  * @throws {RequiredError}
6989
7295
  */
6990
7296
  localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6991
- /**
6992
- *
6993
- * @summary PIN login for members using memberId.
6994
- * @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
6995
- * @param {*} [options] Override http request option.
6996
- * @deprecated
6997
- * @throws {RequiredError}
6998
- */
6999
- memberPinAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7000
7297
  /**
7001
7298
  *
7002
7299
  * @summary Mock login and hand out token.
@@ -7005,24 +7302,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
7005
7302
  * @throws {RequiredError}
7006
7303
  */
7007
7304
  mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7008
- /**
7009
- *
7010
- * @summary NFC login and hand out token
7011
- * @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
7012
- * @param {*} [options] Override http request option.
7013
- * @deprecated
7014
- * @throws {RequiredError}
7015
- */
7016
- nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7017
- /**
7018
- *
7019
- * @summary PIN login and hand out token
7020
- * @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
7021
- * @param {*} [options] Override http request option.
7022
- * @deprecated
7023
- * @throws {RequiredError}
7024
- */
7025
- pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7026
7305
  /**
7027
7306
  *
7028
7307
  * @summary Get a new JWT token, maintaining the same access level (posId) as the original token
@@ -7108,15 +7387,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
7108
7387
  * @throws {RequiredError}
7109
7388
  */
7110
7389
  confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7111
- /**
7112
- *
7113
- * @summary EAN login and hand out token
7114
- * @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
7115
- * @param {*} [options] Override http request option.
7116
- * @deprecated
7117
- * @throws {RequiredError}
7118
- */
7119
- eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
7120
7390
  /**
7121
7391
  *
7122
7392
  * @summary Generate a QR code for authentication
@@ -7186,15 +7456,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
7186
7456
  * @throws {RequiredError}
7187
7457
  */
7188
7458
  localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
7189
- /**
7190
- *
7191
- * @summary PIN login for members using memberId.
7192
- * @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
7193
- * @param {*} [options] Override http request option.
7194
- * @deprecated
7195
- * @throws {RequiredError}
7196
- */
7197
- memberPinAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
7198
7459
  /**
7199
7460
  *
7200
7461
  * @summary Mock login and hand out token.
@@ -7203,24 +7464,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
7203
7464
  * @throws {RequiredError}
7204
7465
  */
7205
7466
  mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
7206
- /**
7207
- *
7208
- * @summary NFC login and hand out token
7209
- * @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
7210
- * @param {*} [options] Override http request option.
7211
- * @deprecated
7212
- * @throws {RequiredError}
7213
- */
7214
- nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
7215
- /**
7216
- *
7217
- * @summary PIN login and hand out token
7218
- * @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
7219
- * @param {*} [options] Override http request option.
7220
- * @deprecated
7221
- * @throws {RequiredError}
7222
- */
7223
- pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
7224
7467
  /**
7225
7468
  *
7226
7469
  * @summary Get a new JWT token, maintaining the same access level (posId) as the original token
@@ -7306,15 +7549,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
7306
7549
  * @throws {RequiredError}
7307
7550
  */
7308
7551
  confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7309
- /**
7310
- *
7311
- * @summary EAN login and hand out token
7312
- * @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
7313
- * @param {*} [options] Override http request option.
7314
- * @deprecated
7315
- * @throws {RequiredError}
7316
- */
7317
- eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
7318
7552
  /**
7319
7553
  *
7320
7554
  * @summary Generate a QR code for authentication
@@ -7384,15 +7618,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
7384
7618
  * @throws {RequiredError}
7385
7619
  */
7386
7620
  localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
7387
- /**
7388
- *
7389
- * @summary PIN login for members using memberId.
7390
- * @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
7391
- * @param {*} [options] Override http request option.
7392
- * @deprecated
7393
- * @throws {RequiredError}
7394
- */
7395
- memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
7396
7621
  /**
7397
7622
  *
7398
7623
  * @summary Mock login and hand out token.
@@ -7401,24 +7626,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
7401
7626
  * @throws {RequiredError}
7402
7627
  */
7403
7628
  mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
7404
- /**
7405
- *
7406
- * @summary NFC login and hand out token
7407
- * @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
7408
- * @param {*} [options] Override http request option.
7409
- * @deprecated
7410
- * @throws {RequiredError}
7411
- */
7412
- nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
7413
- /**
7414
- *
7415
- * @summary PIN login and hand out token
7416
- * @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
7417
- * @param {*} [options] Override http request option.
7418
- * @deprecated
7419
- * @throws {RequiredError}
7420
- */
7421
- pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
7422
7629
  /**
7423
7630
  *
7424
7631
  * @summary Get a new JWT token, maintaining the same access level (posId) as the original token
@@ -7514,19 +7721,6 @@ export interface AuthenticateApiConfirmQRCodeRequest {
7514
7721
  */
7515
7722
  readonly sessionId: string;
7516
7723
  }
7517
- /**
7518
- * Request parameters for eanAuthentication operation in AuthenticateApi.
7519
- * @export
7520
- * @interface AuthenticateApiEanAuthenticationRequest
7521
- */
7522
- export interface AuthenticateApiEanAuthenticationRequest {
7523
- /**
7524
- * The EAN login.
7525
- * @type {AuthenticationEanRequest}
7526
- * @memberof AuthenticateApiEanAuthentication
7527
- */
7528
- readonly authenticationEanRequest: AuthenticationEanRequest;
7529
- }
7530
7724
  /**
7531
7725
  * Request parameters for getQRStatus operation in AuthenticateApi.
7532
7726
  * @export
@@ -7605,19 +7799,6 @@ export interface AuthenticateApiLocalAuthenticationRequest {
7605
7799
  */
7606
7800
  readonly authenticationLocalRequest: AuthenticationLocalRequest;
7607
7801
  }
7608
- /**
7609
- * Request parameters for memberPinAuthentication operation in AuthenticateApi.
7610
- * @export
7611
- * @interface AuthenticateApiMemberPinAuthenticationRequest
7612
- */
7613
- export interface AuthenticateApiMemberPinAuthenticationRequest {
7614
- /**
7615
- * The PIN login.
7616
- * @type {MemberAuthenticationPinRequest}
7617
- * @memberof AuthenticateApiMemberPinAuthentication
7618
- */
7619
- readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
7620
- }
7621
7802
  /**
7622
7803
  * Request parameters for mockAuthentication operation in AuthenticateApi.
7623
7804
  * @export
@@ -7631,32 +7812,6 @@ export interface AuthenticateApiMockAuthenticationRequest {
7631
7812
  */
7632
7813
  readonly authenticationMockRequest: AuthenticationMockRequest;
7633
7814
  }
7634
- /**
7635
- * Request parameters for nfcAuthentication operation in AuthenticateApi.
7636
- * @export
7637
- * @interface AuthenticateApiNfcAuthenticationRequest
7638
- */
7639
- export interface AuthenticateApiNfcAuthenticationRequest {
7640
- /**
7641
- * The NFC login.
7642
- * @type {AuthenticationNfcRequest}
7643
- * @memberof AuthenticateApiNfcAuthentication
7644
- */
7645
- readonly authenticationNfcRequest: AuthenticationNfcRequest;
7646
- }
7647
- /**
7648
- * Request parameters for pinAuthentication operation in AuthenticateApi.
7649
- * @export
7650
- * @interface AuthenticateApiPinAuthenticationRequest
7651
- */
7652
- export interface AuthenticateApiPinAuthenticationRequest {
7653
- /**
7654
- * The PIN login.
7655
- * @type {AuthenticationPinRequest}
7656
- * @memberof AuthenticateApiPinAuthentication
7657
- */
7658
- readonly authenticationPinRequest: AuthenticationPinRequest;
7659
- }
7660
7815
  /**
7661
7816
  * Request parameters for resetLocal operation in AuthenticateApi.
7662
7817
  * @export
@@ -7769,16 +7924,6 @@ export declare class AuthenticateApi extends BaseAPI {
7769
7924
  * @memberof AuthenticateApi
7770
7925
  */
7771
7926
  confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7772
- /**
7773
- *
7774
- * @summary EAN login and hand out token
7775
- * @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
7776
- * @param {*} [options] Override http request option.
7777
- * @deprecated
7778
- * @throws {RequiredError}
7779
- * @memberof AuthenticateApi
7780
- */
7781
- eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
7782
7927
  /**
7783
7928
  *
7784
7929
  * @summary Generate a QR code for authentication
@@ -7857,16 +8002,6 @@ export declare class AuthenticateApi extends BaseAPI {
7857
8002
  * @memberof AuthenticateApi
7858
8003
  */
7859
8004
  localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
7860
- /**
7861
- *
7862
- * @summary PIN login for members using memberId.
7863
- * @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
7864
- * @param {*} [options] Override http request option.
7865
- * @deprecated
7866
- * @throws {RequiredError}
7867
- * @memberof AuthenticateApi
7868
- */
7869
- memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
7870
8005
  /**
7871
8006
  *
7872
8007
  * @summary Mock login and hand out token.
@@ -7876,26 +8011,6 @@ export declare class AuthenticateApi extends BaseAPI {
7876
8011
  * @memberof AuthenticateApi
7877
8012
  */
7878
8013
  mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
7879
- /**
7880
- *
7881
- * @summary NFC login and hand out token
7882
- * @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
7883
- * @param {*} [options] Override http request option.
7884
- * @deprecated
7885
- * @throws {RequiredError}
7886
- * @memberof AuthenticateApi
7887
- */
7888
- nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
7889
- /**
7890
- *
7891
- * @summary PIN login and hand out token
7892
- * @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
7893
- * @param {*} [options] Override http request option.
7894
- * @deprecated
7895
- * @throws {RequiredError}
7896
- * @memberof AuthenticateApi
7897
- */
7898
- pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
7899
8014
  /**
7900
8015
  *
7901
8016
  * @summary Get a new JWT token, maintaining the same access level (posId) as the original token
@@ -7982,7 +8097,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
7982
8097
  * @param {boolean} [hasFine] Only users with(out) fines
7983
8098
  * @param {number} [minFine] Minimum fine
7984
8099
  * @param {number} [maxFine] Maximum fine
7985
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8100
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
7986
8101
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
7987
8102
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
7988
8103
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -7992,7 +8107,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
7992
8107
  * @param {*} [options] Override http request option.
7993
8108
  * @throws {RequiredError}
7994
8109
  */
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>;
8110
+ 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
8111
  /**
7997
8112
  *
7998
8113
  * @summary Retrieves the requested balance
@@ -8032,7 +8147,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8032
8147
  * @param {boolean} [hasFine] Only users with(out) fines
8033
8148
  * @param {number} [minFine] Minimum fine
8034
8149
  * @param {number} [maxFine] Maximum fine
8035
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8150
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
8036
8151
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
8037
8152
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
8038
8153
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8042,7 +8157,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8042
8157
  * @param {*} [options] Override http request option.
8043
8158
  * @throws {RequiredError}
8044
8159
  */
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>>;
8160
+ 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
8161
  /**
8047
8162
  *
8048
8163
  * @summary Retrieves the requested balance
@@ -8159,10 +8274,10 @@ export interface BalanceApiGetAllBalanceRequest {
8159
8274
  readonly maxFine?: number;
8160
8275
  /**
8161
8276
  * Filter based on user type.
8162
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
8277
+ * @type {Array<UserType>}
8163
8278
  * @memberof BalanceApiGetAllBalance
8164
8279
  */
8165
- readonly userTypes?: GetAllBalanceUserTypesEnum;
8280
+ readonly userTypes?: Array<UserType>;
8166
8281
  /**
8167
8282
  * Column to order balance by - eg: id,amount
8168
8283
  * @type {string}
@@ -8256,11 +8371,6 @@ export declare class BalanceApi extends BaseAPI {
8256
8371
  */
8257
8372
  getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
8258
8373
  }
8259
- /**
8260
- * @export
8261
- */
8262
- export declare const GetAllBalanceUserTypesEnum: {};
8263
- export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
8264
8374
  /**
8265
8375
  * @export
8266
8376
  */
@@ -10681,7 +10791,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
10681
10791
  * @param {*} [options] Override http request option.
10682
10792
  * @throws {RequiredError}
10683
10793
  */
10684
- handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10794
+ handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
10685
10795
  /**
10686
10796
  *
10687
10797
  * @summary Notify all users which will pay administrative costs within a year
@@ -10759,7 +10869,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
10759
10869
  * @param {*} [options] Override http request option.
10760
10870
  * @throws {RequiredError}
10761
10871
  */
10762
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10872
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
10763
10873
  /**
10764
10874
  *
10765
10875
  * @summary Notify all users which will pay administrative costs within a year
@@ -10982,7 +11092,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
10982
11092
  * @throws {RequiredError}
10983
11093
  * @memberof InactiveAdministrativeCostsApi
10984
11094
  */
10985
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
11095
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
10986
11096
  /**
10987
11097
  *
10988
11098
  * @summary Notify all users which will pay administrative costs within a year
@@ -11027,16 +11137,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11027
11137
  * @summary Returns all invoices in the system.
11028
11138
  * @param {number} [toId] Filter on Id of the debtor
11029
11139
  * @param {number} [invoiceId] Filter on invoice ID
11030
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11140
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11031
11141
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11032
11142
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11033
11143
  * @param {string} [tillDate] End date for selected invoices (exclusive)
11144
+ * @param {string} [description] Filter invoices by description (partial match)
11034
11145
  * @param {number} [take] How many entries the endpoint should return
11035
11146
  * @param {number} [skip] How many entries should be skipped (for pagination)
11036
11147
  * @param {*} [options] Override http request option.
11037
11148
  * @throws {RequiredError}
11038
11149
  */
11039
- getAllInvoices: (toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11150
+ getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11040
11151
  /**
11041
11152
  *
11042
11153
  * @summary Get eligible transactions for invoice creation.
@@ -11047,6 +11158,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11047
11158
  * @throws {RequiredError}
11048
11159
  */
11049
11160
  getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11161
+ /**
11162
+ *
11163
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11164
+ * @param {*} [options] Override http request option.
11165
+ * @throws {RequiredError}
11166
+ */
11167
+ getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11050
11168
  /**
11051
11169
  *
11052
11170
  * @summary Get an invoice pdf.
@@ -11126,16 +11244,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11126
11244
  * @summary Returns all invoices in the system.
11127
11245
  * @param {number} [toId] Filter on Id of the debtor
11128
11246
  * @param {number} [invoiceId] Filter on invoice ID
11129
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11247
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11130
11248
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11131
11249
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11132
11250
  * @param {string} [tillDate] End date for selected invoices (exclusive)
11251
+ * @param {string} [description] Filter invoices by description (partial match)
11133
11252
  * @param {number} [take] How many entries the endpoint should return
11134
11253
  * @param {number} [skip] How many entries should be skipped (for pagination)
11135
11254
  * @param {*} [options] Override http request option.
11136
11255
  * @throws {RequiredError}
11137
11256
  */
11138
- getAllInvoices(toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
11257
+ getAllInvoices(toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
11139
11258
  /**
11140
11259
  *
11141
11260
  * @summary Get eligible transactions for invoice creation.
@@ -11145,7 +11264,14 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11145
11264
  * @param {*} [options] Override http request option.
11146
11265
  * @throws {RequiredError}
11147
11266
  */
11148
- getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse>>;
11267
+ getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
11268
+ /**
11269
+ *
11270
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11271
+ * @param {*} [options] Override http request option.
11272
+ * @throws {RequiredError}
11273
+ */
11274
+ getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
11149
11275
  /**
11150
11276
  *
11151
11277
  * @summary Get an invoice pdf.
@@ -11154,7 +11280,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11154
11280
  * @param {*} [options] Override http request option.
11155
11281
  * @throws {RequiredError}
11156
11282
  */
11157
- getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
11283
+ getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
11158
11284
  /**
11159
11285
  *
11160
11286
  * @summary Returns a single invoice in the system.
@@ -11235,7 +11361,14 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11235
11361
  * @param {*} [options] Override http request option.
11236
11362
  * @throws {RequiredError}
11237
11363
  */
11238
- getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse>;
11364
+ getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
11365
+ /**
11366
+ *
11367
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11368
+ * @param {*} [options] Override http request option.
11369
+ * @throws {RequiredError}
11370
+ */
11371
+ getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
11239
11372
  /**
11240
11373
  *
11241
11374
  * @summary Get an invoice pdf.
@@ -11243,7 +11376,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11243
11376
  * @param {*} [options] Override http request option.
11244
11377
  * @throws {RequiredError}
11245
11378
  */
11246
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
11379
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
11247
11380
  /**
11248
11381
  *
11249
11382
  * @summary Returns a single invoice in the system.
@@ -11336,10 +11469,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
11336
11469
  readonly invoiceId?: number;
11337
11470
  /**
11338
11471
  * Filter based on Invoice State.
11339
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
11472
+ * @type {Array<GetAllInvoicesCurrentStateParameterInner>}
11340
11473
  * @memberof InvoicesApiGetAllInvoices
11341
11474
  */
11342
- readonly currentState?: GetAllInvoicesCurrentStateEnum;
11475
+ readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
11343
11476
  /**
11344
11477
  * Boolean if invoice entries should be returned
11345
11478
  * @type {boolean}
@@ -11358,6 +11491,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
11358
11491
  * @memberof InvoicesApiGetAllInvoices
11359
11492
  */
11360
11493
  readonly tillDate?: string;
11494
+ /**
11495
+ * Filter invoices by description (partial match)
11496
+ * @type {string}
11497
+ * @memberof InvoicesApiGetAllInvoices
11498
+ */
11499
+ readonly description?: string;
11361
11500
  /**
11362
11501
  * How many entries the endpoint should return
11363
11502
  * @type {number}
@@ -11536,7 +11675,15 @@ export declare class InvoicesApi extends BaseAPI {
11536
11675
  * @throws {RequiredError}
11537
11676
  * @memberof InvoicesApi
11538
11677
  */
11539
- getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
11678
+ getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
11679
+ /**
11680
+ *
11681
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11682
+ * @param {*} [options] Override http request option.
11683
+ * @throws {RequiredError}
11684
+ * @memberof InvoicesApi
11685
+ */
11686
+ getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
11540
11687
  /**
11541
11688
  *
11542
11689
  * @summary Get an invoice pdf.
@@ -11545,7 +11692,7 @@ export declare class InvoicesApi extends BaseAPI {
11545
11692
  * @throws {RequiredError}
11546
11693
  * @memberof InvoicesApi
11547
11694
  */
11548
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
11695
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
11549
11696
  /**
11550
11697
  *
11551
11698
  * @summary Returns a single invoice in the system.
@@ -11583,11 +11730,6 @@ export declare class InvoicesApi extends BaseAPI {
11583
11730
  */
11584
11731
  updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
11585
11732
  }
11586
- /**
11587
- * @export
11588
- */
11589
- export declare const GetAllInvoicesCurrentStateEnum: {};
11590
- export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
11591
11733
  /**
11592
11734
  * PayoutRequestsApi - axios parameter creator
11593
11735
  * @export
@@ -14142,11 +14284,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
14142
14284
  /**
14143
14285
  * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
14144
14286
  * @summary Get dry-run sync results for users
14145
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14287
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14146
14288
  * @param {*} [options] Override http request option.
14147
14289
  * @throws {RequiredError}
14148
14290
  */
14149
- getUserSyncResults: (service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14291
+ getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14150
14292
  };
14151
14293
  /**
14152
14294
  * SyncApi - functional programming interface
@@ -14156,11 +14298,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
14156
14298
  /**
14157
14299
  * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
14158
14300
  * @summary Get dry-run sync results for users
14159
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14301
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14160
14302
  * @param {*} [options] Override http request option.
14161
14303
  * @throws {RequiredError}
14162
14304
  */
14163
- getUserSyncResults(service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
14305
+ getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
14164
14306
  };
14165
14307
  /**
14166
14308
  * SyncApi - factory interface
@@ -14184,10 +14326,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
14184
14326
  export interface SyncApiGetUserSyncResultsRequest {
14185
14327
  /**
14186
14328
  * Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14187
- * @type {Array<string>}
14329
+ * @type {Array<'LDAP' | 'GEWISDB'>}
14188
14330
  * @memberof SyncApiGetUserSyncResults
14189
14331
  */
14190
- readonly service?: GetUserSyncResultsServiceEnum;
14332
+ readonly service?: Array<GetUserSyncResultsServiceEnum>;
14191
14333
  }
14192
14334
  /**
14193
14335
  * SyncApi - object-oriented interface
@@ -14209,7 +14351,10 @@ export declare class SyncApi extends BaseAPI {
14209
14351
  /**
14210
14352
  * @export
14211
14353
  */
14212
- export declare const GetUserSyncResultsServiceEnum: {};
14354
+ export declare const GetUserSyncResultsServiceEnum: {
14355
+ readonly Ldap: "LDAP";
14356
+ readonly Gewisdb: "GEWISDB";
14357
+ };
14213
14358
  export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
14214
14359
  /**
14215
14360
  * TermsOfServiceApi - axios parameter creator
@@ -14959,12 +15104,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14959
15104
  * @summary Returns all existing transfers
14960
15105
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
14961
15106
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15107
+ * @param {number} [fromId] Filter transfers from this user ID
15108
+ * @param {number} [toId] Filter transfers to this user ID
15109
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
14962
15110
  * @param {number} [take] How many transfers the endpoint should return
14963
15111
  * @param {number} [skip] How many transfers should be skipped (for pagination)
14964
15112
  * @param {*} [options] Override http request option.
14965
15113
  * @throws {RequiredError}
14966
15114
  */
14967
- getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15115
+ getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14968
15116
  /**
14969
15117
  *
14970
15118
  * @summary Returns the requested transfer
@@ -14980,7 +15128,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14980
15128
  * @param {string} [tillDate] End date for selected transfers (exclusive)
14981
15129
  * @param {number} [fromId] Filter transfers from this user ID
14982
15130
  * @param {number} [toId] Filter transfers to this user ID
14983
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15131
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
14984
15132
  * @param {*} [options] Override http request option.
14985
15133
  * @throws {RequiredError}
14986
15134
  */
@@ -14993,6 +15141,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14993
15141
  * @throws {RequiredError}
14994
15142
  */
14995
15143
  getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15144
+ /**
15145
+ *
15146
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15147
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15148
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15149
+ * @param {number} [fromId] Filter transfers from this user ID
15150
+ * @param {number} [toId] Filter transfers to this user ID
15151
+ * @param {*} [options] Override http request option.
15152
+ * @throws {RequiredError}
15153
+ */
15154
+ getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14996
15155
  };
14997
15156
  /**
14998
15157
  * TransfersApi - functional programming interface
@@ -15020,12 +15179,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15020
15179
  * @summary Returns all existing transfers
15021
15180
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
15022
15181
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15182
+ * @param {number} [fromId] Filter transfers from this user ID
15183
+ * @param {number} [toId] Filter transfers to this user ID
15184
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
15023
15185
  * @param {number} [take] How many transfers the endpoint should return
15024
15186
  * @param {number} [skip] How many transfers should be skipped (for pagination)
15025
15187
  * @param {*} [options] Override http request option.
15026
15188
  * @throws {RequiredError}
15027
15189
  */
15028
- getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransferResponse>>>;
15190
+ getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTransferResponse>>;
15029
15191
  /**
15030
15192
  *
15031
15193
  * @summary Returns the requested transfer
@@ -15041,7 +15203,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15041
15203
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15042
15204
  * @param {number} [fromId] Filter transfers from this user ID
15043
15205
  * @param {number} [toId] Filter transfers to this user ID
15044
- * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15206
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15045
15207
  * @param {*} [options] Override http request option.
15046
15208
  * @throws {RequiredError}
15047
15209
  */
@@ -15054,6 +15216,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15054
15216
  * @throws {RequiredError}
15055
15217
  */
15056
15218
  getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
15219
+ /**
15220
+ *
15221
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15222
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15223
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15224
+ * @param {number} [fromId] Filter transfers from this user ID
15225
+ * @param {number} [toId] Filter transfers to this user ID
15226
+ * @param {*} [options] Override http request option.
15227
+ * @throws {RequiredError}
15228
+ */
15229
+ getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
15057
15230
  };
15058
15231
  /**
15059
15232
  * TransfersApi - factory interface
@@ -15083,7 +15256,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
15083
15256
  * @param {*} [options] Override http request option.
15084
15257
  * @throws {RequiredError}
15085
15258
  */
15086
- getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransferResponse>>;
15259
+ getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
15087
15260
  /**
15088
15261
  *
15089
15262
  * @summary Returns the requested transfer
@@ -15108,6 +15281,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
15108
15281
  * @throws {RequiredError}
15109
15282
  */
15110
15283
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
15284
+ /**
15285
+ *
15286
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15287
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15288
+ * @param {*} [options] Override http request option.
15289
+ * @throws {RequiredError}
15290
+ */
15291
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
15111
15292
  };
15112
15293
  /**
15113
15294
  * Request parameters for createTransfer operation in TransfersApi.
@@ -15153,6 +15334,24 @@ export interface TransfersApiGetAllTransfersRequest {
15153
15334
  * @memberof TransfersApiGetAllTransfers
15154
15335
  */
15155
15336
  readonly tillDate?: string;
15337
+ /**
15338
+ * Filter transfers from this user ID
15339
+ * @type {number}
15340
+ * @memberof TransfersApiGetAllTransfers
15341
+ */
15342
+ readonly fromId?: number;
15343
+ /**
15344
+ * Filter transfers to this user ID
15345
+ * @type {number}
15346
+ * @memberof TransfersApiGetAllTransfers
15347
+ */
15348
+ readonly toId?: number;
15349
+ /**
15350
+ * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
15351
+ * @type {string}
15352
+ * @memberof TransfersApiGetAllTransfers
15353
+ */
15354
+ readonly category?: string;
15156
15355
  /**
15157
15356
  * How many transfers the endpoint should return
15158
15357
  * @type {number}
@@ -15210,7 +15409,7 @@ export interface TransfersApiGetTransferAggregateRequest {
15210
15409
  */
15211
15410
  readonly toId?: number;
15212
15411
  /**
15213
- * Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15412
+ * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15214
15413
  * @type {string}
15215
15414
  * @memberof TransfersApiGetTransferAggregate
15216
15415
  */
@@ -15229,6 +15428,37 @@ export interface TransfersApiGetTransferPdfRequest {
15229
15428
  */
15230
15429
  readonly id: number;
15231
15430
  }
15431
+ /**
15432
+ * Request parameters for getTransferSummary operation in TransfersApi.
15433
+ * @export
15434
+ * @interface TransfersApiGetTransferSummaryRequest
15435
+ */
15436
+ export interface TransfersApiGetTransferSummaryRequest {
15437
+ /**
15438
+ * Start date for selected transfers (inclusive)
15439
+ * @type {string}
15440
+ * @memberof TransfersApiGetTransferSummary
15441
+ */
15442
+ readonly fromDate?: string;
15443
+ /**
15444
+ * End date for selected transfers (exclusive)
15445
+ * @type {string}
15446
+ * @memberof TransfersApiGetTransferSummary
15447
+ */
15448
+ readonly tillDate?: string;
15449
+ /**
15450
+ * Filter transfers from this user ID
15451
+ * @type {number}
15452
+ * @memberof TransfersApiGetTransferSummary
15453
+ */
15454
+ readonly fromId?: number;
15455
+ /**
15456
+ * Filter transfers to this user ID
15457
+ * @type {number}
15458
+ * @memberof TransfersApiGetTransferSummary
15459
+ */
15460
+ readonly toId?: number;
15461
+ }
15232
15462
  /**
15233
15463
  * TransfersApi - object-oriented interface
15234
15464
  * @export
@@ -15262,7 +15492,7 @@ export declare class TransfersApi extends BaseAPI {
15262
15492
  * @throws {RequiredError}
15263
15493
  * @memberof TransfersApi
15264
15494
  */
15265
- getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferResponse[], any, {}>>;
15495
+ getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
15266
15496
  /**
15267
15497
  *
15268
15498
  * @summary Returns the requested transfer
@@ -15290,6 +15520,15 @@ export declare class TransfersApi extends BaseAPI {
15290
15520
  * @memberof TransfersApi
15291
15521
  */
15292
15522
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
15523
+ /**
15524
+ *
15525
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15526
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15527
+ * @param {*} [options] Override http request option.
15528
+ * @throws {RequiredError}
15529
+ * @memberof TransfersApi
15530
+ */
15531
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
15293
15532
  }
15294
15533
  /**
15295
15534
  * UserNotificationPreferencesApi - axios parameter creator