@gewis/sudosos-client 0.0.0-develop.b75eff4 → 0.0.0-develop.b8bab32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +927 -304
- package/dist/api.js +917 -413
- 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
|
*/
|
|
@@ -3154,21 +3263,15 @@ export interface InvoiceUserResponse {
|
|
|
3154
3263
|
/**
|
|
3155
3264
|
*
|
|
3156
3265
|
* @export
|
|
3157
|
-
* @interface
|
|
3266
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3158
3267
|
*/
|
|
3159
|
-
export interface
|
|
3160
|
-
/**
|
|
3161
|
-
*
|
|
3162
|
-
* @type {number}
|
|
3163
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3164
|
-
*/
|
|
3165
|
-
'memberId': number;
|
|
3268
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3166
3269
|
/**
|
|
3167
|
-
*
|
|
3270
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3168
3271
|
* @type {string}
|
|
3169
|
-
* @memberof
|
|
3272
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3170
3273
|
*/
|
|
3171
|
-
'
|
|
3274
|
+
'reason': string;
|
|
3172
3275
|
}
|
|
3173
3276
|
/**
|
|
3174
3277
|
*
|
|
@@ -3219,13 +3322,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3219
3322
|
* @type {PaginationResult}
|
|
3220
3323
|
* @memberof PaginatedBalanceResponse
|
|
3221
3324
|
*/
|
|
3222
|
-
'_pagination'
|
|
3325
|
+
'_pagination': PaginationResult;
|
|
3223
3326
|
/**
|
|
3224
3327
|
* Returned balance responses
|
|
3225
3328
|
* @type {Array<BalanceResponse>}
|
|
3226
3329
|
* @memberof PaginatedBalanceResponse
|
|
3227
3330
|
*/
|
|
3228
|
-
'records'
|
|
3331
|
+
'records': Array<BalanceResponse>;
|
|
3229
3332
|
}
|
|
3230
3333
|
/**
|
|
3231
3334
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3238,13 +3341,13 @@ export interface PaginatedBannerResponse {
|
|
|
3238
3341
|
* @type {PaginationResult}
|
|
3239
3342
|
* @memberof PaginatedBannerResponse
|
|
3240
3343
|
*/
|
|
3241
|
-
'_pagination'
|
|
3344
|
+
'_pagination': PaginationResult;
|
|
3242
3345
|
/**
|
|
3243
3346
|
* Returned banners
|
|
3244
3347
|
* @type {Array<BannerResponse>}
|
|
3245
3348
|
* @memberof PaginatedBannerResponse
|
|
3246
3349
|
*/
|
|
3247
|
-
'records'
|
|
3350
|
+
'records': Array<BannerResponse>;
|
|
3248
3351
|
}
|
|
3249
3352
|
/**
|
|
3250
3353
|
*
|
|
@@ -3265,6 +3368,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3265
3368
|
*/
|
|
3266
3369
|
'records': Array<BaseEventResponse>;
|
|
3267
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
|
+
}
|
|
3268
3390
|
/**
|
|
3269
3391
|
*
|
|
3270
3392
|
* @export
|
|
@@ -3304,7 +3426,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3304
3426
|
'records': Array<BaseTransactionResponse>;
|
|
3305
3427
|
}
|
|
3306
3428
|
/**
|
|
3307
|
-
*
|
|
3429
|
+
* Paginated API Response for the `container` entity.
|
|
3308
3430
|
* @export
|
|
3309
3431
|
* @interface PaginatedContainerResponse
|
|
3310
3432
|
*/
|
|
@@ -3323,7 +3445,7 @@ export interface PaginatedContainerResponse {
|
|
|
3323
3445
|
'records': Array<ContainerResponse>;
|
|
3324
3446
|
}
|
|
3325
3447
|
/**
|
|
3326
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3327
3449
|
* @export
|
|
3328
3450
|
* @interface PaginatedContainerWithProductResponse
|
|
3329
3451
|
*/
|
|
@@ -3409,13 +3531,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3409
3531
|
* @type {PaginationResult}
|
|
3410
3532
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3411
3533
|
*/
|
|
3412
|
-
'_pagination'
|
|
3534
|
+
'_pagination': PaginationResult;
|
|
3413
3535
|
/**
|
|
3414
3536
|
* Returned InactiveAdministrativeCost
|
|
3415
3537
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3416
3538
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3417
3539
|
*/
|
|
3418
|
-
'records'
|
|
3540
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3419
3541
|
}
|
|
3420
3542
|
/**
|
|
3421
3543
|
*
|
|
@@ -3437,7 +3559,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3437
3559
|
'records': Array<InvoiceResponseTypes>;
|
|
3438
3560
|
}
|
|
3439
3561
|
/**
|
|
3440
|
-
*
|
|
3562
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3441
3563
|
* @export
|
|
3442
3564
|
* @interface PaginatedPointOfSaleResponse
|
|
3443
3565
|
*/
|
|
@@ -3456,7 +3578,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3456
3578
|
'records': Array<PointOfSaleResponse>;
|
|
3457
3579
|
}
|
|
3458
3580
|
/**
|
|
3459
|
-
*
|
|
3581
|
+
* Paginated API Response for the `product category` entity.
|
|
3460
3582
|
* @export
|
|
3461
3583
|
* @interface PaginatedProductCategoryResponse
|
|
3462
3584
|
*/
|
|
@@ -3475,7 +3597,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3475
3597
|
'records': Array<ProductCategoryResponse>;
|
|
3476
3598
|
}
|
|
3477
3599
|
/**
|
|
3478
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product` entity.
|
|
3479
3601
|
* @export
|
|
3480
3602
|
* @interface PaginatedProductResponse
|
|
3481
3603
|
*/
|
|
@@ -3570,7 +3692,7 @@ export interface PaginatedUserResponse {
|
|
|
3570
3692
|
'records': Array<UserResponse>;
|
|
3571
3693
|
}
|
|
3572
3694
|
/**
|
|
3573
|
-
*
|
|
3695
|
+
* Paginated API Response for the `vat group` entity.
|
|
3574
3696
|
* @export
|
|
3575
3697
|
* @interface PaginatedVatGroupResponse
|
|
3576
3698
|
*/
|
|
@@ -3695,6 +3817,31 @@ export interface PatchUserTypeRequest {
|
|
|
3695
3817
|
*/
|
|
3696
3818
|
'userType': string;
|
|
3697
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
|
+
}
|
|
3698
3845
|
/**
|
|
3699
3846
|
*
|
|
3700
3847
|
* @export
|
|
@@ -3902,7 +4049,7 @@ export interface PermissionResponse {
|
|
|
3902
4049
|
'actions': Array<ActionResponse>;
|
|
3903
4050
|
}
|
|
3904
4051
|
/**
|
|
3905
|
-
*
|
|
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).
|
|
3906
4053
|
* @export
|
|
3907
4054
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3908
4055
|
*/
|
|
@@ -4055,7 +4202,7 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4055
4202
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4056
4203
|
}
|
|
4057
4204
|
/**
|
|
4058
|
-
*
|
|
4205
|
+
* API Request for creating or updating a `product category` entity.
|
|
4059
4206
|
* @export
|
|
4060
4207
|
* @interface ProductCategoryRequest
|
|
4061
4208
|
*/
|
|
@@ -4219,6 +4366,56 @@ export interface ProductResponse {
|
|
|
4219
4366
|
*/
|
|
4220
4367
|
'priceList': boolean;
|
|
4221
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];
|
|
4222
4419
|
/**
|
|
4223
4420
|
*
|
|
4224
4421
|
* @export
|
|
@@ -5120,23 +5317,23 @@ export interface TotalBalanceResponse {
|
|
|
5120
5317
|
*/
|
|
5121
5318
|
'date': string;
|
|
5122
5319
|
/**
|
|
5123
|
-
*
|
|
5124
|
-
* @type {
|
|
5320
|
+
*
|
|
5321
|
+
* @type {DineroObjectResponse}
|
|
5125
5322
|
* @memberof TotalBalanceResponse
|
|
5126
5323
|
*/
|
|
5127
|
-
'totalPositive':
|
|
5324
|
+
'totalPositive': DineroObjectResponse;
|
|
5128
5325
|
/**
|
|
5129
|
-
*
|
|
5130
|
-
* @type {
|
|
5326
|
+
*
|
|
5327
|
+
* @type {DineroObjectResponse}
|
|
5131
5328
|
* @memberof TotalBalanceResponse
|
|
5132
5329
|
*/
|
|
5133
|
-
'totalNegative':
|
|
5330
|
+
'totalNegative': DineroObjectResponse;
|
|
5134
5331
|
/**
|
|
5135
|
-
*
|
|
5136
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5332
|
+
* The total balances for the different user types
|
|
5333
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5137
5334
|
* @memberof TotalBalanceResponse
|
|
5138
5335
|
*/
|
|
5139
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5336
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5140
5337
|
}
|
|
5141
5338
|
/**
|
|
5142
5339
|
*
|
|
@@ -5721,7 +5918,7 @@ export interface TransferSummaryResponse {
|
|
|
5721
5918
|
'manualDeletions': TransferAggregateResponse;
|
|
5722
5919
|
}
|
|
5723
5920
|
/**
|
|
5724
|
-
*
|
|
5921
|
+
* API Request for updating a `container` entity.
|
|
5725
5922
|
* @export
|
|
5726
5923
|
* @interface UpdateContainerRequest
|
|
5727
5924
|
*/
|
|
@@ -5971,7 +6168,7 @@ export interface UpdatePinRequest {
|
|
|
5971
6168
|
'pin': string;
|
|
5972
6169
|
}
|
|
5973
6170
|
/**
|
|
5974
|
-
*
|
|
6171
|
+
* API Request for updating a `point of sale` entity.
|
|
5975
6172
|
* @export
|
|
5976
6173
|
* @interface UpdatePointOfSaleRequest
|
|
5977
6174
|
*/
|
|
@@ -6008,7 +6205,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6008
6205
|
'cashierRoleIds'?: Array<number>;
|
|
6009
6206
|
}
|
|
6010
6207
|
/**
|
|
6011
|
-
*
|
|
6208
|
+
* API Request for updating a `product` entity.
|
|
6012
6209
|
* @export
|
|
6013
6210
|
* @interface UpdateProductRequest
|
|
6014
6211
|
*/
|
|
@@ -6173,9 +6370,15 @@ export interface UpdateUserRequest {
|
|
|
6173
6370
|
* @memberof UpdateUserRequest
|
|
6174
6371
|
*/
|
|
6175
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;
|
|
6176
6379
|
}
|
|
6177
6380
|
/**
|
|
6178
|
-
*
|
|
6381
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6179
6382
|
* @export
|
|
6180
6383
|
* @interface UpdateVatGroupRequest
|
|
6181
6384
|
*/
|
|
@@ -6389,6 +6592,12 @@ export interface UserResponse {
|
|
|
6389
6592
|
* @memberof UserResponse
|
|
6390
6593
|
*/
|
|
6391
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;
|
|
6392
6601
|
}
|
|
6393
6602
|
/**
|
|
6394
6603
|
*
|
|
@@ -6537,7 +6746,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6537
6746
|
'totalNegative': DineroObjectResponse;
|
|
6538
6747
|
}
|
|
6539
6748
|
/**
|
|
6540
|
-
*
|
|
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.
|
|
6541
6750
|
* @export
|
|
6542
6751
|
* @interface UserWithIndex
|
|
6543
6752
|
*/
|
|
@@ -6569,7 +6778,7 @@ export interface ValidationResponse {
|
|
|
6569
6778
|
'errors': Array<string>;
|
|
6570
6779
|
}
|
|
6571
6780
|
/**
|
|
6572
|
-
*
|
|
6781
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6573
6782
|
* @export
|
|
6574
6783
|
* @interface VatDeclarationResponse
|
|
6575
6784
|
*/
|
|
@@ -6594,7 +6803,7 @@ export interface VatDeclarationResponse {
|
|
|
6594
6803
|
'rows': Array<VatDeclarationRow>;
|
|
6595
6804
|
}
|
|
6596
6805
|
/**
|
|
6597
|
-
*
|
|
6806
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6598
6807
|
* @export
|
|
6599
6808
|
* @interface VatDeclarationRow
|
|
6600
6809
|
*/
|
|
@@ -7060,15 +7269,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7060
7269
|
* @throws {RequiredError}
|
|
7061
7270
|
*/
|
|
7062
7271
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7063
|
-
/**
|
|
7064
|
-
*
|
|
7065
|
-
* @summary EAN login and hand out token
|
|
7066
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
|
|
7067
|
-
* @param {*} [options] Override http request option.
|
|
7068
|
-
* @deprecated
|
|
7069
|
-
* @throws {RequiredError}
|
|
7070
|
-
*/
|
|
7071
|
-
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7072
7272
|
/**
|
|
7073
7273
|
*
|
|
7074
7274
|
* @summary Generate a QR code for authentication
|
|
@@ -7138,15 +7338,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7138
7338
|
* @throws {RequiredError}
|
|
7139
7339
|
*/
|
|
7140
7340
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7141
|
-
/**
|
|
7142
|
-
*
|
|
7143
|
-
* @summary PIN login for members using memberId.
|
|
7144
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
|
|
7145
|
-
* @param {*} [options] Override http request option.
|
|
7146
|
-
* @deprecated
|
|
7147
|
-
* @throws {RequiredError}
|
|
7148
|
-
*/
|
|
7149
|
-
memberPinAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7150
7341
|
/**
|
|
7151
7342
|
*
|
|
7152
7343
|
* @summary Mock login and hand out token.
|
|
@@ -7157,25 +7348,7 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7157
7348
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7158
7349
|
/**
|
|
7159
7350
|
*
|
|
7160
|
-
* @summary
|
|
7161
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
|
|
7162
|
-
* @param {*} [options] Override http request option.
|
|
7163
|
-
* @deprecated
|
|
7164
|
-
* @throws {RequiredError}
|
|
7165
|
-
*/
|
|
7166
|
-
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
|
-
/**
|
|
7168
|
-
*
|
|
7169
|
-
* @summary PIN login and hand out token
|
|
7170
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
|
|
7171
|
-
* @param {*} [options] Override http request option.
|
|
7172
|
-
* @deprecated
|
|
7173
|
-
* @throws {RequiredError}
|
|
7174
|
-
*/
|
|
7175
|
-
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7176
|
-
/**
|
|
7177
|
-
*
|
|
7178
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7351
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7179
7352
|
* @param {*} [options] Override http request option.
|
|
7180
7353
|
* @throws {RequiredError}
|
|
7181
7354
|
*/
|
|
@@ -7258,15 +7431,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7258
7431
|
* @throws {RequiredError}
|
|
7259
7432
|
*/
|
|
7260
7433
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7261
|
-
/**
|
|
7262
|
-
*
|
|
7263
|
-
* @summary EAN login and hand out token
|
|
7264
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login.
|
|
7265
|
-
* @param {*} [options] Override http request option.
|
|
7266
|
-
* @deprecated
|
|
7267
|
-
* @throws {RequiredError}
|
|
7268
|
-
*/
|
|
7269
|
-
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7270
7434
|
/**
|
|
7271
7435
|
*
|
|
7272
7436
|
* @summary Generate a QR code for authentication
|
|
@@ -7336,15 +7500,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7336
7500
|
* @throws {RequiredError}
|
|
7337
7501
|
*/
|
|
7338
7502
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7339
|
-
/**
|
|
7340
|
-
*
|
|
7341
|
-
* @summary PIN login for members using memberId.
|
|
7342
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login.
|
|
7343
|
-
* @param {*} [options] Override http request option.
|
|
7344
|
-
* @deprecated
|
|
7345
|
-
* @throws {RequiredError}
|
|
7346
|
-
*/
|
|
7347
|
-
memberPinAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7348
7503
|
/**
|
|
7349
7504
|
*
|
|
7350
7505
|
* @summary Mock login and hand out token.
|
|
@@ -7353,24 +7508,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7353
7508
|
* @throws {RequiredError}
|
|
7354
7509
|
*/
|
|
7355
7510
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7356
|
-
/**
|
|
7357
|
-
*
|
|
7358
|
-
* @summary NFC login and hand out token
|
|
7359
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login.
|
|
7360
|
-
* @param {*} [options] Override http request option.
|
|
7361
|
-
* @deprecated
|
|
7362
|
-
* @throws {RequiredError}
|
|
7363
|
-
*/
|
|
7364
|
-
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7365
|
-
/**
|
|
7366
|
-
*
|
|
7367
|
-
* @summary PIN login and hand out token
|
|
7368
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login.
|
|
7369
|
-
* @param {*} [options] Override http request option.
|
|
7370
|
-
* @deprecated
|
|
7371
|
-
* @throws {RequiredError}
|
|
7372
|
-
*/
|
|
7373
|
-
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7374
7511
|
/**
|
|
7375
7512
|
*
|
|
7376
7513
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7456,15 +7593,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7456
7593
|
* @throws {RequiredError}
|
|
7457
7594
|
*/
|
|
7458
7595
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
|
-
/**
|
|
7460
|
-
*
|
|
7461
|
-
* @summary EAN login and hand out token
|
|
7462
|
-
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7463
|
-
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @deprecated
|
|
7465
|
-
* @throws {RequiredError}
|
|
7466
|
-
*/
|
|
7467
|
-
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7468
7596
|
/**
|
|
7469
7597
|
*
|
|
7470
7598
|
* @summary Generate a QR code for authentication
|
|
@@ -7534,15 +7662,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7534
7662
|
* @throws {RequiredError}
|
|
7535
7663
|
*/
|
|
7536
7664
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7537
|
-
/**
|
|
7538
|
-
*
|
|
7539
|
-
* @summary PIN login for members using memberId.
|
|
7540
|
-
* @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
|
|
7541
|
-
* @param {*} [options] Override http request option.
|
|
7542
|
-
* @deprecated
|
|
7543
|
-
* @throws {RequiredError}
|
|
7544
|
-
*/
|
|
7545
|
-
memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7546
7665
|
/**
|
|
7547
7666
|
*
|
|
7548
7667
|
* @summary Mock login and hand out token.
|
|
@@ -7551,24 +7670,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7551
7670
|
* @throws {RequiredError}
|
|
7552
7671
|
*/
|
|
7553
7672
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7554
|
-
/**
|
|
7555
|
-
*
|
|
7556
|
-
* @summary NFC login and hand out token
|
|
7557
|
-
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7558
|
-
* @param {*} [options] Override http request option.
|
|
7559
|
-
* @deprecated
|
|
7560
|
-
* @throws {RequiredError}
|
|
7561
|
-
*/
|
|
7562
|
-
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7563
|
-
/**
|
|
7564
|
-
*
|
|
7565
|
-
* @summary PIN login and hand out token
|
|
7566
|
-
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7567
|
-
* @param {*} [options] Override http request option.
|
|
7568
|
-
* @deprecated
|
|
7569
|
-
* @throws {RequiredError}
|
|
7570
|
-
*/
|
|
7571
|
-
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7572
7673
|
/**
|
|
7573
7674
|
*
|
|
7574
7675
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -7664,19 +7765,6 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7664
7765
|
*/
|
|
7665
7766
|
readonly sessionId: string;
|
|
7666
7767
|
}
|
|
7667
|
-
/**
|
|
7668
|
-
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7669
|
-
* @export
|
|
7670
|
-
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7671
|
-
*/
|
|
7672
|
-
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7673
|
-
/**
|
|
7674
|
-
* The EAN login.
|
|
7675
|
-
* @type {AuthenticationEanRequest}
|
|
7676
|
-
* @memberof AuthenticateApiEanAuthentication
|
|
7677
|
-
*/
|
|
7678
|
-
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7679
|
-
}
|
|
7680
7768
|
/**
|
|
7681
7769
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7682
7770
|
* @export
|
|
@@ -7755,19 +7843,6 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7755
7843
|
*/
|
|
7756
7844
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7757
7845
|
}
|
|
7758
|
-
/**
|
|
7759
|
-
* Request parameters for memberPinAuthentication operation in AuthenticateApi.
|
|
7760
|
-
* @export
|
|
7761
|
-
* @interface AuthenticateApiMemberPinAuthenticationRequest
|
|
7762
|
-
*/
|
|
7763
|
-
export interface AuthenticateApiMemberPinAuthenticationRequest {
|
|
7764
|
-
/**
|
|
7765
|
-
* The PIN login.
|
|
7766
|
-
* @type {MemberAuthenticationPinRequest}
|
|
7767
|
-
* @memberof AuthenticateApiMemberPinAuthentication
|
|
7768
|
-
*/
|
|
7769
|
-
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7770
|
-
}
|
|
7771
7846
|
/**
|
|
7772
7847
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7773
7848
|
* @export
|
|
@@ -7781,32 +7856,6 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7781
7856
|
*/
|
|
7782
7857
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7783
7858
|
}
|
|
7784
|
-
/**
|
|
7785
|
-
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
7786
|
-
* @export
|
|
7787
|
-
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
7788
|
-
*/
|
|
7789
|
-
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7790
|
-
/**
|
|
7791
|
-
* The NFC login.
|
|
7792
|
-
* @type {AuthenticationNfcRequest}
|
|
7793
|
-
* @memberof AuthenticateApiNfcAuthentication
|
|
7794
|
-
*/
|
|
7795
|
-
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
7796
|
-
}
|
|
7797
|
-
/**
|
|
7798
|
-
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
7799
|
-
* @export
|
|
7800
|
-
* @interface AuthenticateApiPinAuthenticationRequest
|
|
7801
|
-
*/
|
|
7802
|
-
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7803
|
-
/**
|
|
7804
|
-
* The PIN login.
|
|
7805
|
-
* @type {AuthenticationPinRequest}
|
|
7806
|
-
* @memberof AuthenticateApiPinAuthentication
|
|
7807
|
-
*/
|
|
7808
|
-
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
7809
|
-
}
|
|
7810
7859
|
/**
|
|
7811
7860
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7812
7861
|
* @export
|
|
@@ -7919,16 +7968,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7919
7968
|
* @memberof AuthenticateApi
|
|
7920
7969
|
*/
|
|
7921
7970
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7922
|
-
/**
|
|
7923
|
-
*
|
|
7924
|
-
* @summary EAN login and hand out token
|
|
7925
|
-
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7926
|
-
* @param {*} [options] Override http request option.
|
|
7927
|
-
* @deprecated
|
|
7928
|
-
* @throws {RequiredError}
|
|
7929
|
-
* @memberof AuthenticateApi
|
|
7930
|
-
*/
|
|
7931
|
-
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7932
7971
|
/**
|
|
7933
7972
|
*
|
|
7934
7973
|
* @summary Generate a QR code for authentication
|
|
@@ -8007,16 +8046,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8007
8046
|
* @memberof AuthenticateApi
|
|
8008
8047
|
*/
|
|
8009
8048
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8010
|
-
/**
|
|
8011
|
-
*
|
|
8012
|
-
* @summary PIN login for members using memberId.
|
|
8013
|
-
* @param {AuthenticateApiMemberPinAuthenticationRequest} requestParameters Request parameters.
|
|
8014
|
-
* @param {*} [options] Override http request option.
|
|
8015
|
-
* @deprecated
|
|
8016
|
-
* @throws {RequiredError}
|
|
8017
|
-
* @memberof AuthenticateApi
|
|
8018
|
-
*/
|
|
8019
|
-
memberPinAuthentication(requestParameters: AuthenticateApiMemberPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8020
8049
|
/**
|
|
8021
8050
|
*
|
|
8022
8051
|
* @summary Mock login and hand out token.
|
|
@@ -8026,26 +8055,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8026
8055
|
* @memberof AuthenticateApi
|
|
8027
8056
|
*/
|
|
8028
8057
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8029
|
-
/**
|
|
8030
|
-
*
|
|
8031
|
-
* @summary NFC login and hand out token
|
|
8032
|
-
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8033
|
-
* @param {*} [options] Override http request option.
|
|
8034
|
-
* @deprecated
|
|
8035
|
-
* @throws {RequiredError}
|
|
8036
|
-
* @memberof AuthenticateApi
|
|
8037
|
-
*/
|
|
8038
|
-
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8039
|
-
/**
|
|
8040
|
-
*
|
|
8041
|
-
* @summary PIN login and hand out token
|
|
8042
|
-
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8043
|
-
* @param {*} [options] Override http request option.
|
|
8044
|
-
* @deprecated
|
|
8045
|
-
* @throws {RequiredError}
|
|
8046
|
-
* @memberof AuthenticateApi
|
|
8047
|
-
*/
|
|
8048
|
-
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8049
8058
|
/**
|
|
8050
8059
|
*
|
|
8051
8060
|
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
@@ -10826,7 +10835,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10826
10835
|
* @param {*} [options] Override http request option.
|
|
10827
10836
|
* @throws {RequiredError}
|
|
10828
10837
|
*/
|
|
10829
|
-
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>>>;
|
|
10830
10839
|
/**
|
|
10831
10840
|
*
|
|
10832
10841
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10904,7 +10913,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10904
10913
|
* @param {*} [options] Override http request option.
|
|
10905
10914
|
* @throws {RequiredError}
|
|
10906
10915
|
*/
|
|
10907
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10916
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10908
10917
|
/**
|
|
10909
10918
|
*
|
|
10910
10919
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11127,7 +11136,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11127
11136
|
* @throws {RequiredError}
|
|
11128
11137
|
* @memberof InactiveAdministrativeCostsApi
|
|
11129
11138
|
*/
|
|
11130
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11139
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11131
11140
|
/**
|
|
11132
11141
|
*
|
|
11133
11142
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11299,7 +11308,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11299
11308
|
* @param {*} [options] Override http request option.
|
|
11300
11309
|
* @throws {RequiredError}
|
|
11301
11310
|
*/
|
|
11302
|
-
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>>>;
|
|
11303
11312
|
/**
|
|
11304
11313
|
*
|
|
11305
11314
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11315,7 +11324,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11315
11324
|
* @param {*} [options] Override http request option.
|
|
11316
11325
|
* @throws {RequiredError}
|
|
11317
11326
|
*/
|
|
11318
|
-
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>>;
|
|
11319
11328
|
/**
|
|
11320
11329
|
*
|
|
11321
11330
|
* @summary Returns a single invoice in the system.
|
|
@@ -11396,7 +11405,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11396
11405
|
* @param {*} [options] Override http request option.
|
|
11397
11406
|
* @throws {RequiredError}
|
|
11398
11407
|
*/
|
|
11399
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11408
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11400
11409
|
/**
|
|
11401
11410
|
*
|
|
11402
11411
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11411,7 +11420,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11411
11420
|
* @param {*} [options] Override http request option.
|
|
11412
11421
|
* @throws {RequiredError}
|
|
11413
11422
|
*/
|
|
11414
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11423
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11415
11424
|
/**
|
|
11416
11425
|
*
|
|
11417
11426
|
* @summary Returns a single invoice in the system.
|
|
@@ -11710,7 +11719,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11710
11719
|
* @throws {RequiredError}
|
|
11711
11720
|
* @memberof InvoicesApi
|
|
11712
11721
|
*/
|
|
11713
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11722
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11714
11723
|
/**
|
|
11715
11724
|
*
|
|
11716
11725
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11727,7 +11736,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11727
11736
|
* @throws {RequiredError}
|
|
11728
11737
|
* @memberof InvoicesApi
|
|
11729
11738
|
*/
|
|
11730
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11739
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11731
11740
|
/**
|
|
11732
11741
|
*
|
|
11733
11742
|
* @summary Returns a single invoice in the system.
|
|
@@ -11765,6 +11774,492 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11765
11774
|
*/
|
|
11766
11775
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11767
11776
|
}
|
|
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.
|
|
11981
|
+
* @export
|
|
11982
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11983
|
+
*/
|
|
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
|
+
}
|
|
11768
12263
|
/**
|
|
11769
12264
|
* PayoutRequestsApi - axios parameter creator
|
|
11770
12265
|
* @export
|
|
@@ -15139,12 +15634,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15139
15634
|
* @summary Returns all existing transfers
|
|
15140
15635
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15141
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
|
|
15142
15640
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15143
15641
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15144
15642
|
* @param {*} [options] Override http request option.
|
|
15145
15643
|
* @throws {RequiredError}
|
|
15146
15644
|
*/
|
|
15147
|
-
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>;
|
|
15148
15646
|
/**
|
|
15149
15647
|
*
|
|
15150
15648
|
* @summary Returns the requested transfer
|
|
@@ -15211,12 +15709,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15211
15709
|
* @summary Returns all existing transfers
|
|
15212
15710
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15213
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
|
|
15214
15715
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15215
15716
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15216
15717
|
* @param {*} [options] Override http request option.
|
|
15217
15718
|
* @throws {RequiredError}
|
|
15218
15719
|
*/
|
|
15219
|
-
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>>;
|
|
15220
15721
|
/**
|
|
15221
15722
|
*
|
|
15222
15723
|
* @summary Returns the requested transfer
|
|
@@ -15285,7 +15786,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15285
15786
|
* @param {*} [options] Override http request option.
|
|
15286
15787
|
* @throws {RequiredError}
|
|
15287
15788
|
*/
|
|
15288
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15789
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15289
15790
|
/**
|
|
15290
15791
|
*
|
|
15291
15792
|
* @summary Returns the requested transfer
|
|
@@ -15363,6 +15864,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15363
15864
|
* @memberof TransfersApiGetAllTransfers
|
|
15364
15865
|
*/
|
|
15365
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;
|
|
15366
15885
|
/**
|
|
15367
15886
|
* How many transfers the endpoint should return
|
|
15368
15887
|
* @type {number}
|
|
@@ -15503,7 +16022,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15503
16022
|
* @throws {RequiredError}
|
|
15504
16023
|
* @memberof TransfersApi
|
|
15505
16024
|
*/
|
|
15506
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16025
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15507
16026
|
/**
|
|
15508
16027
|
*
|
|
15509
16028
|
* @summary Returns the requested transfer
|
|
@@ -15904,6 +16423,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15904
16423
|
* @throws {RequiredError}
|
|
15905
16424
|
*/
|
|
15906
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>;
|
|
15907
16440
|
/**
|
|
15908
16441
|
*
|
|
15909
16442
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16266,6 +16799,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16266
16799
|
* @throws {RequiredError}
|
|
16267
16800
|
*/
|
|
16268
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>>;
|
|
16269
16816
|
/**
|
|
16270
16817
|
*
|
|
16271
16818
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16610,6 +17157,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16610
17157
|
* @throws {RequiredError}
|
|
16611
17158
|
*/
|
|
16612
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>;
|
|
16613
17168
|
/**
|
|
16614
17169
|
*
|
|
16615
17170
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17101,6 +17656,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17101
17656
|
*/
|
|
17102
17657
|
readonly skip?: number;
|
|
17103
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
|
+
}
|
|
17104
17708
|
/**
|
|
17105
17709
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17106
17710
|
* @export
|
|
@@ -17767,6 +18371,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17767
18371
|
* @memberof UsersApi
|
|
17768
18372
|
*/
|
|
17769
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, {}>>;
|
|
17770
18383
|
/**
|
|
17771
18384
|
*
|
|
17772
18385
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17962,6 +18575,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17962
18575
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17963
18576
|
};
|
|
17964
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];
|
|
17965
18588
|
/**
|
|
17966
18589
|
* @export
|
|
17967
18590
|
*/
|