@gewis/sudosos-client 0.0.0-develop.2275206 → 0.0.0-develop.23674a9

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
@@ -1683,11 +1683,11 @@ export interface CreateContainerRequest {
1683
1683
  */
1684
1684
  'public': boolean;
1685
1685
  /**
1686
- * Id of the user who will own the container, if undefined it will default to the token ID.
1686
+ * Id of the organ that will own the container
1687
1687
  * @type {number}
1688
1688
  * @memberof CreateContainerRequest
1689
1689
  */
1690
- 'ownerId'?: number;
1690
+ 'ownerId': number;
1691
1691
  }
1692
1692
  /**
1693
1693
  *
@@ -1880,7 +1880,7 @@ export interface CreatePointOfSaleRequest {
1880
1880
  */
1881
1881
  'containers': Array<number>;
1882
1882
  /**
1883
- * ID of the user who will own the POS, if undefined it will default to the token ID.
1883
+ * ID of the user who will own the POS.
1884
1884
  * @type {number}
1885
1885
  * @memberof CreatePointOfSaleRequest
1886
1886
  */
@@ -2566,10 +2566,15 @@ export interface FineResponse {
2566
2566
  /**
2567
2567
  *
2568
2568
  * @export
2569
- * @interface GetAllBalanceUserTypesParameterInner
2569
+ * @enum {string}
2570
2570
  */
2571
- export interface GetAllBalanceUserTypesParameterInner {
2572
- }
2571
+ export declare const GetAllInvoicesCurrentStateParameterInner: {
2572
+ readonly Created: "CREATED";
2573
+ readonly Sent: "SENT";
2574
+ readonly Paid: "PAID";
2575
+ readonly Deleted: "DELETED";
2576
+ };
2577
+ export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
2573
2578
  /**
2574
2579
  * @type GetAllPayoutRequestsRequestedByIdParameter
2575
2580
  * @export
@@ -2724,6 +2729,37 @@ export interface InactiveAdministrativeCostResponse {
2724
2729
  */
2725
2730
  'transfer': TransferResponse;
2726
2731
  }
2732
+ /**
2733
+ *
2734
+ * @export
2735
+ * @interface InvoiceDriftResponse
2736
+ */
2737
+ export interface InvoiceDriftResponse {
2738
+ /**
2739
+ *
2740
+ * @type {BaseInvoiceResponse}
2741
+ * @memberof InvoiceDriftResponse
2742
+ */
2743
+ 'invoice': BaseInvoiceResponse;
2744
+ /**
2745
+ *
2746
+ * @type {DineroObjectResponse}
2747
+ * @memberof InvoiceDriftResponse
2748
+ */
2749
+ 'actualAmount': DineroObjectResponse;
2750
+ /**
2751
+ *
2752
+ * @type {DineroObjectResponse}
2753
+ * @memberof InvoiceDriftResponse
2754
+ */
2755
+ 'expectedAmount': DineroObjectResponse;
2756
+ /**
2757
+ *
2758
+ * @type {DineroObjectResponse}
2759
+ * @memberof InvoiceDriftResponse
2760
+ */
2761
+ 'deltaAmount': DineroObjectResponse;
2762
+ }
2727
2763
  /**
2728
2764
  *
2729
2765
  * @export
@@ -3183,13 +3219,13 @@ export interface PaginatedBalanceResponse {
3183
3219
  * @type {PaginationResult}
3184
3220
  * @memberof PaginatedBalanceResponse
3185
3221
  */
3186
- '_pagination'?: PaginationResult;
3222
+ '_pagination': PaginationResult;
3187
3223
  /**
3188
3224
  * Returned balance responses
3189
3225
  * @type {Array<BalanceResponse>}
3190
3226
  * @memberof PaginatedBalanceResponse
3191
3227
  */
3192
- 'records'?: Array<BalanceResponse>;
3228
+ 'records': Array<BalanceResponse>;
3193
3229
  }
3194
3230
  /**
3195
3231
  * Paginated API Response for the `banner` entity.
@@ -3202,13 +3238,13 @@ export interface PaginatedBannerResponse {
3202
3238
  * @type {PaginationResult}
3203
3239
  * @memberof PaginatedBannerResponse
3204
3240
  */
