@gewis/sudosos-client 0.0.0-develop.efea20e → 0.0.0-develop.f5251b0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +110 -0
- package/dist/api.d.ts +424 -342
- package/dist/api.js +130 -295
- package/dist/base.js +1 -1
- package/package.json +4 -4
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
|
*/
|
|
@@ -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
|
|
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
|
-
* @
|
|
2647
|
+
* @enum {string}
|
|
2570
2648
|
*/
|
|
2571
|
-
export
|
|
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'
|
|
3281
|
+
'_pagination': PaginationResult;
|
|
3187
3282
|
/**
|
|
3188
3283
|
* Returned balance responses
|
|
3189
3284
|
* @type {Array<BalanceResponse>}
|
|
3190
3285
|
* @memberof PaginatedBalanceResponse
|
|
3191
3286
|
*/
|
|
3192
|
-
'records'
|
|
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'
|
|
3300
|
+
'_pagination': PaginationResult;
|
|
3206
3301
|
/**
|
|
3207
3302
|
* Returned banners
|
|
3208
3303
|
* @type {Array<BannerResponse>}
|
|
3209
3304
|
* @memberof PaginatedBannerResponse
|
|
3210
3305
|
*/
|
|
3211
|
-
'records'
|
|
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'
|
|
3490
|
+
'_pagination': PaginationResult;
|
|
3377
3491
|
/**
|
|
3378
3492
|
* Returned InactiveAdministrativeCost
|
|
3379
3493
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3380
3494
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3381
3495
|
*/
|
|
3382
|
-
'records'
|
|
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
|
-
*
|
|
5088
|
-
* @type {
|
|
5276
|
+
*
|
|
5277
|
+
* @type {DineroObjectResponse}
|
|
5089
5278
|
* @memberof TotalBalanceResponse
|
|
5090
5279
|
*/
|
|
5091
|
-
'totalPositive':
|
|
5280
|
+
'totalPositive': DineroObjectResponse;
|
|
5092
5281
|
/**
|
|
5093
|
-
*
|
|
5094
|
-
* @type {
|
|
5282
|
+
*
|
|
5283
|
+
* @type {DineroObjectResponse}
|
|
5095
5284
|
* @memberof TotalBalanceResponse
|
|
5096
5285
|
*/
|
|
5097
|
-
'totalNegative':
|
|
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
|
*
|
|
@@ -5685,7 +5874,7 @@ export interface TransferSummaryResponse {
|
|
|
5685
5874
|
'manualDeletions': TransferAggregateResponse;
|
|
5686
5875
|
}
|
|
5687
5876
|
/**
|
|
5688
|
-
*
|
|
5877
|
+
* API Request for updating a `container` entity.
|
|
5689
5878
|
* @export
|
|
5690
5879
|
* @interface UpdateContainerRequest
|
|
5691
5880
|
*/
|
|
@@ -5935,7 +6124,7 @@ export interface UpdatePinRequest {
|
|
|
5935
6124
|
'pin': string;
|
|
5936
6125
|
}
|
|
5937
6126
|
/**
|
|
5938
|
-
*
|
|
6127
|
+
* API Request for updating a `point of sale` entity.
|
|
5939
6128
|
* @export
|
|
5940
6129
|
* @interface UpdatePointOfSaleRequest
|
|
5941
6130
|
*/
|
|
@@ -5972,7 +6161,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
5972
6161
|
'cashierRoleIds'?: Array<number>;
|
|
5973
6162
|
}
|
|
5974
6163
|
/**
|
|
5975
|
-
*
|
|
6164
|
+
* API Request for updating a `product` entity.
|
|
5976
6165
|
* @export
|
|
5977
6166
|
* @interface UpdateProductRequest
|
|
5978
6167
|
*/
|
|
@@ -6137,9 +6326,15 @@ export interface UpdateUserRequest {
|
|
|
6137
6326
|
* @memberof UpdateUserRequest
|
|
6138
6327
|
*/
|
|
6139
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;
|
|
6140
6335
|
}
|
|
6141
6336
|
/**
|
|
6142
|
-
*
|
|
6337
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6143
6338
|
* @export
|
|
6144
6339
|
* @interface UpdateVatGroupRequest
|
|
6145
6340
|
*/
|
|
@@ -6353,6 +6548,12 @@ export interface UserResponse {
|
|
|
6353
6548
|
* @memberof UserResponse
|
|
6354
6549
|
*/
|
|
6355
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;
|
|
6356
6557
|
}
|
|
6357
6558
|
/**
|
|
6358
6559
|
*
|
|
@@ -6459,6 +6660,22 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6459
6660
|
*/
|
|
6460
6661
|
'nickname'?: string;
|
|
6461
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];
|
|
6462
6679
|
/**
|
|
6463
6680
|
*
|
|
6464
6681
|
* @export
|
|
@@ -6485,7 +6702,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6485
6702
|
'totalNegative': DineroObjectResponse;
|
|
6486
6703
|
}
|
|
6487
6704
|
/**
|
|
6488
|
-
*
|
|
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.
|
|
6489
6706
|
* @export
|
|
6490
6707
|
* @interface UserWithIndex
|
|
6491
6708
|
*/
|
|
@@ -6500,6 +6717,25 @@ export interface UserWithIndex {
|
|
|
6500
6717
|
/**
|
|
6501
6718
|
*
|
|
6502
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
|
|
6503
6739
|
* @interface VatDeclarationResponse
|
|
6504
6740
|
*/
|
|
6505
6741
|
export interface VatDeclarationResponse {
|
|
@@ -6523,7 +6759,7 @@ export interface VatDeclarationResponse {
|
|
|
6523
6759
|
'rows': Array<VatDeclarationRow>;
|
|
6524
6760
|
}
|
|
6525
6761
|
/**
|
|
6526
|
-
*
|
|
6762
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6527
6763
|
* @export
|
|
6528
6764
|
* @interface VatDeclarationRow
|
|
6529
6765
|
*/
|
|
@@ -6989,15 +7225,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6989
7225
|
* @throws {RequiredError}
|
|
6990
7226
|
*/
|
|
6991
7227
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6992
|
-
/**
|
|
6993
|
-
*
|
|
6994
|
-
* @summary EAN login and hand out token
|
|
6995
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
|
|
6996
|
-
* @param {*} [options] Override http request option.
|
|
6997
|
-
* @deprecated
|
|
6998
|
-
* @throws {RequiredError}
|
|
6999
|
-
*/
|
|
7000
|
-
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7001
7228
|
/**
|
|
7002
7229
|
*
|
|
7003
7230
|
* @summary Generate a QR code for authentication
|
|
@@ -7067,15 +7294,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7067
7294
|
* @throws {RequiredError}
|
|
7068
7295
|
*/
|
|
7069
7296
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7070
|
-
/**
|
|
7071
|
-
*
|
|
7072
|
-
* @summary PIN login for members using memberId.
|
|
7073
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
|
|
7074
|
-
* @param {*} [options] Override http request option.
|
|
7075
|
-
* @deprecated
|
|
7076
|
-
* @throws {RequiredError}
|
|
7077
|
-
*/
|
|
7078
|
-
memberPinAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7079
7297
|
/**
|
|
7080
7298
|
*
|
|
7081
7299
|
* @summary Mock login and hand out token.
|
|
@@ -7084,24 +7302,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7084
7302
|
* @throws {RequiredError}
|
|
7085
7303
|
*/
|
|
7086
7304
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7087
|
-
/**
|
|
7088
|
-
*
|
|
7089
|
-
* @summary NFC login and hand out token
|
|
7090
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
|
|
7091
|
-
* @param {*} [options] Override http request option.
|
|
7092
|
-
* @deprecated
|
|
7093
|
-
* @throws {RequiredError}
|
|
7094
|
-
*/
|
|
7095
|
-
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7096
|
-
/**
|
|
7097
|
-
*
|
|
7098
|
-
* @summary PIN login and hand out token
|
|
7099
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
|
|
7100
|
-
* @param {*} [options] Override http request option.
|
|
7101
|
-
* @deprecated
|
|
7102
|
-
* @throws {RequiredError}
|
|
7103
|
-
*/
|
|
7104
|
-
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7105
7305
|
/**
|
|
7106
7306
|
*
|
|
7107
7307
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7187,15 +7387,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7187
7387
|
* @throws {RequiredError}
|
|
7188
7388
|
*/
|
|
7189
7389
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7190
|
-
/**
|
|
7191
|
-
*
|
|
7192
|
-
* @summary EAN login and hand out token
|
|
7193
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
|
|
7194
|
-
* @param {*} [options] Override http request option.
|
|
7195
|
-
* @deprecated
|
|
7196
|
-
* @throws {RequiredError}
|
|
7197
|
-
*/
|
|
7198
|
-
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7199
7390
|
/**
|
|
7200
7391
|
*
|
|
7201
7392
|
* @summary Generate a QR code for authentication
|
|
@@ -7265,15 +7456,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7265
7456
|
* @throws {RequiredError}
|
|
7266
7457
|
*/
|
|
7267
7458
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7268
|
-
/**
|
|
7269
|
-
*
|
|
7270
|
-
* @summary PIN login for members using memberId.
|
|
7271
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
|
|
7272
|
-
* @param {*} [options] Override http request option.
|
|
7273
|
-
* @deprecated
|
|
7274
|
-
* @throws {RequiredError}
|
|
7275
|
-
*/
|
|
7276
|
-
memberPinAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7277
7459
|
/**
|
|
7278
7460
|
*
|
|
7279
7461
|
* @summary Mock login and hand out token.
|
|
@@ -7282,24 +7464,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7282
7464
|
* @throws {RequiredError}
|
|
7283
7465
|
*/
|
|
7284
7466
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7285
|
-
/**
|
|
7286
|
-
*
|
|
7287
|
-
* @summary NFC login and hand out token
|
|
7288
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
|
|
7289
|
-
* @param {*} [options] Override http request option.
|
|
7290
|
-
* @deprecated
|
|
7291
|
-
* @throws {RequiredError}
|
|
7292
|
-
*/
|
|
7293
|
-
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7294
|
-
/**
|
|
7295
|
-
*
|
|
7296
|
-
* @summary PIN login and hand out token
|
|
7297
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
|
|
7298
|
-
* @param {*} [options] Override http request option.
|
|
7299
|
-
* @deprecated
|
|
7300
|
-
* @throws {RequiredError}
|
|
7301
|
-
*/
|
|
7302
|
-
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7303
7467
|
/**
|
|
7304
7468
|
*
|
|
7305
7469
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7385,15 +7549,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7385
7549
|
* @throws {RequiredError}
|
|
7386
7550
|
*/
|
|
7387
7551
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7388
|
-
/**
|
|
7389
|
-
*
|
|
7390
|
-
* @summary EAN login and hand out token
|
|
7391
|
-
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7392
|
-
* @param {*} [options] Override http request option.
|
|
7393
|
-
* @deprecated
|
|
7394
|
-
* @throws {RequiredError}
|
|
7395
|
-
*/
|
|
7396
|
-
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7397
7552
|
/**
|
|
7398
7553
|
*
|
|
7399
7554
|
* @summary Generate a QR code for authentication
|
|
@@ -7463,15 +7618,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7463
7618
|
* @throws {RequiredError}
|
|
7464
7619
|
*/
|
|
7465
7620
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7466
|
-
/**
|
|
7467
|
-
*
|
|
7468
|
-
* @summary PIN login for members using memberId.
|
|
7469
|
-
* @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
|
|
7470
|
-
* @param {*} [options] Override http request option.
|
|
7471
|
-
* @deprecated
|
|
7472
|
-
* @throws {RequiredError}
|
|
7473
|
-
*/
|
|
7474
|
-
memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7475
7621
|
/**
|
|
7476
7622
|
*
|
|
7477
7623
|
* @summary Mock login and hand out token.
|
|
@@ -7480,24 +7626,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7480
7626
|
* @throws {RequiredError}
|
|
7481
7627
|
*/
|
|
7482
7628
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7483
|
-
/**
|
|
7484
|
-
*
|
|
7485
|
-
* @summary NFC login and hand out token
|
|
7486
|
-
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7487
|
-
* @param {*} [options] Override http request option.
|
|
7488
|
-
* @deprecated
|
|
7489
|
-
* @throws {RequiredError}
|
|
7490
|
-
*/
|
|
7491
|
-
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7492
|
-
/**
|
|
7493
|
-
*
|
|
7494
|
-
* @summary PIN login and hand out token
|
|
7495
|
-
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7496
|
-
* @param {*} [options] Override http request option.
|
|
7497
|
-
* @deprecated
|
|
7498
|
-
* @throws {RequiredError}
|
|
7499
|
-
*/
|
|
7500
|
-
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7501
7629
|
/**
|
|
7502
7630
|
*
|
|
7503
7631
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7593,19 +7721,6 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7593
7721
|
*/
|
|
7594
7722
|
readonly sessionId: string;
|
|
7595
7723
|
}
|
|
7596
|
-
/**
|
|
7597
|
-
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7598
|
-
* @export
|
|
7599
|
-
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7600
|
-
*/
|
|
7601
|
-
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7602
|
-
/**
|
|
7603
|
-
* The EAN login.
|
|
7604
|
-
* @type {AuthenticationEanRequest}
|
|
7605
|
-
* @memberof AuthenticateApiEanAuthentication
|
|
7606
|
-
*/
|
|
7607
|
-
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7608
|
-
}
|
|
7609
7724
|
/**
|
|
7610
7725
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7611
7726
|
* @export
|
|
@@ -7684,19 +7799,6 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7684
7799
|
*/
|
|
7685
7800
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7686
7801
|
}
|
|
7687
|
-
/**
|
|
7688
|
-
* Request parameters for memberPinAuthentication operation in AuthenticateApi.
|
|
7689
|
-
* @export
|
|
7690
|
-
* @interface AuthenticateApiMemberPinAuthenticationRequest
|
|
7691
|
-
*/
|
|
7692
|
-
export interface AuthenticateApiMemberPinAuthenticationRequest {
|
|
7693
|
-
/**
|
|
7694
|
-
* The PIN login.
|
|
7695
|
-
* @type {MemberAuthenticationPinRequest}
|
|
7696
|
-
* @memberof AuthenticateApiMemberPinAuthentication
|
|
7697
|
-
*/
|
|
7698
|
-
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7699
|
-
}
|
|
7700
7802
|
/**
|
|
7701
7803
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7702
7804
|
* @export
|
|
@@ -7710,32 +7812,6 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7710
7812
|
*/
|
|
7711
7813
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7712
7814
|
}
|
|
7713
|
-
/**
|
|
7714
|
-
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
7715
|
-
* @export
|
|
7716
|
-
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
7717
|
-
*/
|
|
7718
|
-
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7719
|
-
/**
|
|
7720
|
-
* The NFC login.
|
|
7721
|
-
* @type {AuthenticationNfcRequest}
|
|
7722
|
-
* @memberof AuthenticateApiNfcAuthentication
|
|
7723
|
-
*/
|
|
7724
|
-
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
7725
|
-
}
|
|
7726
|
-
/**
|
|
7727
|
-
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
7728
|
-
* @export
|
|
7729
|
-
* @interface AuthenticateApiPinAuthenticationRequest
|
|
7730
|
-
*/
|
|
7731
|
-
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7732
|
-
/**
|
|
7733
|
-
* The PIN login.
|
|
7734
|
-
* @type {AuthenticationPinRequest}
|
|
7735
|
-
* @memberof AuthenticateApiPinAuthentication
|
|
7736
|
-
*/
|
|
7737
|
-
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
7738
|
-
}
|
|
7739
7815
|
/**
|
|
7740
7816
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7741
7817
|
* @export
|
|
@@ -7848,16 +7924,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7848
7924
|
* @memberof AuthenticateApi
|
|
7849
7925
|
*/
|
|
7850
7926
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7851
|
-
/**
|
|
7852
|
-
*
|
|
7853
|
-
* @summary EAN login and hand out token
|
|
7854
|
-
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7855
|
-
* @param {*} [options] Override http request option.
|
|
7856
|
-
* @deprecated
|
|
7857
|
-
* @throws {RequiredError}
|
|
7858
|
-
* @memberof AuthenticateApi
|
|
7859
|
-
*/
|
|
7860
|
-
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7861
7927
|
/**
|
|
7862
7928
|
*
|
|
7863
7929
|
* @summary Generate a QR code for authentication
|
|
@@ -7936,16 +8002,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7936
8002
|
* @memberof AuthenticateApi
|
|
7937
8003
|
*/
|
|
7938
8004
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7939
|
-
/**
|
|
7940
|
-
*
|
|
7941
|
-
* @summary PIN login for members using memberId.
|
|
7942
|
-
* @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
|
|
7943
|
-
* @param {*} [options] Override http request option.
|
|
7944
|
-
* @deprecated
|
|
7945
|
-
* @throws {RequiredError}
|
|
7946
|
-
* @memberof AuthenticateApi
|
|
7947
|
-
*/
|
|
7948
|
-
memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7949
8005
|
/**
|
|
7950
8006
|
*
|
|
7951
8007
|
* @summary Mock login and hand out token.
|
|
@@ -7955,26 +8011,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7955
8011
|
* @memberof AuthenticateApi
|
|
7956
8012
|
*/
|
|
7957
8013
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7958
|
-
/**
|
|
7959
|
-
*
|
|
7960
|
-
* @summary NFC login and hand out token
|
|
7961
|
-
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7962
|
-
* @param {*} [options] Override http request option.
|
|
7963
|
-
* @deprecated
|
|
7964
|
-
* @throws {RequiredError}
|
|
7965
|
-
* @memberof AuthenticateApi
|
|
7966
|
-
*/
|
|
7967
|
-
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7968
|
-
/**
|
|
7969
|
-
*
|
|
7970
|
-
* @summary PIN login and hand out token
|
|
7971
|
-
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7972
|
-
* @param {*} [options] Override http request option.
|
|
7973
|
-
* @deprecated
|
|
7974
|
-
* @throws {RequiredError}
|
|
7975
|
-
* @memberof AuthenticateApi
|
|
7976
|
-
*/
|
|
7977
|
-
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7978
8014
|
/**
|
|
7979
8015
|
*
|
|
7980
8016
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -8061,7 +8097,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8061
8097
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8062
8098
|
* @param {number} [minFine] Minimum fine
|
|
8063
8099
|
* @param {number} [maxFine] Maximum fine
|
|
8064
|
-
* @param {
|
|
8100
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8065
8101
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8066
8102
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8067
8103
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8071,7 +8107,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8071
8107
|
* @param {*} [options] Override http request option.
|
|
8072
8108
|
* @throws {RequiredError}
|
|
8073
8109
|
*/
|
|
8074
|
-
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
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>;
|
|
8075
8111
|
/**
|
|
8076
8112
|
*
|
|
8077
8113
|
* @summary Retrieves the requested balance
|
|
@@ -8111,7 +8147,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8111
8147
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8112
8148
|
* @param {number} [minFine] Minimum fine
|
|
8113
8149
|
* @param {number} [maxFine] Maximum fine
|
|
8114
|
-
* @param {
|
|
8150
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8115
8151
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8116
8152
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8117
8153
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8121,7 +8157,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8121
8157
|
* @param {*} [options] Override http request option.
|
|
8122
8158
|
* @throws {RequiredError}
|
|
8123
8159
|
*/
|
|
8124
|
-
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
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>>;
|
|
8125
8161
|
/**
|
|
8126
8162
|
*
|
|
8127
8163
|
* @summary Retrieves the requested balance
|
|
@@ -8238,10 +8274,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8238
8274
|
readonly maxFine?: number;
|
|
8239
8275
|
/**
|
|
8240
8276
|
* Filter based on user type.
|
|
8241
|
-
* @type {Array<
|
|
8277
|
+
* @type {Array<UserType>}
|
|
8242
8278
|
* @memberof BalanceApiGetAllBalance
|
|
8243
8279
|
*/
|
|
8244
|
-
readonly userTypes?:
|
|
8280
|
+
readonly userTypes?: Array<UserType>;
|
|
8245
8281
|
/**
|
|
8246
8282
|
* Column to order balance by - eg: id,amount
|
|
8247
8283
|
* @type {string}
|
|
@@ -8335,11 +8371,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8335
8371
|
*/
|
|
8336
8372
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8337
8373
|
}
|
|
8338
|
-
/**
|
|
8339
|
-
* @export
|
|
8340
|
-
*/
|
|
8341
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8342
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8343
8374
|
/**
|
|
8344
8375
|
* @export
|
|
8345
8376
|
*/
|
|
@@ -10760,7 +10791,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10760
10791
|
* @param {*} [options] Override http request option.
|
|
10761
10792
|
* @throws {RequiredError}
|
|
10762
10793
|
*/
|
|
10763
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10794
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10764
10795
|
/**
|
|
10765
10796
|
*
|
|
10766
10797
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10838,7 +10869,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10838
10869
|
* @param {*} [options] Override http request option.
|
|
10839
10870
|
* @throws {RequiredError}
|
|
10840
10871
|
*/
|
|
10841
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10872
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10842
10873
|
/**
|
|
10843
10874
|
*
|
|
10844
10875
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11061,7 +11092,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11061
11092
|
* @throws {RequiredError}
|
|
11062
11093
|
* @memberof InactiveAdministrativeCostsApi
|
|
11063
11094
|
*/
|
|
11064
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11095
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11065
11096
|
/**
|
|
11066
11097
|
*
|
|
11067
11098
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11106,7 +11137,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11106
11137
|
* @summary Returns all invoices in the system.
|
|
11107
11138
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11108
11139
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11109
|
-
* @param {
|
|
11140
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11110
11141
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11111
11142
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11112
11143
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11116,7 +11147,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11116
11147
|
* @param {*} [options] Override http request option.
|
|
11117
11148
|
* @throws {RequiredError}
|
|
11118
11149
|
*/
|
|
11119
|
-
getAllInvoices: (toId?: number, invoiceId?: number, currentState?:
|
|
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>;
|
|
11120
11151
|
/**
|
|
11121
11152
|
*
|
|
11122
11153
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11127,6 +11158,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11127
11158
|
* @throws {RequiredError}
|
|
11128
11159
|
*/
|
|
11129
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>;
|
|
11130
11168
|
/**
|
|
11131
11169
|
*
|
|
11132
11170
|
* @summary Get an invoice pdf.
|
|
@@ -11206,7 +11244,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11206
11244
|
* @summary Returns all invoices in the system.
|
|
11207
11245
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11208
11246
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11209
|
-
* @param {
|
|
11247
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11210
11248
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11211
11249
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11212
11250
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11216,7 +11254,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11216
11254
|
* @param {*} [options] Override http request option.
|
|
11217
11255
|
* @throws {RequiredError}
|
|
11218
11256
|
*/
|
|
11219
|
-
getAllInvoices(toId?: number, invoiceId?: number, currentState?:
|
|
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>>;
|
|
11220
11258
|
/**
|
|
11221
11259
|
*
|
|
11222
11260
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11226,7 +11264,14 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11226
11264
|
* @param {*} [options] Override http request option.
|
|
11227
11265
|
* @throws {RequiredError}
|
|
11228
11266
|
*/
|
|
11229
|
-
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>>>;
|
|
11230
11275
|
/**
|
|
11231
11276
|
*
|
|
11232
11277
|
* @summary Get an invoice pdf.
|
|
@@ -11235,7 +11280,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11235
11280
|
* @param {*} [options] Override http request option.
|
|
11236
11281
|
* @throws {RequiredError}
|
|
11237
11282
|
*/
|
|
11238
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11283
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11239
11284
|
/**
|
|
11240
11285
|
*
|
|
11241
11286
|
* @summary Returns a single invoice in the system.
|
|
@@ -11316,7 +11361,14 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11316
11361
|
* @param {*} [options] Override http request option.
|
|
11317
11362
|
* @throws {RequiredError}
|
|
11318
11363
|
*/
|
|
11319
|
-
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>>;
|
|
11320
11372
|
/**
|
|
11321
11373
|
*
|
|
11322
11374
|
* @summary Get an invoice pdf.
|
|
@@ -11324,7 +11376,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11324
11376
|
* @param {*} [options] Override http request option.
|
|
11325
11377
|
* @throws {RequiredError}
|
|
11326
11378
|
*/
|
|
11327
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11379
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11328
11380
|
/**
|
|
11329
11381
|
*
|
|
11330
11382
|
* @summary Returns a single invoice in the system.
|
|
@@ -11417,10 +11469,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11417
11469
|
readonly invoiceId?: number;
|
|
11418
11470
|
/**
|
|
11419
11471
|
* Filter based on Invoice State.
|
|
11420
|
-
* @type {Array<
|
|
11472
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11421
11473
|
* @memberof InvoicesApiGetAllInvoices
|
|
11422
11474
|
*/
|
|
11423
|
-
readonly currentState?:
|
|
11475
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11424
11476
|
/**
|
|
11425
11477
|
* Boolean if invoice entries should be returned
|
|
11426
11478
|
* @type {boolean}
|
|
@@ -11623,7 +11675,15 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11623
11675
|
* @throws {RequiredError}
|
|
11624
11676
|
* @memberof InvoicesApi
|
|
11625
11677
|
*/
|
|
11626
|
-
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, {}>>;
|
|
11627
11687
|
/**
|
|
11628
11688
|
*
|
|
11629
11689
|
* @summary Get an invoice pdf.
|
|
@@ -11632,7 +11692,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11632
11692
|
* @throws {RequiredError}
|
|
11633
11693
|
* @memberof InvoicesApi
|
|
11634
11694
|
*/
|
|
11635
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11695
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11636
11696
|
/**
|
|
11637
11697
|
*
|
|
11638
11698
|
* @summary Returns a single invoice in the system.
|
|
@@ -11670,11 +11730,6 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11670
11730
|
*/
|
|
11671
11731
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11672
11732
|
}
|
|
11673
|
-
/**
|
|
11674
|
-
* @export
|
|
11675
|
-
*/
|
|
11676
|
-
export declare const GetAllInvoicesCurrentStateEnum: {};
|
|
11677
|
-
export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
|
|
11678
11733
|
/**
|
|
11679
11734
|
* PayoutRequestsApi - axios parameter creator
|
|
11680
11735
|
* @export
|
|
@@ -14229,11 +14284,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
14229
14284
|
/**
|
|
14230
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.
|
|
14231
14286
|
* @summary Get dry-run sync results for users
|
|
14232
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14287
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14233
14288
|
* @param {*} [options] Override http request option.
|
|
14234
14289
|
* @throws {RequiredError}
|
|
14235
14290
|
*/
|
|
14236
|
-
getUserSyncResults: (service?: GetUserSyncResultsServiceEnum
|
|
14291
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14237
14292
|
};
|
|
14238
14293
|
/**
|
|
14239
14294
|
* SyncApi - functional programming interface
|
|
@@ -14243,11 +14298,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
|
14243
14298
|
/**
|
|
14244
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.
|
|
14245
14300
|
* @summary Get dry-run sync results for users
|
|
14246
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14301
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14247
14302
|
* @param {*} [options] Override http request option.
|
|
14248
14303
|
* @throws {RequiredError}
|
|
14249
14304
|
*/
|
|
14250
|
-
getUserSyncResults(service?: GetUserSyncResultsServiceEnum
|
|
14305
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14251
14306
|
};
|
|
14252
14307
|
/**
|
|
14253
14308
|
* SyncApi - factory interface
|
|
@@ -14271,10 +14326,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14271
14326
|
export interface SyncApiGetUserSyncResultsRequest {
|
|
14272
14327
|
/**
|
|
14273
14328
|
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14274
|
-
* @type {Array<
|
|
14329
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
14275
14330
|
* @memberof SyncApiGetUserSyncResults
|
|
14276
14331
|
*/
|
|
14277
|
-
readonly service?: GetUserSyncResultsServiceEnum
|
|
14332
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
14278
14333
|
}
|
|
14279
14334
|
/**
|
|
14280
14335
|
* SyncApi - object-oriented interface
|
|
@@ -14296,7 +14351,10 @@ export declare class SyncApi extends BaseAPI {
|
|
|
14296
14351
|
/**
|
|
14297
14352
|
* @export
|
|
14298
14353
|
*/
|
|
14299
|
-
export declare const GetUserSyncResultsServiceEnum: {
|
|
14354
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
14355
|
+
readonly Ldap: "LDAP";
|
|
14356
|
+
readonly Gewisdb: "GEWISDB";
|
|
14357
|
+
};
|
|
14300
14358
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14301
14359
|
/**
|
|
14302
14360
|
* TermsOfServiceApi - axios parameter creator
|
|
@@ -15046,12 +15104,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15046
15104
|
* @summary Returns all existing transfers
|
|
15047
15105
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15048
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
|
|
15049
15110
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15050
15111
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15051
15112
|
* @param {*} [options] Override http request option.
|
|
15052
15113
|
* @throws {RequiredError}
|
|
15053
15114
|
*/
|
|
15054
|
-
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>;
|
|
15055
15116
|
/**
|
|
15056
15117
|
*
|
|
15057
15118
|
* @summary Returns the requested transfer
|
|
@@ -15118,12 +15179,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15118
15179
|
* @summary Returns all existing transfers
|
|
15119
15180
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15120
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
|
|
15121
15185
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15122
15186
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15123
15187
|
* @param {*} [options] Override http request option.
|
|
15124
15188
|
* @throws {RequiredError}
|
|
15125
15189
|
*/
|
|
15126
|
-
getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
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>>;
|
|
15127
15191
|
/**
|
|
15128
15192
|
*
|
|
15129
15193
|
* @summary Returns the requested transfer
|
|
@@ -15192,7 +15256,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15192
15256
|
* @param {*} [options] Override http request option.
|
|
15193
15257
|
* @throws {RequiredError}
|
|
15194
15258
|
*/
|
|
15195
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15259
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15196
15260
|
/**
|
|
15197
15261
|
*
|
|
15198
15262
|
* @summary Returns the requested transfer
|
|
@@ -15270,6 +15334,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15270
15334
|
* @memberof TransfersApiGetAllTransfers
|
|
15271
15335
|
*/
|
|
15272
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;
|
|
15273
15355
|
/**
|
|
15274
15356
|
* How many transfers the endpoint should return
|
|
15275
15357
|
* @type {number}
|
|
@@ -15410,7 +15492,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15410
15492
|
* @throws {RequiredError}
|
|
15411
15493
|
* @memberof TransfersApi
|
|
15412
15494
|
*/
|
|
15413
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
15495
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15414
15496
|
/**
|
|
15415
15497
|
*
|
|
15416
15498
|
* @summary Returns the requested transfer
|