@gewis/sudosos-client 0.0.0-develop.fd219fb → 0.0.0-develop.ff396b7
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 +1776 -634
- package/dist/api.js +1393 -389
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface AcceptTosRequest {
|
|
|
25
25
|
* @memberof AcceptTosRequest
|
|
26
26
|
*/
|
|
27
27
|
'extensiveDataProcessing': boolean;
|
|
28
|
+
/**
|
|
29
|
+
* The TOS version being accepted.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AcceptTosRequest
|
|
32
|
+
*/
|
|
33
|
+
'version': string;
|
|
28
34
|
}
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
@@ -70,6 +76,12 @@ export interface AuthenticationEanRequest {
|
|
|
70
76
|
* @memberof AuthenticationEanRequest
|
|
71
77
|
*/
|
|
72
78
|
'eanCode': string;
|
|
79
|
+
/**
|
|
80
|
+
* POS identifier
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof AuthenticationEanRequest
|
|
83
|
+
*/
|
|
84
|
+
'posId': number;
|
|
73
85
|
}
|
|
74
86
|
/**
|
|
75
87
|
*
|
|
@@ -159,6 +171,12 @@ export interface AuthenticationNfcRequest {
|
|
|
159
171
|
* @memberof AuthenticationNfcRequest
|
|
160
172
|
*/
|
|
161
173
|
'nfcCode': string;
|
|
174
|
+
/**
|
|
175
|
+
* POS identifier
|
|
176
|
+
* @type {number}
|
|
177
|
+
* @memberof AuthenticationNfcRequest
|
|
178
|
+
*/
|
|
179
|
+
'posId': number;
|
|
162
180
|
}
|
|
163
181
|
/**
|
|
164
182
|
*
|
|
@@ -178,6 +196,12 @@ export interface AuthenticationPinRequest {
|
|
|
178
196
|
* @memberof AuthenticationPinRequest
|
|
179
197
|
*/
|
|
180
198
|
'pin': string;
|
|
199
|
+
/**
|
|
200
|
+
* POS identifier
|
|
201
|
+
* @type {number}
|
|
202
|
+
* @memberof AuthenticationPinRequest
|
|
203
|
+
*/
|
|
204
|
+
'posId': number;
|
|
181
205
|
}
|
|
182
206
|
/**
|
|
183
207
|
*
|
|
@@ -260,69 +284,6 @@ export interface AuthenticationResponse {
|
|
|
260
284
|
*/
|
|
261
285
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
262
286
|
}
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @export
|
|
266
|
-
* @interface AuthenticationSecureEanRequest
|
|
267
|
-
*/
|
|
268
|
-
export interface AuthenticationSecureEanRequest {
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {string}
|
|
272
|
-
* @memberof AuthenticationSecureEanRequest
|
|
273
|
-
*/
|
|
274
|
-
'eanCode': string;
|
|
275
|
-
/**
|
|
276
|
-
* POS identifier
|
|
277
|
-
* @type {number}
|
|
278
|
-
* @memberof AuthenticationSecureEanRequest
|
|
279
|
-
*/
|
|
280
|
-
'posId': number;
|
|
281
|
-
}
|
|
282
|
-
/**
|
|
283
|
-
*
|
|
284
|
-
* @export
|
|
285
|
-
* @interface AuthenticationSecureNfcRequest
|
|
286
|
-
*/
|
|
287
|
-
export interface AuthenticationSecureNfcRequest {
|
|
288
|
-
/**
|
|
289
|
-
*
|
|
290
|
-
* @type {string}
|
|
291
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
292
|
-
*/
|
|
293
|
-
'nfcCode': string;
|
|
294
|
-
/**
|
|
295
|
-
* POS identifier
|
|
296
|
-
* @type {number}
|
|
297
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
298
|
-
*/
|
|
299
|
-
'posId': number;
|
|
300
|
-
}
|
|
301
|
-
/**
|
|
302
|
-
*
|
|
303
|
-
* @export
|
|
304
|
-
* @interface AuthenticationSecurePinRequest
|
|
305
|
-
*/
|
|
306
|
-
export interface AuthenticationSecurePinRequest {
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @type {number}
|
|
310
|
-
* @memberof AuthenticationSecurePinRequest
|
|
311
|
-
*/
|
|
312
|
-
'userId': number;
|
|
313
|
-
/**
|
|
314
|
-
*
|
|
315
|
-
* @type {string}
|
|
316
|
-
* @memberof AuthenticationSecurePinRequest
|
|
317
|
-
*/
|
|
318
|
-
'pin': string;
|
|
319
|
-
/**
|
|
320
|
-
* POS identifier (required for secure authentication)
|
|
321
|
-
* @type {number}
|
|
322
|
-
* @memberof AuthenticationSecurePinRequest
|
|
323
|
-
*/
|
|
324
|
-
'posId': number;
|
|
325
|
-
}
|
|
326
287
|
/**
|
|
327
288
|
*
|
|
328
289
|
* @export
|
|
@@ -946,6 +907,104 @@ export interface BaseInvoiceResponse {
|
|
|
946
907
|
*/
|
|
947
908
|
'totalInclVat': DineroObjectResponse;
|
|
948
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* 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.
|
|
912
|
+
* @export
|
|
913
|
+
* @interface BasePaymentRequestResponse
|
|
914
|
+
*/
|
|
915
|
+
export interface BasePaymentRequestResponse {
|
|
916
|
+
/**
|
|
917
|
+
* UUID v4 identifier (also the public share-link id).
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof BasePaymentRequestResponse
|
|
920
|
+
*/
|
|
921
|
+
'uuid': string;
|
|
922
|
+
/**
|
|
923
|
+
* ISO-8601 creation timestamp.
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof BasePaymentRequestResponse
|
|
926
|
+
*/
|
|
927
|
+
'createdAt'?: string;
|
|
928
|
+
/**
|
|
929
|
+
* ISO-8601 last update timestamp.
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof BasePaymentRequestResponse
|
|
932
|
+
*/
|
|
933
|
+
'updatedAt'?: string;
|
|
934
|
+
/**
|
|
935
|
+
* Optimistic-locking version.
|
|
936
|
+
* @type {number}
|
|
937
|
+
* @memberof BasePaymentRequestResponse
|
|
938
|
+
*/
|
|
939
|
+
'version'?: number;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {BaseUserResponse}
|
|
943
|
+
* @memberof BasePaymentRequestResponse
|
|
944
|
+
*/
|
|
945
|
+
'for': BaseUserResponse;
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {BaseUserResponse}
|
|
949
|
+
* @memberof BasePaymentRequestResponse
|
|
950
|
+
*/
|
|
951
|
+
'createdBy': BaseUserResponse;
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {DineroObjectResponse}
|
|
955
|
+
* @memberof BasePaymentRequestResponse
|
|
956
|
+
*/
|
|
957
|
+
'amount': DineroObjectResponse;
|
|
958
|
+
/**
|
|
959
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof BasePaymentRequestResponse
|
|
962
|
+
*/
|
|
963
|
+
'expiresAt': string;
|
|
964
|
+
/**
|
|
965
|
+
* ISO-8601 timestamp the request was marked paid (null if not paid).
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof BasePaymentRequestResponse
|
|
968
|
+
*/
|
|
969
|
+
'paidAt'?: string;
|
|
970
|
+
/**
|
|
971
|
+
* ISO-8601 timestamp the request was cancelled (null if not cancelled).
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof BasePaymentRequestResponse
|
|
974
|
+
*/
|
|
975
|
+
'cancelledAt'?: string;
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {BaseUserResponse}
|
|
979
|
+
* @memberof BasePaymentRequestResponse
|
|
980
|
+
*/
|
|
981
|
+
'cancelledBy'?: BaseUserResponse;
|
|
982
|
+
/**
|
|
983
|
+
*
|
|
984
|
+
* @type {BaseUserResponse}
|
|
985
|
+
* @memberof BasePaymentRequestResponse
|
|
986
|
+
*/
|
|
987
|
+
'fulfilledBy'?: BaseUserResponse;
|
|
988
|
+
/**
|
|
989
|
+
* Optional human-readable description.
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof BasePaymentRequestResponse
|
|
992
|
+
*/
|
|
993
|
+
'description'?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Derived lifecycle status.
|
|
996
|
+
* @type {string}
|
|
997
|
+
* @memberof BasePaymentRequestResponse
|
|
998
|
+
*/
|
|
999
|
+
'status': BasePaymentRequestResponseStatusEnum;
|
|
1000
|
+
}
|
|
1001
|
+
export declare const BasePaymentRequestResponseStatusEnum: {
|
|
1002
|
+
readonly Pending: "PENDING";
|
|
1003
|
+
readonly Paid: "PAID";
|
|
1004
|
+
readonly Expired: "EXPIRED";
|
|
1005
|
+
readonly Cancelled: "CANCELLED";
|
|
1006
|
+
};
|
|
1007
|
+
export type BasePaymentRequestResponseStatusEnum = typeof BasePaymentRequestResponseStatusEnum[keyof typeof BasePaymentRequestResponseStatusEnum];
|
|
949
1008
|
/**
|
|
950
1009
|
*
|
|
951
1010
|
* @export
|
|
@@ -1186,6 +1245,31 @@ export interface BaseResponse {
|
|
|
1186
1245
|
*/
|
|
1187
1246
|
'version'?: number;
|
|
1188
1247
|
}
|
|
1248
|
+
/**
|
|
1249
|
+
* 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.
|
|
1250
|
+
* @export
|
|
1251
|
+
* @interface BaseResponseWithoutId
|
|
1252
|
+
*/
|
|
1253
|
+
export interface BaseResponseWithoutId {
|
|
1254
|
+
/**
|
|
1255
|
+
* The creation Date of the entity.
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof BaseResponseWithoutId
|
|
1258
|
+
*/
|
|
1259
|
+
'createdAt'?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The last update Date of the entity.
|
|
1262
|
+
* @type {string}
|
|
1263
|
+
* @memberof BaseResponseWithoutId
|
|
1264
|
+
*/
|
|
1265
|
+
'updatedAt'?: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* The version of the entity.
|
|
1268
|
+
* @type {number}
|
|
1269
|
+
* @memberof BaseResponseWithoutId
|
|
1270
|
+
*/
|
|
1271
|
+
'version'?: number;
|
|
1272
|
+
}
|
|
1189
1273
|
/**
|
|
1190
1274
|
*
|
|
1191
1275
|
* @export
|
|
@@ -1659,7 +1743,7 @@ export interface ContainerWithProductsResponse {
|
|
|
1659
1743
|
'products': Array<ProductResponse>;
|
|
1660
1744
|
}
|
|
1661
1745
|
/**
|
|
1662
|
-
*
|
|
1746
|
+
* API Request for creating a `container` entity.
|
|
1663
1747
|
* @export
|
|
1664
1748
|
* @interface CreateContainerRequest
|
|
1665
1749
|
*/
|
|
@@ -1824,6 +1908,37 @@ export interface CreateInvoiceRequest {
|
|
|
1824
1908
|
*/
|
|
1825
1909
|
'amount': DineroObjectRequest;
|
|
1826
1910
|
}
|
|
1911
|
+
/**
|
|
1912
|
+
*
|
|
1913
|
+
* @export
|
|
1914
|
+
* @interface CreatePaymentRequestRequest
|
|
1915
|
+
*/
|
|
1916
|
+
export interface CreatePaymentRequestRequest {
|
|
1917
|
+
/**
|
|
1918
|
+
* The ID of the user whose balance will be credited on payment.
|
|
1919
|
+
* @type {number}
|
|
1920
|
+
* @memberof CreatePaymentRequestRequest
|
|
1921
|
+
*/
|
|
1922
|
+
'forId': number;
|
|
1923
|
+
/**
|
|
1924
|
+
*
|
|
1925
|
+
* @type {DineroObjectRequest}
|
|
1926
|
+
* @memberof CreatePaymentRequestRequest
|
|
1927
|
+
*/
|
|
1928
|
+
'amount': DineroObjectRequest;
|
|
1929
|
+
/**
|
|
1930
|
+
* ISO-8601 timestamp after which the request stops accepting payments.
|
|
1931
|
+
* @type {string}
|
|
1932
|
+
* @memberof CreatePaymentRequestRequest
|
|
1933
|
+
*/
|
|
1934
|
+
'expiresAt': string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Optional human-readable description (e.g. invoice reference).
|
|
1937
|
+
* @type {string}
|
|
1938
|
+
* @memberof CreatePaymentRequestRequest
|
|
1939
|
+
*/
|
|
1940
|
+
'description'?: string;
|
|
1941
|
+
}
|
|
1827
1942
|
/**
|
|
1828
1943
|
*
|
|
1829
1944
|
* @export
|
|
@@ -1856,7 +1971,7 @@ export interface CreatePermissionParams {
|
|
|
1856
1971
|
'attributes': Array<string>;
|
|
1857
1972
|
}
|
|
1858
1973
|
/**
|
|
1859
|
-
*
|
|
1974
|
+
* API Request for creating a `point of sale` entity.
|
|
1860
1975
|
* @export
|
|
1861
1976
|
* @interface CreatePointOfSaleRequest
|
|
1862
1977
|
*/
|
|
@@ -1880,7 +1995,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1880
1995
|
*/
|
|
1881
1996
|
'containers': Array<number>;
|
|
1882
1997
|
/**
|
|
1883
|
-
* ID of the user who will own the POS
|
|
1998
|
+
* ID of the user who will own the POS.
|
|
1884
1999
|
* @type {number}
|
|
1885
2000
|
* @memberof CreatePointOfSaleRequest
|
|
1886
2001
|
*/
|
|
@@ -1893,7 +2008,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1893
2008
|
'cashierRoleIds'?: Array<number>;
|
|
1894
2009
|
}
|
|
1895
2010
|
/**
|
|
1896
|
-
*
|
|
2011
|
+
* API Request for creating a `product` entity.
|
|
1897
2012
|
* @export
|
|
1898
2013
|
* @interface CreateProductRequest
|
|
1899
2014
|
*/
|
|
@@ -2003,6 +2118,19 @@ export interface CreateShiftRequest {
|
|
|
2003
2118
|
*/
|
|
2004
2119
|
'roles': Array<string>;
|
|
2005
2120
|
}
|
|
2121
|
+
/**
|
|
2122
|
+
*
|
|
2123
|
+
* @export
|
|
2124
|
+
* @interface CreateTerminalPaymentRequest
|
|
2125
|
+
*/
|
|
2126
|
+
export interface CreateTerminalPaymentRequest {
|
|
2127
|
+
/**
|
|
2128
|
+
*
|
|
2129
|
+
* @type {TransactionRequest}
|
|
2130
|
+
* @memberof CreateTerminalPaymentRequest
|
|
2131
|
+
*/
|
|
2132
|
+
'transaction': TransactionRequest;
|
|
2133
|
+
}
|
|
2006
2134
|
/**
|
|
2007
2135
|
*
|
|
2008
2136
|
* @export
|
|
@@ -3154,44 +3282,38 @@ export interface InvoiceUserResponse {
|
|
|
3154
3282
|
/**
|
|
3155
3283
|
*
|
|
3156
3284
|
* @export
|
|
3157
|
-
* @interface
|
|
3285
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3158
3286
|
*/
|
|
3159
|
-
export interface
|
|
3160
|
-
/**
|
|
3161
|
-
*
|
|
3162
|
-
* @type {number}
|
|
3163
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3164
|
-
*/
|
|
3165
|
-
'memberId': number;
|
|
3287
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3166
3288
|
/**
|
|
3167
|
-
*
|
|
3289
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3168
3290
|
* @type {string}
|
|
3169
|
-
* @memberof
|
|
3291
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3170
3292
|
*/
|
|
3171
|
-
'
|
|
3293
|
+
'reason': string;
|
|
3172
3294
|
}
|
|
3173
3295
|
/**
|
|
3174
3296
|
*
|
|
3175
3297
|
* @export
|
|
3176
|
-
* @interface
|
|
3298
|
+
* @interface MemberAuthenticationPinRequest
|
|
3177
3299
|
*/
|
|
3178
|
-
export interface
|
|
3300
|
+
export interface MemberAuthenticationPinRequest {
|
|
3179
3301
|
/**
|
|
3180
3302
|
*
|
|
3181
3303
|
* @type {number}
|
|
3182
|
-
* @memberof
|
|
3304
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3183
3305
|
*/
|
|
3184
3306
|
'memberId': number;
|
|
3185
3307
|
/**
|
|
3186
3308
|
*
|
|
3187
3309
|
* @type {string}
|
|
3188
|
-
* @memberof
|
|
3310
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3189
3311
|
*/
|
|
3190
3312
|
'pin': string;
|
|
3191
3313
|
/**
|
|
3192
3314
|
* POS identifier
|
|
3193
3315
|
* @type {number}
|
|
3194
|
-
* @memberof
|
|
3316
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3195
3317
|
*/
|
|
3196
3318
|
'posId': number;
|
|
3197
3319
|
}
|
|
@@ -3265,6 +3387,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3265
3387
|
*/
|
|
3266
3388
|
'records': Array<BaseEventResponse>;
|
|
3267
3389
|
}
|
|
3390
|
+
/**
|
|
3391
|
+
*
|
|
3392
|
+
* @export
|
|
3393
|
+
* @interface PaginatedBasePaymentRequestResponse
|
|
3394
|
+
*/
|
|
3395
|
+
export interface PaginatedBasePaymentRequestResponse {
|
|
3396
|
+
/**
|
|
3397
|
+
*
|
|
3398
|
+
* @type {PaginationResult}
|
|
3399
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3400
|
+
*/
|
|
3401
|
+
'_pagination': PaginationResult;
|
|
3402
|
+
/**
|
|
3403
|
+
* Returned payment requests
|
|
3404
|
+
* @type {Array<BasePaymentRequestResponse>}
|
|
3405
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3406
|
+
*/
|
|
3407
|
+
'records': Array<BasePaymentRequestResponse>;
|
|
3408
|
+
}
|
|
3268
3409
|
/**
|
|
3269
3410
|
*
|
|
3270
3411
|
* @export
|
|
@@ -3304,7 +3445,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3304
3445
|
'records': Array<BaseTransactionResponse>;
|
|
3305
3446
|
}
|
|
3306
3447
|
/**
|
|
3307
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity.
|
|
3308
3449
|
* @export
|
|
3309
3450
|
* @interface PaginatedContainerResponse
|
|
3310
3451
|
*/
|
|
@@ -3323,7 +3464,7 @@ export interface PaginatedContainerResponse {
|
|
|
3323
3464
|
'records': Array<ContainerResponse>;
|
|
3324
3465
|
}
|
|
3325
3466
|
/**
|
|
3326
|
-
*
|
|
3467
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3327
3468
|
* @export
|
|
3328
3469
|
* @interface PaginatedContainerWithProductResponse
|
|
3329
3470
|
*/
|
|
@@ -3437,7 +3578,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3437
3578
|
'records': Array<InvoiceResponseTypes>;
|
|
3438
3579
|
}
|
|
3439
3580
|
/**
|
|
3440
|
-
*
|
|
3581
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3441
3582
|
* @export
|
|
3442
3583
|
* @interface PaginatedPointOfSaleResponse
|
|
3443
3584
|
*/
|
|
@@ -3456,7 +3597,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3456
3597
|
'records': Array<PointOfSaleResponse>;
|
|
3457
3598
|
}
|
|
3458
3599
|
/**
|
|
3459
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product category` entity.
|
|
3460
3601
|
* @export
|
|
3461
3602
|
* @interface PaginatedProductCategoryResponse
|
|
3462
3603
|
*/
|
|
@@ -3475,7 +3616,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3475
3616
|
'records': Array<ProductCategoryResponse>;
|
|
3476
3617
|
}
|
|
3477
3618
|
/**
|
|
3478
|
-
*
|
|
3619
|
+
* Paginated API Response for the `product` entity.
|
|
3479
3620
|
* @export
|
|
3480
3621
|
* @interface PaginatedProductResponse
|
|
3481
3622
|
*/
|
|
@@ -3570,7 +3711,7 @@ export interface PaginatedUserResponse {
|
|
|
3570
3711
|
'records': Array<UserResponse>;
|
|
3571
3712
|
}
|
|
3572
3713
|
/**
|
|
3573
|
-
*
|
|
3714
|
+
* Paginated API Response for the `vat group` entity.
|
|
3574
3715
|
* @export
|
|
3575
3716
|
* @interface PaginatedVatGroupResponse
|
|
3576
3717
|
*/
|
|
@@ -3695,6 +3836,31 @@ export interface PatchUserTypeRequest {
|
|
|
3695
3836
|
*/
|
|
3696
3837
|
'userType': string;
|
|
3697
3838
|
}
|
|
3839
|
+
/**
|
|
3840
|
+
* Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
|
|
3841
|
+
* @export
|
|
3842
|
+
* @interface PaymentRequestStartResponse
|
|
3843
|
+
*/
|
|
3844
|
+
export interface PaymentRequestStartResponse {
|
|
3845
|
+
/**
|
|
3846
|
+
* The PaymentRequest id the intent is linked to.
|
|
3847
|
+
* @type {string}
|
|
3848
|
+
* @memberof PaymentRequestStartResponse
|
|
3849
|
+
*/
|
|
3850
|
+
'paymentRequestId': string;
|
|
3851
|
+
/**
|
|
3852
|
+
* Stripe payment intent id.
|
|
3853
|
+
* @type {string}
|
|
3854
|
+
* @memberof PaymentRequestStartResponse
|
|
3855
|
+
*/
|
|
3856
|
+
'stripeId': string;
|
|
3857
|
+
/**
|
|
3858
|
+
* Stripe client secret for the intent.
|
|
3859
|
+
* @type {string}
|
|
3860
|
+
* @memberof PaymentRequestStartResponse
|
|
3861
|
+
*/
|
|
3862
|
+
'clientSecret': string;
|
|
3863
|
+
}
|
|
3698
3864
|
/**
|
|
3699
3865
|
*
|
|
3700
3866
|
* @export
|
|
@@ -3902,7 +4068,7 @@ export interface PermissionResponse {
|
|
|
3902
4068
|
'actions': Array<ActionResponse>;
|
|
3903
4069
|
}
|
|
3904
4070
|
/**
|
|
3905
|
-
*
|
|
4071
|
+
* 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
4072
|
* @export
|
|
3907
4073
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3908
4074
|
*/
|
|
@@ -4057,6 +4223,19 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4057
4223
|
/**
|
|
4058
4224
|
*
|
|
4059
4225
|
* @export
|
|
4226
|
+
* @interface ProcessTerminalPaymentRequest
|
|
4227
|
+
*/
|
|
4228
|
+
export interface ProcessTerminalPaymentRequest {
|
|
4229
|
+
/**
|
|
4230
|
+
* The ID of the Stripe terminal to perform the payment with
|
|
4231
|
+
* @type {string}
|
|
4232
|
+
* @memberof ProcessTerminalPaymentRequest
|
|
4233
|
+
*/
|
|
4234
|
+
'stripeTerminalId': string;
|
|
4235
|
+
}
|
|
4236
|
+
/**
|
|
4237
|
+
* API Request for creating or updating a `product category` entity.
|
|
4238
|
+
* @export
|
|
4060
4239
|
* @interface ProductCategoryRequest
|
|
4061
4240
|
*/
|
|
4062
4241
|
export interface ProductCategoryRequest {
|
|
@@ -4220,27 +4399,77 @@ export interface ProductResponse {
|
|
|
4220
4399
|
'priceList': boolean;
|
|
4221
4400
|
}
|
|
4222
4401
|
/**
|
|
4223
|
-
*
|
|
4402
|
+
* 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.
|
|
4224
4403
|
* @export
|
|
4225
|
-
* @interface
|
|
4404
|
+
* @interface PublicPaymentRequestResponse
|
|
4226
4405
|
*/
|
|
4227
|
-
export interface
|
|
4406
|
+
export interface PublicPaymentRequestResponse {
|
|
4228
4407
|
/**
|
|
4229
|
-
*
|
|
4408
|
+
* UUID v4 identifier.
|
|
4230
4409
|
* @type {string}
|
|
4231
|
-
* @memberof
|
|
4410
|
+
* @memberof PublicPaymentRequestResponse
|
|
4232
4411
|
*/
|
|
4233
|
-
'
|
|
4412
|
+
'uuid': string;
|
|
4234
4413
|
/**
|
|
4235
|
-
*
|
|
4414
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4236
4415
|
* @type {string}
|
|
4237
|
-
* @memberof
|
|
4416
|
+
* @memberof PublicPaymentRequestResponse
|
|
4238
4417
|
*/
|
|
4239
|
-
'
|
|
4418
|
+
'forDisplayName': string;
|
|
4240
4419
|
/**
|
|
4241
|
-
*
|
|
4242
|
-
* @type {
|
|
4243
|
-
* @memberof
|
|
4420
|
+
*
|
|
4421
|
+
* @type {DineroObjectResponse}
|
|
4422
|
+
* @memberof PublicPaymentRequestResponse
|
|
4423
|
+
*/
|
|
4424
|
+
'amount': DineroObjectResponse;
|
|
4425
|
+
/**
|
|
4426
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4427
|
+
* @type {string}
|
|
4428
|
+
* @memberof PublicPaymentRequestResponse
|
|
4429
|
+
*/
|
|
4430
|
+
'expiresAt': string;
|
|
4431
|
+
/**
|
|
4432
|
+
* Optional human-readable description.
|
|
4433
|
+
* @type {string}
|
|
4434
|
+
* @memberof PublicPaymentRequestResponse
|
|
4435
|
+
*/
|
|
4436
|
+
'description'?: string;
|
|
4437
|
+
/**
|
|
4438
|
+
* Derived lifecycle status.
|
|
4439
|
+
* @type {string}
|
|
4440
|
+
* @memberof PublicPaymentRequestResponse
|
|
4441
|
+
*/
|
|
4442
|
+
'status': PublicPaymentRequestResponseStatusEnum;
|
|
4443
|
+
}
|
|
4444
|
+
export declare const PublicPaymentRequestResponseStatusEnum: {
|
|
4445
|
+
readonly Pending: "PENDING";
|
|
4446
|
+
readonly Paid: "PAID";
|
|
4447
|
+
readonly Expired: "EXPIRED";
|
|
4448
|
+
readonly Cancelled: "CANCELLED";
|
|
4449
|
+
};
|
|
4450
|
+
export type PublicPaymentRequestResponseStatusEnum = typeof PublicPaymentRequestResponseStatusEnum[keyof typeof PublicPaymentRequestResponseStatusEnum];
|
|
4451
|
+
/**
|
|
4452
|
+
*
|
|
4453
|
+
* @export
|
|
4454
|
+
* @interface QRCodeResponse
|
|
4455
|
+
*/
|
|
4456
|
+
export interface QRCodeResponse {
|
|
4457
|
+
/**
|
|
4458
|
+
* The session ID
|
|
4459
|
+
* @type {string}
|
|
4460
|
+
* @memberof QRCodeResponse
|
|
4461
|
+
*/
|
|
4462
|
+
'sessionId': string;
|
|
4463
|
+
/**
|
|
4464
|
+
* The QR code URL
|
|
4465
|
+
* @type {string}
|
|
4466
|
+
* @memberof QRCodeResponse
|
|
4467
|
+
*/
|
|
4468
|
+
'qrCodeUrl': string;
|
|
4469
|
+
/**
|
|
4470
|
+
* The expiry date of the QR code
|
|
4471
|
+
* @type {string}
|
|
4472
|
+
* @memberof QRCodeResponse
|
|
4244
4473
|
*/
|
|
4245
4474
|
'expiresAt': string;
|
|
4246
4475
|
}
|
|
@@ -4896,6 +5125,37 @@ export interface StripePaymentIntentStatusResponse {
|
|
|
4896
5125
|
*/
|
|
4897
5126
|
'state': number;
|
|
4898
5127
|
}
|
|
5128
|
+
/**
|
|
5129
|
+
*
|
|
5130
|
+
* @export
|
|
5131
|
+
* @interface StripePaymentTerminalResponse
|
|
5132
|
+
*/
|
|
5133
|
+
export interface StripePaymentTerminalResponse {
|
|
5134
|
+
/**
|
|
5135
|
+
* The ID of the payment terminal
|
|
5136
|
+
* @type {string}
|
|
5137
|
+
* @memberof StripePaymentTerminalResponse
|
|
5138
|
+
*/
|
|
5139
|
+
'id': string;
|
|
5140
|
+
/**
|
|
5141
|
+
* The name of the payment terminal
|
|
5142
|
+
* @type {string}
|
|
5143
|
+
* @memberof StripePaymentTerminalResponse
|
|
5144
|
+
*/
|
|
5145
|
+
'name': string;
|
|
5146
|
+
/**
|
|
5147
|
+
* When the terminal was last seen. If more than 1 minute ago, the terminal might be offline. If more than 5 minutes ago, it is definitely offline.
|
|
5148
|
+
* @type {string}
|
|
5149
|
+
* @memberof StripePaymentTerminalResponse
|
|
5150
|
+
*/
|
|
5151
|
+
'lastSeenAt': string;
|
|
5152
|
+
/**
|
|
5153
|
+
* Whether the terminal is available to start processing a payment
|
|
5154
|
+
* @type {boolean}
|
|
5155
|
+
* @memberof StripePaymentTerminalResponse
|
|
5156
|
+
*/
|
|
5157
|
+
'available': boolean;
|
|
5158
|
+
}
|
|
4899
5159
|
/**
|
|
4900
5160
|
*
|
|
4901
5161
|
* @export
|
|
@@ -5088,6 +5348,67 @@ export interface SubTransactionRowResponse {
|
|
|
5088
5348
|
*/
|
|
5089
5349
|
'totalPriceInclVat': DineroObjectResponse;
|
|
5090
5350
|
}
|
|
5351
|
+
/**
|
|
5352
|
+
*
|
|
5353
|
+
* @export
|
|
5354
|
+
* @interface TerminalPaymentResponse
|
|
5355
|
+
*/
|
|
5356
|
+
export interface TerminalPaymentResponse {
|
|
5357
|
+
/**
|
|
5358
|
+
* The unique id of the entity.
|
|
5359
|
+
* @type {number}
|
|
5360
|
+
* @memberof TerminalPaymentResponse
|
|
5361
|
+
*/
|
|
5362
|
+
'id': number;
|
|
5363
|
+
/**
|
|
5364
|
+
* The creation Date of the entity.
|
|
5365
|
+
* @type {string}
|
|
5366
|
+
* @memberof TerminalPaymentResponse
|
|
5367
|
+
*/
|
|
5368
|
+
'createdAt'?: string;
|
|
5369
|
+
/**
|
|
5370
|
+
* The last update Date of the entity.
|
|
5371
|
+
* @type {string}
|
|
5372
|
+
* @memberof TerminalPaymentResponse
|
|
5373
|
+
*/
|
|
5374
|
+
'updatedAt'?: string;
|
|
5375
|
+
/**
|
|
5376
|
+
* The version of the entity.
|
|
5377
|
+
* @type {number}
|
|
5378
|
+
* @memberof TerminalPaymentResponse
|
|
5379
|
+
*/
|
|
5380
|
+
'version'?: number;
|
|
5381
|
+
/**
|
|
5382
|
+
*
|
|
5383
|
+
* @type {TransactionResponse}
|
|
5384
|
+
* @memberof TerminalPaymentResponse
|
|
5385
|
+
*/
|
|
5386
|
+
'transaction'?: TransactionResponse;
|
|
5387
|
+
/**
|
|
5388
|
+
*
|
|
5389
|
+
* @type {TransferResponse}
|
|
5390
|
+
* @memberof TerminalPaymentResponse
|
|
5391
|
+
*/
|
|
5392
|
+
'transfer'?: TransferResponse;
|
|
5393
|
+
/**
|
|
5394
|
+
*
|
|
5395
|
+
* @type {BaseUserResponse}
|
|
5396
|
+
* @memberof TerminalPaymentResponse
|
|
5397
|
+
*/
|
|
5398
|
+
'createdBy': BaseUserResponse;
|
|
5399
|
+
/**
|
|
5400
|
+
* The state of the terminal payment. One of \'created\', \'processing\', \'paid\' or \'cancelled\'.
|
|
5401
|
+
* @type {string}
|
|
5402
|
+
* @memberof TerminalPaymentResponse
|
|
5403
|
+
*/
|
|
5404
|
+
'state': string;
|
|
5405
|
+
/**
|
|
5406
|
+
*
|
|
5407
|
+
* @type {DineroObjectResponse}
|
|
5408
|
+
* @memberof TerminalPaymentResponse
|
|
5409
|
+
*/
|
|
5410
|
+
'amount': DineroObjectResponse;
|
|
5411
|
+
}
|
|
5091
5412
|
/**
|
|
5092
5413
|
*
|
|
5093
5414
|
* @export
|
|
@@ -5100,6 +5421,12 @@ export interface TermsOfServiceResponse {
|
|
|
5100
5421
|
* @memberof TermsOfServiceResponse
|
|
5101
5422
|
*/
|
|
5102
5423
|
'versionNumber': string;
|
|
5424
|
+
/**
|
|
5425
|
+
* The date this version took effect.
|
|
5426
|
+
* @type {string}
|
|
5427
|
+
* @memberof TermsOfServiceResponse
|
|
5428
|
+
*/
|
|
5429
|
+
'date': string;
|
|
5103
5430
|
/**
|
|
5104
5431
|
* The terms of service content.
|
|
5105
5432
|
* @type {string}
|
|
@@ -5107,6 +5434,17 @@ export interface TermsOfServiceResponse {
|
|
|
5107
5434
|
*/
|
|
5108
5435
|
'content': string;
|
|
5109
5436
|
}
|
|
5437
|
+
/**
|
|
5438
|
+
* The terms of service status of a user
|
|
5439
|
+
* @export
|
|
5440
|
+
* @enum {string}
|
|
5441
|
+
*/
|
|
5442
|
+
export declare const TermsOfServiceStatus: {
|
|
5443
|
+
readonly Accepted: "ACCEPTED";
|
|
5444
|
+
readonly NotAccepted: "NOT_ACCEPTED";
|
|
5445
|
+
readonly NotRequired: "NOT_REQUIRED";
|
|
5446
|
+
};
|
|
5447
|
+
export type TermsOfServiceStatus = typeof TermsOfServiceStatus[keyof typeof TermsOfServiceStatus];
|
|
5110
5448
|
/**
|
|
5111
5449
|
*
|
|
5112
5450
|
* @export
|
|
@@ -5721,7 +6059,7 @@ export interface TransferSummaryResponse {
|
|
|
5721
6059
|
'manualDeletions': TransferAggregateResponse;
|
|
5722
6060
|
}
|
|
5723
6061
|
/**
|
|
5724
|
-
*
|
|
6062
|
+
* API Request for updating a `container` entity.
|
|
5725
6063
|
* @export
|
|
5726
6064
|
* @interface UpdateContainerRequest
|
|
5727
6065
|
*/
|
|
@@ -5971,7 +6309,7 @@ export interface UpdatePinRequest {
|
|
|
5971
6309
|
'pin': string;
|
|
5972
6310
|
}
|
|
5973
6311
|
/**
|
|
5974
|
-
*
|
|
6312
|
+
* API Request for updating a `point of sale` entity.
|
|
5975
6313
|
* @export
|
|
5976
6314
|
* @interface UpdatePointOfSaleRequest
|
|
5977
6315
|
*/
|
|
@@ -6008,7 +6346,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6008
6346
|
'cashierRoleIds'?: Array<number>;
|
|
6009
6347
|
}
|
|
6010
6348
|
/**
|
|
6011
|
-
*
|
|
6349
|
+
* API Request for updating a `product` entity.
|
|
6012
6350
|
* @export
|
|
6013
6351
|
* @interface UpdateProductRequest
|
|
6014
6352
|
*/
|
|
@@ -6173,9 +6511,21 @@ export interface UpdateUserRequest {
|
|
|
6173
6511
|
* @memberof UpdateUserRequest
|
|
6174
6512
|
*/
|
|
6175
6513
|
'inactiveNotificationSend'?: boolean;
|
|
6514
|
+
/**
|
|
6515
|
+
* ISO date at which the account expires; pass null to clear
|
|
6516
|
+
* @type {string}
|
|
6517
|
+
* @memberof UpdateUserRequest
|
|
6518
|
+
*/
|
|
6519
|
+
'expiryDate'?: string | null;
|
|
6520
|
+
/**
|
|
6521
|
+
* Whether organ members can manage this organ\'s products and containers without BAC/GEWIS PM. Only meaningful for organ users.
|
|
6522
|
+
* @type {boolean}
|
|
6523
|
+
* @memberof UpdateUserRequest
|
|
6524
|
+
*/
|
|
6525
|
+
'productSelfService'?: boolean;
|
|
6176
6526
|
}
|
|
6177
6527
|
/**
|
|
6178
|
-
*
|
|
6528
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6179
6529
|
* @export
|
|
6180
6530
|
* @interface UpdateVatGroupRequest
|
|
6181
6531
|
*/
|
|
@@ -6348,11 +6698,17 @@ export interface UserResponse {
|
|
|
6348
6698
|
*/
|
|
6349
6699
|
'email'?: string;
|
|
6350
6700
|
/**
|
|
6351
|
-
* Whether this user
|
|
6352
|
-
* @type {
|
|
6701
|
+
* Whether this user is required to accept the TOS
|
|
6702
|
+
* @type {boolean}
|
|
6703
|
+
* @memberof UserResponse
|
|
6704
|
+
*/
|
|
6705
|
+
'tosRequired'?: boolean;
|
|
6706
|
+
/**
|
|
6707
|
+
*
|
|
6708
|
+
* @type {TermsOfServiceStatus}
|
|
6353
6709
|
* @memberof UserResponse
|
|
6354
6710
|
*/
|
|
6355
|
-
'acceptedToS'?:
|
|
6711
|
+
'acceptedToS'?: TermsOfServiceStatus;
|
|
6356
6712
|
/**
|
|
6357
6713
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6358
6714
|
* @type {boolean}
|
|
@@ -6389,6 +6745,12 @@ export interface UserResponse {
|
|
|
6389
6745
|
* @memberof UserResponse
|
|
6390
6746
|
*/
|
|
6391
6747
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6748
|
+
/**
|
|
6749
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6750
|
+
* @type {string}
|
|
6751
|
+
* @memberof UserResponse
|
|
6752
|
+
*/
|
|
6753
|
+
'expiryDate'?: string | null;
|
|
6392
6754
|
}
|
|
6393
6755
|
/**
|
|
6394
6756
|
*
|
|
@@ -6495,6 +6857,50 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6495
6857
|
*/
|
|
6496
6858
|
'nickname'?: string;
|
|
6497
6859
|
}
|
|
6860
|
+
/**
|
|
6861
|
+
*
|
|
6862
|
+
* @export
|
|
6863
|
+
* @interface UserTosAcceptanceResponse
|
|
6864
|
+
*/
|
|
6865
|
+
export interface UserTosAcceptanceResponse {
|
|
6866
|
+
/**
|
|
6867
|
+
* The accepted terms of service version number.
|
|
6868
|
+
* @type {string}
|
|
6869
|
+
* @memberof UserTosAcceptanceResponse
|
|
6870
|
+
*/
|
|
6871
|
+
'versionNumber': string;
|
|
6872
|
+
/**
|
|
6873
|
+
* The date at which this version was accepted.
|
|
6874
|
+
* @type {string}
|
|
6875
|
+
* @memberof UserTosAcceptanceResponse
|
|
6876
|
+
*/
|
|
6877
|
+
'acceptedAt': string;
|
|
6878
|
+
}
|
|
6879
|
+
/**
|
|
6880
|
+
*
|
|
6881
|
+
* @export
|
|
6882
|
+
* @interface UserTosResponse
|
|
6883
|
+
*/
|
|
6884
|
+
export interface UserTosResponse {
|
|
6885
|
+
/**
|
|
6886
|
+
*
|
|
6887
|
+
* @type {TermsOfServiceStatus}
|
|
6888
|
+
* @memberof UserTosResponse
|
|
6889
|
+
*/
|
|
6890
|
+
'status': TermsOfServiceStatus;
|
|
6891
|
+
/**
|
|
6892
|
+
* The current terms of service version number.
|
|
6893
|
+
* @type {string}
|
|
6894
|
+
* @memberof UserTosResponse
|
|
6895
|
+
*/
|
|
6896
|
+
'currentVersion': string;
|
|
6897
|
+
/**
|
|
6898
|
+
* All TOS versions the user has accepted.
|
|
6899
|
+
* @type {Array<UserTosAcceptanceResponse>}
|
|
6900
|
+
* @memberof UserTosResponse
|
|
6901
|
+
*/
|
|
6902
|
+
'acceptances': Array<UserTosAcceptanceResponse>;
|
|
6903
|
+
}
|
|
6498
6904
|
/**
|
|
6499
6905
|
* The type of a user
|
|
6500
6906
|
* @export
|
|
@@ -6537,7 +6943,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6537
6943
|
'totalNegative': DineroObjectResponse;
|
|
6538
6944
|
}
|
|
6539
6945
|
/**
|
|
6540
|
-
*
|
|
6946
|
+
* 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
6947
|
* @export
|
|
6542
6948
|
* @interface UserWithIndex
|
|
6543
6949
|
*/
|
|
@@ -6569,7 +6975,7 @@ export interface ValidationResponse {
|
|
|
6569
6975
|
'errors': Array<string>;
|
|
6570
6976
|
}
|
|
6571
6977
|
/**
|
|
6572
|
-
*
|
|
6978
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6573
6979
|
* @export
|
|
6574
6980
|
* @interface VatDeclarationResponse
|
|
6575
6981
|
*/
|
|
@@ -6594,7 +7000,7 @@ export interface VatDeclarationResponse {
|
|
|
6594
7000
|
'rows': Array<VatDeclarationRow>;
|
|
6595
7001
|
}
|
|
6596
7002
|
/**
|
|
6597
|
-
*
|
|
7003
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6598
7004
|
* @export
|
|
6599
7005
|
* @interface VatDeclarationRow
|
|
6600
7006
|
*/
|
|
@@ -7062,10 +7468,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7062
7468
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7063
7469
|
/**
|
|
7064
7470
|
*
|
|
7065
|
-
* @summary EAN
|
|
7066
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7471
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7472
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7067
7473
|
* @param {*} [options] Override http request option.
|
|
7068
|
-
* @deprecated
|
|
7069
7474
|
* @throws {RequiredError}
|
|
7070
7475
|
*/
|
|
7071
7476
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7140,13 +7545,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7140
7545
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7141
7546
|
/**
|
|
7142
7547
|
*
|
|
7143
|
-
* @summary PIN
|
|
7144
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7548
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7549
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7145
7550
|
* @param {*} [options] Override http request option.
|
|
7146
|
-
* @deprecated
|
|
7147
7551
|
* @throws {RequiredError}
|
|
7148
7552
|
*/
|
|
7149
|
-
|
|
7553
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7150
7554
|
/**
|
|
7151
7555
|
*
|
|
7152
7556
|
* @summary Mock login and hand out token.
|
|
@@ -7157,19 +7561,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7157
7561
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7158
7562
|
/**
|
|
7159
7563
|
*
|
|
7160
|
-
* @summary NFC
|
|
7161
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7564
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7565
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7162
7566
|
* @param {*} [options] Override http request option.
|
|
7163
|
-
* @deprecated
|
|
7164
7567
|
* @throws {RequiredError}
|
|
7165
7568
|
*/
|
|
7166
7569
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
7570
|
/**
|
|
7168
7571
|
*
|
|
7169
|
-
* @summary PIN
|
|
7170
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7572
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7573
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7171
7574
|
* @param {*} [options] Override http request option.
|
|
7172
|
-
* @deprecated
|
|
7173
7575
|
* @throws {RequiredError}
|
|
7174
7576
|
*/
|
|
7175
7577
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7196,38 +7598,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7196
7598
|
* @throws {RequiredError}
|
|
7197
7599
|
*/
|
|
7198
7600
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7199
|
-
/**
|
|
7200
|
-
*
|
|
7201
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7202
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7203
|
-
* @param {*} [options] Override http request option.
|
|
7204
|
-
* @throws {RequiredError}
|
|
7205
|
-
*/
|
|
7206
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7207
|
-
/**
|
|
7208
|
-
*
|
|
7209
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7210
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7211
|
-
* @param {*} [options] Override http request option.
|
|
7212
|
-
* @throws {RequiredError}
|
|
7213
|
-
*/
|
|
7214
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7215
|
-
/**
|
|
7216
|
-
*
|
|
7217
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7218
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7219
|
-
* @param {*} [options] Override http request option.
|
|
7220
|
-
* @throws {RequiredError}
|
|
7221
|
-
*/
|
|
7222
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7223
|
-
/**
|
|
7224
|
-
*
|
|
7225
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7226
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7227
|
-
* @param {*} [options] Override http request option.
|
|
7228
|
-
* @throws {RequiredError}
|
|
7229
|
-
*/
|
|
7230
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7231
7601
|
};
|
|
7232
7602
|
/**
|
|
7233
7603
|
* AuthenticateApi - functional programming interface
|
|
@@ -7260,10 +7630,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7260
7630
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7261
7631
|
/**
|
|
7262
7632
|
*
|
|
7263
|
-
* @summary EAN
|
|
7264
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7633
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7634
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7265
7635
|
* @param {*} [options] Override http request option.
|
|
7266
|
-
* @deprecated
|
|
7267
7636
|
* @throws {RequiredError}
|
|
7268
7637
|
*/
|
|
7269
7638
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7338,13 +7707,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7338
7707
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7339
7708
|
/**
|
|
7340
7709
|
*
|
|
7341
|
-
* @summary PIN
|
|
7342
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7710
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7711
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7343
7712
|
* @param {*} [options] Override http request option.
|
|
7344
|
-
* @deprecated
|
|
7345
7713
|
* @throws {RequiredError}
|
|
7346
7714
|
*/
|
|
7347
|
-
|
|
7715
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7348
7716
|
/**
|
|
7349
7717
|
*
|
|
7350
7718
|
* @summary Mock login and hand out token.
|
|
@@ -7355,19 +7723,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7355
7723
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7356
7724
|
/**
|
|
7357
7725
|
*
|
|
7358
|
-
* @summary NFC
|
|
7359
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7726
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7727
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7360
7728
|
* @param {*} [options] Override http request option.
|
|
7361
|
-
* @deprecated
|
|
7362
7729
|
* @throws {RequiredError}
|
|
7363
7730
|
*/
|
|
7364
7731
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7365
7732
|
/**
|
|
7366
7733
|
*
|
|
7367
|
-
* @summary PIN
|
|
7368
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7734
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7735
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7369
7736
|
* @param {*} [options] Override http request option.
|
|
7370
|
-
* @deprecated
|
|
7371
7737
|
* @throws {RequiredError}
|
|
7372
7738
|
*/
|
|
7373
7739
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7394,38 +7760,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7394
7760
|
* @throws {RequiredError}
|
|
7395
7761
|
*/
|
|
7396
7762
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7397
|
-
/**
|
|
7398
|
-
*
|
|
7399
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7400
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7401
|
-
* @param {*} [options] Override http request option.
|
|
7402
|
-
* @throws {RequiredError}
|
|
7403
|
-
*/
|
|
7404
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7405
|
-
/**
|
|
7406
|
-
*
|
|
7407
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7408
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7409
|
-
* @param {*} [options] Override http request option.
|
|
7410
|
-
* @throws {RequiredError}
|
|
7411
|
-
*/
|
|
7412
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7413
|
-
/**
|
|
7414
|
-
*
|
|
7415
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7416
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7417
|
-
* @param {*} [options] Override http request option.
|
|
7418
|
-
* @throws {RequiredError}
|
|
7419
|
-
*/
|
|
7420
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7421
|
-
/**
|
|
7422
|
-
*
|
|
7423
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7424
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7425
|
-
* @param {*} [options] Override http request option.
|
|
7426
|
-
* @throws {RequiredError}
|
|
7427
|
-
*/
|
|
7428
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7429
7763
|
};
|
|
7430
7764
|
/**
|
|
7431
7765
|
* AuthenticateApi - factory interface
|
|
@@ -7458,10 +7792,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7458
7792
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
7793
|
/**
|
|
7460
7794
|
*
|
|
7461
|
-
* @summary EAN
|
|
7795
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7462
7796
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7463
7797
|
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @deprecated
|
|
7465
7798
|
* @throws {RequiredError}
|
|
7466
7799
|
*/
|
|
7467
7800
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7536,13 +7869,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7536
7869
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7537
7870
|
/**
|
|
7538
7871
|
*
|
|
7539
|
-
* @summary PIN
|
|
7540
|
-
* @param {
|
|
7872
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7873
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7541
7874
|
* @param {*} [options] Override http request option.
|
|
7542
|
-
* @deprecated
|
|
7543
7875
|
* @throws {RequiredError}
|
|
7544
7876
|
*/
|
|
7545
|
-
|
|
7877
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7546
7878
|
/**
|
|
7547
7879
|
*
|
|
7548
7880
|
* @summary Mock login and hand out token.
|
|
@@ -7553,19 +7885,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7553
7885
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7554
7886
|
/**
|
|
7555
7887
|
*
|
|
7556
|
-
* @summary NFC
|
|
7888
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7557
7889
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7558
7890
|
* @param {*} [options] Override http request option.
|
|
7559
|
-
* @deprecated
|
|
7560
7891
|
* @throws {RequiredError}
|
|
7561
7892
|
*/
|
|
7562
7893
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7563
7894
|
/**
|
|
7564
7895
|
*
|
|
7565
|
-
* @summary PIN
|
|
7896
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7566
7897
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7567
7898
|
* @param {*} [options] Override http request option.
|
|
7568
|
-
* @deprecated
|
|
7569
7899
|
* @throws {RequiredError}
|
|
7570
7900
|
*/
|
|
7571
7901
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7592,38 +7922,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7592
7922
|
* @throws {RequiredError}
|
|
7593
7923
|
*/
|
|
7594
7924
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7595
|
-
/**
|
|
7596
|
-
*
|
|
7597
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7598
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7599
|
-
* @param {*} [options] Override http request option.
|
|
7600
|
-
* @throws {RequiredError}
|
|
7601
|
-
*/
|
|
7602
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7603
|
-
/**
|
|
7604
|
-
*
|
|
7605
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7606
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7607
|
-
* @param {*} [options] Override http request option.
|
|
7608
|
-
* @throws {RequiredError}
|
|
7609
|
-
*/
|
|
7610
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7611
|
-
/**
|
|
7612
|
-
*
|
|
7613
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7614
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7615
|
-
* @param {*} [options] Override http request option.
|
|
7616
|
-
* @throws {RequiredError}
|
|
7617
|
-
*/
|
|
7618
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7619
|
-
/**
|
|
7620
|
-
*
|
|
7621
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7622
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7623
|
-
* @param {*} [options] Override http request option.
|
|
7624
|
-
* @throws {RequiredError}
|
|
7625
|
-
*/
|
|
7626
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7627
7925
|
};
|
|
7628
7926
|
/**
|
|
7629
7927
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7671,7 +7969,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7671
7969
|
*/
|
|
7672
7970
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7673
7971
|
/**
|
|
7674
|
-
* The EAN login
|
|
7972
|
+
* The EAN login request with posId
|
|
7675
7973
|
* @type {AuthenticationEanRequest}
|
|
7676
7974
|
* @memberof AuthenticateApiEanAuthentication
|
|
7677
7975
|
*/
|
|
@@ -7756,15 +8054,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7756
8054
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7757
8055
|
}
|
|
7758
8056
|
/**
|
|
7759
|
-
* Request parameters for
|
|
8057
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7760
8058
|
* @export
|
|
7761
|
-
* @interface
|
|
8059
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7762
8060
|
*/
|
|
7763
|
-
export interface
|
|
8061
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7764
8062
|
/**
|
|
7765
|
-
* The PIN login
|
|
8063
|
+
* The PIN login request with posId
|
|
7766
8064
|
* @type {MemberAuthenticationPinRequest}
|
|
7767
|
-
* @memberof
|
|
8065
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7768
8066
|
*/
|
|
7769
8067
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7770
8068
|
}
|
|
@@ -7788,7 +8086,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7788
8086
|
*/
|
|
7789
8087
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7790
8088
|
/**
|
|
7791
|
-
* The NFC login
|
|
8089
|
+
* The NFC login request with posId
|
|
7792
8090
|
* @type {AuthenticationNfcRequest}
|
|
7793
8091
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7794
8092
|
*/
|
|
@@ -7801,7 +8099,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7801
8099
|
*/
|
|
7802
8100
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7803
8101
|
/**
|
|
7804
|
-
* The PIN login
|
|
8102
|
+
* The PIN login request with posId
|
|
7805
8103
|
* @type {AuthenticationPinRequest}
|
|
7806
8104
|
* @memberof AuthenticateApiPinAuthentication
|
|
7807
8105
|
*/
|
|
@@ -7834,71 +8132,19 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7834
8132
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7835
8133
|
}
|
|
7836
8134
|
/**
|
|
7837
|
-
*
|
|
8135
|
+
* AuthenticateApi - object-oriented interface
|
|
7838
8136
|
* @export
|
|
7839
|
-
* @
|
|
8137
|
+
* @class AuthenticateApi
|
|
8138
|
+
* @extends {BaseAPI}
|
|
7840
8139
|
*/
|
|
7841
|
-
export
|
|
8140
|
+
export declare class AuthenticateApi extends BaseAPI {
|
|
7842
8141
|
/**
|
|
7843
|
-
*
|
|
7844
|
-
* @
|
|
7845
|
-
* @
|
|
7846
|
-
|
|
7847
|
-
|
|
7848
|
-
|
|
7849
|
-
/**
|
|
7850
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7851
|
-
* @export
|
|
7852
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7853
|
-
*/
|
|
7854
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7855
|
-
/**
|
|
7856
|
-
* The PIN login request with posId
|
|
7857
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7858
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7859
|
-
*/
|
|
7860
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7861
|
-
}
|
|
7862
|
-
/**
|
|
7863
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7864
|
-
* @export
|
|
7865
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7866
|
-
*/
|
|
7867
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7868
|
-
/**
|
|
7869
|
-
* The NFC login request with posId
|
|
7870
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7871
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7872
|
-
*/
|
|
7873
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7874
|
-
}
|
|
7875
|
-
/**
|
|
7876
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7877
|
-
* @export
|
|
7878
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7879
|
-
*/
|
|
7880
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7881
|
-
/**
|
|
7882
|
-
* The PIN login request with posId
|
|
7883
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7884
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7885
|
-
*/
|
|
7886
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7887
|
-
}
|
|
7888
|
-
/**
|
|
7889
|
-
* AuthenticateApi - object-oriented interface
|
|
7890
|
-
* @export
|
|
7891
|
-
* @class AuthenticateApi
|
|
7892
|
-
* @extends {BaseAPI}
|
|
7893
|
-
*/
|
|
7894
|
-
export declare class AuthenticateApi extends BaseAPI {
|
|
7895
|
-
/**
|
|
7896
|
-
*
|
|
7897
|
-
* @summary Get a JWT token for the given POS
|
|
7898
|
-
* @param {AuthenticateApiAuthenticatePointOfSaleRequest} requestParameters Request parameters.
|
|
7899
|
-
* @param {*} [options] Override http request option.
|
|
7900
|
-
* @throws {RequiredError}
|
|
7901
|
-
* @memberof AuthenticateApi
|
|
8142
|
+
*
|
|
8143
|
+
* @summary Get a JWT token for the given POS
|
|
8144
|
+
* @param {AuthenticateApiAuthenticatePointOfSaleRequest} requestParameters Request parameters.
|
|
8145
|
+
* @param {*} [options] Override http request option.
|
|
8146
|
+
* @throws {RequiredError}
|
|
8147
|
+
* @memberof AuthenticateApi
|
|
7902
8148
|
*/
|
|
7903
8149
|
authenticatePointOfSale(requestParameters: AuthenticateApiAuthenticatePointOfSaleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7904
8150
|
/**
|
|
@@ -7921,10 +8167,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7921
8167
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7922
8168
|
/**
|
|
7923
8169
|
*
|
|
7924
|
-
* @summary EAN
|
|
8170
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7925
8171
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7926
8172
|
* @param {*} [options] Override http request option.
|
|
7927
|
-
* @deprecated
|
|
7928
8173
|
* @throws {RequiredError}
|
|
7929
8174
|
* @memberof AuthenticateApi
|
|
7930
8175
|
*/
|
|
@@ -8009,14 +8254,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8009
8254
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8010
8255
|
/**
|
|
8011
8256
|
*
|
|
8012
|
-
* @summary PIN
|
|
8013
|
-
* @param {
|
|
8257
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8258
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8014
8259
|
* @param {*} [options] Override http request option.
|
|
8015
|
-
* @deprecated
|
|
8016
8260
|
* @throws {RequiredError}
|
|
8017
8261
|
* @memberof AuthenticateApi
|
|
8018
8262
|
*/
|
|
8019
|
-
|
|
8263
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8020
8264
|
/**
|
|
8021
8265
|
*
|
|
8022
8266
|
* @summary Mock login and hand out token.
|
|
@@ -8028,20 +8272,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8028
8272
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8029
8273
|
/**
|
|
8030
8274
|
*
|
|
8031
|
-
* @summary NFC
|
|
8275
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8032
8276
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8033
8277
|
* @param {*} [options] Override http request option.
|
|
8034
|
-
* @deprecated
|
|
8035
8278
|
* @throws {RequiredError}
|
|
8036
8279
|
* @memberof AuthenticateApi
|
|
8037
8280
|
*/
|
|
8038
8281
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8039
8282
|
/**
|
|
8040
8283
|
*
|
|
8041
|
-
* @summary PIN
|
|
8284
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8042
8285
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8043
8286
|
* @param {*} [options] Override http request option.
|
|
8044
|
-
* @deprecated
|
|
8045
8287
|
* @throws {RequiredError}
|
|
8046
8288
|
* @memberof AuthenticateApi
|
|
8047
8289
|
*/
|
|
@@ -8072,42 +8314,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8072
8314
|
* @memberof AuthenticateApi
|
|
8073
8315
|
*/
|
|
8074
8316
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8075
|
-
/**
|
|
8076
|
-
*
|
|
8077
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
8078
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
8079
|
-
* @param {*} [options] Override http request option.
|
|
8080
|
-
* @throws {RequiredError}
|
|
8081
|
-
* @memberof AuthenticateApi
|
|
8082
|
-
*/
|
|
8083
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8084
|
-
/**
|
|
8085
|
-
*
|
|
8086
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
8087
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8088
|
-
* @param {*} [options] Override http request option.
|
|
8089
|
-
* @throws {RequiredError}
|
|
8090
|
-
* @memberof AuthenticateApi
|
|
8091
|
-
*/
|
|
8092
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8093
|
-
/**
|
|
8094
|
-
*
|
|
8095
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
8096
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8097
|
-
* @param {*} [options] Override http request option.
|
|
8098
|
-
* @throws {RequiredError}
|
|
8099
|
-
* @memberof AuthenticateApi
|
|
8100
|
-
*/
|
|
8101
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8102
|
-
/**
|
|
8103
|
-
*
|
|
8104
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
8105
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
8106
|
-
* @param {*} [options] Override http request option.
|
|
8107
|
-
* @throws {RequiredError}
|
|
8108
|
-
* @memberof AuthenticateApi
|
|
8109
|
-
*/
|
|
8110
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8111
8317
|
}
|
|
8112
8318
|
/**
|
|
8113
8319
|
* BalanceApi - axios parameter creator
|
|
@@ -10826,7 +11032,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10826
11032
|
* @param {*} [options] Override http request option.
|
|
10827
11033
|
* @throws {RequiredError}
|
|
10828
11034
|
*/
|
|
10829
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11035
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10830
11036
|
/**
|
|
10831
11037
|
*
|
|
10832
11038
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10904,7 +11110,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10904
11110
|
* @param {*} [options] Override http request option.
|
|
10905
11111
|
* @throws {RequiredError}
|
|
10906
11112
|
*/
|
|
10907
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11113
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10908
11114
|
/**
|
|
10909
11115
|
*
|
|
10910
11116
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11127,7 +11333,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11127
11333
|
* @throws {RequiredError}
|
|
11128
11334
|
* @memberof InactiveAdministrativeCostsApi
|
|
11129
11335
|
*/
|
|
11130
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11336
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11131
11337
|
/**
|
|
11132
11338
|
*
|
|
11133
11339
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11299,7 +11505,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11299
11505
|
* @param {*} [options] Override http request option.
|
|
11300
11506
|
* @throws {RequiredError}
|
|
11301
11507
|
*/
|
|
11302
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11508
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11303
11509
|
/**
|
|
11304
11510
|
*
|
|
11305
11511
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11315,7 +11521,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11315
11521
|
* @param {*} [options] Override http request option.
|
|
11316
11522
|
* @throws {RequiredError}
|
|
11317
11523
|
*/
|
|
11318
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11524
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11319
11525
|
/**
|
|
11320
11526
|
*
|
|
11321
11527
|
* @summary Returns a single invoice in the system.
|
|
@@ -11396,7 +11602,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11396
11602
|
* @param {*} [options] Override http request option.
|
|
11397
11603
|
* @throws {RequiredError}
|
|
11398
11604
|
*/
|
|
11399
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11605
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11400
11606
|
/**
|
|
11401
11607
|
*
|
|
11402
11608
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11411,7 +11617,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11411
11617
|
* @param {*} [options] Override http request option.
|
|
11412
11618
|
* @throws {RequiredError}
|
|
11413
11619
|
*/
|
|
11414
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11620
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11415
11621
|
/**
|
|
11416
11622
|
*
|
|
11417
11623
|
* @summary Returns a single invoice in the system.
|
|
@@ -11710,7 +11916,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11710
11916
|
* @throws {RequiredError}
|
|
11711
11917
|
* @memberof InvoicesApi
|
|
11712
11918
|
*/
|
|
11713
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11919
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11714
11920
|
/**
|
|
11715
11921
|
*
|
|
11716
11922
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11727,7 +11933,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11727
11933
|
* @throws {RequiredError}
|
|
11728
11934
|
* @memberof InvoicesApi
|
|
11729
11935
|
*/
|
|
11730
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11936
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11731
11937
|
/**
|
|
11732
11938
|
*
|
|
11733
11939
|
* @summary Returns a single invoice in the system.
|
|
@@ -11766,324 +11972,810 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11766
11972
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11767
11973
|
}
|
|
11768
11974
|
/**
|
|
11769
|
-
*
|
|
11975
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11770
11976
|
* @export
|
|
11771
11977
|
*/
|
|
11772
|
-
export declare const
|
|
11978
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11773
11979
|
/**
|
|
11774
11980
|
*
|
|
11775
|
-
* @summary
|
|
11776
|
-
* @param {
|
|
11981
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11982
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11777
11983
|
* @param {*} [options] Override http request option.
|
|
11778
11984
|
* @throws {RequiredError}
|
|
11779
11985
|
*/
|
|
11780
|
-
|
|
11986
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11781
11987
|
/**
|
|
11782
11988
|
*
|
|
11783
|
-
* @summary
|
|
11784
|
-
* @param {
|
|
11785
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11786
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11787
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11788
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11789
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11790
|
-
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
11989
|
+
* @summary Create a new PaymentRequest.
|
|
11990
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11791
11991
|
* @param {*} [options] Override http request option.
|
|
11792
11992
|
* @throws {RequiredError}
|
|
11793
11993
|
*/
|
|
11794
|
-
|
|
11994
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11795
11995
|
/**
|
|
11796
11996
|
*
|
|
11797
|
-
* @summary
|
|
11798
|
-
* @param {number}
|
|
11799
|
-
* @param {
|
|
11997
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11998
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11999
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
12000
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
12001
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
12002
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
12003
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
12004
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11800
12005
|
* @param {*} [options] Override http request option.
|
|
11801
12006
|
* @throws {RequiredError}
|
|
11802
12007
|
*/
|
|
11803
|
-
|
|
12008
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11804
12009
|
/**
|
|
11805
12010
|
*
|
|
11806
|
-
* @summary
|
|
11807
|
-
* @param {
|
|
12011
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12012
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11808
12013
|
* @param {*} [options] Override http request option.
|
|
11809
12014
|
* @throws {RequiredError}
|
|
11810
12015
|
*/
|
|
11811
|
-
|
|
12016
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11812
12017
|
/**
|
|
11813
12018
|
*
|
|
11814
|
-
* @summary
|
|
11815
|
-
* @param {
|
|
11816
|
-
* @param {
|
|
12019
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12020
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12021
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11817
12022
|
* @param {*} [options] Override http request option.
|
|
11818
12023
|
* @throws {RequiredError}
|
|
11819
12024
|
*/
|
|
11820
|
-
|
|
12025
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12026
|
+
/**
|
|
12027
|
+
*
|
|
12028
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12029
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12030
|
+
* @param {*} [options] Override http request option.
|
|
12031
|
+
* @throws {RequiredError}
|
|
12032
|
+
*/
|
|
12033
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11821
12034
|
};
|
|
11822
12035
|
/**
|
|
11823
|
-
*
|
|
12036
|
+
* PaymentRequestsApi - functional programming interface
|
|
11824
12037
|
* @export
|
|
11825
12038
|
*/
|
|
11826
|
-
export declare const
|
|
12039
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11827
12040
|
/**
|
|
11828
12041
|
*
|
|
11829
|
-
* @summary
|
|
11830
|
-
* @param {
|
|
12042
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12043
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11831
12044
|
* @param {*} [options] Override http request option.
|
|
11832
12045
|
* @throws {RequiredError}
|
|
11833
12046
|
*/
|
|
11834
|
-
|
|
12047
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11835
12048
|
/**
|
|
11836
12049
|
*
|
|
11837
|
-
* @summary
|
|
11838
|
-
* @param {
|
|
11839
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11840
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11841
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11842
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11843
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11844
|
-
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12050
|
+
* @summary Create a new PaymentRequest.
|
|
12051
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11845
12052
|
* @param {*} [options] Override http request option.
|
|
11846
12053
|
* @throws {RequiredError}
|
|
11847
12054
|
*/
|
|
11848
|
-
|
|
12055
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11849
12056
|
/**
|
|
11850
12057
|
*
|
|
11851
|
-
* @summary
|
|
11852
|
-
* @param {number}
|
|
11853
|
-
* @param {
|
|
12058
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12059
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
12060
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
12061
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
12062
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
12063
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
12064
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
12065
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11854
12066
|
* @param {*} [options] Override http request option.
|
|
11855
12067
|
* @throws {RequiredError}
|
|
11856
12068
|
*/
|
|
11857
|
-
|
|
12069
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11858
12070
|
/**
|
|
11859
12071
|
*
|
|
11860
|
-
* @summary
|
|
11861
|
-
* @param {
|
|
12072
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12073
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11862
12074
|
* @param {*} [options] Override http request option.
|
|
11863
12075
|
* @throws {RequiredError}
|
|
11864
12076
|
*/
|
|
11865
|
-
|
|
12077
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11866
12078
|
/**
|
|
11867
12079
|
*
|
|
11868
|
-
* @summary
|
|
11869
|
-
* @param {
|
|
11870
|
-
* @param {
|
|
12080
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12081
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12082
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11871
12083
|
* @param {*} [options] Override http request option.
|
|
11872
12084
|
* @throws {RequiredError}
|
|
11873
12085
|
*/
|
|
11874
|
-
|
|
12086
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12087
|
+
/**
|
|
12088
|
+
*
|
|
12089
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12090
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12091
|
+
* @param {*} [options] Override http request option.
|
|
12092
|
+
* @throws {RequiredError}
|
|
12093
|
+
*/
|
|
12094
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11875
12095
|
};
|
|
11876
12096
|
/**
|
|
11877
|
-
*
|
|
12097
|
+
* PaymentRequestsApi - factory interface
|
|
11878
12098
|
* @export
|
|
11879
12099
|
*/
|
|
11880
|
-
export declare const
|
|
12100
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11881
12101
|
/**
|
|
11882
12102
|
*
|
|
11883
|
-
* @summary
|
|
11884
|
-
* @param {
|
|
12103
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12104
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11885
12105
|
* @param {*} [options] Override http request option.
|
|
11886
12106
|
* @throws {RequiredError}
|
|
11887
12107
|
*/
|
|
11888
|
-
|
|
12108
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11889
12109
|
/**
|
|
11890
12110
|
*
|
|
11891
|
-
* @summary
|
|
11892
|
-
* @param {
|
|
12111
|
+
* @summary Create a new PaymentRequest.
|
|
12112
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11893
12113
|
* @param {*} [options] Override http request option.
|
|
11894
12114
|
* @throws {RequiredError}
|
|
11895
12115
|
*/
|
|
11896
|
-
|
|
12116
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11897
12117
|
/**
|
|
11898
12118
|
*
|
|
11899
|
-
* @summary
|
|
11900
|
-
* @param {
|
|
12119
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12120
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11901
12121
|
* @param {*} [options] Override http request option.
|
|
11902
12122
|
* @throws {RequiredError}
|
|
11903
12123
|
*/
|
|
11904
|
-
|
|
12124
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11905
12125
|
/**
|
|
11906
12126
|
*
|
|
11907
|
-
* @summary
|
|
11908
|
-
* @param {
|
|
12127
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12128
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11909
12129
|
* @param {*} [options] Override http request option.
|
|
11910
12130
|
* @throws {RequiredError}
|
|
11911
12131
|
*/
|
|
11912
|
-
|
|
12132
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11913
12133
|
/**
|
|
11914
12134
|
*
|
|
11915
|
-
* @summary
|
|
11916
|
-
* @param {
|
|
12135
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12136
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11917
12137
|
* @param {*} [options] Override http request option.
|
|
11918
12138
|
* @throws {RequiredError}
|
|
11919
12139
|
*/
|
|
11920
|
-
|
|
12140
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12141
|
+
/**
|
|
12142
|
+
*
|
|
12143
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12144
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12145
|
+
* @param {*} [options] Override http request option.
|
|
12146
|
+
* @throws {RequiredError}
|
|
12147
|
+
*/
|
|
12148
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11921
12149
|
};
|
|
11922
12150
|
/**
|
|
11923
|
-
* Request parameters for
|
|
12151
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11924
12152
|
* @export
|
|
11925
|
-
* @interface
|
|
12153
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11926
12154
|
*/
|
|
11927
|
-
export interface
|
|
12155
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11928
12156
|
/**
|
|
11929
|
-
*
|
|
11930
|
-
* @type {
|
|
11931
|
-
* @memberof
|
|
12157
|
+
* UUID v4 of the payment request.
|
|
12158
|
+
* @type {string}
|
|
12159
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11932
12160
|
*/
|
|
11933
|
-
readonly
|
|
12161
|
+
readonly id: string;
|
|
11934
12162
|
}
|
|
11935
12163
|
/**
|
|
11936
|
-
* Request parameters for
|
|
12164
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11937
12165
|
* @export
|
|
11938
|
-
* @interface
|
|
12166
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11939
12167
|
*/
|
|
11940
|
-
export interface
|
|
12168
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11941
12169
|
/**
|
|
11942
|
-
*
|
|
11943
|
-
* @type {
|
|
11944
|
-
* @memberof
|
|
12170
|
+
* The request to create
|
|
12171
|
+
* @type {CreatePaymentRequestRequest}
|
|
12172
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11945
12173
|
*/
|
|
11946
|
-
readonly
|
|
12174
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
12175
|
+
}
|
|
12176
|
+
/**
|
|
12177
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
12178
|
+
* @export
|
|
12179
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
12180
|
+
*/
|
|
12181
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11947
12182
|
/**
|
|
11948
|
-
*
|
|
11949
|
-
* @type {
|
|
11950
|
-
* @memberof
|
|
12183
|
+
* Filter by beneficiary user id.
|
|
12184
|
+
* @type {number}
|
|
12185
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11951
12186
|
*/
|
|
11952
|
-
readonly
|
|
12187
|
+
readonly forId?: number;
|
|
11953
12188
|
/**
|
|
11954
|
-
*
|
|
11955
|
-
* @type {
|
|
11956
|
-
* @memberof
|
|
12189
|
+
* Filter by creator user id.
|
|
12190
|
+
* @type {number}
|
|
12191
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11957
12192
|
*/
|
|
11958
|
-
readonly
|
|
12193
|
+
readonly createdById?: number;
|
|
11959
12194
|
/**
|
|
11960
|
-
*
|
|
12195
|
+
* Comma-separated list of derived statuses.
|
|
12196
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12197
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12198
|
+
*/
|
|
12199
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12200
|
+
/**
|
|
12201
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
11961
12202
|
* @type {string}
|
|
11962
|
-
* @memberof
|
|
12203
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11963
12204
|
*/
|
|
11964
|
-
readonly
|
|
12205
|
+
readonly fromDate?: string;
|
|
11965
12206
|
/**
|
|
11966
|
-
*
|
|
12207
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
11967
12208
|
* @type {string}
|
|
11968
|
-
* @memberof
|
|
12209
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11969
12210
|
*/
|
|
11970
|
-
readonly
|
|
12211
|
+
readonly tillDate?: string;
|
|
11971
12212
|
/**
|
|
11972
|
-
* How many
|
|
12213
|
+
* How many rows the endpoint should return
|
|
11973
12214
|
* @type {number}
|
|
11974
|
-
* @memberof
|
|
12215
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11975
12216
|
*/
|
|
11976
12217
|
readonly take?: number;
|
|
11977
12218
|
/**
|
|
11978
|
-
* How many
|
|
12219
|
+
* How many rows to skip (for pagination)
|
|
11979
12220
|
* @type {number}
|
|
11980
|
-
* @memberof
|
|
12221
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11981
12222
|
*/
|
|
11982
12223
|
readonly skip?: number;
|
|
11983
12224
|
}
|
|
11984
12225
|
/**
|
|
11985
|
-
* Request parameters for
|
|
12226
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11986
12227
|
* @export
|
|
11987
|
-
* @interface
|
|
12228
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11988
12229
|
*/
|
|
11989
|
-
export interface
|
|
11990
|
-
/**
|
|
11991
|
-
* The ID of the payout request object that should be returned
|
|
11992
|
-
* @type {number}
|
|
11993
|
-
* @memberof PayoutRequestsApiGetPayoutRequestPdf
|
|
11994
|
-
*/
|
|
11995
|
-
readonly id: number;
|
|
12230
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11996
12231
|
/**
|
|
11997
|
-
*
|
|
11998
|
-
* @type {
|
|
11999
|
-
* @memberof
|
|
12232
|
+
* UUID v4 of the payment request.
|
|
12233
|
+
* @type {string}
|
|
12234
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12000
12235
|
*/
|
|
12001
|
-
readonly
|
|
12236
|
+
readonly id: string;
|
|
12002
12237
|
}
|
|
12003
12238
|
/**
|
|
12004
|
-
* Request parameters for
|
|
12239
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12005
12240
|
* @export
|
|
12006
|
-
* @interface
|
|
12241
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12007
12242
|
*/
|
|
12008
|
-
export interface
|
|
12243
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
12009
12244
|
/**
|
|
12010
|
-
*
|
|
12011
|
-
* @type {
|
|
12012
|
-
* @memberof
|
|
12245
|
+
* UUID v4 of the payment request.
|
|
12246
|
+
* @type {string}
|
|
12247
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12013
12248
|
*/
|
|
12014
|
-
readonly id:
|
|
12249
|
+
readonly id: string;
|
|
12250
|
+
/**
|
|
12251
|
+
* The audit reason
|
|
12252
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12253
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12254
|
+
*/
|
|
12255
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12015
12256
|
}
|
|
12016
12257
|
/**
|
|
12017
|
-
* Request parameters for
|
|
12258
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12018
12259
|
* @export
|
|
12019
|
-
* @interface
|
|
12260
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12020
12261
|
*/
|
|
12021
|
-
export interface
|
|
12022
|
-
/**
|
|
12023
|
-
* The ID of the payout request object that should be returned
|
|
12024
|
-
* @type {number}
|
|
12025
|
-
* @memberof PayoutRequestsApiSetPayoutRequestStatus
|
|
12026
|
-
*/
|
|
12027
|
-
readonly id: number;
|
|
12262
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12028
12263
|
/**
|
|
12029
|
-
*
|
|
12030
|
-
* @type {
|
|
12031
|
-
* @memberof
|
|
12264
|
+
* UUID v4 of the payment request.
|
|
12265
|
+
* @type {string}
|
|
12266
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12032
12267
|
*/
|
|
12033
|
-
readonly
|
|
12268
|
+
readonly id: string;
|
|
12034
12269
|
}
|
|
12035
12270
|
/**
|
|
12036
|
-
*
|
|
12271
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12037
12272
|
* @export
|
|
12038
|
-
* @class
|
|
12273
|
+
* @class PaymentRequestsApi
|
|
12039
12274
|
* @extends {BaseAPI}
|
|
12040
12275
|
*/
|
|
12041
|
-
export declare class
|
|
12276
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12042
12277
|
/**
|
|
12043
12278
|
*
|
|
12044
|
-
* @summary
|
|
12045
|
-
* @param {
|
|
12279
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12280
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12046
12281
|
* @param {*} [options] Override http request option.
|
|
12047
12282
|
* @throws {RequiredError}
|
|
12048
|
-
* @memberof
|
|
12283
|
+
* @memberof PaymentRequestsApi
|
|
12049
12284
|
*/
|
|
12050
|
-
|
|
12285
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12051
12286
|
/**
|
|
12052
12287
|
*
|
|
12053
|
-
* @summary
|
|
12054
|
-
* @param {
|
|
12288
|
+
* @summary Create a new PaymentRequest.
|
|
12289
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12055
12290
|
* @param {*} [options] Override http request option.
|
|
12056
12291
|
* @throws {RequiredError}
|
|
12057
|
-
* @memberof
|
|
12292
|
+
* @memberof PaymentRequestsApi
|
|
12058
12293
|
*/
|
|
12059
|
-
|
|
12294
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12060
12295
|
/**
|
|
12061
12296
|
*
|
|
12062
|
-
* @summary
|
|
12063
|
-
* @param {
|
|
12297
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12298
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12064
12299
|
* @param {*} [options] Override http request option.
|
|
12065
12300
|
* @throws {RequiredError}
|
|
12066
|
-
* @memberof
|
|
12301
|
+
* @memberof PaymentRequestsApi
|
|
12067
12302
|
*/
|
|
12068
|
-
|
|
12303
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12069
12304
|
/**
|
|
12070
12305
|
*
|
|
12071
|
-
* @summary
|
|
12072
|
-
* @param {
|
|
12306
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12307
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12073
12308
|
* @param {*} [options] Override http request option.
|
|
12074
12309
|
* @throws {RequiredError}
|
|
12075
|
-
* @memberof
|
|
12310
|
+
* @memberof PaymentRequestsApi
|
|
12076
12311
|
*/
|
|
12077
|
-
|
|
12312
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12078
12313
|
/**
|
|
12079
12314
|
*
|
|
12080
|
-
* @summary
|
|
12081
|
-
* @param {
|
|
12315
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12316
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12082
12317
|
* @param {*} [options] Override http request option.
|
|
12083
12318
|
* @throws {RequiredError}
|
|
12084
|
-
* @memberof
|
|
12319
|
+
* @memberof PaymentRequestsApi
|
|
12085
12320
|
*/
|
|
12086
|
-
|
|
12321
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12322
|
+
/**
|
|
12323
|
+
*
|
|
12324
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12325
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12326
|
+
* @param {*} [options] Override http request option.
|
|
12327
|
+
* @throws {RequiredError}
|
|
12328
|
+
* @memberof PaymentRequestsApi
|
|
12329
|
+
*/
|
|
12330
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12331
|
+
}
|
|
12332
|
+
/**
|
|
12333
|
+
* @export
|
|
12334
|
+
*/
|
|
12335
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12336
|
+
readonly Pending: "PENDING";
|
|
12337
|
+
readonly Paid: "PAID";
|
|
12338
|
+
readonly Expired: "EXPIRED";
|
|
12339
|
+
readonly Cancelled: "CANCELLED";
|
|
12340
|
+
};
|
|
12341
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12342
|
+
/**
|
|
12343
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12344
|
+
* @export
|
|
12345
|
+
*/
|
|
12346
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12347
|
+
/**
|
|
12348
|
+
*
|
|
12349
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12350
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12351
|
+
* @param {*} [options] Override http request option.
|
|
12352
|
+
* @throws {RequiredError}
|
|
12353
|
+
*/
|
|
12354
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12355
|
+
/**
|
|
12356
|
+
*
|
|
12357
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12358
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12359
|
+
* @param {*} [options] Override http request option.
|
|
12360
|
+
* @throws {RequiredError}
|
|
12361
|
+
*/
|
|
12362
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12363
|
+
};
|
|
12364
|
+
/**
|
|
12365
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12366
|
+
* @export
|
|
12367
|
+
*/
|
|
12368
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
12369
|
+
/**
|
|
12370
|
+
*
|
|
12371
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12372
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12373
|
+
* @param {*} [options] Override http request option.
|
|
12374
|
+
* @throws {RequiredError}
|
|
12375
|
+
*/
|
|
12376
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
12377
|
+
/**
|
|
12378
|
+
*
|
|
12379
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12380
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12381
|
+
* @param {*} [options] Override http request option.
|
|
12382
|
+
* @throws {RequiredError}
|
|
12383
|
+
*/
|
|
12384
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12385
|
+
};
|
|
12386
|
+
/**
|
|
12387
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12388
|
+
* @export
|
|
12389
|
+
*/
|
|
12390
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12391
|
+
/**
|
|
12392
|
+
*
|
|
12393
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12394
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12395
|
+
* @param {*} [options] Override http request option.
|
|
12396
|
+
* @throws {RequiredError}
|
|
12397
|
+
*/
|
|
12398
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12399
|
+
/**
|
|
12400
|
+
*
|
|
12401
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12402
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12403
|
+
* @param {*} [options] Override http request option.
|
|
12404
|
+
* @throws {RequiredError}
|
|
12405
|
+
*/
|
|
12406
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12407
|
+
};
|
|
12408
|
+
/**
|
|
12409
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12410
|
+
* @export
|
|
12411
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12412
|
+
*/
|
|
12413
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12414
|
+
/**
|
|
12415
|
+
* UUID v4 of the payment request.
|
|
12416
|
+
* @type {string}
|
|
12417
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12418
|
+
*/
|
|
12419
|
+
readonly id: string;
|
|
12420
|
+
}
|
|
12421
|
+
/**
|
|
12422
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12423
|
+
* @export
|
|
12424
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12425
|
+
*/
|
|
12426
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12427
|
+
/**
|
|
12428
|
+
* UUID v4 of the payment request.
|
|
12429
|
+
* @type {string}
|
|
12430
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12431
|
+
*/
|
|
12432
|
+
readonly id: string;
|
|
12433
|
+
}
|
|
12434
|
+
/**
|
|
12435
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12436
|
+
* @export
|
|
12437
|
+
* @class PaymentRequestsPublicApi
|
|
12438
|
+
* @extends {BaseAPI}
|
|
12439
|
+
*/
|
|
12440
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12441
|
+
/**
|
|
12442
|
+
*
|
|
12443
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12444
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12445
|
+
* @param {*} [options] Override http request option.
|
|
12446
|
+
* @throws {RequiredError}
|
|
12447
|
+
* @memberof PaymentRequestsPublicApi
|
|
12448
|
+
*/
|
|
12449
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12450
|
+
/**
|
|
12451
|
+
*
|
|
12452
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12453
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12454
|
+
* @param {*} [options] Override http request option.
|
|
12455
|
+
* @throws {RequiredError}
|
|
12456
|
+
* @memberof PaymentRequestsPublicApi
|
|
12457
|
+
*/
|
|
12458
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12459
|
+
}
|
|
12460
|
+
/**
|
|
12461
|
+
* PayoutRequestsApi - axios parameter creator
|
|
12462
|
+
* @export
|
|
12463
|
+
*/
|
|
12464
|
+
export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12465
|
+
/**
|
|
12466
|
+
*
|
|
12467
|
+
* @summary Create a new payout request
|
|
12468
|
+
* @param {PayoutRequestRequest} payoutRequestRequest New payout request
|
|
12469
|
+
* @param {*} [options] Override http request option.
|
|
12470
|
+
* @throws {RequiredError}
|
|
12471
|
+
*/
|
|
12472
|
+
createPayoutRequest: (payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12473
|
+
/**
|
|
12474
|
+
*
|
|
12475
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12476
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
|
|
12477
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
12478
|
+
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
12479
|
+
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
12480
|
+
* @param {string} [status] Status of the payout requests (OR relation)
|
|
12481
|
+
* @param {number} [take] How many payout requests the endpoint should return
|
|
12482
|
+
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12483
|
+
* @param {*} [options] Override http request option.
|
|
12484
|
+
* @throws {RequiredError}
|
|
12485
|
+
*/
|
|
12486
|
+
getAllPayoutRequests: (requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12487
|
+
/**
|
|
12488
|
+
*
|
|
12489
|
+
* @summary Get a payout request pdf
|
|
12490
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12491
|
+
* @param {boolean} [force] Whether to force regeneration of the pdf
|
|
12492
|
+
* @param {*} [options] Override http request option.
|
|
12493
|
+
* @throws {RequiredError}
|
|
12494
|
+
*/
|
|
12495
|
+
getPayoutRequestPdf: (id: number, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12496
|
+
/**
|
|
12497
|
+
*
|
|
12498
|
+
* @summary Get a single payout request
|
|
12499
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12500
|
+
* @param {*} [options] Override http request option.
|
|
12501
|
+
* @throws {RequiredError}
|
|
12502
|
+
*/
|
|
12503
|
+
getSinglePayoutRequest: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12504
|
+
/**
|
|
12505
|
+
*
|
|
12506
|
+
* @summary Create a new status for a payout request
|
|
12507
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12508
|
+
* @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
|
|
12509
|
+
* @param {*} [options] Override http request option.
|
|
12510
|
+
* @throws {RequiredError}
|
|
12511
|
+
*/
|
|
12512
|
+
setPayoutRequestStatus: (id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12513
|
+
};
|
|
12514
|
+
/**
|
|
12515
|
+
* PayoutRequestsApi - functional programming interface
|
|
12516
|
+
* @export
|
|
12517
|
+
*/
|
|
12518
|
+
export declare const PayoutRequestsApiFp: (configuration?: Configuration) => {
|
|
12519
|
+
/**
|
|
12520
|
+
*
|
|
12521
|
+
* @summary Create a new payout request
|
|
12522
|
+
* @param {PayoutRequestRequest} payoutRequestRequest New payout request
|
|
12523
|
+
* @param {*} [options] Override http request option.
|
|
12524
|
+
* @throws {RequiredError}
|
|
12525
|
+
*/
|
|
12526
|
+
createPayoutRequest(payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
|
|
12527
|
+
/**
|
|
12528
|
+
*
|
|
12529
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12530
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
|
|
12531
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
12532
|
+
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
12533
|
+
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
12534
|
+
* @param {string} [status] Status of the payout requests (OR relation)
|
|
12535
|
+
* @param {number} [take] How many payout requests the endpoint should return
|
|
12536
|
+
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12537
|
+
* @param {*} [options] Override http request option.
|
|
12538
|
+
* @throws {RequiredError}
|
|
12539
|
+
*/
|
|
12540
|
+
getAllPayoutRequests(requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePayoutRequestResponse>>;
|
|
12541
|
+
/**
|
|
12542
|
+
*
|
|
12543
|
+
* @summary Get a payout request pdf
|
|
12544
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12545
|
+
* @param {boolean} [force] Whether to force regeneration of the pdf
|
|
12546
|
+
* @param {*} [options] Override http request option.
|
|
12547
|
+
* @throws {RequiredError}
|
|
12548
|
+
*/
|
|
12549
|
+
getPayoutRequestPdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
12550
|
+
/**
|
|
12551
|
+
*
|
|
12552
|
+
* @summary Get a single payout request
|
|
12553
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12554
|
+
* @param {*} [options] Override http request option.
|
|
12555
|
+
* @throws {RequiredError}
|
|
12556
|
+
*/
|
|
12557
|
+
getSinglePayoutRequest(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
|
|
12558
|
+
/**
|
|
12559
|
+
*
|
|
12560
|
+
* @summary Create a new status for a payout request
|
|
12561
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12562
|
+
* @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
|
|
12563
|
+
* @param {*} [options] Override http request option.
|
|
12564
|
+
* @throws {RequiredError}
|
|
12565
|
+
*/
|
|
12566
|
+
setPayoutRequestStatus(id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
|
|
12567
|
+
};
|
|
12568
|
+
/**
|
|
12569
|
+
* PayoutRequestsApi - factory interface
|
|
12570
|
+
* @export
|
|
12571
|
+
*/
|
|
12572
|
+
export declare const PayoutRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12573
|
+
/**
|
|
12574
|
+
*
|
|
12575
|
+
* @summary Create a new payout request
|
|
12576
|
+
* @param {PayoutRequestsApiCreatePayoutRequestRequest} requestParameters Request parameters.
|
|
12577
|
+
* @param {*} [options] Override http request option.
|
|
12578
|
+
* @throws {RequiredError}
|
|
12579
|
+
*/
|
|
12580
|
+
createPayoutRequest(requestParameters: PayoutRequestsApiCreatePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
|
|
12581
|
+
/**
|
|
12582
|
+
*
|
|
12583
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12584
|
+
* @param {PayoutRequestsApiGetAllPayoutRequestsRequest} requestParameters Request parameters.
|
|
12585
|
+
* @param {*} [options] Override http request option.
|
|
12586
|
+
* @throws {RequiredError}
|
|
12587
|
+
*/
|
|
12588
|
+
getAllPayoutRequests(requestParameters?: PayoutRequestsApiGetAllPayoutRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePayoutRequestResponse>;
|
|
12589
|
+
/**
|
|
12590
|
+
*
|
|
12591
|
+
* @summary Get a payout request pdf
|
|
12592
|
+
* @param {PayoutRequestsApiGetPayoutRequestPdfRequest} requestParameters Request parameters.
|
|
12593
|
+
* @param {*} [options] Override http request option.
|
|
12594
|
+
* @throws {RequiredError}
|
|
12595
|
+
*/
|
|
12596
|
+
getPayoutRequestPdf(requestParameters: PayoutRequestsApiGetPayoutRequestPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
12597
|
+
/**
|
|
12598
|
+
*
|
|
12599
|
+
* @summary Get a single payout request
|
|
12600
|
+
* @param {PayoutRequestsApiGetSinglePayoutRequestRequest} requestParameters Request parameters.
|
|
12601
|
+
* @param {*} [options] Override http request option.
|
|
12602
|
+
* @throws {RequiredError}
|
|
12603
|
+
*/
|
|
12604
|
+
getSinglePayoutRequest(requestParameters: PayoutRequestsApiGetSinglePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
|
|
12605
|
+
/**
|
|
12606
|
+
*
|
|
12607
|
+
* @summary Create a new status for a payout request
|
|
12608
|
+
* @param {PayoutRequestsApiSetPayoutRequestStatusRequest} requestParameters Request parameters.
|
|
12609
|
+
* @param {*} [options] Override http request option.
|
|
12610
|
+
* @throws {RequiredError}
|
|
12611
|
+
*/
|
|
12612
|
+
setPayoutRequestStatus(requestParameters: PayoutRequestsApiSetPayoutRequestStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
|
|
12613
|
+
};
|
|
12614
|
+
/**
|
|
12615
|
+
* Request parameters for createPayoutRequest operation in PayoutRequestsApi.
|
|
12616
|
+
* @export
|
|
12617
|
+
* @interface PayoutRequestsApiCreatePayoutRequestRequest
|
|
12618
|
+
*/
|
|
12619
|
+
export interface PayoutRequestsApiCreatePayoutRequestRequest {
|
|
12620
|
+
/**
|
|
12621
|
+
* New payout request
|
|
12622
|
+
* @type {PayoutRequestRequest}
|
|
12623
|
+
* @memberof PayoutRequestsApiCreatePayoutRequest
|
|
12624
|
+
*/
|
|
12625
|
+
readonly payoutRequestRequest: PayoutRequestRequest;
|
|
12626
|
+
}
|
|
12627
|
+
/**
|
|
12628
|
+
* Request parameters for getAllPayoutRequests operation in PayoutRequestsApi.
|
|
12629
|
+
* @export
|
|
12630
|
+
* @interface PayoutRequestsApiGetAllPayoutRequestsRequest
|
|
12631
|
+
*/
|
|
12632
|
+
export interface PayoutRequestsApiGetAllPayoutRequestsRequest {
|
|
12633
|
+
/**
|
|
12634
|
+
* ID of user(s) who requested a payout
|
|
12635
|
+
* @type {GetAllPayoutRequestsRequestedByIdParameter}
|
|
12636
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12637
|
+
*/
|
|
12638
|
+
readonly requestedById?: GetAllPayoutRequestsRequestedByIdParameter;
|
|
12639
|
+
/**
|
|
12640
|
+
* ID of user(s) who approved a payout
|
|
12641
|
+
* @type {GetAllPayoutRequestsRequestedByIdParameter}
|
|
12642
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12643
|
+
*/
|
|
12644
|
+
readonly approvedById?: GetAllPayoutRequestsRequestedByIdParameter;
|
|
12645
|
+
/**
|
|
12646
|
+
* Start date for selected transactions (inclusive)
|
|
12647
|
+
* @type {string}
|
|
12648
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12649
|
+
*/
|
|
12650
|
+
readonly fromDate?: string;
|
|
12651
|
+
/**
|
|
12652
|
+
* End date for selected transactions (exclusive)
|
|
12653
|
+
* @type {string}
|
|
12654
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12655
|
+
*/
|
|
12656
|
+
readonly tillDate?: string;
|
|
12657
|
+
/**
|
|
12658
|
+
* Status of the payout requests (OR relation)
|
|
12659
|
+
* @type {string}
|
|
12660
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12661
|
+
*/
|
|
12662
|
+
readonly status?: string;
|
|
12663
|
+
/**
|
|
12664
|
+
* How many payout requests the endpoint should return
|
|
12665
|
+
* @type {number}
|
|
12666
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12667
|
+
*/
|
|
12668
|
+
readonly take?: number;
|
|
12669
|
+
/**
|
|
12670
|
+
* How many payout requests should be skipped (for pagination)
|
|
12671
|
+
* @type {number}
|
|
12672
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
12673
|
+
*/
|
|
12674
|
+
readonly skip?: number;
|
|
12675
|
+
}
|
|
12676
|
+
/**
|
|
12677
|
+
* Request parameters for getPayoutRequestPdf operation in PayoutRequestsApi.
|
|
12678
|
+
* @export
|
|
12679
|
+
* @interface PayoutRequestsApiGetPayoutRequestPdfRequest
|
|
12680
|
+
*/
|
|
12681
|
+
export interface PayoutRequestsApiGetPayoutRequestPdfRequest {
|
|
12682
|
+
/**
|
|
12683
|
+
* The ID of the payout request object that should be returned
|
|
12684
|
+
* @type {number}
|
|
12685
|
+
* @memberof PayoutRequestsApiGetPayoutRequestPdf
|
|
12686
|
+
*/
|
|
12687
|
+
readonly id: number;
|
|
12688
|
+
/**
|
|
12689
|
+
* Whether to force regeneration of the pdf
|
|
12690
|
+
* @type {boolean}
|
|
12691
|
+
* @memberof PayoutRequestsApiGetPayoutRequestPdf
|
|
12692
|
+
*/
|
|
12693
|
+
readonly force?: boolean;
|
|
12694
|
+
}
|
|
12695
|
+
/**
|
|
12696
|
+
* Request parameters for getSinglePayoutRequest operation in PayoutRequestsApi.
|
|
12697
|
+
* @export
|
|
12698
|
+
* @interface PayoutRequestsApiGetSinglePayoutRequestRequest
|
|
12699
|
+
*/
|
|
12700
|
+
export interface PayoutRequestsApiGetSinglePayoutRequestRequest {
|
|
12701
|
+
/**
|
|
12702
|
+
* The ID of the payout request object that should be returned
|
|
12703
|
+
* @type {number}
|
|
12704
|
+
* @memberof PayoutRequestsApiGetSinglePayoutRequest
|
|
12705
|
+
*/
|
|
12706
|
+
readonly id: number;
|
|
12707
|
+
}
|
|
12708
|
+
/**
|
|
12709
|
+
* Request parameters for setPayoutRequestStatus operation in PayoutRequestsApi.
|
|
12710
|
+
* @export
|
|
12711
|
+
* @interface PayoutRequestsApiSetPayoutRequestStatusRequest
|
|
12712
|
+
*/
|
|
12713
|
+
export interface PayoutRequestsApiSetPayoutRequestStatusRequest {
|
|
12714
|
+
/**
|
|
12715
|
+
* The ID of the payout request object that should be returned
|
|
12716
|
+
* @type {number}
|
|
12717
|
+
* @memberof PayoutRequestsApiSetPayoutRequestStatus
|
|
12718
|
+
*/
|
|
12719
|
+
readonly id: number;
|
|
12720
|
+
/**
|
|
12721
|
+
* New state of payout request
|
|
12722
|
+
* @type {PayoutRequestStatusRequest}
|
|
12723
|
+
* @memberof PayoutRequestsApiSetPayoutRequestStatus
|
|
12724
|
+
*/
|
|
12725
|
+
readonly payoutRequestStatusRequest: PayoutRequestStatusRequest;
|
|
12726
|
+
}
|
|
12727
|
+
/**
|
|
12728
|
+
* PayoutRequestsApi - object-oriented interface
|
|
12729
|
+
* @export
|
|
12730
|
+
* @class PayoutRequestsApi
|
|
12731
|
+
* @extends {BaseAPI}
|
|
12732
|
+
*/
|
|
12733
|
+
export declare class PayoutRequestsApi extends BaseAPI {
|
|
12734
|
+
/**
|
|
12735
|
+
*
|
|
12736
|
+
* @summary Create a new payout request
|
|
12737
|
+
* @param {PayoutRequestsApiCreatePayoutRequestRequest} requestParameters Request parameters.
|
|
12738
|
+
* @param {*} [options] Override http request option.
|
|
12739
|
+
* @throws {RequiredError}
|
|
12740
|
+
* @memberof PayoutRequestsApi
|
|
12741
|
+
*/
|
|
12742
|
+
createPayoutRequest(requestParameters: PayoutRequestsApiCreatePayoutRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutRequestResponse, any, {}>>;
|
|
12743
|
+
/**
|
|
12744
|
+
*
|
|
12745
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12746
|
+
* @param {PayoutRequestsApiGetAllPayoutRequestsRequest} requestParameters Request parameters.
|
|
12747
|
+
* @param {*} [options] Override http request option.
|
|
12748
|
+
* @throws {RequiredError}
|
|
12749
|
+
* @memberof PayoutRequestsApi
|
|
12750
|
+
*/
|
|
12751
|
+
getAllPayoutRequests(requestParameters?: PayoutRequestsApiGetAllPayoutRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePayoutRequestResponse, any, {}>>;
|
|
12752
|
+
/**
|
|
12753
|
+
*
|
|
12754
|
+
* @summary Get a payout request pdf
|
|
12755
|
+
* @param {PayoutRequestsApiGetPayoutRequestPdfRequest} requestParameters Request parameters.
|
|
12756
|
+
* @param {*} [options] Override http request option.
|
|
12757
|
+
* @throws {RequiredError}
|
|
12758
|
+
* @memberof PayoutRequestsApi
|
|
12759
|
+
*/
|
|
12760
|
+
getPayoutRequestPdf(requestParameters: PayoutRequestsApiGetPayoutRequestPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
12761
|
+
/**
|
|
12762
|
+
*
|
|
12763
|
+
* @summary Get a single payout request
|
|
12764
|
+
* @param {PayoutRequestsApiGetSinglePayoutRequestRequest} requestParameters Request parameters.
|
|
12765
|
+
* @param {*} [options] Override http request option.
|
|
12766
|
+
* @throws {RequiredError}
|
|
12767
|
+
* @memberof PayoutRequestsApi
|
|
12768
|
+
*/
|
|
12769
|
+
getSinglePayoutRequest(requestParameters: PayoutRequestsApiGetSinglePayoutRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutRequestResponse, any, {}>>;
|
|
12770
|
+
/**
|
|
12771
|
+
*
|
|
12772
|
+
* @summary Create a new status for a payout request
|
|
12773
|
+
* @param {PayoutRequestsApiSetPayoutRequestStatusRequest} requestParameters Request parameters.
|
|
12774
|
+
* @param {*} [options] Override http request option.
|
|
12775
|
+
* @throws {RequiredError}
|
|
12776
|
+
* @memberof PayoutRequestsApi
|
|
12777
|
+
*/
|
|
12778
|
+
setPayoutRequestStatus(requestParameters: PayoutRequestsApiSetPayoutRequestStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutRequestResponse, any, {}>>;
|
|
12087
12779
|
}
|
|
12088
12780
|
/**
|
|
12089
12781
|
* PointofsaleApi - axios parameter creator
|
|
@@ -14211,186 +14903,462 @@ export declare class ServerSettingsApi extends BaseAPI {
|
|
|
14211
14903
|
setWrappedEnabled(requestParameters: ServerSettingsApiSetWrappedEnabledRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
14212
14904
|
}
|
|
14213
14905
|
/**
|
|
14214
|
-
* StripeApi - axios parameter creator
|
|
14906
|
+
* StripeApi - axios parameter creator
|
|
14907
|
+
* @export
|
|
14908
|
+
*/
|
|
14909
|
+
export declare const StripeApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14910
|
+
/**
|
|
14911
|
+
*
|
|
14912
|
+
* @summary Start the stripe deposit flow
|
|
14913
|
+
* @param {StripeRequest} stripeRequest The deposit that should be created
|
|
14914
|
+
* @param {*} [options] Override http request option.
|
|
14915
|
+
* @throws {RequiredError}
|
|
14916
|
+
*/
|
|
14917
|
+
deposit: (stripeRequest: StripeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14918
|
+
/**
|
|
14919
|
+
*
|
|
14920
|
+
* @summary Get the Stripe public key
|
|
14921
|
+
* @param {*} [options] Override http request option.
|
|
14922
|
+
* @throws {RequiredError}
|
|
14923
|
+
*/
|
|
14924
|
+
getStripePublicKey: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14925
|
+
/**
|
|
14926
|
+
*
|
|
14927
|
+
* @summary Webhook for Stripe event updates
|
|
14928
|
+
* @param {*} [options] Override http request option.
|
|
14929
|
+
* @throws {RequiredError}
|
|
14930
|
+
*/
|
|
14931
|
+
webhook: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14932
|
+
};
|
|
14933
|
+
/**
|
|
14934
|
+
* StripeApi - functional programming interface
|
|
14935
|
+
* @export
|
|
14936
|
+
*/
|
|
14937
|
+
export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
14938
|
+
/**
|
|
14939
|
+
*
|
|
14940
|
+
* @summary Start the stripe deposit flow
|
|
14941
|
+
* @param {StripeRequest} stripeRequest The deposit that should be created
|
|
14942
|
+
* @param {*} [options] Override http request option.
|
|
14943
|
+
* @throws {RequiredError}
|
|
14944
|
+
*/
|
|
14945
|
+
deposit(stripeRequest: StripeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StripePaymentIntentResponse>>;
|
|
14946
|
+
/**
|
|
14947
|
+
*
|
|
14948
|
+
* @summary Get the Stripe public key
|
|
14949
|
+
* @param {*} [options] Override http request option.
|
|
14950
|
+
* @throws {RequiredError}
|
|
14951
|
+
*/
|
|
14952
|
+
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14953
|
+
/**
|
|
14954
|
+
*
|
|
14955
|
+
* @summary Webhook for Stripe event updates
|
|
14956
|
+
* @param {*} [options] Override http request option.
|
|
14957
|
+
* @throws {RequiredError}
|
|
14958
|
+
*/
|
|
14959
|
+
webhook(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14960
|
+
};
|
|
14961
|
+
/**
|
|
14962
|
+
* StripeApi - factory interface
|
|
14963
|
+
* @export
|
|
14964
|
+
*/
|
|
14965
|
+
export declare const StripeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14966
|
+
/**
|
|
14967
|
+
*
|
|
14968
|
+
* @summary Start the stripe deposit flow
|
|
14969
|
+
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
14970
|
+
* @param {*} [options] Override http request option.
|
|
14971
|
+
* @throws {RequiredError}
|
|
14972
|
+
*/
|
|
14973
|
+
deposit(requestParameters: StripeApiDepositRequest, options?: RawAxiosRequestConfig): AxiosPromise<StripePaymentIntentResponse>;
|
|
14974
|
+
/**
|
|
14975
|
+
*
|
|
14976
|
+
* @summary Get the Stripe public key
|
|
14977
|
+
* @param {*} [options] Override http request option.
|
|
14978
|
+
* @throws {RequiredError}
|
|
14979
|
+
*/
|
|
14980
|
+
getStripePublicKey(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
14981
|
+
/**
|
|
14982
|
+
*
|
|
14983
|
+
* @summary Webhook for Stripe event updates
|
|
14984
|
+
* @param {*} [options] Override http request option.
|
|
14985
|
+
* @throws {RequiredError}
|
|
14986
|
+
*/
|
|
14987
|
+
webhook(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
14988
|
+
};
|
|
14989
|
+
/**
|
|
14990
|
+
* Request parameters for deposit operation in StripeApi.
|
|
14991
|
+
* @export
|
|
14992
|
+
* @interface StripeApiDepositRequest
|
|
14993
|
+
*/
|
|
14994
|
+
export interface StripeApiDepositRequest {
|
|
14995
|
+
/**
|
|
14996
|
+
* The deposit that should be created
|
|
14997
|
+
* @type {StripeRequest}
|
|
14998
|
+
* @memberof StripeApiDeposit
|
|
14999
|
+
*/
|
|
15000
|
+
readonly stripeRequest: StripeRequest;
|
|
15001
|
+
}
|
|
15002
|
+
/**
|
|
15003
|
+
* StripeApi - object-oriented interface
|
|
15004
|
+
* @export
|
|
15005
|
+
* @class StripeApi
|
|
15006
|
+
* @extends {BaseAPI}
|
|
15007
|
+
*/
|
|
15008
|
+
export declare class StripeApi extends BaseAPI {
|
|
15009
|
+
/**
|
|
15010
|
+
*
|
|
15011
|
+
* @summary Start the stripe deposit flow
|
|
15012
|
+
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15013
|
+
* @param {*} [options] Override http request option.
|
|
15014
|
+
* @throws {RequiredError}
|
|
15015
|
+
* @memberof StripeApi
|
|
15016
|
+
*/
|
|
15017
|
+
deposit(requestParameters: StripeApiDepositRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentIntentResponse, any, {}>>;
|
|
15018
|
+
/**
|
|
15019
|
+
*
|
|
15020
|
+
* @summary Get the Stripe public key
|
|
15021
|
+
* @param {*} [options] Override http request option.
|
|
15022
|
+
* @throws {RequiredError}
|
|
15023
|
+
* @memberof StripeApi
|
|
15024
|
+
*/
|
|
15025
|
+
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
15026
|
+
/**
|
|
15027
|
+
*
|
|
15028
|
+
* @summary Webhook for Stripe event updates
|
|
15029
|
+
* @param {*} [options] Override http request option.
|
|
15030
|
+
* @throws {RequiredError}
|
|
15031
|
+
* @memberof StripeApi
|
|
15032
|
+
*/
|
|
15033
|
+
webhook(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
15034
|
+
}
|
|
15035
|
+
/**
|
|
15036
|
+
* SyncApi - axios parameter creator
|
|
15037
|
+
* @export
|
|
15038
|
+
*/
|
|
15039
|
+
export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15040
|
+
/**
|
|
15041
|
+
* 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.
|
|
15042
|
+
* @summary Get dry-run sync results for users
|
|
15043
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15044
|
+
* @param {*} [options] Override http request option.
|
|
15045
|
+
* @throws {RequiredError}
|
|
15046
|
+
*/
|
|
15047
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15048
|
+
};
|
|
15049
|
+
/**
|
|
15050
|
+
* SyncApi - functional programming interface
|
|
15051
|
+
* @export
|
|
15052
|
+
*/
|
|
15053
|
+
export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
15054
|
+
/**
|
|
15055
|
+
* 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.
|
|
15056
|
+
* @summary Get dry-run sync results for users
|
|
15057
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15058
|
+
* @param {*} [options] Override http request option.
|
|
15059
|
+
* @throws {RequiredError}
|
|
15060
|
+
*/
|
|
15061
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15062
|
+
};
|
|
15063
|
+
/**
|
|
15064
|
+
* SyncApi - factory interface
|
|
15065
|
+
* @export
|
|
15066
|
+
*/
|
|
15067
|
+
export declare const SyncApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15068
|
+
/**
|
|
15069
|
+
* 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.
|
|
15070
|
+
* @summary Get dry-run sync results for users
|
|
15071
|
+
* @param {SyncApiGetUserSyncResultsRequest} requestParameters Request parameters.
|
|
15072
|
+
* @param {*} [options] Override http request option.
|
|
15073
|
+
* @throws {RequiredError}
|
|
15074
|
+
*/
|
|
15075
|
+
getUserSyncResults(requestParameters?: SyncApiGetUserSyncResultsRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15076
|
+
};
|
|
15077
|
+
/**
|
|
15078
|
+
* Request parameters for getUserSyncResults operation in SyncApi.
|
|
15079
|
+
* @export
|
|
15080
|
+
* @interface SyncApiGetUserSyncResultsRequest
|
|
15081
|
+
*/
|
|
15082
|
+
export interface SyncApiGetUserSyncResultsRequest {
|
|
15083
|
+
/**
|
|
15084
|
+
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15085
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
15086
|
+
* @memberof SyncApiGetUserSyncResults
|
|
15087
|
+
*/
|
|
15088
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
15089
|
+
}
|
|
15090
|
+
/**
|
|
15091
|
+
* SyncApi - object-oriented interface
|
|
15092
|
+
* @export
|
|
15093
|
+
* @class SyncApi
|
|
15094
|
+
* @extends {BaseAPI}
|
|
15095
|
+
*/
|
|
15096
|
+
export declare class SyncApi extends BaseAPI {
|
|
15097
|
+
/**
|
|
15098
|
+
* 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.
|
|
15099
|
+
* @summary Get dry-run sync results for users
|
|
15100
|
+
* @param {SyncApiGetUserSyncResultsRequest} requestParameters Request parameters.
|
|
15101
|
+
* @param {*} [options] Override http request option.
|
|
15102
|
+
* @throws {RequiredError}
|
|
15103
|
+
* @memberof SyncApi
|
|
15104
|
+
*/
|
|
15105
|
+
getUserSyncResults(requestParameters?: SyncApiGetUserSyncResultsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
15106
|
+
}
|
|
15107
|
+
/**
|
|
15108
|
+
* @export
|
|
15109
|
+
*/
|
|
15110
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
15111
|
+
readonly Ldap: "LDAP";
|
|
15112
|
+
readonly Gewisdb: "GEWISDB";
|
|
15113
|
+
};
|
|
15114
|
+
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
15115
|
+
/**
|
|
15116
|
+
* TerminalPaymentsApi - axios parameter creator
|
|
15117
|
+
* @export
|
|
15118
|
+
*/
|
|
15119
|
+
export declare const TerminalPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15120
|
+
/**
|
|
15121
|
+
*
|
|
15122
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15123
|
+
* @param {number} id The ID of the terminal payment
|
|
15124
|
+
* @param {*} [options] Override http request option.
|
|
15125
|
+
* @throws {RequiredError}
|
|
15126
|
+
*/
|
|
15127
|
+
cancelTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15128
|
+
/**
|
|
15129
|
+
*
|
|
15130
|
+
* @summary Create a terminal payment before executing.
|
|
15131
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15132
|
+
* @param {*} [options] Override http request option.
|
|
15133
|
+
* @throws {RequiredError}
|
|
15134
|
+
*/
|
|
15135
|
+
createTerminalPayment: (createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15136
|
+
/**
|
|
15137
|
+
*
|
|
15138
|
+
* @summary Get single terminal payment by ID
|
|
15139
|
+
* @param {number} id The ID of the terminal payment
|
|
15140
|
+
* @param {*} [options] Override http request option.
|
|
15141
|
+
* @throws {RequiredError}
|
|
15142
|
+
*/
|
|
15143
|
+
getSingleTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15144
|
+
/**
|
|
15145
|
+
*
|
|
15146
|
+
* @summary Get all Stripe terminals
|
|
15147
|
+
* @param {*} [options] Override http request option.
|
|
15148
|
+
* @throws {RequiredError}
|
|
15149
|
+
*/
|
|
15150
|
+
getStripeTerminals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15151
|
+
/**
|
|
15152
|
+
*
|
|
15153
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15154
|
+
* @param {number} id The ID of the terminal payment
|
|
15155
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15156
|
+
* @param {*} [options] Override http request option.
|
|
15157
|
+
* @throws {RequiredError}
|
|
15158
|
+
*/
|
|
15159
|
+
startTerminalPayment: (id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15160
|
+
};
|
|
15161
|
+
/**
|
|
15162
|
+
* TerminalPaymentsApi - functional programming interface
|
|
14215
15163
|
* @export
|
|
14216
15164
|
*/
|
|
14217
|
-
export declare const
|
|
15165
|
+
export declare const TerminalPaymentsApiFp: (configuration?: Configuration) => {
|
|
14218
15166
|
/**
|
|
14219
15167
|
*
|
|
14220
|
-
* @summary
|
|
14221
|
-
* @param {
|
|
15168
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15169
|
+
* @param {number} id The ID of the terminal payment
|
|
14222
15170
|
* @param {*} [options] Override http request option.
|
|
14223
15171
|
* @throws {RequiredError}
|
|
14224
15172
|
*/
|
|
14225
|
-
|
|
15173
|
+
cancelTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
14226
15174
|
/**
|
|
14227
15175
|
*
|
|
14228
|
-
* @summary
|
|
15176
|
+
* @summary Create a terminal payment before executing.
|
|
15177
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
14229
15178
|
* @param {*} [options] Override http request option.
|
|
14230
15179
|
* @throws {RequiredError}
|
|
14231
15180
|
*/
|
|
14232
|
-
|
|
14233
|
-
};
|
|
14234
|
-
/**
|
|
14235
|
-
* StripeApi - functional programming interface
|
|
14236
|
-
* @export
|
|
14237
|
-
*/
|
|
14238
|
-
export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
15181
|
+
createTerminalPayment(createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
14239
15182
|
/**
|
|
14240
15183
|
*
|
|
14241
|
-
* @summary
|
|
14242
|
-
* @param {
|
|
15184
|
+
* @summary Get single terminal payment by ID
|
|
15185
|
+
* @param {number} id The ID of the terminal payment
|
|
14243
15186
|
* @param {*} [options] Override http request option.
|
|
14244
15187
|
* @throws {RequiredError}
|
|
14245
15188
|
*/
|
|
14246
|
-
|
|
15189
|
+
getSingleTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
14247
15190
|
/**
|
|
14248
15191
|
*
|
|
14249
|
-
* @summary Get
|
|
15192
|
+
* @summary Get all Stripe terminals
|
|
14250
15193
|
* @param {*} [options] Override http request option.
|
|
14251
15194
|
* @throws {RequiredError}
|
|
14252
15195
|
*/
|
|
14253
|
-
|
|
15196
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<StripePaymentTerminalResponse>>>;
|
|
15197
|
+
/**
|
|
15198
|
+
*
|
|
15199
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15200
|
+
* @param {number} id The ID of the terminal payment
|
|
15201
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15202
|
+
* @param {*} [options] Override http request option.
|
|
15203
|
+
* @throws {RequiredError}
|
|
15204
|
+
*/
|
|
15205
|
+
startTerminalPayment(id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14254
15206
|
};
|
|
14255
15207
|
/**
|
|
14256
|
-
*
|
|
15208
|
+
* TerminalPaymentsApi - factory interface
|
|
14257
15209
|
* @export
|
|
14258
15210
|
*/
|
|
14259
|
-
export declare const
|
|
15211
|
+
export declare const TerminalPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14260
15212
|
/**
|
|
14261
15213
|
*
|
|
14262
|
-
* @summary
|
|
14263
|
-
* @param {
|
|
15214
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15215
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
14264
15216
|
* @param {*} [options] Override http request option.
|
|
14265
15217
|
* @throws {RequiredError}
|
|
14266
15218
|
*/
|
|
14267
|
-
|
|
15219
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14268
15220
|
/**
|
|
14269
15221
|
*
|
|
14270
|
-
* @summary
|
|
15222
|
+
* @summary Create a terminal payment before executing.
|
|
15223
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
14271
15224
|
* @param {*} [options] Override http request option.
|
|
14272
15225
|
* @throws {RequiredError}
|
|
14273
15226
|
*/
|
|
14274
|
-
|
|
14275
|
-
};
|
|
14276
|
-
/**
|
|
14277
|
-
* Request parameters for deposit operation in StripeApi.
|
|
14278
|
-
* @export
|
|
14279
|
-
* @interface StripeApiDepositRequest
|
|
14280
|
-
*/
|
|
14281
|
-
export interface StripeApiDepositRequest {
|
|
15227
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14282
15228
|
/**
|
|
14283
|
-
*
|
|
14284
|
-
* @
|
|
14285
|
-
* @
|
|
15229
|
+
*
|
|
15230
|
+
* @summary Get single terminal payment by ID
|
|
15231
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15232
|
+
* @param {*} [options] Override http request option.
|
|
15233
|
+
* @throws {RequiredError}
|
|
14286
15234
|
*/
|
|
14287
|
-
|
|
14288
|
-
}
|
|
14289
|
-
/**
|
|
14290
|
-
* StripeApi - object-oriented interface
|
|
14291
|
-
* @export
|
|
14292
|
-
* @class StripeApi
|
|
14293
|
-
* @extends {BaseAPI}
|
|
14294
|
-
*/
|
|
14295
|
-
export declare class StripeApi extends BaseAPI {
|
|
15235
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14296
15236
|
/**
|
|
14297
15237
|
*
|
|
14298
|
-
* @summary
|
|
14299
|
-
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15238
|
+
* @summary Get all Stripe terminals
|
|
14300
15239
|
* @param {*} [options] Override http request option.
|
|
14301
15240
|
* @throws {RequiredError}
|
|
14302
|
-
* @memberof StripeApi
|
|
14303
15241
|
*/
|
|
14304
|
-
|
|
15242
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): AxiosPromise<Array<StripePaymentTerminalResponse>>;
|
|
14305
15243
|
/**
|
|
14306
15244
|
*
|
|
14307
|
-
* @summary
|
|
15245
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15246
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
14308
15247
|
* @param {*} [options] Override http request option.
|
|
14309
15248
|
* @throws {RequiredError}
|
|
14310
|
-
* @memberof StripeApi
|
|
14311
15249
|
*/
|
|
14312
|
-
|
|
14313
|
-
}
|
|
15250
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15251
|
+
};
|
|
14314
15252
|
/**
|
|
14315
|
-
*
|
|
15253
|
+
* Request parameters for cancelTerminalPayment operation in TerminalPaymentsApi.
|
|
14316
15254
|
* @export
|
|
15255
|
+
* @interface TerminalPaymentsApiCancelTerminalPaymentRequest
|
|
14317
15256
|
*/
|
|
14318
|
-
export
|
|
15257
|
+
export interface TerminalPaymentsApiCancelTerminalPaymentRequest {
|
|
14319
15258
|
/**
|
|
14320
|
-
*
|
|
14321
|
-
* @
|
|
14322
|
-
* @
|
|
14323
|
-
* @param {*} [options] Override http request option.
|
|
14324
|
-
* @throws {RequiredError}
|
|
15259
|
+
* The ID of the terminal payment
|
|
15260
|
+
* @type {number}
|
|
15261
|
+
* @memberof TerminalPaymentsApiCancelTerminalPayment
|
|
14325
15262
|
*/
|
|
14326
|
-
|
|
14327
|
-
}
|
|
15263
|
+
readonly id: number;
|
|
15264
|
+
}
|
|
14328
15265
|
/**
|
|
14329
|
-
*
|
|
15266
|
+
* Request parameters for createTerminalPayment operation in TerminalPaymentsApi.
|
|
14330
15267
|
* @export
|
|
15268
|
+
* @interface TerminalPaymentsApiCreateTerminalPaymentRequest
|
|
14331
15269
|
*/
|
|
14332
|
-
export
|
|
15270
|
+
export interface TerminalPaymentsApiCreateTerminalPaymentRequest {
|
|
14333
15271
|
/**
|
|
14334
|
-
*
|
|
14335
|
-
* @
|
|
14336
|
-
* @
|
|
14337
|
-
* @param {*} [options] Override http request option.
|
|
14338
|
-
* @throws {RequiredError}
|
|
15272
|
+
* The terminal payment that should be created.
|
|
15273
|
+
* @type {CreateTerminalPaymentRequest}
|
|
15274
|
+
* @memberof TerminalPaymentsApiCreateTerminalPayment
|
|
14339
15275
|
*/
|
|
14340
|
-
|
|
14341
|
-
}
|
|
15276
|
+
readonly createTerminalPaymentRequest: CreateTerminalPaymentRequest;
|
|
15277
|
+
}
|
|
14342
15278
|
/**
|
|
14343
|
-
*
|
|
15279
|
+
* Request parameters for getSingleTerminalPayment operation in TerminalPaymentsApi.
|
|
14344
15280
|
* @export
|
|
15281
|
+
* @interface TerminalPaymentsApiGetSingleTerminalPaymentRequest
|
|
14345
15282
|
*/
|
|
14346
|
-
export
|
|
15283
|
+
export interface TerminalPaymentsApiGetSingleTerminalPaymentRequest {
|
|
14347
15284
|
/**
|
|
14348
|
-
*
|
|
14349
|
-
* @
|
|
14350
|
-
* @
|
|
14351
|
-
* @param {*} [options] Override http request option.
|
|
14352
|
-
* @throws {RequiredError}
|
|
15285
|
+
* The ID of the terminal payment
|
|
15286
|
+
* @type {number}
|
|
15287
|
+
* @memberof TerminalPaymentsApiGetSingleTerminalPayment
|
|
14353
15288
|
*/
|
|
14354
|
-
|
|
14355
|
-
}
|
|
15289
|
+
readonly id: number;
|
|
15290
|
+
}
|
|
14356
15291
|
/**
|
|
14357
|
-
* Request parameters for
|
|
15292
|
+
* Request parameters for startTerminalPayment operation in TerminalPaymentsApi.
|
|
14358
15293
|
* @export
|
|
14359
|
-
* @interface
|
|
15294
|
+
* @interface TerminalPaymentsApiStartTerminalPaymentRequest
|
|
14360
15295
|
*/
|
|
14361
|
-
export interface
|
|
15296
|
+
export interface TerminalPaymentsApiStartTerminalPaymentRequest {
|
|
14362
15297
|
/**
|
|
14363
|
-
*
|
|
14364
|
-
* @type {
|
|
14365
|
-
* @memberof
|
|
15298
|
+
* The ID of the terminal payment
|
|
15299
|
+
* @type {number}
|
|
15300
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
14366
15301
|
*/
|
|
14367
|
-
readonly
|
|
15302
|
+
readonly id: number;
|
|
15303
|
+
/**
|
|
15304
|
+
* Payment options
|
|
15305
|
+
* @type {ProcessTerminalPaymentRequest}
|
|
15306
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15307
|
+
*/
|
|
15308
|
+
readonly processTerminalPaymentRequest: ProcessTerminalPaymentRequest;
|
|
14368
15309
|
}
|
|
14369
15310
|
/**
|
|
14370
|
-
*
|
|
15311
|
+
* TerminalPaymentsApi - object-oriented interface
|
|
14371
15312
|
* @export
|
|
14372
|
-
* @class
|
|
15313
|
+
* @class TerminalPaymentsApi
|
|
14373
15314
|
* @extends {BaseAPI}
|
|
14374
15315
|
*/
|
|
14375
|
-
export declare class
|
|
15316
|
+
export declare class TerminalPaymentsApi extends BaseAPI {
|
|
14376
15317
|
/**
|
|
14377
|
-
*
|
|
14378
|
-
* @summary
|
|
14379
|
-
* @param {
|
|
15318
|
+
*
|
|
15319
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15320
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
14380
15321
|
* @param {*} [options] Override http request option.
|
|
14381
15322
|
* @throws {RequiredError}
|
|
14382
|
-
* @memberof
|
|
15323
|
+
* @memberof TerminalPaymentsApi
|
|
14383
15324
|
*/
|
|
14384
|
-
|
|
15325
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15326
|
+
/**
|
|
15327
|
+
*
|
|
15328
|
+
* @summary Create a terminal payment before executing.
|
|
15329
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15330
|
+
* @param {*} [options] Override http request option.
|
|
15331
|
+
* @throws {RequiredError}
|
|
15332
|
+
* @memberof TerminalPaymentsApi
|
|
15333
|
+
*/
|
|
15334
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15335
|
+
/**
|
|
15336
|
+
*
|
|
15337
|
+
* @summary Get single terminal payment by ID
|
|
15338
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15339
|
+
* @param {*} [options] Override http request option.
|
|
15340
|
+
* @throws {RequiredError}
|
|
15341
|
+
* @memberof TerminalPaymentsApi
|
|
15342
|
+
*/
|
|
15343
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15344
|
+
/**
|
|
15345
|
+
*
|
|
15346
|
+
* @summary Get all Stripe terminals
|
|
15347
|
+
* @param {*} [options] Override http request option.
|
|
15348
|
+
* @throws {RequiredError}
|
|
15349
|
+
* @memberof TerminalPaymentsApi
|
|
15350
|
+
*/
|
|
15351
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentTerminalResponse[], any, {}>>;
|
|
15352
|
+
/**
|
|
15353
|
+
*
|
|
15354
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15355
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
15356
|
+
* @param {*} [options] Override http request option.
|
|
15357
|
+
* @throws {RequiredError}
|
|
15358
|
+
* @memberof TerminalPaymentsApi
|
|
15359
|
+
*/
|
|
15360
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
14385
15361
|
}
|
|
14386
|
-
/**
|
|
14387
|
-
* @export
|
|
14388
|
-
*/
|
|
14389
|
-
export declare const GetUserSyncResultsServiceEnum: {
|
|
14390
|
-
readonly Ldap: "LDAP";
|
|
14391
|
-
readonly Gewisdb: "GEWISDB";
|
|
14392
|
-
};
|
|
14393
|
-
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14394
15362
|
/**
|
|
14395
15363
|
* TermsOfServiceApi - axios parameter creator
|
|
14396
15364
|
* @export
|
|
@@ -15139,12 +16107,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15139
16107
|
* @summary Returns all existing transfers
|
|
15140
16108
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15141
16109
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16110
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16111
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16112
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15142
16113
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15143
16114
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15144
16115
|
* @param {*} [options] Override http request option.
|
|
15145
16116
|
* @throws {RequiredError}
|
|
15146
16117
|
*/
|
|
15147
|
-
getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16118
|
+
getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15148
16119
|
/**
|
|
15149
16120
|
*
|
|
15150
16121
|
* @summary Returns the requested transfer
|
|
@@ -15211,12 +16182,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15211
16182
|
* @summary Returns all existing transfers
|
|
15212
16183
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15213
16184
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16185
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16186
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16187
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15214
16188
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15215
16189
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15216
16190
|
* @param {*} [options] Override http request option.
|
|
15217
16191
|
* @throws {RequiredError}
|
|
15218
16192
|
*/
|
|
15219
|
-
getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
16193
|
+
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
16194
|
/**
|
|
15221
16195
|
*
|
|
15222
16196
|
* @summary Returns the requested transfer
|
|
@@ -15285,7 +16259,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15285
16259
|
* @param {*} [options] Override http request option.
|
|
15286
16260
|
* @throws {RequiredError}
|
|
15287
16261
|
*/
|
|
15288
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
16262
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15289
16263
|
/**
|
|
15290
16264
|
*
|
|
15291
16265
|
* @summary Returns the requested transfer
|
|
@@ -15363,6 +16337,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15363
16337
|
* @memberof TransfersApiGetAllTransfers
|
|
15364
16338
|
*/
|
|
15365
16339
|
readonly tillDate?: string;
|
|
16340
|
+
/**
|
|
16341
|
+
* Filter transfers from this user ID
|
|
16342
|
+
* @type {number}
|
|
16343
|
+
* @memberof TransfersApiGetAllTransfers
|
|
16344
|
+
*/
|
|
16345
|
+
readonly fromId?: number;
|
|
16346
|
+
/**
|
|
16347
|
+
* Filter transfers to this user ID
|
|
16348
|
+
* @type {number}
|
|
16349
|
+
* @memberof TransfersApiGetAllTransfers
|
|
16350
|
+
*/
|
|
16351
|
+
readonly toId?: number;
|
|
16352
|
+
/**
|
|
16353
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
16354
|
+
* @type {string}
|
|
16355
|
+
* @memberof TransfersApiGetAllTransfers
|
|
16356
|
+
*/
|
|
16357
|
+
readonly category?: string;
|
|
15366
16358
|
/**
|
|
15367
16359
|
* How many transfers the endpoint should return
|
|
15368
16360
|
* @type {number}
|
|
@@ -15503,7 +16495,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15503
16495
|
* @throws {RequiredError}
|
|
15504
16496
|
* @memberof TransfersApi
|
|
15505
16497
|
*/
|
|
15506
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16498
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15507
16499
|
/**
|
|
15508
16500
|
*
|
|
15509
16501
|
* @summary Returns the requested transfer
|
|
@@ -15752,7 +16744,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15752
16744
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15753
16745
|
/**
|
|
15754
16746
|
*
|
|
15755
|
-
* @summary Accept the Terms of Service
|
|
16747
|
+
* @summary Accept the current Terms of Service version
|
|
15756
16748
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15757
16749
|
* @param {*} [options] Override http request option.
|
|
15758
16750
|
* @throws {RequiredError}
|
|
@@ -15882,6 +16874,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15882
16874
|
* @throws {RequiredError}
|
|
15883
16875
|
*/
|
|
15884
16876
|
getUserSettings: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16877
|
+
/**
|
|
16878
|
+
*
|
|
16879
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
16880
|
+
* @param {number} id The id of the user
|
|
16881
|
+
* @param {*} [options] Override http request option.
|
|
16882
|
+
* @throws {RequiredError}
|
|
16883
|
+
*/
|
|
16884
|
+
getUserTos: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15885
16885
|
/**
|
|
15886
16886
|
*
|
|
15887
16887
|
* @summary Returns the user\'s containers
|
|
@@ -15904,6 +16904,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15904
16904
|
* @throws {RequiredError}
|
|
15905
16905
|
*/
|
|
15906
16906
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16907
|
+
/**
|
|
16908
|
+
*
|
|
16909
|
+
* @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.
|
|
16910
|
+
* @param {number} id The id of the beneficiary user.
|
|
16911
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16912
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16913
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16914
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16915
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16916
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16917
|
+
* @param {*} [options] Override http request option.
|
|
16918
|
+
* @throws {RequiredError}
|
|
16919
|
+
*/
|
|
16920
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15907
16921
|
/**
|
|
15908
16922
|
*
|
|
15909
16923
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16114,7 +17128,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16114
17128
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
16115
17129
|
/**
|
|
16116
17130
|
*
|
|
16117
|
-
* @summary Accept the Terms of Service
|
|
17131
|
+
* @summary Accept the current Terms of Service version
|
|
16118
17132
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
16119
17133
|
* @param {*} [options] Override http request option.
|
|
16120
17134
|
* @throws {RequiredError}
|
|
@@ -16244,6 +17258,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16244
17258
|
* @throws {RequiredError}
|
|
16245
17259
|
*/
|
|
16246
17260
|
getUserSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettingsResponse>>;
|
|
17261
|
+
/**
|
|
17262
|
+
*
|
|
17263
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17264
|
+
* @param {number} id The id of the user
|
|
17265
|
+
* @param {*} [options] Override http request option.
|
|
17266
|
+
* @throws {RequiredError}
|
|
17267
|
+
*/
|
|
17268
|
+
getUserTos(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserTosResponse>>;
|
|
16247
17269
|
/**
|
|
16248
17270
|
*
|
|
16249
17271
|
* @summary Returns the user\'s containers
|
|
@@ -16266,6 +17288,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16266
17288
|
* @throws {RequiredError}
|
|
16267
17289
|
*/
|
|
16268
17290
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
17291
|
+
/**
|
|
17292
|
+
*
|
|
17293
|
+
* @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.
|
|
17294
|
+
* @param {number} id The id of the beneficiary user.
|
|
17295
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
17296
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
17297
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
17298
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
17299
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
17300
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
17301
|
+
* @param {*} [options] Override http request option.
|
|
17302
|
+
* @throws {RequiredError}
|
|
17303
|
+
*/
|
|
17304
|
+
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
17305
|
/**
|
|
16270
17306
|
*
|
|
16271
17307
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16476,7 +17512,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16476
17512
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16477
17513
|
/**
|
|
16478
17514
|
*
|
|
16479
|
-
* @summary Accept the Terms of Service
|
|
17515
|
+
* @summary Accept the current Terms of Service version
|
|
16480
17516
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16481
17517
|
* @param {*} [options] Override http request option.
|
|
16482
17518
|
* @throws {RequiredError}
|
|
@@ -16594,6 +17630,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16594
17630
|
* @throws {RequiredError}
|
|
16595
17631
|
*/
|
|
16596
17632
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserSettingsResponse>;
|
|
17633
|
+
/**
|
|
17634
|
+
*
|
|
17635
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17636
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
17637
|
+
* @param {*} [options] Override http request option.
|
|
17638
|
+
* @throws {RequiredError}
|
|
17639
|
+
*/
|
|
17640
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserTosResponse>;
|
|
16597
17641
|
/**
|
|
16598
17642
|
*
|
|
16599
17643
|
* @summary Returns the user\'s containers
|
|
@@ -16610,6 +17654,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16610
17654
|
* @throws {RequiredError}
|
|
16611
17655
|
*/
|
|
16612
17656
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17657
|
+
/**
|
|
17658
|
+
*
|
|
17659
|
+
* @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.
|
|
17660
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17661
|
+
* @param {*} [options] Override http request option.
|
|
17662
|
+
* @throws {RequiredError}
|
|
17663
|
+
*/
|
|
17664
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16613
17665
|
/**
|
|
16614
17666
|
*
|
|
16615
17667
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17039,6 +18091,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
17039
18091
|
*/
|
|
17040
18092
|
readonly id: number;
|
|
17041
18093
|
}
|
|
18094
|
+
/**
|
|
18095
|
+
* Request parameters for getUserTos operation in UsersApi.
|
|
18096
|
+
* @export
|
|
18097
|
+
* @interface UsersApiGetUserTosRequest
|
|
18098
|
+
*/
|
|
18099
|
+
export interface UsersApiGetUserTosRequest {
|
|
18100
|
+
/**
|
|
18101
|
+
* The id of the user
|
|
18102
|
+
* @type {number}
|
|
18103
|
+
* @memberof UsersApiGetUserTos
|
|
18104
|
+
*/
|
|
18105
|
+
readonly id: number;
|
|
18106
|
+
}
|
|
17042
18107
|
/**
|
|
17043
18108
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
17044
18109
|
* @export
|
|
@@ -17101,6 +18166,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17101
18166
|
*/
|
|
17102
18167
|
readonly skip?: number;
|
|
17103
18168
|
}
|
|
18169
|
+
/**
|
|
18170
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
18171
|
+
* @export
|
|
18172
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
18173
|
+
*/
|
|
18174
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
18175
|
+
/**
|
|
18176
|
+
* The id of the beneficiary user.
|
|
18177
|
+
* @type {number}
|
|
18178
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18179
|
+
*/
|
|
18180
|
+
readonly id: number;
|
|
18181
|
+
/**
|
|
18182
|
+
* Filter by creator user id.
|
|
18183
|
+
* @type {number}
|
|
18184
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18185
|
+
*/
|
|
18186
|
+
readonly createdById?: number;
|
|
18187
|
+
/**
|
|
18188
|
+
* Comma-separated list of derived statuses.
|
|
18189
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
18190
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18191
|
+
*/
|
|
18192
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
18193
|
+
/**
|
|
18194
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
18195
|
+
* @type {string}
|
|
18196
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18197
|
+
*/
|
|
18198
|
+
readonly fromDate?: string;
|
|
18199
|
+
/**
|
|
18200
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
18201
|
+
* @type {string}
|
|
18202
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18203
|
+
*/
|
|
18204
|
+
readonly tillDate?: string;
|
|
18205
|
+
/**
|
|
18206
|
+
* How many rows the endpoint should return
|
|
18207
|
+
* @type {number}
|
|
18208
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18209
|
+
*/
|
|
18210
|
+
readonly take?: number;
|
|
18211
|
+
/**
|
|
18212
|
+
* How many rows to skip (for pagination)
|
|
18213
|
+
* @type {number}
|
|
18214
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18215
|
+
*/
|
|
18216
|
+
readonly skip?: number;
|
|
18217
|
+
}
|
|
17104
18218
|
/**
|
|
17105
18219
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17106
18220
|
* @export
|
|
@@ -17616,7 +18730,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17616
18730
|
export declare class UsersApi extends BaseAPI {
|
|
17617
18731
|
/**
|
|
17618
18732
|
*
|
|
17619
|
-
* @summary Accept the Terms of Service
|
|
18733
|
+
* @summary Accept the current Terms of Service version
|
|
17620
18734
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17621
18735
|
* @param {*} [options] Override http request option.
|
|
17622
18736
|
* @throws {RequiredError}
|
|
@@ -17749,6 +18863,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17749
18863
|
* @memberof UsersApi
|
|
17750
18864
|
*/
|
|
17751
18865
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserSettingsResponse, any, {}>>;
|
|
18866
|
+
/**
|
|
18867
|
+
*
|
|
18868
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
18869
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
18870
|
+
* @param {*} [options] Override http request option.
|
|
18871
|
+
* @throws {RequiredError}
|
|
18872
|
+
* @memberof UsersApi
|
|
18873
|
+
*/
|
|
18874
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserTosResponse, any, {}>>;
|
|
17752
18875
|
/**
|
|
17753
18876
|
*
|
|
17754
18877
|
* @summary Returns the user\'s containers
|
|
@@ -17767,6 +18890,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17767
18890
|
* @memberof UsersApi
|
|
17768
18891
|
*/
|
|
17769
18892
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18893
|
+
/**
|
|
18894
|
+
*
|
|
18895
|
+
* @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.
|
|
18896
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18897
|
+
* @param {*} [options] Override http request option.
|
|
18898
|
+
* @throws {RequiredError}
|
|
18899
|
+
* @memberof UsersApi
|
|
18900
|
+
*/
|
|
18901
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17770
18902
|
/**
|
|
17771
18903
|
*
|
|
17772
18904
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17962,6 +19094,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17962
19094
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17963
19095
|
};
|
|
17964
19096
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
19097
|
+
/**
|
|
19098
|
+
* @export
|
|
19099
|
+
*/
|
|
19100
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
19101
|
+
readonly Pending: "PENDING";
|
|
19102
|
+
readonly Paid: "PAID";
|
|
19103
|
+
readonly Expired: "EXPIRED";
|
|
19104
|
+
readonly Cancelled: "CANCELLED";
|
|
19105
|
+
};
|
|
19106
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17965
19107
|
/**
|
|
17966
19108
|
* @export
|
|
17967
19109
|
*/
|