3205
- '_pagination'?: PaginationResult;
3241
+ '_pagination': PaginationResult;
3206
3242
  /**
3207
3243
  * Returned banners
3208
3244
  * @type {Array<BannerResponse>}
3209
3245
  * @memberof PaginatedBannerResponse
3210
3246
  */
3211
- 'records'?: Array<BannerResponse>;
3247
+ 'records': Array<BannerResponse>;
3212
3248
  }
3213
3249
  /**
3214
3250
  *
@@ -3373,13 +3409,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
3373
3409
  * @type {PaginationResult}
3374
3410
  * @memberof PaginatedInactiveAdministrativeCostResponse
3375
3411
  */
3376
- '_pagination'?: PaginationResult;
3412
+ '_pagination': PaginationResult;
3377
3413
  /**
3378
3414
  * Returned InactiveAdministrativeCost
3379
3415
  * @type {Array<InactiveAdministrativeCostResponse>}
3380
3416
  * @memberof PaginatedInactiveAdministrativeCostResponse
3381
3417
  */
3382
- 'records'?: Array<InactiveAdministrativeCostResponse>;
3418
+ 'records': Array<InactiveAdministrativeCostResponse>;
3383
3419
  }
3384
3420
  /**
3385
3421
  *
@@ -5084,23 +5120,23 @@ export interface TotalBalanceResponse {
5084
5120
  */
5085
5121
  'date': string;
5086
5122
  /**
5087
- * The total amount of positive balance in SudoSOS
5088
- * @type {number}
5123
+ *
5124
+ * @type {DineroObjectResponse}
5089
5125
  * @memberof TotalBalanceResponse
5090
5126
  */
5091
- 'totalPositive': number;
5127
+ 'totalPositive': DineroObjectResponse;
5092
5128
  /**
5093
- * The total amount of negative balance in SudoSOS
5094
- * @type {number}
5129
+ *
5130
+ * @type {DineroObjectResponse}
5095
5131
  * @memberof TotalBalanceResponse
5096
5132
  */
5097
- 'totalNegative': number;
5133
+ 'totalNegative': DineroObjectResponse;
5098
5134
  /**
5099
- *
5100
- * @type {UserTypeTotalBalanceResponse}
5135
+ * The total balances for the different user types
5136
+ * @type {Array<UserTypeTotalBalanceResponse>}
5101
5137
  * @memberof TotalBalanceResponse
5102
5138
  */
5103
- 'userTypeBalances': UserTypeTotalBalanceResponse;
5139
+ 'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
5104
5140
  }
5105
5141
  /**
5106
5142
  *
@@ -5605,6 +5641,85 @@ export interface TransferResponse {
5605
5641
  */
5606
5642
  'sellerPayout'?: SellerPayoutResponse;
5607
5643
  }
5644
+ /**
5645
+ *
5646
+ * @export
5647
+ * @interface TransferSummaryResponse
5648
+ */
5649
+ export interface TransferSummaryResponse {
5650
+ /**
5651
+ *
5652
+ * @type {TransferAggregateResponse}
5653
+ * @memberof TransferSummaryResponse
5654
+ */
5655
+ 'total': TransferAggregateResponse;
5656
+ /**
5657
+ *
5658
+ * @type {TransferAggregateResponse}
5659
+ * @memberof TransferSummaryResponse
5660
+ */
5661
+ 'deposits': TransferAggregateResponse;
5662
+ /**
5663
+ *
5664
+ * @type {TransferAggregateResponse}
5665
+ * @memberof TransferSummaryResponse
5666
+ */
5667
+ 'payoutRequests': TransferAggregateResponse;
5668
+ /**
5669
+ *
5670
+ * @type {TransferAggregateResponse}
5671
+ * @memberof TransferSummaryResponse
5672
+ */
5673
+ 'sellerPayouts': TransferAggregateResponse;
5674
+ /**
5675
+ *
5676
+ * @type {TransferAggregateResponse}
5677
+ * @memberof TransferSummaryResponse
5678
+ */
5679
+ 'invoices': TransferAggregateResponse;
5680
+ /**
5681
+ *
5682
+ * @type {TransferAggregateResponse}
5683
+ * @memberof TransferSummaryResponse
5684
+ */
5685
+ 'creditInvoices': TransferAggregateResponse;
5686
+ /**
5687
+ *
5688
+ * @type {TransferAggregateResponse}
5689
+ * @memberof TransferSummaryResponse
5690
+ */
5691
+ 'fines': TransferAggregateResponse;
5692
+ /**
5693
+ *
5694
+ * @type {TransferAggregateResponse}
5695
+ * @memberof TransferSummaryResponse
5696
+ */
5697
+ 'waivedFines': TransferAggregateResponse;
5698
+ /**
5699
+ *
5700
+ * @type {TransferAggregateResponse}
5701
+ * @memberof TransferSummaryResponse
5702
+ */
5703
+ 'writeOffs': TransferAggregateResponse;
5704
+ /**
5705
+ *
5706
+ * @type {TransferAggregateResponse}
5707
+ * @memberof TransferSummaryResponse
5708
+ */
5709
+ 'inactiveAdministrativeCosts': TransferAggregateResponse;
5710
+ /**
5711
+ *
5712
+ * @type {TransferAggregateResponse}
5713
+ * @memberof TransferSummaryResponse
5714
+ */
5715
+ 'manualCreations': TransferAggregateResponse;
5716
+ /**
5717
+ *
5718
+ * @type {TransferAggregateResponse}
5719
+ * @memberof TransferSummaryResponse
5720
+ */
5721
+ 'manualDeletions': TransferAggregateResponse;
5722
+ }
5608
5723
  /**
5609
5724
  *
5610
5725
  * @export
@@ -6380,6 +6495,22 @@ export interface UserToInactiveAdministrativeCostResponse {
6380
6495
  */
