@gewis/sudosos-client 0.0.0-develop.903ca1d → 0.0.0-develop.a15b7fe
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 +987 -331
- package/dist/api.js +860 -335
- 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
|
*/
|
|
@@ -1824,6 +1902,37 @@ export interface CreateInvoiceRequest {
|
|
|
1824
1902
|
*/
|
|
1825
1903
|
'amount': DineroObjectRequest;
|
|
1826
1904
|
}
|
|
1905
|
+
/**
|
|
1906
|
+
*
|
|
1907
|
+
* @export
|
|
1908
|
+
* @interface CreatePaymentRequestRequest
|
|
1909
|
+
*/
|
|
1910
|
+
export interface CreatePaymentRequestRequest {
|
|
1911
|
+
/**
|
|
1912
|
+
* The ID of the user whose balance will be credited on payment.
|
|
1913
|
+
* @type {number}
|
|
1914
|
+
* @memberof CreatePaymentRequestRequest
|
|
1915
|
+
*/
|
|
1916
|
+
'forId': number;
|
|
1917
|
+
/**
|
|
1918
|
+
*
|
|
1919
|
+
* @type {DineroObjectRequest}
|
|
1920
|
+
* @memberof CreatePaymentRequestRequest
|
|
1921
|
+
*/
|
|
1922
|
+
'amount': DineroObjectRequest;
|
|
1923
|
+
/**
|
|
1924
|
+
* ISO-8601 timestamp after which the request stops accepting payments.
|
|
1925
|
+
* @type {string}
|
|
1926
|
+
* @memberof CreatePaymentRequestRequest
|
|
1927
|
+
*/
|
|
1928
|
+
'expiresAt': string;
|
|
1929
|
+
/**
|
|
1930
|
+
* Optional human-readable description (e.g. invoice reference).
|
|
1931
|
+
* @type {string}
|
|
1932
|
+
* @memberof CreatePaymentRequestRequest
|
|
1933
|
+
*/
|
|
1934
|
+
'description'?: string;
|
|
1935
|
+
}
|
|
1827
1936
|
/**
|
|
1828
1937
|
*
|
|
1829
1938
|
* @export
|
|
@@ -1856,7 +1965,7 @@ export interface CreatePermissionParams {
|
|
|
1856
1965
|
'attributes': Array<string>;
|
|
1857
1966
|
}
|
|
1858
1967
|
/**
|
|
1859
|
-
*
|
|
1968
|
+
* API Request for creating a `point of sale` entity.
|
|
1860
1969
|
* @export
|
|
1861
1970
|
* @interface CreatePointOfSaleRequest
|
|
1862
1971
|
*/
|
|
@@ -1880,7 +1989,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1880
1989
|
*/
|
|
1881
1990
|
'containers': Array<number>;
|
|
1882
1991
|
/**
|
|
1883
|
-
* ID of the user who will own the POS
|
|
1992
|
+
* ID of the user who will own the POS.
|
|
1884
1993
|
* @type {number}
|
|
1885
1994
|
* @memberof CreatePointOfSaleRequest
|
|
1886
1995
|
*/
|
|
@@ -1893,7 +2002,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1893
2002
|
'cashierRoleIds'?: Array<number>;
|
|
1894
2003
|
}
|
|
1895
2004
|
/**
|
|
1896
|
-
*
|
|
2005
|
+
* API Request for creating a `product` entity.
|
|
1897
2006
|
* @export
|
|
1898
2007
|
* @interface CreateProductRequest
|
|
1899
2008
|
*/
|
|
@@ -2566,10 +2675,15 @@ export interface FineResponse {
|
|
|
2566
2675
|
/**
|
|
2567
2676
|
*
|
|
2568
2677
|
* @export
|
|
2569
|
-
* @
|
|
2678
|
+
* @enum {string}
|
|
2570
2679
|
*/
|
|
2571
|
-
export
|
|
2572
|
-
|
|
2680
|
+
export declare const GetAllInvoicesCurrentStateParameterInner: {
|
|
2681
|
+
readonly Created: "CREATED";
|
|
2682
|
+
readonly Sent: "SENT";
|
|
2683
|
+
readonly Paid: "PAID";
|
|
2684
|
+
readonly Deleted: "DELETED";
|
|
2685
|
+
};
|
|
2686
|
+
export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
|
|
2573
2687
|
/**
|
|
2574
2688
|
* @type GetAllPayoutRequestsRequestedByIdParameter
|
|
2575
2689
|
* @export
|
|
@@ -3149,21 +3263,15 @@ export interface InvoiceUserResponse {
|
|
|
3149
3263
|
/**
|
|
3150
3264
|
*
|
|
3151
3265
|
* @export
|
|
3152
|
-
* @interface
|
|
3266
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3153
3267
|
*/
|
|
3154
|
-
export interface
|
|
3155
|
-
/**
|
|
3156
|
-
*
|
|
3157
|
-
* @type {number}
|
|
3158
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3159
|
-
*/
|
|
3160
|
-
'memberId': number;
|
|
3268
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3161
3269
|
/**
|
|
3162
|
-
*
|
|
3270
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3163
3271
|
* @type {string}
|
|
3164
|
-
* @memberof
|
|
3272
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3165
3273
|
*/
|
|
3166
|
-
'
|
|
3274
|
+
'reason': string;
|
|
3167
3275
|
}
|
|
3168
3276
|
/**
|
|
3169
3277
|
*
|
|
@@ -3214,13 +3322,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3214
3322
|
* @type {PaginationResult}
|
|
3215
3323
|
* @memberof PaginatedBalanceResponse
|
|
3216
3324
|
*/
|
|
3217
|
-
'_pagination'
|
|
3325
|
+
'_pagination': PaginationResult;
|
|
3218
3326
|
/**
|
|
3219
3327
|
* Returned balance responses
|
|
3220
3328
|
* @type {Array<BalanceResponse>}
|
|
3221
3329
|
* @memberof PaginatedBalanceResponse
|
|
3222
3330
|
*/
|
|
3223
|
-
'records'
|
|
3331
|
+
'records': Array<BalanceResponse>;
|
|
3224
3332
|
}
|
|
3225
3333
|
/**
|
|
3226
3334
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3233,13 +3341,13 @@ export interface PaginatedBannerResponse {
|
|
|
3233
3341
|
* @type {PaginationResult}
|
|
3234
3342
|
* @memberof PaginatedBannerResponse
|
|
3235
3343
|
*/
|
|
3236
|
-
'_pagination'
|
|
3344
|
+
'_pagination': PaginationResult;
|
|
3237
3345
|
/**
|
|
3238
3346
|
* Returned banners
|
|
3239
3347
|
* @type {Array<BannerResponse>}
|
|
3240
3348
|
* @memberof PaginatedBannerResponse
|
|
3241
3349
|
*/
|
|
3242
|
-
'records'
|
|
3350
|
+
'records': Array<BannerResponse>;
|
|
3243
3351
|
}
|
|
3244
3352
|
/**
|
|
3245
3353
|
*
|
|
@@ -3260,6 +3368,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3260
3368
|
*/
|
|
3261
3369
|
'records': Array<BaseEventResponse>;
|
|
3262
3370
|
}
|
|
3371
|
+
/**
|
|
3372
|
+
*
|
|
3373
|
+
* @export
|
|
3374
|
+
* @interface PaginatedBasePaymentRequestResponse
|
|
3375
|
+
*/
|
|
3376
|
+
export interface PaginatedBasePaymentRequestResponse {
|
|
3377
|
+
/**
|
|
3378
|
+
*
|
|
3379
|
+
* @type {PaginationResult}
|
|
3380
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3381
|
+
*/
|
|
3382
|
+
'_pagination': PaginationResult;
|
|
3383
|
+
/**
|
|
3384
|
+
* Returned payment requests
|
|
3385
|
+
* @type {Array<BasePaymentRequestResponse>}
|
|
3386
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3387
|
+
*/
|
|
3388
|
+
'records': Array<BasePaymentRequestResponse>;
|
|
3389
|
+
}
|
|
3263
3390
|
/**
|
|
3264
3391
|
*
|
|
3265
3392
|
* @export
|
|
@@ -3299,7 +3426,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3299
3426
|
'records': Array<BaseTransactionResponse>;
|
|
3300
3427
|
}
|
|
3301
3428
|
/**
|
|
3302
|
-
*
|
|
3429
|
+
* Paginated API Response for the `container` entity.
|
|
3303
3430
|
* @export
|
|
3304
3431
|
* @interface PaginatedContainerResponse
|
|
3305
3432
|
*/
|
|
@@ -3318,7 +3445,7 @@ export interface PaginatedContainerResponse {
|
|
|
3318
3445
|
'records': Array<ContainerResponse>;
|
|
3319
3446
|
}
|
|
3320
3447
|
/**
|
|
3321
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3322
3449
|
* @export
|
|
3323
3450
|
* @interface PaginatedContainerWithProductResponse
|
|
3324
3451
|
*/
|
|
@@ -3404,13 +3531,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3404
3531
|
* @type {PaginationResult}
|
|
3405
3532
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3406
3533
|
*/
|
|
3407
|
-
'_pagination'
|
|
3534
|
+
'_pagination': PaginationResult;
|
|
3408
3535
|
/**
|
|
3409
3536
|
* Returned InactiveAdministrativeCost
|
|
3410
3537
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3411
3538
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3412
3539
|
*/
|
|
3413
|
-
'records'
|
|
3540
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3414
3541
|
}
|
|
3415
3542
|
/**
|
|
3416
3543
|
*
|
|
@@ -3432,7 +3559,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3432
3559
|
'records': Array<InvoiceResponseTypes>;
|
|
3433
3560
|
}
|
|
3434
3561
|
/**
|
|
3435
|
-
*
|
|
3562
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3436
3563
|
* @export
|
|
3437
3564
|
* @interface PaginatedPointOfSaleResponse
|
|
3438
3565
|
*/
|
|
@@ -3451,7 +3578,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3451
3578
|
'records': Array<PointOfSaleResponse>;
|
|
3452
3579
|
}
|
|
3453
3580
|
/**
|
|
3454
|
-
*
|
|
3581
|
+
* Paginated API Response for the `product category` entity.
|
|
3455
3582
|
* @export
|
|
3456
3583
|
* @interface PaginatedProductCategoryResponse
|
|
3457
3584
|
*/
|
|
@@ -3470,7 +3597,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3470
3597
|
'records': Array<ProductCategoryResponse>;
|
|
3471
3598
|
}
|
|
3472
3599
|
/**
|
|
3473
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product` entity.
|
|
3474
3601
|
* @export
|
|
3475
3602
|
* @interface PaginatedProductResponse
|
|
3476
3603
|
*/
|
|
@@ -3565,7 +3692,7 @@ export interface PaginatedUserResponse {
|
|
|
3565
3692
|
'records': Array<UserResponse>;
|
|
3566
3693
|
}
|
|
3567
3694
|
/**
|
|
3568
|
-
*
|
|
3695
|
+
* Paginated API Response for the `vat group` entity.
|
|
3569
3696
|
* @export
|
|
3570
3697
|
* @interface PaginatedVatGroupResponse
|
|
3571
3698
|
*/
|
|
@@ -3690,6 +3817,31 @@ export interface PatchUserTypeRequest {
|
|
|
3690
3817
|
*/
|
|
3691
3818
|
'userType': string;
|
|
3692
3819
|
}
|
|
3820
|
+
/**
|
|
3821
|
+
* Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
|
|
3822
|
+
* @export
|
|
3823
|
+
* @interface PaymentRequestStartResponse
|
|
3824
|
+
*/
|
|
3825
|
+
export interface PaymentRequestStartResponse {
|
|
3826
|
+
/**
|
|
3827
|
+
* The PaymentRequest id the intent is linked to.
|
|
3828
|
+
* @type {string}
|
|
3829
|
+
* @memberof PaymentRequestStartResponse
|
|
3830
|
+
*/
|
|
3831
|
+
'paymentRequestId': string;
|
|
3832
|
+
/**
|
|
3833
|
+
* Stripe payment intent id.
|
|
3834
|
+
* @type {string}
|
|
3835
|
+
* @memberof PaymentRequestStartResponse
|
|
3836
|
+
*/
|
|
3837
|
+
'stripeId': string;
|
|
3838
|
+
/**
|
|
3839
|
+
* Stripe client secret for the intent.
|
|
3840
|
+
* @type {string}
|
|
3841
|
+
* @memberof PaymentRequestStartResponse
|
|
3842
|
+
*/
|
|
3843
|
+
'clientSecret': string;
|
|
3844
|
+
}
|
|
3693
3845
|
/**
|
|
3694
3846
|
*
|
|
3695
3847
|
* @export
|
|
@@ -3897,7 +4049,7 @@ export interface PermissionResponse {
|
|
|
3897
4049
|
'actions': Array<ActionResponse>;
|
|
3898
4050
|
}
|
|
3899
4051
|
/**
|
|
3900
|
-
*
|
|
4052
|
+
* 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).
|
|
3901
4053
|
* @export
|
|
3902
4054
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3903
4055
|
*/
|
|
@@ -4050,7 +4202,7 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4050
4202
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4051
4203
|
}
|
|
4052
4204
|
/**
|
|
4053
|
-
*
|
|
4205
|
+
* API Request for creating or updating a `product category` entity.
|
|
4054
4206
|
* @export
|
|
4055
4207
|
* @interface ProductCategoryRequest
|
|
4056
4208
|
*/
|
|
@@ -4214,6 +4366,56 @@ export interface ProductResponse {
|
|
|
4214
4366
|
*/
|
|
4215
4367
|
'priceList': boolean;
|
|
4216
4368
|
}
|
|
4369
|
+
/**
|
|
4370
|
+
* 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.
|
|
4371
|
+
* @export
|
|
4372
|
+
* @interface PublicPaymentRequestResponse
|
|
4373
|
+
*/
|
|
4374
|
+
export interface PublicPaymentRequestResponse {
|
|
4375
|
+
/**
|
|
4376
|
+
* UUID v4 identifier.
|
|
4377
|
+
* @type {string}
|
|
4378
|
+
* @memberof PublicPaymentRequestResponse
|
|
4379
|
+
*/
|
|
4380
|
+
'uuid': string;
|
|
4381
|
+
/**
|
|
4382
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4383
|
+
* @type {string}
|
|
4384
|
+
* @memberof PublicPaymentRequestResponse
|
|
4385
|
+
*/
|
|
4386
|
+
'forDisplayName': string;
|
|
4387
|
+
/**
|
|
4388
|
+
*
|
|
4389
|
+
* @type {DineroObjectResponse}
|
|
4390
|
+
* @memberof PublicPaymentRequestResponse
|
|
4391
|
+
*/
|
|
4392
|
+
'amount': DineroObjectResponse;
|
|
4393
|
+
/**
|
|
4394
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4395
|
+
* @type {string}
|
|
4396
|
+
* @memberof PublicPaymentRequestResponse
|
|
4397
|
+
*/
|
|
4398
|
+
'expiresAt': string;
|
|
4399
|
+
/**
|
|
4400
|
+
* Optional human-readable description.
|
|
4401
|
+
* @type {string}
|
|
4402
|
+
* @memberof PublicPaymentRequestResponse
|
|
4403
|
+
*/
|
|
4404
|
+
'description'?: string;
|
|
4405
|
+
/**
|
|
4406
|
+
* Derived lifecycle status.
|
|
4407
|
+
* @type {string}
|
|
4408
|
+
* @memberof PublicPaymentRequestResponse
|
|
4409
|
+
*/
|
|
4410
|
+
'status': PublicPaymentRequestResponseStatusEnum;
|
|
4411
|
+
}
|
|
4412
|
+
export declare const PublicPaymentRequestResponseStatusEnum: {
|
|
4413
|
+
readonly Pending: "PENDING";
|
|
4414
|
+
readonly Paid: "PAID";
|
|
4415
|
+
readonly Expired: "EXPIRED";
|
|
4416
|
+
readonly Cancelled: "CANCELLED";
|
|
4417
|
+
};
|
|
4418
|
+
export type PublicPaymentRequestResponseStatusEnum = typeof PublicPaymentRequestResponseStatusEnum[keyof typeof PublicPaymentRequestResponseStatusEnum];
|
|
4217
4419
|
/**
|
|
4218
4420
|
*
|
|
4219
4421
|
* @export
|
|
@@ -5115,23 +5317,23 @@ export interface TotalBalanceResponse {
|
|
|
5115
5317
|
*/
|
|
5116
5318
|
'date': string;
|
|
5117
5319
|
/**
|
|
5118
|
-
*
|
|
5119
|
-
* @type {
|
|
5320
|
+
*
|
|
5321
|
+
* @type {DineroObjectResponse}
|
|
5120
5322
|
* @memberof TotalBalanceResponse
|
|
5121
5323
|
*/
|
|
5122
|
-
'totalPositive':
|
|
5324
|
+
'totalPositive': DineroObjectResponse;
|
|
5123
5325
|
/**
|
|
5124
|
-
*
|
|
5125
|
-
* @type {
|
|
5326
|
+
*
|
|
5327
|
+
* @type {DineroObjectResponse}
|
|
5126
5328
|
* @memberof TotalBalanceResponse
|
|
5127
5329
|
*/
|
|
5128
|
-
'totalNegative':
|
|
5330
|
+
'totalNegative': DineroObjectResponse;
|
|
5129
5331
|
/**
|
|
5130
|
-
*
|
|
5131
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5332
|
+
* The total balances for the different user types
|
|
5333
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5132
5334
|
* @memberof TotalBalanceResponse
|
|
5133
5335
|
*/
|
|
5134
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5336
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5135
5337
|
}
|
|
5136
5338
|
/**
|
|
5137
5339
|
*
|
|
@@ -5716,7 +5918,7 @@ export interface TransferSummaryResponse {
|
|
|
5716
5918
|
'manualDeletions': TransferAggregateResponse;
|
|
5717
5919
|
}
|
|
5718
5920
|
/**
|
|
5719
|
-
*
|
|
5921
|
+
* API Request for updating a `container` entity.
|
|
5720
5922
|
* @export
|
|
5721
5923
|
* @interface UpdateContainerRequest
|
|
5722
5924
|
*/
|
|
@@ -5966,7 +6168,7 @@ export interface UpdatePinRequest {
|
|
|
5966
6168
|
'pin': string;
|
|
5967
6169
|
}
|
|
5968
6170
|
/**
|
|
5969
|
-
*
|
|
6171
|
+
* API Request for updating a `point of sale` entity.
|
|
5970
6172
|
* @export
|
|
5971
6173
|
* @interface UpdatePointOfSaleRequest
|
|
5972
6174
|
*/
|
|
@@ -6003,7 +6205,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6003
6205
|
'cashierRoleIds'?: Array<number>;
|
|
6004
6206
|
}
|
|
6005
6207
|
/**
|
|
6006
|
-
*
|
|
6208
|
+
* API Request for updating a `product` entity.
|
|
6007
6209
|
* @export
|
|
6008
6210
|
* @interface UpdateProductRequest
|
|
6009
6211
|
*/
|
|
@@ -6168,9 +6370,15 @@ export interface UpdateUserRequest {
|
|
|
6168
6370
|
* @memberof UpdateUserRequest
|
|
6169
6371
|
*/
|
|
6170
6372
|
'inactiveNotificationSend'?: boolean;
|
|
6373
|
+
/**
|
|
6374
|
+
* ISO date at which the account expires; pass null to clear
|
|
6375
|
+
* @type {string}
|
|
6376
|
+
* @memberof UpdateUserRequest
|
|
6377
|
+
*/
|
|
6378
|
+
'expiryDate'?: string | null;
|
|
6171
6379
|
}
|
|
6172
6380
|
/**
|
|
6173
|
-
*
|
|
6381
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6174
6382
|
* @export
|
|
6175
6383
|
* @interface UpdateVatGroupRequest
|
|
6176
6384
|
*/
|
|
@@ -6384,6 +6592,12 @@ export interface UserResponse {
|
|
|
6384
6592
|
* @memberof UserResponse
|
|
6385
6593
|
*/
|
|
6386
6594
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6595
|
+
/**
|
|
6596
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6597
|
+
* @type {string}
|
|
6598
|
+
* @memberof UserResponse
|
|
6599
|
+
*/
|
|
6600
|
+
'expiryDate'?: string | null;
|
|
6387
6601
|
}
|
|
6388
6602
|
/**
|
|
6389
6603
|
*
|
|
@@ -6490,6 +6704,22 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6490
6704
|
*/
|
|
6491
6705
|
'nickname'?: string;
|
|
6492
6706
|
}
|
|
6707
|
+
/**
|
|
6708
|
+
* The type of a user
|
|
6709
|
+
* @export
|
|
6710
|
+
* @enum {string}
|
|
6711
|
+
*/
|
|
6712
|
+
export declare const UserType: {
|
|
6713
|
+
readonly Member: "MEMBER";
|
|
6714
|
+
readonly Organ: "ORGAN";
|
|
6715
|
+
readonly Voucher: "VOUCHER";
|
|
6716
|
+
readonly LocalUser: "LOCAL_USER";
|
|
6717
|
+
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6718
|
+
readonly Invoice: "INVOICE";
|
|
6719
|
+
readonly PointOfSale: "POINT_OF_SALE";
|
|
6720
|
+
readonly Integration: "INTEGRATION";
|
|
6721
|
+
};
|
|
6722
|
+
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6493
6723
|
/**
|
|
6494
6724
|
*
|
|
6495
6725
|
* @export
|
|
@@ -6516,7 +6746,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6516
6746
|
'totalNegative': DineroObjectResponse;
|
|
6517
6747
|
}
|
|
6518
6748
|
/**
|
|
6519
|
-
*
|
|
6749
|
+
* 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.
|
|
6520
6750
|
* @export
|
|
6521
6751
|
* @interface UserWithIndex
|
|
6522
6752
|
*/
|
|
@@ -6531,6 +6761,25 @@ export interface UserWithIndex {
|
|
|
6531
6761
|
/**
|
|
6532
6762
|
*
|
|
6533
6763
|
* @export
|
|
6764
|
+
* @interface ValidationResponse
|
|
6765
|
+
*/
|
|
6766
|
+
export interface ValidationResponse {
|
|
6767
|
+
/**
|
|
6768
|
+
* Whether the request passed validation.
|
|
6769
|
+
* @type {boolean}
|
|
6770
|
+
* @memberof ValidationResponse
|
|
6771
|
+
*/
|
|
6772
|
+
'valid': boolean;
|
|
6773
|
+
/**
|
|
6774
|
+
* List of validation error messages.
|
|
6775
|
+
* @type {Array<string>}
|
|
6776
|
+
* @memberof ValidationResponse
|
|
6777
|
+
*/
|
|
6778
|
+
'errors': Array<string>;
|
|
6779
|
+
}
|
|
6780
|
+
/**
|
|
6781
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6782
|
+
* @export
|
|
6534
6783
|
* @interface VatDeclarationResponse
|
|
6535
6784
|
*/
|
|
6536
6785
|
export interface VatDeclarationResponse {
|
|
@@ -6554,7 +6803,7 @@ export interface VatDeclarationResponse {
|
|
|
6554
6803
|
'rows': Array<VatDeclarationRow>;
|
|
6555
6804
|
}
|
|
6556
6805
|
/**
|
|
6557
|
-
*
|
|
6806
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6558
6807
|
* @export
|
|
6559
6808
|
* @interface VatDeclarationRow
|
|
6560
6809
|
*/
|
|
@@ -7020,15 +7269,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7020
7269
|
* @throws {RequiredError}
|
|
7021
7270
|
*/
|
|
7022
7271
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7023
|
-
/**
|
|
7024
|
-
*
|
|
7025
|
-
* @summary EAN login and hand out token
|
|
7026
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
|
|
7027
|
-
* @param {*} [options] Override http request option.
|
|
7028
|
-
* @deprecated
|
|
7029
|
-
* @throws {RequiredError}
|
|
7030
|
-
*/
|
|
7031
|
-
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7032
7272
|
/**
|
|
7033
7273
|
*
|
|
7034
7274
|
* @summary Generate a QR code for authentication
|
|
@@ -7098,15 +7338,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7098
7338
|
* @throws {RequiredError}
|
|
7099
7339
|
*/
|
|
7100
7340
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7101
|
-
/**
|
|
7102
|
-
*
|
|
7103
|
-
* @summary PIN login for members using memberId.
|
|
7104
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
|
|
7105
|
-
* @param {*} [options] Override http request option.
|
|
7106
|
-
* @deprecated
|
|
7107
|
-
* @throws {RequiredError}
|
|
7108
|
-
*/
|
|
7109
|
-
memberPinAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7110
7341
|
/**
|
|
7111
7342
|
*
|
|
7112
7343
|
* @summary Mock login and hand out token.
|
|
@@ -7115,24 +7346,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7115
7346
|
* @throws {RequiredError}
|
|
7116
7347
|
*/
|
|
7117
7348
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7118
|
-
/**
|
|
7119
|
-
*
|
|
7120
|
-
* @summary NFC login and hand out token
|
|
7121
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
|
|
7122
|
-
* @param {*} [options] Override http request option.
|
|
7123
|
-
* @deprecated
|
|
7124
|
-
* @throws {RequiredError}
|
|
7125
|
-
*/
|
|
7126
|
-
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7127
|
-
/**
|
|
7128
|
-
*
|
|
7129
|
-
* @summary PIN login and hand out token
|
|
7130
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
|
|
7131
|
-
* @param {*} [options] Override http request option.
|
|
7132
|
-
* @deprecated
|
|
7133
|
-
* @throws {RequiredError}
|
|
7134
|
-
*/
|
|
7135
|
-
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7136
7349
|
/**
|
|
7137
7350
|
*
|
|
7138
7351
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7218,15 +7431,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7218
7431
|
* @throws {RequiredError}
|
|
7219
7432
|
*/
|
|
7220
7433
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7221
|
-
/**
|
|
7222
|
-
*
|
|
7223
|
-
* @summary EAN login and hand out token
|
|
7224
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
|
|
7225
|
-
* @param {*} [options] Override http request option.
|
|
7226
|
-
* @deprecated
|
|
7227
|
-
* @throws {RequiredError}
|
|
7228
|
-
*/
|
|
7229
|
-
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7230
7434
|
/**
|
|
7231
7435
|
*
|
|
7232
7436
|
* @summary Generate a QR code for authentication
|
|
@@ -7296,15 +7500,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7296
7500
|
* @throws {RequiredError}
|
|
7297
7501
|
*/
|
|
7298
7502
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7299
|
-
/**
|
|
7300
|
-
*
|
|
7301
|
-
* @summary PIN login for members using memberId.
|
|
7302
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
|
|
7303
|
-
* @param {*} [options] Override http request option.
|
|
7304
|
-
* @deprecated
|
|
7305
|
-
* @throws {RequiredError}
|
|
7306
|
-
*/
|
|
7307
|
-
memberPinAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7308
7503
|
/**
|
|
7309
7504
|
*
|
|
7310
7505
|
* @summary Mock login and hand out token.
|
|
@@ -7313,24 +7508,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7313
7508
|
* @throws {RequiredError}
|
|
7314
7509
|
*/
|
|
7315
7510
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7316
|
-
/**
|
|
7317
|
-
*
|
|
7318
|
-
* @summary NFC login and hand out token
|
|
7319
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
|
|
7320
|
-
* @param {*} [options] Override http request option.
|
|
7321
|
-
* @deprecated
|
|
7322
|
-
* @throws {RequiredError}
|
|
7323
|
-
*/
|
|
7324
|
-
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7325
|
-
/**
|
|
7326
|
-
*
|
|
7327
|
-
* @summary PIN login and hand out token
|
|
7328
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
|
|
7329
|
-
* @param {*} [options] Override http request option.
|
|
7330
|
-
* @deprecated
|
|
7331
|
-
* @throws {RequiredError}
|
|
7332
|
-
*/
|
|
7333
|
-
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7334
7511
|
/**
|
|
7335
7512
|
*
|
|
7336
7513
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7416,15 +7593,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7416
7593
|
* @throws {RequiredError}
|
|
7417
7594
|
*/
|
|
7418
7595
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7419
|
-
/**
|
|
7420
|
-
*
|
|
7421
|
-
* @summary EAN login and hand out token
|
|
7422
|
-
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7423
|
-
* @param {*} [options] Override http request option.
|
|
7424
|
-
* @deprecated
|
|
7425
|
-
* @throws {RequiredError}
|
|
7426
|
-
*/
|
|
7427
|
-
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7428
7596
|
/**
|
|
7429
7597
|
*
|
|
7430
7598
|
* @summary Generate a QR code for authentication
|
|
@@ -7494,15 +7662,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7494
7662
|
* @throws {RequiredError}
|
|
7495
7663
|
*/
|
|
7496
7664
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7497
|
-
/**
|
|
7498
|
-
*
|
|
7499
|
-
* @summary PIN login for members using memberId.
|
|
7500
|
-
* @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
|
|
7501
|
-
* @param {*} [options] Override http request option.
|
|
7502
|
-
* @deprecated
|
|
7503
|
-
* @throws {RequiredError}
|
|
7504
|
-
*/
|
|
7505
|
-
memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7506
7665
|
/**
|
|
7507
7666
|
*
|
|
7508
7667
|
* @summary Mock login and hand out token.
|
|
@@ -7511,24 +7670,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7511
7670
|
* @throws {RequiredError}
|
|
7512
7671
|
*/
|
|
7513
7672
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7514
|
-
/**
|
|
7515
|
-
*
|
|
7516
|
-
* @summary NFC login and hand out token
|
|
7517
|
-
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7518
|
-
* @param {*} [options] Override http request option.
|
|
7519
|
-
* @deprecated
|
|
7520
|
-
* @throws {RequiredError}
|
|
7521
|
-
*/
|
|
7522
|
-
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7523
|
-
/**
|
|
7524
|
-
*
|
|
7525
|
-
* @summary PIN login and hand out token
|
|
7526
|
-
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7527
|
-
* @param {*} [options] Override http request option.
|
|
7528
|
-
* @deprecated
|
|
7529
|
-
* @throws {RequiredError}
|
|
7530
|
-
*/
|
|
7531
|
-
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7532
7673
|
/**
|
|
7533
7674
|
*
|
|
7534
7675
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7624,19 +7765,6 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7624
7765
|
*/
|
|
7625
7766
|
readonly sessionId: string;
|
|
7626
7767
|
}
|
|
7627
|
-
/**
|
|
7628
|
-
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7629
|
-
* @export
|
|
7630
|
-
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7631
|
-
*/
|
|
7632
|
-
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7633
|
-
/**
|
|
7634
|
-
* The EAN login.
|
|
7635
|
-
* @type {AuthenticationEanRequest}
|
|
7636
|
-
* @memberof AuthenticateApiEanAuthentication
|
|
7637
|
-
*/
|
|
7638
|
-
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7639
|
-
}
|
|
7640
7768
|
/**
|
|
7641
7769
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7642
7770
|
* @export
|
|
@@ -7715,19 +7843,6 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7715
7843
|
*/
|
|
7716
7844
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7717
7845
|
}
|
|
7718
|
-
/**
|
|
7719
|
-
* Request parameters for memberPinAuthentication operation in AuthenticateApi.
|
|
7720
|
-
* @export
|
|
7721
|
-
* @interface AuthenticateApiMemberPinAuthenticationRequest
|
|
7722
|
-
*/
|
|
7723
|
-
export interface AuthenticateApiMemberPinAuthenticationRequest {
|
|
7724
|
-
/**
|
|
7725
|
-
* The PIN login.
|
|
7726
|
-
* @type {MemberAuthenticationPinRequest}
|
|
7727
|
-
* @memberof AuthenticateApiMemberPinAuthentication
|
|
7728
|
-
*/
|
|
7729
|
-
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7730
|
-
}
|
|
7731
7846
|
/**
|
|
7732
7847
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7733
7848
|
* @export
|
|
@@ -7741,32 +7856,6 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7741
7856
|
*/
|
|
7742
7857
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7743
7858
|
}
|
|
7744
|
-
/**
|
|
7745
|
-
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
7746
|
-
* @export
|
|
7747
|
-
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
7748
|
-
*/
|
|
7749
|
-
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7750
|
-
/**
|
|
7751
|
-
* The NFC login.
|
|
7752
|
-
* @type {AuthenticationNfcRequest}
|
|
7753
|
-
* @memberof AuthenticateApiNfcAuthentication
|
|
7754
|
-
*/
|
|
7755
|
-
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
7756
|
-
}
|
|
7757
|
-
/**
|
|
7758
|
-
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
7759
|
-
* @export
|
|
7760
|
-
* @interface AuthenticateApiPinAuthenticationRequest
|
|
7761
|
-
*/
|
|
7762
|
-
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7763
|
-
/**
|
|
7764
|
-
* The PIN login.
|
|
7765
|
-
* @type {AuthenticationPinRequest}
|
|
7766
|
-
* @memberof AuthenticateApiPinAuthentication
|
|
7767
|
-
*/
|
|
7768
|
-
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
7769
|
-
}
|
|
7770
7859
|
/**
|
|
7771
7860
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7772
7861
|
* @export
|
|
@@ -7879,16 +7968,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7879
7968
|
* @memberof AuthenticateApi
|
|
7880
7969
|
*/
|
|
7881
7970
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7882
|
-
/**
|
|
7883
|
-
*
|
|
7884
|
-
* @summary EAN login and hand out token
|
|
7885
|
-
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7886
|
-
* @param {*} [options] Override http request option.
|
|
7887
|
-
* @deprecated
|
|
7888
|
-
* @throws {RequiredError}
|
|
7889
|
-
* @memberof AuthenticateApi
|
|
7890
|
-
*/
|
|
7891
|
-
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7892
7971
|
/**
|
|
7893
7972
|
*
|
|
7894
7973
|
* @summary Generate a QR code for authentication
|
|
@@ -7967,16 +8046,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7967
8046
|
* @memberof AuthenticateApi
|
|
7968
8047
|
*/
|
|
7969
8048
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7970
|
-
/**
|
|
7971
|
-
*
|
|
7972
|
-
* @summary PIN login for members using memberId.
|
|
7973
|
-
* @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
|
|
7974
|
-
* @param {*} [options] Override http request option.
|
|
7975
|
-
* @deprecated
|
|
7976
|
-
* @throws {RequiredError}
|
|
7977
|
-
* @memberof AuthenticateApi
|
|
7978
|
-
*/
|
|
7979
|
-
memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7980
8049
|
/**
|
|
7981
8050
|
*
|
|
7982
8051
|
* @summary Mock login and hand out token.
|
|
@@ -7986,26 +8055,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7986
8055
|
* @memberof AuthenticateApi
|
|
7987
8056
|
*/
|
|
7988
8057
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7989
|
-
/**
|
|
7990
|
-
*
|
|
7991
|
-
* @summary NFC login and hand out token
|
|
7992
|
-
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7993
|
-
* @param {*} [options] Override http request option.
|
|
7994
|
-
* @deprecated
|
|
7995
|
-
* @throws {RequiredError}
|
|
7996
|
-
* @memberof AuthenticateApi
|
|
7997
|
-
*/
|
|
7998
|
-
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7999
|
-
/**
|
|
8000
|
-
*
|
|
8001
|
-
* @summary PIN login and hand out token
|
|
8002
|
-
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8003
|
-
* @param {*} [options] Override http request option.
|
|
8004
|
-
* @deprecated
|
|
8005
|
-
* @throws {RequiredError}
|
|
8006
|
-
* @memberof AuthenticateApi
|
|
8007
|
-
*/
|
|
8008
|
-
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8009
8058
|
/**
|
|
8010
8059
|
*
|
|
8011
8060
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -8092,7 +8141,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8092
8141
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8093
8142
|
* @param {number} [minFine] Minimum fine
|
|
8094
8143
|
* @param {number} [maxFine] Maximum fine
|
|
8095
|
-
* @param {
|
|
8144
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8096
8145
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8097
8146
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8098
8147
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8102,7 +8151,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8102
8151
|
* @param {*} [options] Override http request option.
|
|
8103
8152
|
* @throws {RequiredError}
|
|
8104
8153
|
*/
|
|
8105
|
-
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8154
|
+
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>;
|
|
8106
8155
|
/**
|
|
8107
8156
|
*
|
|
8108
8157
|
* @summary Retrieves the requested balance
|
|
@@ -8142,7 +8191,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8142
8191
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8143
8192
|
* @param {number} [minFine] Minimum fine
|
|
8144
8193
|
* @param {number} [maxFine] Maximum fine
|
|
8145
|
-
* @param {
|
|
8194
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8146
8195
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8147
8196
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8148
8197
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8152,7 +8201,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8152
8201
|
* @param {*} [options] Override http request option.
|
|
8153
8202
|
* @throws {RequiredError}
|
|
8154
8203
|
*/
|
|
8155
|
-
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8204
|
+
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>>;
|
|
8156
8205
|
/**
|
|
8157
8206
|
*
|
|
8158
8207
|
* @summary Retrieves the requested balance
|
|
@@ -8269,10 +8318,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8269
8318
|
readonly maxFine?: number;
|
|
8270
8319
|
/**
|
|
8271
8320
|
* Filter based on user type.
|
|
8272
|
-
* @type {Array<
|
|
8321
|
+
* @type {Array<UserType>}
|
|
8273
8322
|
* @memberof BalanceApiGetAllBalance
|
|
8274
8323
|
*/
|
|
8275
|
-
readonly userTypes?:
|
|
8324
|
+
readonly userTypes?: Array<UserType>;
|
|
8276
8325
|
/**
|
|
8277
8326
|
* Column to order balance by - eg: id,amount
|
|
8278
8327
|
* @type {string}
|
|
@@ -8366,11 +8415,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8366
8415
|
*/
|
|
8367
8416
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8368
8417
|
}
|
|
8369
|
-
/**
|
|
8370
|
-
* @export
|
|
8371
|
-
*/
|
|
8372
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8373
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8374
8418
|
/**
|
|
8375
8419
|
* @export
|
|
8376
8420
|
*/
|
|
@@ -10791,7 +10835,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10791
10835
|
* @param {*} [options] Override http request option.
|
|
10792
10836
|
* @throws {RequiredError}
|
|
10793
10837
|
*/
|
|
10794
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10838
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10795
10839
|
/**
|
|
10796
10840
|
*
|
|
10797
10841
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10869,7 +10913,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10869
10913
|
* @param {*} [options] Override http request option.
|
|
10870
10914
|
* @throws {RequiredError}
|
|
10871
10915
|
*/
|
|
10872
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10916
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10873
10917
|
/**
|
|
10874
10918
|
*
|
|
10875
10919
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11092,7 +11136,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11092
11136
|
* @throws {RequiredError}
|
|
11093
11137
|
* @memberof InactiveAdministrativeCostsApi
|
|
11094
11138
|
*/
|
|
11095
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11139
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11096
11140
|
/**
|
|
11097
11141
|
*
|
|
11098
11142
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11137,7 +11181,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11137
11181
|
* @summary Returns all invoices in the system.
|
|
11138
11182
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11139
11183
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11140
|
-
* @param {
|
|
11184
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11141
11185
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11142
11186
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11143
11187
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11147,7 +11191,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11147
11191
|
* @param {*} [options] Override http request option.
|
|
11148
11192
|
* @throws {RequiredError}
|
|
11149
11193
|
*/
|
|
11150
|
-
getAllInvoices: (toId?: number, invoiceId?: number, currentState?:
|
|
11194
|
+
getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11151
11195
|
/**
|
|
11152
11196
|
*
|
|
11153
11197
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11244,7 +11288,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11244
11288
|
* @summary Returns all invoices in the system.
|
|
11245
11289
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11246
11290
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11247
|
-
* @param {
|
|
11291
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11248
11292
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11249
11293
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11250
11294
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11254,7 +11298,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11254
11298
|
* @param {*} [options] Override http request option.
|
|
11255
11299
|
* @throws {RequiredError}
|
|
11256
11300
|
*/
|
|
11257
|
-
getAllInvoices(toId?: number, invoiceId?: number, currentState?:
|
|
11301
|
+
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>>;
|
|
11258
11302
|
/**
|
|
11259
11303
|
*
|
|
11260
11304
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11264,7 +11308,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11264
11308
|
* @param {*} [options] Override http request option.
|
|
11265
11309
|
* @throws {RequiredError}
|
|
11266
11310
|
*/
|
|
11267
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11311
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11268
11312
|
/**
|
|
11269
11313
|
*
|
|
11270
11314
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11280,7 +11324,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11280
11324
|
* @param {*} [options] Override http request option.
|
|
11281
11325
|
* @throws {RequiredError}
|
|
11282
11326
|
*/
|
|
11283
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11327
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11284
11328
|
/**
|
|
11285
11329
|
*
|
|
11286
11330
|
* @summary Returns a single invoice in the system.
|
|
@@ -11361,7 +11405,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11361
11405
|
* @param {*} [options] Override http request option.
|
|
11362
11406
|
* @throws {RequiredError}
|
|
11363
11407
|
*/
|
|
11364
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11408
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11365
11409
|
/**
|
|
11366
11410
|
*
|
|
11367
11411
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11376,7 +11420,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11376
11420
|
* @param {*} [options] Override http request option.
|
|
11377
11421
|
* @throws {RequiredError}
|
|
11378
11422
|
*/
|
|
11379
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11423
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11380
11424
|
/**
|
|
11381
11425
|
*
|
|
11382
11426
|
* @summary Returns a single invoice in the system.
|
|
@@ -11469,10 +11513,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11469
11513
|
readonly invoiceId?: number;
|
|
11470
11514
|
/**
|
|
11471
11515
|
* Filter based on Invoice State.
|
|
11472
|
-
* @type {Array<
|
|
11516
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11473
11517
|
* @memberof InvoicesApiGetAllInvoices
|
|
11474
11518
|
*/
|
|
11475
|
-
readonly currentState?:
|
|
11519
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11476
11520
|
/**
|
|
11477
11521
|
* Boolean if invoice entries should be returned
|
|
11478
11522
|
* @type {boolean}
|
|
@@ -11675,7 +11719,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11675
11719
|
* @throws {RequiredError}
|
|
11676
11720
|
* @memberof InvoicesApi
|
|
11677
11721
|
*/
|
|
11678
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11722
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11679
11723
|
/**
|
|
11680
11724
|
*
|
|
11681
11725
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11692,7 +11736,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11692
11736
|
* @throws {RequiredError}
|
|
11693
11737
|
* @memberof InvoicesApi
|
|
11694
11738
|
*/
|
|
11695
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11739
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11696
11740
|
/**
|
|
11697
11741
|
*
|
|
11698
11742
|
* @summary Returns a single invoice in the system.
|
|
@@ -11731,10 +11775,491 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11731
11775
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11732
11776
|
}
|
|
11733
11777
|
/**
|
|
11778
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11779
|
+
* @export
|
|
11780
|
+
*/
|
|
11781
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11782
|
+
/**
|
|
11783
|
+
*
|
|
11784
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11785
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11786
|
+
* @param {*} [options] Override http request option.
|
|
11787
|
+
* @throws {RequiredError}
|
|
11788
|
+
*/
|
|
11789
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11790
|
+
/**
|
|
11791
|
+
*
|
|
11792
|
+
* @summary Create a new PaymentRequest.
|
|
11793
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11794
|
+
* @param {*} [options] Override http request option.
|
|
11795
|
+
* @throws {RequiredError}
|
|
11796
|
+
*/
|
|
11797
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11798
|
+
/**
|
|
11799
|
+
*
|
|
11800
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11801
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11802
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11803
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11804
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11805
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11806
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11807
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11808
|
+
* @param {*} [options] Override http request option.
|
|
11809
|
+
* @throws {RequiredError}
|
|
11810
|
+
*/
|
|
11811
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11812
|
+
/**
|
|
11813
|
+
*
|
|
11814
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11815
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11816
|
+
* @param {*} [options] Override http request option.
|
|
11817
|
+
* @throws {RequiredError}
|
|
11818
|
+
*/
|
|
11819
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11820
|
+
/**
|
|
11821
|
+
*
|
|
11822
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11823
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11824
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11825
|
+
* @param {*} [options] Override http request option.
|
|
11826
|
+
* @throws {RequiredError}
|
|
11827
|
+
*/
|
|
11828
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11829
|
+
/**
|
|
11830
|
+
*
|
|
11831
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11832
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11833
|
+
* @param {*} [options] Override http request option.
|
|
11834
|
+
* @throws {RequiredError}
|
|
11835
|
+
*/
|
|
11836
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11837
|
+
};
|
|
11838
|
+
/**
|
|
11839
|
+
* PaymentRequestsApi - functional programming interface
|
|
11840
|
+
* @export
|
|
11841
|
+
*/
|
|
11842
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11843
|
+
/**
|
|
11844
|
+
*
|
|
11845
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11846
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11847
|
+
* @param {*} [options] Override http request option.
|
|
11848
|
+
* @throws {RequiredError}
|
|
11849
|
+
*/
|
|
11850
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11851
|
+
/**
|
|
11852
|
+
*
|
|
11853
|
+
* @summary Create a new PaymentRequest.
|
|
11854
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11855
|
+
* @param {*} [options] Override http request option.
|
|
11856
|
+
* @throws {RequiredError}
|
|
11857
|
+
*/
|
|
11858
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11859
|
+
/**
|
|
11860
|
+
*
|
|
11861
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11862
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11863
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11864
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11865
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11866
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11867
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11868
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11869
|
+
* @param {*} [options] Override http request option.
|
|
11870
|
+
* @throws {RequiredError}
|
|
11871
|
+
*/
|
|
11872
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11873
|
+
/**
|
|
11874
|
+
*
|
|
11875
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11876
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11877
|
+
* @param {*} [options] Override http request option.
|
|
11878
|
+
* @throws {RequiredError}
|
|
11879
|
+
*/
|
|
11880
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11881
|
+
/**
|
|
11882
|
+
*
|
|
11883
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11884
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11885
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11886
|
+
* @param {*} [options] Override http request option.
|
|
11887
|
+
* @throws {RequiredError}
|
|
11888
|
+
*/
|
|
11889
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11890
|
+
/**
|
|
11891
|
+
*
|
|
11892
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11893
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11894
|
+
* @param {*} [options] Override http request option.
|
|
11895
|
+
* @throws {RequiredError}
|
|
11896
|
+
*/
|
|
11897
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11898
|
+
};
|
|
11899
|
+
/**
|
|
11900
|
+
* PaymentRequestsApi - factory interface
|
|
11901
|
+
* @export
|
|
11902
|
+
*/
|
|
11903
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11907
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11908
|
+
* @param {*} [options] Override http request option.
|
|
11909
|
+
* @throws {RequiredError}
|
|
11910
|
+
*/
|
|
11911
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11912
|
+
/**
|
|
11913
|
+
*
|
|
11914
|
+
* @summary Create a new PaymentRequest.
|
|
11915
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11916
|
+
* @param {*} [options] Override http request option.
|
|
11917
|
+
* @throws {RequiredError}
|
|
11918
|
+
*/
|
|
11919
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11920
|
+
/**
|
|
11921
|
+
*
|
|
11922
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11923
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11924
|
+
* @param {*} [options] Override http request option.
|
|
11925
|
+
* @throws {RequiredError}
|
|
11926
|
+
*/
|
|
11927
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11928
|
+
/**
|
|
11929
|
+
*
|
|
11930
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11931
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11932
|
+
* @param {*} [options] Override http request option.
|
|
11933
|
+
* @throws {RequiredError}
|
|
11934
|
+
*/
|
|
11935
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11936
|
+
/**
|
|
11937
|
+
*
|
|
11938
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11939
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11940
|
+
* @param {*} [options] Override http request option.
|
|
11941
|
+
* @throws {RequiredError}
|
|
11942
|
+
*/
|
|
11943
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11944
|
+
/**
|
|
11945
|
+
*
|
|
11946
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11947
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11948
|
+
* @param {*} [options] Override http request option.
|
|
11949
|
+
* @throws {RequiredError}
|
|
11950
|
+
*/
|
|
11951
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11952
|
+
};
|
|
11953
|
+
/**
|
|
11954
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11955
|
+
* @export
|
|
11956
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11957
|
+
*/
|
|
11958
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11959
|
+
/**
|
|
11960
|
+
* UUID v4 of the payment request.
|
|
11961
|
+
* @type {string}
|
|
11962
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11963
|
+
*/
|
|
11964
|
+
readonly id: string;
|
|
11965
|
+
}
|
|
11966
|
+
/**
|
|
11967
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11968
|
+
* @export
|
|
11969
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11970
|
+
*/
|
|
11971
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11972
|
+
/**
|
|
11973
|
+
* The request to create
|
|
11974
|
+
* @type {CreatePaymentRequestRequest}
|
|
11975
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11976
|
+
*/
|
|
11977
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11978
|
+
}
|
|
11979
|
+
/**
|
|
11980
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11734
11981
|
* @export
|
|
11982
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11735
11983
|
*/
|
|
11736
|
-
export
|
|
11737
|
-
|
|
11984
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11985
|
+
/**
|
|
11986
|
+
* Filter by beneficiary user id.
|
|
11987
|
+
* @type {number}
|
|
11988
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11989
|
+
*/
|
|
11990
|
+
readonly forId?: number;
|
|
11991
|
+
/**
|
|
11992
|
+
* Filter by creator user id.
|
|
11993
|
+
* @type {number}
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11995
|
+
*/
|
|
11996
|
+
readonly createdById?: number;
|
|
11997
|
+
/**
|
|
11998
|
+
* Comma-separated list of derived statuses.
|
|
11999
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12001
|
+
*/
|
|
12002
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12003
|
+
/**
|
|
12004
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12005
|
+
* @type {string}
|
|
12006
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12007
|
+
*/
|
|
12008
|
+
readonly fromDate?: string;
|
|
12009
|
+
/**
|
|
12010
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12011
|
+
* @type {string}
|
|
12012
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12013
|
+
*/
|
|
12014
|
+
readonly tillDate?: string;
|
|
12015
|
+
/**
|
|
12016
|
+
* How many rows the endpoint should return
|
|
12017
|
+
* @type {number}
|
|
12018
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12019
|
+
*/
|
|
12020
|
+
readonly take?: number;
|
|
12021
|
+
/**
|
|
12022
|
+
* How many rows to skip (for pagination)
|
|
12023
|
+
* @type {number}
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12025
|
+
*/
|
|
12026
|
+
readonly skip?: number;
|
|
12027
|
+
}
|
|
12028
|
+
/**
|
|
12029
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
12030
|
+
* @export
|
|
12031
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
12032
|
+
*/
|
|
12033
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
12034
|
+
/**
|
|
12035
|
+
* UUID v4 of the payment request.
|
|
12036
|
+
* @type {string}
|
|
12037
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12038
|
+
*/
|
|
12039
|
+
readonly id: string;
|
|
12040
|
+
}
|
|
12041
|
+
/**
|
|
12042
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12043
|
+
* @export
|
|
12044
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12045
|
+
*/
|
|
12046
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
12047
|
+
/**
|
|
12048
|
+
* UUID v4 of the payment request.
|
|
12049
|
+
* @type {string}
|
|
12050
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12051
|
+
*/
|
|
12052
|
+
readonly id: string;
|
|
12053
|
+
/**
|
|
12054
|
+
* The audit reason
|
|
12055
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12057
|
+
*/
|
|
12058
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12059
|
+
}
|
|
12060
|
+
/**
|
|
12061
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12062
|
+
* @export
|
|
12063
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12064
|
+
*/
|
|
12065
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12066
|
+
/**
|
|
12067
|
+
* UUID v4 of the payment request.
|
|
12068
|
+
* @type {string}
|
|
12069
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12070
|
+
*/
|
|
12071
|
+
readonly id: string;
|
|
12072
|
+
}
|
|
12073
|
+
/**
|
|
12074
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12075
|
+
* @export
|
|
12076
|
+
* @class PaymentRequestsApi
|
|
12077
|
+
* @extends {BaseAPI}
|
|
12078
|
+
*/
|
|
12079
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12080
|
+
/**
|
|
12081
|
+
*
|
|
12082
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12083
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12084
|
+
* @param {*} [options] Override http request option.
|
|
12085
|
+
* @throws {RequiredError}
|
|
12086
|
+
* @memberof PaymentRequestsApi
|
|
12087
|
+
*/
|
|
12088
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12089
|
+
/**
|
|
12090
|
+
*
|
|
12091
|
+
* @summary Create a new PaymentRequest.
|
|
12092
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12093
|
+
* @param {*} [options] Override http request option.
|
|
12094
|
+
* @throws {RequiredError}
|
|
12095
|
+
* @memberof PaymentRequestsApi
|
|
12096
|
+
*/
|
|
12097
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12098
|
+
/**
|
|
12099
|
+
*
|
|
12100
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12101
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12102
|
+
* @param {*} [options] Override http request option.
|
|
12103
|
+
* @throws {RequiredError}
|
|
12104
|
+
* @memberof PaymentRequestsApi
|
|
12105
|
+
*/
|
|
12106
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12107
|
+
/**
|
|
12108
|
+
*
|
|
12109
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12110
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12111
|
+
* @param {*} [options] Override http request option.
|
|
12112
|
+
* @throws {RequiredError}
|
|
12113
|
+
* @memberof PaymentRequestsApi
|
|
12114
|
+
*/
|
|
12115
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12116
|
+
/**
|
|
12117
|
+
*
|
|
12118
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12119
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12120
|
+
* @param {*} [options] Override http request option.
|
|
12121
|
+
* @throws {RequiredError}
|
|
12122
|
+
* @memberof PaymentRequestsApi
|
|
12123
|
+
*/
|
|
12124
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12125
|
+
/**
|
|
12126
|
+
*
|
|
12127
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12128
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12129
|
+
* @param {*} [options] Override http request option.
|
|
12130
|
+
* @throws {RequiredError}
|
|
12131
|
+
* @memberof PaymentRequestsApi
|
|
12132
|
+
*/
|
|
12133
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12134
|
+
}
|
|
12135
|
+
/**
|
|
12136
|
+
* @export
|
|
12137
|
+
*/
|
|
12138
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12139
|
+
readonly Pending: "PENDING";
|
|
12140
|
+
readonly Paid: "PAID";
|
|
12141
|
+
readonly Expired: "EXPIRED";
|
|
12142
|
+
readonly Cancelled: "CANCELLED";
|
|
12143
|
+
};
|
|
12144
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12145
|
+
/**
|
|
12146
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12147
|
+
* @export
|
|
12148
|
+
*/
|
|
12149
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12150
|
+
/**
|
|
12151
|
+
*
|
|
12152
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12153
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12154
|
+
* @param {*} [options] Override http request option.
|
|
12155
|
+
* @throws {RequiredError}
|
|
12156
|
+
*/
|
|
12157
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12158
|
+
/**
|
|
12159
|
+
*
|
|
12160
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12161
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12162
|
+
* @param {*} [options] Override http request option.
|
|
12163
|
+
* @throws {RequiredError}
|
|
12164
|
+
*/
|
|
12165
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12166
|
+
};
|
|
12167
|
+
/**
|
|
12168
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12169
|
+
* @export
|
|
12170
|
+
*/
|
|
12171
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
12172
|
+
/**
|
|
12173
|
+
*
|
|
12174
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12175
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12176
|
+
* @param {*} [options] Override http request option.
|
|
12177
|
+
* @throws {RequiredError}
|
|
12178
|
+
*/
|
|
12179
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
12180
|
+
/**
|
|
12181
|
+
*
|
|
12182
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12183
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12184
|
+
* @param {*} [options] Override http request option.
|
|
12185
|
+
* @throws {RequiredError}
|
|
12186
|
+
*/
|
|
12187
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12188
|
+
};
|
|
12189
|
+
/**
|
|
12190
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12191
|
+
* @export
|
|
12192
|
+
*/
|
|
12193
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12194
|
+
/**
|
|
12195
|
+
*
|
|
12196
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12197
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12198
|
+
* @param {*} [options] Override http request option.
|
|
12199
|
+
* @throws {RequiredError}
|
|
12200
|
+
*/
|
|
12201
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12202
|
+
/**
|
|
12203
|
+
*
|
|
12204
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12205
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12206
|
+
* @param {*} [options] Override http request option.
|
|
12207
|
+
* @throws {RequiredError}
|
|
12208
|
+
*/
|
|
12209
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12210
|
+
};
|
|
12211
|
+
/**
|
|
12212
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12213
|
+
* @export
|
|
12214
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12215
|
+
*/
|
|
12216
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12217
|
+
/**
|
|
12218
|
+
* UUID v4 of the payment request.
|
|
12219
|
+
* @type {string}
|
|
12220
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12221
|
+
*/
|
|
12222
|
+
readonly id: string;
|
|
12223
|
+
}
|
|
12224
|
+
/**
|
|
12225
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12226
|
+
* @export
|
|
12227
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12228
|
+
*/
|
|
12229
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12230
|
+
/**
|
|
12231
|
+
* UUID v4 of the payment request.
|
|
12232
|
+
* @type {string}
|
|
12233
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12234
|
+
*/
|
|
12235
|
+
readonly id: string;
|
|
12236
|
+
}
|
|
12237
|
+
/**
|
|
12238
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12239
|
+
* @export
|
|
12240
|
+
* @class PaymentRequestsPublicApi
|
|
12241
|
+
* @extends {BaseAPI}
|
|
12242
|
+
*/
|
|
12243
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12244
|
+
/**
|
|
12245
|
+
*
|
|
12246
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12247
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12248
|
+
* @param {*} [options] Override http request option.
|
|
12249
|
+
* @throws {RequiredError}
|
|
12250
|
+
* @memberof PaymentRequestsPublicApi
|
|
12251
|
+
*/
|
|
12252
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12253
|
+
/**
|
|
12254
|
+
*
|
|
12255
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12256
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12257
|
+
* @param {*} [options] Override http request option.
|
|
12258
|
+
* @throws {RequiredError}
|
|
12259
|
+
* @memberof PaymentRequestsPublicApi
|
|
12260
|
+
*/
|
|
12261
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12262
|
+
}
|
|
11738
12263
|
/**
|
|
11739
12264
|
* PayoutRequestsApi - axios parameter creator
|
|
11740
12265
|
* @export
|
|
@@ -14289,11 +14814,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
14289
14814
|
/**
|
|
14290
14815
|
* 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.
|
|
14291
14816
|
* @summary Get dry-run sync results for users
|
|
14292
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14817
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14293
14818
|
* @param {*} [options] Override http request option.
|
|
14294
14819
|
* @throws {RequiredError}
|
|
14295
14820
|
*/
|
|
14296
|
-
getUserSyncResults: (service?: GetUserSyncResultsServiceEnum
|
|
14821
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14297
14822
|
};
|
|
14298
14823
|
/**
|
|
14299
14824
|
* SyncApi - functional programming interface
|
|
@@ -14303,11 +14828,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
|
14303
14828
|
/**
|
|
14304
14829
|
* 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.
|
|
14305
14830
|
* @summary Get dry-run sync results for users
|
|
14306
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14831
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14307
14832
|
* @param {*} [options] Override http request option.
|
|
14308
14833
|
* @throws {RequiredError}
|
|
14309
14834
|
*/
|
|
14310
|
-
getUserSyncResults(service?: GetUserSyncResultsServiceEnum
|
|
14835
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14311
14836
|
};
|
|
14312
14837
|
/**
|
|
14313
14838
|
* SyncApi - factory interface
|
|
@@ -14331,10 +14856,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14331
14856
|
export interface SyncApiGetUserSyncResultsRequest {
|
|
14332
14857
|
/**
|
|
14333
14858
|
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14334
|
-
* @type {Array<
|
|
14859
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
14335
14860
|
* @memberof SyncApiGetUserSyncResults
|
|
14336
14861
|
*/
|
|
14337
|
-
readonly service?: GetUserSyncResultsServiceEnum
|
|
14862
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
14338
14863
|
}
|
|
14339
14864
|
/**
|
|
14340
14865
|
* SyncApi - object-oriented interface
|
|
@@ -14356,7 +14881,10 @@ export declare class SyncApi extends BaseAPI {
|
|
|
14356
14881
|
/**
|
|
14357
14882
|
* @export
|
|
14358
14883
|
*/
|
|
14359
|
-
export declare const GetUserSyncResultsServiceEnum: {
|
|
14884
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
14885
|
+
readonly Ldap: "LDAP";
|
|
14886
|
+
readonly Gewisdb: "GEWISDB";
|
|
14887
|
+
};
|
|
14360
14888
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14361
14889
|
/**
|
|
14362
14890
|
* TermsOfServiceApi - axios parameter creator
|
|
@@ -15106,12 +15634,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15106
15634
|
* @summary Returns all existing transfers
|
|
15107
15635
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15108
15636
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15637
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15638
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15639
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15109
15640
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15110
15641
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15111
15642
|
* @param {*} [options] Override http request option.
|
|
15112
15643
|
* @throws {RequiredError}
|
|
15113
15644
|
*/
|
|
15114
|
-
getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15645
|
+
getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15115
15646
|
/**
|
|
15116
15647
|
*
|
|
15117
15648
|
* @summary Returns the requested transfer
|
|
@@ -15178,12 +15709,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15178
15709
|
* @summary Returns all existing transfers
|
|
15179
15710
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15180
15711
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15712
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15713
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15714
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15181
15715
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15182
15716
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15183
15717
|
* @param {*} [options] Override http request option.
|
|
15184
15718
|
* @throws {RequiredError}
|
|
15185
15719
|
*/
|
|
15186
|
-
getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
15720
|
+
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTransferResponse>>;
|
|
15187
15721
|
/**
|
|
15188
15722
|
*
|
|
15189
15723
|
* @summary Returns the requested transfer
|
|
@@ -15252,7 +15786,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15252
15786
|
* @param {*} [options] Override http request option.
|
|
15253
15787
|
* @throws {RequiredError}
|
|
15254
15788
|
*/
|
|
15255
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15789
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15256
15790
|
/**
|
|
15257
15791
|
*
|
|
15258
15792
|
* @summary Returns the requested transfer
|
|
@@ -15330,6 +15864,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15330
15864
|
* @memberof TransfersApiGetAllTransfers
|
|
15331
15865
|
*/
|
|
15332
15866
|
readonly tillDate?: string;
|
|
15867
|
+
/**
|
|
15868
|
+
* Filter transfers from this user ID
|
|
15869
|
+
* @type {number}
|
|
15870
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15871
|
+
*/
|
|
15872
|
+
readonly fromId?: number;
|
|
15873
|
+
/**
|
|
15874
|
+
* Filter transfers to this user ID
|
|
15875
|
+
* @type {number}
|
|
15876
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15877
|
+
*/
|
|
15878
|
+
readonly toId?: number;
|
|
15879
|
+
/**
|
|
15880
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15881
|
+
* @type {string}
|
|
15882
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15883
|
+
*/
|
|
15884
|
+
readonly category?: string;
|
|
15333
15885
|
/**
|
|
15334
15886
|
* How many transfers the endpoint should return
|
|
15335
15887
|
* @type {number}
|
|
@@ -15470,7 +16022,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15470
16022
|
* @throws {RequiredError}
|
|
15471
16023
|
* @memberof TransfersApi
|
|
15472
16024
|
*/
|
|
15473
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16025
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15474
16026
|
/**
|
|
15475
16027
|
*
|
|
15476
16028
|
* @summary Returns the requested transfer
|
|
@@ -15871,6 +16423,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15871
16423
|
* @throws {RequiredError}
|
|
15872
16424
|
*/
|
|
15873
16425
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16426
|
+
/**
|
|
16427
|
+
*
|
|
16428
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
16429
|
+
* @param {number} id The id of the beneficiary user.
|
|
16430
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16431
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16432
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16433
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16434
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16435
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16436
|
+
* @param {*} [options] Override http request option.
|
|
16437
|
+
* @throws {RequiredError}
|
|
16438
|
+
*/
|
|
16439
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15874
16440
|
/**
|
|
15875
16441
|
*
|
|
15876
16442
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16233,6 +16799,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16233
16799
|
* @throws {RequiredError}
|
|
16234
16800
|
*/
|
|
16235
16801
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
16802
|
+
/**
|
|
16803
|
+
*
|
|
16804
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
16805
|
+
* @param {number} id The id of the beneficiary user.
|
|
16806
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16807
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16808
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16809
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16810
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16811
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16812
|
+
* @param {*} [options] Override http request option.
|
|
16813
|
+
* @throws {RequiredError}
|
|
16814
|
+
*/
|
|
16815
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16236
16816
|
/**
|
|
16237
16817
|
*
|
|
16238
16818
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16577,6 +17157,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16577
17157
|
* @throws {RequiredError}
|
|
16578
17158
|
*/
|
|
16579
17159
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17160
|
+
/**
|
|
17161
|
+
*
|
|
17162
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
17163
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17164
|
+
* @param {*} [options] Override http request option.
|
|
17165
|
+
* @throws {RequiredError}
|
|
17166
|
+
*/
|
|
17167
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16580
17168
|
/**
|
|
16581
17169
|
*
|
|
16582
17170
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17068,6 +17656,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17068
17656
|
*/
|
|
17069
17657
|
readonly skip?: number;
|
|
17070
17658
|
}
|
|
17659
|
+
/**
|
|
17660
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
17661
|
+
* @export
|
|
17662
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
17663
|
+
*/
|
|
17664
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
17665
|
+
/**
|
|
17666
|
+
* The id of the beneficiary user.
|
|
17667
|
+
* @type {number}
|
|
17668
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17669
|
+
*/
|
|
17670
|
+
readonly id: number;
|
|
17671
|
+
/**
|
|
17672
|
+
* Filter by creator user id.
|
|
17673
|
+
* @type {number}
|
|
17674
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17675
|
+
*/
|
|
17676
|
+
readonly createdById?: number;
|
|
17677
|
+
/**
|
|
17678
|
+
* Comma-separated list of derived statuses.
|
|
17679
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
17680
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17681
|
+
*/
|
|
17682
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
17683
|
+
/**
|
|
17684
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
17685
|
+
* @type {string}
|
|
17686
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17687
|
+
*/
|
|
17688
|
+
readonly fromDate?: string;
|
|
17689
|
+
/**
|
|
17690
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
17691
|
+
* @type {string}
|
|
17692
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17693
|
+
*/
|
|
17694
|
+
readonly tillDate?: string;
|
|
17695
|
+
/**
|
|
17696
|
+
* How many rows the endpoint should return
|
|
17697
|
+
* @type {number}
|
|
17698
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17699
|
+
*/
|
|
17700
|
+
readonly take?: number;
|
|
17701
|
+
/**
|
|
17702
|
+
* How many rows to skip (for pagination)
|
|
17703
|
+
* @type {number}
|
|
17704
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17705
|
+
*/
|
|
17706
|
+
readonly skip?: number;
|
|
17707
|
+
}
|
|
17071
17708
|
/**
|
|
17072
17709
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17073
17710
|
* @export
|
|
@@ -17734,6 +18371,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17734
18371
|
* @memberof UsersApi
|
|
17735
18372
|
*/
|
|
17736
18373
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18374
|
+
/**
|
|
18375
|
+
*
|
|
18376
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
18377
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18378
|
+
* @param {*} [options] Override http request option.
|
|
18379
|
+
* @throws {RequiredError}
|
|
18380
|
+
* @memberof UsersApi
|
|
18381
|
+
*/
|
|
18382
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17737
18383
|
/**
|
|
17738
18384
|
*
|
|
17739
18385
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17929,6 +18575,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17929
18575
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17930
18576
|
};
|
|
17931
18577
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
18578
|
+
/**
|
|
18579
|
+
* @export
|
|
18580
|
+
*/
|
|
18581
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
18582
|
+
readonly Pending: "PENDING";
|
|
18583
|
+
readonly Paid: "PAID";
|
|
18584
|
+
readonly Expired: "EXPIRED";
|
|
18585
|
+
readonly Cancelled: "CANCELLED";
|
|
18586
|
+
};
|
|
18587
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17932
18588
|
/**
|
|
17933
18589
|
* @export
|
|
17934
18590
|
*/
|