6381
6496
  'nickname'?: string;
6382
6497
  }
6498
+ /**
6499
+ * The type of a user
6500
+ * @export
6501
+ * @enum {string}
6502
+ */
6503
+ export declare const UserType: {
6504
+ readonly Member: "MEMBER";
6505
+ readonly Organ: "ORGAN";
6506
+ readonly Voucher: "VOUCHER";
6507
+ readonly LocalUser: "LOCAL_USER";
6508
+ readonly LocalAdmin: "LOCAL_ADMIN";
6509
+ readonly Invoice: "INVOICE";
6510
+ readonly PointOfSale: "POINT_OF_SALE";
6511
+ readonly Integration: "INTEGRATION";
6512
+ };
6513
+ export type UserType = typeof UserType[keyof typeof UserType];
6383
6514
  /**
6384
6515
  *
6385
6516
  * @export
@@ -6418,6 +6549,25 @@ export interface UserWithIndex {
6418
6549
  */
6419
6550
  'index': number;
6420
6551
  }
6552
+ /**
6553
+ *
6554
+ * @export
6555
+ * @interface ValidationResponse
6556
+ */
6557
+ export interface ValidationResponse {
6558
+ /**
6559
+ * Whether the request passed validation.
6560
+ * @type {boolean}
6561
+ * @memberof ValidationResponse
6562
+ */
6563
+ 'valid': boolean;
6564
+ /**
6565
+ * List of validation error messages.
6566
+ * @type {Array<string>}
6567
+ * @memberof ValidationResponse
6568
+ */
6569
+ 'errors': Array<string>;
6570
+ }
6421
6571
  /**
6422
6572
  *
6423
6573
  * @export
@@ -7982,7 +8132,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
7982
8132
  * @param {boolean} [hasFine] Only users with(out) fines
7983
8133
  * @param {number} [minFine] Minimum fine
7984
8134
  * @param {number} [maxFine] Maximum fine
7985
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8135
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
7986
8136
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
7987
8137
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
7988
8138
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -7992,7 +8142,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
7992
8142
  * @param {*} [options] Override http request option.
7993
8143
  * @throws {RequiredError}
7994
8144
  */
7995
- getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: GetAllBalanceUserTypesEnum, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8145
+ getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7996
8146
  /**
7997
8147
  *
7998
8148
  * @summary Retrieves the requested balance
@@ -8032,7 +8182,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8032
8182
  * @param {boolean} [hasFine] Only users with(out) fines
8033
8183
  * @param {number} [minFine] Minimum fine
8034
8184
  * @param {number} [maxFine] Maximum fine
8035
- * @param {GetAllBalanceUserTypesEnum} [userTypes] Filter based on user type.
8185
+ * @param {Array<UserType>} [userTypes] Filter based on user type.
8036
8186
  * @param {string} [orderBy] Column to order balance by - eg: id,amount
8037
8187
  * @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
8038
8188
  * @param {boolean} [allowDeleted] Whether to include deleted users
@@ -8042,7 +8192,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
8042
8192
  * @param {*} [options] Override http request option.
8043
8193
  * @throws {RequiredError}
8044
8194
  */
8045
- getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: GetAllBalanceUserTypesEnum, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBalanceResponse>>;
8195
+ getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBalanceResponse>>;
8046
8196
  /**
8047
8197
  *
8048
8198
  * @summary Retrieves the requested balance
@@ -8159,10 +8309,10 @@ export interface BalanceApiGetAllBalanceRequest {
8159
8309
  readonly maxFine?: number;
8160
8310
  /**
8161
8311
  * Filter based on user type.
8162
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
8312
+ * @type {Array<UserType>}
8163
8313
  * @memberof BalanceApiGetAllBalance
8164
8314
  */
8165
- readonly userTypes?: GetAllBalanceUserTypesEnum;
8315
+ readonly userTypes?: Array<UserType>;
8166
8316
  /**
8167
8317
  * Column to order balance by - eg: id,amount
8168
8318
  * @type {string}
@@ -8256,11 +8406,6 @@ export declare class BalanceApi extends BaseAPI {
8256
8406
  */
8257
8407
  getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
8258
8408
  }
8259
- /**
8260
- * @export
8261
- */
8262
- export declare const GetAllBalanceUserTypesEnum: {};
8263
- export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
8264
8409
  /**
8265
8410
  * @export
8266
8411
  */
@@ -10681,7 +10826,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
10681
10826
  * @param {*} [options] Override http request option.
10682
10827
  * @throws {RequiredError}
10683
10828
  */
10684
- handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10829
+ handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
10685
10830
  /**
10686
10831
  *
10687
10832
  * @summary Notify all users which will pay administrative costs within a year
@@ -10759,7 +10904,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
10759
10904
  * @param {*} [options] Override http request option.
10760
10905
  * @throws {RequiredError}
10761
10906
  */
10762
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10907
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
10763
10908
  /**
10764
10909
  *
10765
10910
  * @summary Notify all users which will pay administrative costs within a year
@@ -10982,7 +11127,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
10982
11127
  * @throws {RequiredError}
10983
11128
  * @memberof InactiveAdministrativeCostsApi
10984
11129
  */
10985
- handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
11130
+ handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
10986
11131
  /**
10987
11132
  *
10988
11133
  * @summary Notify all users which will pay administrative costs within a year
@@ -11027,16 +11172,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11027
11172
  * @summary Returns all invoices in the system.
11028
11173
  * @param {number} [toId] Filter on Id of the debtor
11029
11174
  * @param {number} [invoiceId] Filter on invoice ID
11030
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11175
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11031
11176
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11032
11177
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11033
11178
  * @param {string} [tillDate] End date for selected invoices (exclusive)
11179
+ * @param {string} [description] Filter invoices by description (partial match)
11034
11180
  * @param {number} [take] How many entries the endpoint should return
11035
11181
  * @param {number} [skip] How many entries should be skipped (for pagination)
11036
11182
  * @param {*} [options] Override http request option.
11037
11183
  * @throws {RequiredError}
11038
11184
  */
11039
- getAllInvoices: (toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11185
+ getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11040
11186
  /**
11041
11187
  *
11042
11188
  * @summary Get eligible transactions for invoice creation.
@@ -11047,6 +11193,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
11047
11193
  * @throws {RequiredError}
11048
11194
  */
11049
11195
  getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11196
+ /**
11197
+ *
11198
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11199
+ * @param {*} [options] Override http request option.
11200
+ * @throws {RequiredError}
11201
+ */
11202
+ getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11050
11203
  /**
11051
11204
  *
11052
11205
  * @summary Get an invoice pdf.
@@ -11126,16 +11279,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11126
11279
  * @summary Returns all invoices in the system.
11127
11280
  * @param {number} [toId] Filter on Id of the debtor
11128
11281
  * @param {number} [invoiceId] Filter on invoice ID
11129
- * @param {GetAllInvoicesCurrentStateEnum} [currentState] Filter based on Invoice State.
11282
+ * @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
11130
11283
  * @param {boolean} [returnEntries] Boolean if invoice entries should be returned
11131
11284
  * @param {string} [fromDate] Start date for selected invoices (inclusive)
11132
11285
  * @param {string} [tillDate] End date for selected invoices (exclusive)
11286
+ * @param {string} [description] Filter invoices by description (partial match)
11133
11287
  * @param {number} [take] How many entries the endpoint should return
11134
11288
  * @param {number} [skip] How many entries should be skipped (for pagination)
11135
11289
  * @param {*} [options] Override http request option.
11136
11290
  * @throws {RequiredError}
11137
11291
  */
11138
- getAllInvoices(toId?: number, invoiceId?: number, currentState?: GetAllInvoicesCurrentStateEnum, returnEntries?: boolean, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
11292
+ getAllInvoices(toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
11139
11293
  /**
11140
11294
  *
11141
11295
  * @summary Get eligible transactions for invoice creation.
@@ -11146,6 +11300,13 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11146
11300
  * @throws {RequiredError}
11147
11301
  */
11148
11302
  getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse>>;
11303
+ /**
11304
+ *
11305
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11306
+ * @param {*} [options] Override http request option.
11307
+ * @throws {RequiredError}
11308
+ */
11309
+ getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
11149
11310
  /**
11150
11311
  *
11151
11312
  * @summary Get an invoice pdf.
@@ -11154,7 +11315,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11154
11315
  * @param {*} [options] Override http request option.
11155
11316
  * @throws {RequiredError}
11156
11317
  */
11157
- 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>>;
11158
11319
  /**
11159
11320
  *
11160
11321
  * @summary Returns a single invoice in the system.
@@ -11236,6 +11397,13 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11236
11397
  * @throws {RequiredError}
11237
11398
  */
11238
11399
  getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse>;
11400
+ /**
11401
+ *
11402
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11403
+ * @param {*} [options] Override http request option.
11404
+ * @throws {RequiredError}
11405
+ */
11406
+ getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
11239
11407
  /**
11240
11408
  *
11241
11409
  * @summary Get an invoice pdf.
@@ -11243,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11243
11411
  * @param {*} [options] Override http request option.
11244
11412
  * @throws {RequiredError}
11245
11413
  */
11246
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
11414
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
11247
11415
  /**
11248
11416
  *
11249
11417
  * @summary Returns a single invoice in the system.
@@ -11336,10 +11504,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
11336
11504
  readonly invoiceId?: number;
11337
11505
  /**
11338
11506
  * Filter based on Invoice State.
11339
- * @type {Array<GetAllBalanceUserTypesParameterInner>}
11507
+ * @type {Array<GetAllInvoicesCurrentStateParameterInner>}
11340
11508
  * @memberof InvoicesApiGetAllInvoices
11341
11509
  */
11342
- readonly currentState?: GetAllInvoicesCurrentStateEnum;
11510
+ readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
11343
11511
  /**
11344
11512
  * Boolean if invoice entries should be returned
11345
11513
  * @type {boolean}
@@ -11358,6 +11526,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
11358
11526
  * @memberof InvoicesApiGetAllInvoices
11359
11527
  */
11360
11528
  readonly tillDate?: string;
11529
+ /**
11530
+ * Filter invoices by description (partial match)
11531
+ * @type {string}
11532
+ * @memberof InvoicesApiGetAllInvoices
11533
+ */
11534
+ readonly description?: string;
11361
11535
  /**
11362
11536
  * How many entries the endpoint should return
11363
11537
  * @type {number}
@@ -11537,6 +11711,14 @@ export declare class InvoicesApi extends BaseAPI {
11537
11711
  * @memberof InvoicesApi
11538
11712
  */
11539
11713
  getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
11714
+ /**
11715
+ *
11716
+ * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
11717
+ * @param {*} [options] Override http request option.
11718
+ * @throws {RequiredError}
11719
+ * @memberof InvoicesApi
11720
+ */
11721
+ getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
11540
11722
  /**
11541
11723
  *
11542
11724
  * @summary Get an invoice pdf.
@@ -11545,7 +11727,7 @@ export declare class InvoicesApi extends BaseAPI {
11545
11727
  * @throws {RequiredError}
11546
11728
  * @memberof InvoicesApi
11547
11729
  */
11548
- getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
11730
+ getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
11549
11731
  /**
11550
11732
  *
11551
11733
  * @summary Returns a single invoice in the system.
@@ -11583,11 +11765,6 @@ export declare class InvoicesApi extends BaseAPI {
11583
11765
  */
11584
11766
  updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
11585
11767
  }
11586
- /**
11587
- * @export
11588
- */
11589
- export declare const GetAllInvoicesCurrentStateEnum: {};
11590
- export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
11591
11768
  /**
11592
11769
  * PayoutRequestsApi - axios parameter creator
11593
11770
  * @export
@@ -14142,11 +14319,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
14142
14319
  /**
14143
14320
  * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
14144
14321
  * @summary Get dry-run sync results for users
14145
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14322
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14146
14323
  * @param {*} [options] Override http request option.
14147
14324
  * @throws {RequiredError}
14148
14325
  */
14149
- getUserSyncResults: (service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14326
+ getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14150
14327
  };
14151
14328
  /**
14152
14329
  * SyncApi - functional programming interface
@@ -14156,11 +14333,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
14156
14333
  /**
14157
14334
  * Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
14158
14335
  * @summary Get dry-run sync results for users
14159
- * @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14336
+ * @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14160
14337
  * @param {*} [options] Override http request option.
14161
14338
  * @throws {RequiredError}
14162
14339
  */
14163
- getUserSyncResults(service?: GetUserSyncResultsServiceEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
14340
+ getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
14164
14341
  };
14165
14342
  /**
14166
14343
  * SyncApi - factory interface
@@ -14184,10 +14361,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
14184
14361
  export interface SyncApiGetUserSyncResultsRequest {
14185
14362
  /**
14186
14363
  * Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
14187
- * @type {Array<string>}
14364
+ * @type {Array<'LDAP' | 'GEWISDB'>}
14188
14365
  * @memberof SyncApiGetUserSyncResults
14189
14366
  */
14190
- readonly service?: GetUserSyncResultsServiceEnum;
14367
+ readonly service?: Array<GetUserSyncResultsServiceEnum>;
14191
14368
  }
14192
14369
  /**
14193
14370
  * SyncApi - object-oriented interface
@@ -14209,7 +14386,10 @@ export declare class SyncApi extends BaseAPI {
14209
14386
  /**
14210
14387
  * @export
14211
14388
  */
14212
- export declare const GetUserSyncResultsServiceEnum: {};
14389
+ export declare const GetUserSyncResultsServiceEnum: {
14390
+ readonly Ldap: "LDAP";
14391
+ readonly Gewisdb: "GEWISDB";
14392
+ };
14213
14393
  export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
14214
14394
  /**
14215
14395
  * TermsOfServiceApi - axios parameter creator
@@ -14959,12 +15139,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14959
15139
  * @summary Returns all existing transfers
14960
15140
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
14961
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
14962
15145
  * @param {number} [take] How many transfers the endpoint should return
14963
15146
  * @param {number} [skip] How many transfers should be skipped (for pagination)
14964
15147
  * @param {*} [options] Override http request option.
14965
15148
  * @throws {RequiredError}
14966
15149
  */
14967
- 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>;
14968
15151
  /**
14969
15152
  *
14970
15153
  * @summary Returns the requested transfer
@@ -14980,7 +15163,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14980
15163
  * @param {string} [tillDate] End date for selected transfers (exclusive)
14981
15164
  * @param {number} [fromId] Filter transfers from this user ID
14982
15165
  * @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
15166
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
14984
15167
  * @param {*} [options] Override http request option.
14985
15168
  * @throws {RequiredError}
14986
15169
  */
@@ -14993,6 +15176,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
14993
15176
  * @throws {RequiredError}
14994
15177
  */
14995
15178
  getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15179
+ /**
15180
+ *
15181
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15182
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15183
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15184
+ * @param {number} [fromId] Filter transfers from this user ID
15185
+ * @param {number} [toId] Filter transfers to this user ID
15186
+ * @param {*} [options] Override http request option.
15187
+ * @throws {RequiredError}
15188
+ */
15189
+ getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
14996
15190
  };
14997
15191
  /**
14998
15192
  * TransfersApi - functional programming interface
@@ -15020,12 +15214,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15020
15214
  * @summary Returns all existing transfers
15021
15215
  * @param {string} [fromDate] Start date for selected transfers (inclusive)
15022
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
15023
15220
  * @param {number} [take] How many transfers the endpoint should return
15024
15221
  * @param {number} [skip] How many transfers should be skipped (for pagination)
15025
15222
  * @param {*} [options] Override http request option.
15026
15223
  * @throws {RequiredError}
15027
15224
  */
15028
- 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>>>;
15029
15226
  /**
15030
15227
  *
15031
15228
  * @summary Returns the requested transfer
@@ -15041,7 +15238,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15041
15238
  * @param {string} [tillDate] End date for selected transfers (exclusive)
15042
15239
  * @param {number} [fromId] Filter transfers from this user ID
15043
15240
  * @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
15241
+ * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15045
15242
  * @param {*} [options] Override http request option.
15046
15243
  * @throws {RequiredError}
15047
15244
  */
@@ -15054,6 +15251,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
15054
15251
  * @throws {RequiredError}
15055
15252
  */
15056
15253
  getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
15254
+ /**
15255
+ *
15256
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15257
+ * @param {string} [fromDate] Start date for selected transfers (inclusive)
15258
+ * @param {string} [tillDate] End date for selected transfers (exclusive)
15259
+ * @param {number} [fromId] Filter transfers from this user ID
15260
+ * @param {number} [toId] Filter transfers to this user ID
15261
+ * @param {*} [options] Override http request option.
15262
+ * @throws {RequiredError}
15263
+ */
15264
+ getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
15057
15265
  };
15058
15266
  /**
15059
15267
  * TransfersApi - factory interface
@@ -15108,6 +15316,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
15108
15316
  * @throws {RequiredError}
15109
15317
  */
15110
15318
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
15319
+ /**
15320
+ *
15321
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15322
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15323
+ * @param {*} [options] Override http request option.
15324
+ * @throws {RequiredError}
15325
+ */
15326
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
15111
15327
  };
15112
15328
  /**
15113
15329
  * Request parameters for createTransfer operation in TransfersApi.
@@ -15153,6 +15369,24 @@ export interface TransfersApiGetAllTransfersRequest {
15153
15369
  * @memberof TransfersApiGetAllTransfers
15154
15370
  */
15155
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;
15156
15390
  /**
15157
15391
  * How many transfers the endpoint should return
15158
15392
  * @type {number}
@@ -15210,7 +15444,7 @@ export interface TransfersApiGetTransferAggregateRequest {
15210
15444
  */
15211
15445
  readonly toId?: number;
15212
15446
  /**
15213
- * Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15447
+ * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
15214
15448
  * @type {string}
15215
15449
  * @memberof TransfersApiGetTransferAggregate
15216
15450
  */
@@ -15229,6 +15463,37 @@ export interface TransfersApiGetTransferPdfRequest {
15229
15463
  */
15230
15464
  readonly id: number;
15231
15465
  }
15466
+ /**
15467
+ * Request parameters for getTransferSummary operation in TransfersApi.
15468
+ * @export
15469
+ * @interface TransfersApiGetTransferSummaryRequest
15470
+ */
15471
+ export interface TransfersApiGetTransferSummaryRequest {
15472
+ /**
15473
+ * Start date for selected transfers (inclusive)
15474
+ * @type {string}
15475
+ * @memberof TransfersApiGetTransferSummary
15476
+ */
15477
+ readonly fromDate?: string;
15478
+ /**
15479
+ * End date for selected transfers (exclusive)
15480
+ * @type {string}
15481
+ * @memberof TransfersApiGetTransferSummary
15482
+ */
15483
+ readonly tillDate?: string;
15484
+ /**
15485
+ * Filter transfers from this user ID
15486
+ * @type {number}
15487
+ * @memberof TransfersApiGetTransferSummary
15488
+ */
15489
+ readonly fromId?: number;
15490
+ /**
15491
+ * Filter transfers to this user ID
15492
+ * @type {number}
15493
+ * @memberof TransfersApiGetTransferSummary
15494
+ */
15495
+ readonly toId?: number;
15496
+ }
15232
15497
  /**
15233
15498
  * TransfersApi - object-oriented interface
15234
15499
  * @export
@@ -15290,6 +15555,15 @@ export declare class TransfersApi extends BaseAPI {
15290
15555
  * @memberof TransfersApi
15291
15556
  */
15292
15557
  getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
15558
+ /**
15559
+ *
15560
+ * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
15561
+ * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
15562
+ * @param {*} [options] Override http request option.
15563
+ * @throws {RequiredError}
15564
+ * @memberof TransfersApi
15565
+ */
15566
+ getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
15293
15567
  }
15294
15568
  /**
15295
15569
  * UserNotificationPreferencesApi - axios parameter creator