@gewis/sudosos-client 0.0.0-develop.af33803 → 0.0.0-develop.b0ba082
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +110 -0
- package/dist/api.d.ts +1822 -666
- package/dist/api.js +1407 -382
- package/dist/base.js +1 -1
- package/package.json +4 -4
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
|
|
@@ -2566,10 +2694,15 @@ export interface FineResponse {
|
|
|
2566
2694
|
/**
|
|
2567
2695
|
*
|
|
2568
2696
|
* @export
|
|
2569
|
-
* @
|
|
2697
|
+
* @enum {string}
|
|
2570
2698
|
*/
|
|
2571
|
-
export
|
|
2572
|
-
|
|
2699
|
+
export declare const GetAllInvoicesCurrentStateParameterInner: {
|
|
2700
|
+
readonly Created: "CREATED";
|
|
2701
|
+
readonly Sent: "SENT";
|
|
2702
|
+
readonly Paid: "PAID";
|
|
2703
|
+
readonly Deleted: "DELETED";
|
|
2704
|
+
};
|
|
2705
|
+
export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
|
|
2573
2706
|
/**
|
|
2574
2707
|
* @type GetAllPayoutRequestsRequestedByIdParameter
|
|
2575
2708
|
* @export
|
|
@@ -3149,44 +3282,38 @@ export interface InvoiceUserResponse {
|
|
|
3149
3282
|
/**
|
|
3150
3283
|
*
|
|
3151
3284
|
* @export
|
|
3152
|
-
* @interface
|
|
3285
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3153
3286
|
*/
|
|
3154
|
-
export interface
|
|
3155
|
-
/**
|
|
3156
|
-
*
|
|
3157
|
-
* @type {number}
|
|
3158
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3159
|
-
*/
|
|
3160
|
-
'memberId': number;
|
|
3287
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3161
3288
|
/**
|
|
3162
|
-
*
|
|
3289
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3163
3290
|
* @type {string}
|
|
3164
|
-
* @memberof
|
|
3291
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3165
3292
|
*/
|
|
3166
|
-
'
|
|
3293
|
+
'reason': string;
|
|
3167
3294
|
}
|
|
3168
3295
|
/**
|
|
3169
3296
|
*
|
|
3170
3297
|
* @export
|
|
3171
|
-
* @interface
|
|
3298
|
+
* @interface MemberAuthenticationPinRequest
|
|
3172
3299
|
*/
|
|
3173
|
-
export interface
|
|
3300
|
+
export interface MemberAuthenticationPinRequest {
|
|
3174
3301
|
/**
|
|
3175
3302
|
*
|
|
3176
3303
|
* @type {number}
|
|
3177
|
-
* @memberof
|
|
3304
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3178
3305
|
*/
|
|
3179
3306
|
'memberId': number;
|
|
3180
3307
|
/**
|
|
3181
3308
|
*
|
|
3182
3309
|
* @type {string}
|
|
3183
|
-
* @memberof
|
|
3310
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3184
3311
|
*/
|
|
3185
3312
|
'pin': string;
|
|
3186
3313
|
/**
|
|
3187
3314
|
* POS identifier
|
|
3188
3315
|
* @type {number}
|
|
3189
|
-
* @memberof
|
|
3316
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3190
3317
|
*/
|
|
3191
3318
|
'posId': number;
|
|
3192
3319
|
}
|
|
@@ -3214,13 +3341,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3214
3341
|
* @type {PaginationResult}
|
|
3215
3342
|
* @memberof PaginatedBalanceResponse
|
|
3216
3343
|
*/
|
|
3217
|
-
'_pagination'
|
|
3344
|
+
'_pagination': PaginationResult;
|
|
3218
3345
|
/**
|
|
3219
3346
|
* Returned balance responses
|
|
3220
3347
|
* @type {Array<BalanceResponse>}
|
|
3221
3348
|
* @memberof PaginatedBalanceResponse
|
|
3222
3349
|
*/
|
|
3223
|
-
'records'
|
|
3350
|
+
'records': Array<BalanceResponse>;
|
|
3224
3351
|
}
|
|
3225
3352
|
/**
|
|
3226
3353
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3233,13 +3360,13 @@ export interface PaginatedBannerResponse {
|
|
|
3233
3360
|
* @type {PaginationResult}
|
|
3234
3361
|
* @memberof PaginatedBannerResponse
|
|
3235
3362
|
*/
|
|
3236
|
-
'_pagination'
|
|
3363
|
+
'_pagination': PaginationResult;
|
|
3237
3364
|
/**
|
|
3238
3365
|
* Returned banners
|
|
3239
3366
|
* @type {Array<BannerResponse>}
|
|
3240
3367
|
* @memberof PaginatedBannerResponse
|
|
3241
3368
|
*/
|
|
3242
|
-
'records'
|
|
3369
|
+
'records': Array<BannerResponse>;
|
|
3243
3370
|
}
|
|
3244
3371
|
/**
|
|
3245
3372
|
*
|
|
@@ -3260,6 +3387,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3260
3387
|
*/
|
|
3261
3388
|
'records': Array<BaseEventResponse>;
|
|
3262
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
|
+
}
|
|
3263
3409
|
/**
|
|
3264
3410
|
*
|
|
3265
3411
|
* @export
|
|
@@ -3299,7 +3445,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3299
3445
|
'records': Array<BaseTransactionResponse>;
|
|
3300
3446
|
}
|
|
3301
3447
|
/**
|
|
3302
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity.
|
|
3303
3449
|
* @export
|
|
3304
3450
|
* @interface PaginatedContainerResponse
|
|
3305
3451
|
*/
|
|
@@ -3318,7 +3464,7 @@ export interface PaginatedContainerResponse {
|
|
|
3318
3464
|
'records': Array<ContainerResponse>;
|
|
3319
3465
|
}
|
|
3320
3466
|
/**
|
|
3321
|
-
*
|
|
3467
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3322
3468
|
* @export
|
|
3323
3469
|
* @interface PaginatedContainerWithProductResponse
|
|
3324
3470
|
*/
|
|
@@ -3404,13 +3550,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3404
3550
|
* @type {PaginationResult}
|
|
3405
3551
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3406
3552
|
*/
|
|
3407
|
-
'_pagination'
|
|
3553
|
+
'_pagination': PaginationResult;
|
|
3408
3554
|
/**
|
|
3409
3555
|
* Returned InactiveAdministrativeCost
|
|
3410
3556
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3411
3557
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3412
3558
|
*/
|
|
3413
|
-
'records'
|
|
3559
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3414
3560
|
}
|
|
3415
3561
|
/**
|
|
3416
3562
|
*
|
|
@@ -3432,7 +3578,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3432
3578
|
'records': Array<InvoiceResponseTypes>;
|
|
3433
3579
|
}
|
|
3434
3580
|
/**
|
|
3435
|
-
*
|
|
3581
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3436
3582
|
* @export
|
|
3437
3583
|
* @interface PaginatedPointOfSaleResponse
|
|
3438
3584
|
*/
|
|
@@ -3451,7 +3597,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3451
3597
|
'records': Array<PointOfSaleResponse>;
|
|
3452
3598
|
}
|
|
3453
3599
|
/**
|
|
3454
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product category` entity.
|
|
3455
3601
|
* @export
|
|
3456
3602
|
* @interface PaginatedProductCategoryResponse
|
|
3457
3603
|
*/
|
|
@@ -3470,7 +3616,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3470
3616
|
'records': Array<ProductCategoryResponse>;
|
|
3471
3617
|
}
|
|
3472
3618
|
/**
|
|
3473
|
-
*
|
|
3619
|
+
* Paginated API Response for the `product` entity.
|
|
3474
3620
|
* @export
|
|
3475
3621
|
* @interface PaginatedProductResponse
|
|
3476
3622
|
*/
|
|
@@ -3565,7 +3711,7 @@ export interface PaginatedUserResponse {
|
|
|
3565
3711
|
'records': Array<UserResponse>;
|
|
3566
3712
|
}
|
|
3567
3713
|
/**
|
|
3568
|
-
*
|
|
3714
|
+
* Paginated API Response for the `vat group` entity.
|
|
3569
3715
|
* @export
|
|
3570
3716
|
* @interface PaginatedVatGroupResponse
|
|
3571
3717
|
*/
|
|
@@ -3690,6 +3836,31 @@ export interface PatchUserTypeRequest {
|
|
|
3690
3836
|
*/
|
|
3691
3837
|
'userType': string;
|
|
3692
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
|
+
}
|
|
3693
3864
|
/**
|
|
3694
3865
|
*
|
|
3695
3866
|
* @export
|
|
@@ -3897,7 +4068,7 @@ export interface PermissionResponse {
|
|
|
3897
4068
|
'actions': Array<ActionResponse>;
|
|
3898
4069
|
}
|
|
3899
4070
|
/**
|
|
3900
|
-
*
|
|
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).
|
|
3901
4072
|
* @export
|
|
3902
4073
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3903
4074
|
*/
|
|
@@ -4052,6 +4223,19 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4052
4223
|
/**
|
|
4053
4224
|
*
|
|
4054
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
|
|
4055
4239
|
* @interface ProductCategoryRequest
|
|
4056
4240
|
*/
|
|
4057
4241
|
export interface ProductCategoryRequest {
|
|
@@ -4215,11 +4399,61 @@ export interface ProductResponse {
|
|
|
4215
4399
|
'priceList': boolean;
|
|
4216
4400
|
}
|
|
4217
4401
|
/**
|
|
4218
|
-
*
|
|
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.
|
|
4219
4403
|
* @export
|
|
4220
|
-
* @interface
|
|
4404
|
+
* @interface PublicPaymentRequestResponse
|
|
4221
4405
|
*/
|
|
4222
|
-
export interface
|
|
4406
|
+
export interface PublicPaymentRequestResponse {
|
|
4407
|
+
/**
|
|
4408
|
+
* UUID v4 identifier.
|
|
4409
|
+
* @type {string}
|
|
4410
|
+
* @memberof PublicPaymentRequestResponse
|
|
4411
|
+
*/
|
|
4412
|
+
'uuid': string;
|
|
4413
|
+
/**
|
|
4414
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4415
|
+
* @type {string}
|
|
4416
|
+
* @memberof PublicPaymentRequestResponse
|
|
4417
|
+
*/
|
|
4418
|
+
'forDisplayName': string;
|
|
4419
|
+
/**
|
|
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 {
|
|
4223
4457
|
/**
|
|
4224
4458
|
* The session ID
|
|
4225
4459
|
* @type {string}
|
|
@@ -4891,6 +5125,37 @@ export interface StripePaymentIntentStatusResponse {
|
|
|
4891
5125
|
*/
|
|
4892
5126
|
'state': number;
|
|
4893
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
|
+
}
|
|
4894
5159
|
/**
|
|
4895
5160
|
*
|
|
4896
5161
|
* @export
|
|
@@ -5083,6 +5348,67 @@ export interface SubTransactionRowResponse {
|
|
|
5083
5348
|
*/
|
|
5084
5349
|
'totalPriceInclVat': DineroObjectResponse;
|
|
5085
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
|
+
}
|
|
5086
5412
|
/**
|
|
5087
5413
|
*
|
|
5088
5414
|
* @export
|
|
@@ -5095,6 +5421,12 @@ export interface TermsOfServiceResponse {
|
|
|
5095
5421
|
* @memberof TermsOfServiceResponse
|
|
5096
5422
|
*/
|
|
5097
5423
|
'versionNumber': string;
|
|
5424
|
+
/**
|
|
5425
|
+
* The date this version took effect.
|
|
5426
|
+
* @type {string}
|
|
5427
|
+
* @memberof TermsOfServiceResponse
|
|
5428
|
+
*/
|
|
5429
|
+
'date': string;
|
|
5098
5430
|
/**
|
|
5099
5431
|
* The terms of service content.
|
|
5100
5432
|
* @type {string}
|
|
@@ -5102,6 +5434,17 @@ export interface TermsOfServiceResponse {
|
|
|
5102
5434
|
*/
|
|
5103
5435
|
'content': string;
|
|
5104
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];
|
|
5105
5448
|
/**
|
|
5106
5449
|
*
|
|
5107
5450
|
* @export
|
|
@@ -5115,23 +5458,23 @@ export interface TotalBalanceResponse {
|
|
|
5115
5458
|
*/
|
|
5116
5459
|
'date': string;
|
|
5117
5460
|
/**
|
|
5118
|
-
*
|
|
5119
|
-
* @type {
|
|
5461
|
+
*
|
|
5462
|
+
* @type {DineroObjectResponse}
|
|
5120
5463
|
* @memberof TotalBalanceResponse
|
|
5121
5464
|
*/
|
|
5122
|
-
'totalPositive':
|
|
5465
|
+
'totalPositive': DineroObjectResponse;
|
|
5123
5466
|
/**
|
|
5124
|
-
*
|
|
5125
|
-
* @type {
|
|
5467
|
+
*
|
|
5468
|
+
* @type {DineroObjectResponse}
|
|
5126
5469
|
* @memberof TotalBalanceResponse
|
|
5127
5470
|
*/
|
|
5128
|
-
'totalNegative':
|
|
5471
|
+
'totalNegative': DineroObjectResponse;
|
|
5129
5472
|
/**
|
|
5130
|
-
*
|
|
5131
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5473
|
+
* The total balances for the different user types
|
|
5474
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5132
5475
|
* @memberof TotalBalanceResponse
|
|
5133
5476
|
*/
|
|
5134
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5477
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5135
5478
|
}
|
|
5136
5479
|
/**
|
|
5137
5480
|
*
|
|
@@ -5716,7 +6059,7 @@ export interface TransferSummaryResponse {
|
|
|
5716
6059
|
'manualDeletions': TransferAggregateResponse;
|
|
5717
6060
|
}
|
|
5718
6061
|
/**
|
|
5719
|
-
*
|
|
6062
|
+
* API Request for updating a `container` entity.
|
|
5720
6063
|
* @export
|
|
5721
6064
|
* @interface UpdateContainerRequest
|
|
5722
6065
|
*/
|
|
@@ -5966,7 +6309,7 @@ export interface UpdatePinRequest {
|
|
|
5966
6309
|
'pin': string;
|
|
5967
6310
|
}
|
|
5968
6311
|
/**
|
|
5969
|
-
*
|
|
6312
|
+
* API Request for updating a `point of sale` entity.
|
|
5970
6313
|
* @export
|
|
5971
6314
|
* @interface UpdatePointOfSaleRequest
|
|
5972
6315
|
*/
|
|
@@ -6003,7 +6346,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6003
6346
|
'cashierRoleIds'?: Array<number>;
|
|
6004
6347
|
}
|
|
6005
6348
|
/**
|
|
6006
|
-
*
|
|
6349
|
+
* API Request for updating a `product` entity.
|
|
6007
6350
|
* @export
|
|
6008
6351
|
* @interface UpdateProductRequest
|
|
6009
6352
|
*/
|
|
@@ -6168,9 +6511,21 @@ export interface UpdateUserRequest {
|
|
|
6168
6511
|
* @memberof UpdateUserRequest
|
|
6169
6512
|
*/
|
|
6170
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;
|
|
6171
6526
|
}
|
|
6172
6527
|
/**
|
|
6173
|
-
*
|
|
6528
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6174
6529
|
* @export
|
|
6175
6530
|
* @interface UpdateVatGroupRequest
|
|
6176
6531
|
*/
|
|
@@ -6343,11 +6698,17 @@ export interface UserResponse {
|
|
|
6343
6698
|
*/
|
|
6344
6699
|
'email'?: string;
|
|
6345
6700
|
/**
|
|
6346
|
-
* Whether this user
|
|
6347
|
-
* @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}
|
|
6348
6709
|
* @memberof UserResponse
|
|
6349
6710
|
*/
|
|
6350
|
-
'acceptedToS'?:
|
|
6711
|
+
'acceptedToS'?: TermsOfServiceStatus;
|
|
6351
6712
|
/**
|
|
6352
6713
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6353
6714
|
* @type {boolean}
|
|
@@ -6384,6 +6745,12 @@ export interface UserResponse {
|
|
|
6384
6745
|
* @memberof UserResponse
|
|
6385
6746
|
*/
|
|
6386
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;
|
|
6387
6754
|
}
|
|
6388
6755
|
/**
|
|
6389
6756
|
*
|
|
@@ -6490,6 +6857,66 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6490
6857
|
*/
|
|
6491
6858
|
'nickname'?: string;
|
|
6492
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
|
+
}
|
|
6904
|
+
/**
|
|
6905
|
+
* The type of a user
|
|
6906
|
+
* @export
|
|
6907
|
+
* @enum {string}
|
|
6908
|
+
*/
|
|
6909
|
+
export declare const UserType: {
|
|
6910
|
+
readonly Member: "MEMBER";
|
|
6911
|
+
readonly Organ: "ORGAN";
|
|
6912
|
+
readonly Voucher: "VOUCHER";
|
|
6913
|
+
readonly LocalUser: "LOCAL_USER";
|
|
6914
|
+
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6915
|
+
readonly Invoice: "INVOICE";
|
|
6916
|
+
readonly PointOfSale: "POINT_OF_SALE";
|
|
6917
|
+
readonly Integration: "INTEGRATION";
|
|
6918
|
+
};
|
|
6919
|
+
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6493
6920
|
/**
|
|
6494
6921
|
*
|
|
6495
6922
|
* @export
|
|
@@ -6516,7 +6943,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6516
6943
|
'totalNegative': DineroObjectResponse;
|
|
6517
6944
|
}
|
|
6518
6945
|
/**
|
|
6519
|
-
*
|
|
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.
|
|
6520
6947
|
* @export
|
|
6521
6948
|
* @interface UserWithIndex
|
|
6522
6949
|
*/
|
|
@@ -6548,7 +6975,7 @@ export interface ValidationResponse {
|
|
|
6548
6975
|
'errors': Array<string>;
|
|
6549
6976
|
}
|
|
6550
6977
|
/**
|
|
6551
|
-
*
|
|
6978
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6552
6979
|
* @export
|
|
6553
6980
|
* @interface VatDeclarationResponse
|
|
6554
6981
|
*/
|
|
@@ -6573,7 +7000,7 @@ export interface VatDeclarationResponse {
|
|
|
6573
7000
|
'rows': Array<VatDeclarationRow>;
|
|
6574
7001
|
}
|
|
6575
7002
|
/**
|
|
6576
|
-
*
|
|
7003
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6577
7004
|
* @export
|
|
6578
7005
|
* @interface VatDeclarationRow
|
|
6579
7006
|
*/
|
|
@@ -7041,10 +7468,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7041
7468
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7042
7469
|
/**
|
|
7043
7470
|
*
|
|
7044
|
-
* @summary EAN
|
|
7045
|
-
* @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
|
|
7046
7473
|
* @param {*} [options] Override http request option.
|
|
7047
|
-
* @deprecated
|
|
7048
7474
|
* @throws {RequiredError}
|
|
7049
7475
|
*/
|
|
7050
7476
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7119,13 +7545,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7119
7545
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7120
7546
|
/**
|
|
7121
7547
|
*
|
|
7122
|
-
* @summary PIN
|
|
7123
|
-
* @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
|
|
7124
7550
|
* @param {*} [options] Override http request option.
|
|
7125
|
-
* @deprecated
|
|
7126
7551
|
* @throws {RequiredError}
|
|
7127
7552
|
*/
|
|
7128
|
-
|
|
7553
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7129
7554
|
/**
|
|
7130
7555
|
*
|
|
7131
7556
|
* @summary Mock login and hand out token.
|
|
@@ -7136,19 +7561,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7136
7561
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7137
7562
|
/**
|
|
7138
7563
|
*
|
|
7139
|
-
* @summary NFC
|
|
7140
|
-
* @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
|
|
7141
7566
|
* @param {*} [options] Override http request option.
|
|
7142
|
-
* @deprecated
|
|
7143
7567
|
* @throws {RequiredError}
|
|
7144
7568
|
*/
|
|
7145
7569
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7146
7570
|
/**
|
|
7147
7571
|
*
|
|
7148
|
-
* @summary PIN
|
|
7149
|
-
* @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
|
|
7150
7574
|
* @param {*} [options] Override http request option.
|
|
7151
|
-
* @deprecated
|
|
7152
7575
|
* @throws {RequiredError}
|
|
7153
7576
|
*/
|
|
7154
7577
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7175,38 +7598,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7175
7598
|
* @throws {RequiredError}
|
|
7176
7599
|
*/
|
|
7177
7600
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7178
|
-
/**
|
|
7179
|
-
*
|
|
7180
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7181
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7182
|
-
* @param {*} [options] Override http request option.
|
|
7183
|
-
* @throws {RequiredError}
|
|
7184
|
-
*/
|
|
7185
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7186
|
-
/**
|
|
7187
|
-
*
|
|
7188
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7189
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7190
|
-
* @param {*} [options] Override http request option.
|
|
7191
|
-
* @throws {RequiredError}
|
|
7192
|
-
*/
|
|
7193
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7194
|
-
/**
|
|
7195
|
-
*
|
|
7196
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7197
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7198
|
-
* @param {*} [options] Override http request option.
|
|
7199
|
-
* @throws {RequiredError}
|
|
7200
|
-
*/
|
|
7201
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7202
|
-
/**
|
|
7203
|
-
*
|
|
7204
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7205
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7206
|
-
* @param {*} [options] Override http request option.
|
|
7207
|
-
* @throws {RequiredError}
|
|
7208
|
-
*/
|
|
7209
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7210
7601
|
};
|
|
7211
7602
|
/**
|
|
7212
7603
|
* AuthenticateApi - functional programming interface
|
|
@@ -7239,10 +7630,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7239
7630
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7240
7631
|
/**
|
|
7241
7632
|
*
|
|
7242
|
-
* @summary EAN
|
|
7243
|
-
* @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
|
|
7244
7635
|
* @param {*} [options] Override http request option.
|
|
7245
|
-
* @deprecated
|
|
7246
7636
|
* @throws {RequiredError}
|
|
7247
7637
|
*/
|
|
7248
7638
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7317,13 +7707,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7317
7707
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7318
7708
|
/**
|
|
7319
7709
|
*
|
|
7320
|
-
* @summary PIN
|
|
7321
|
-
* @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
|
|
7322
7712
|
* @param {*} [options] Override http request option.
|
|
7323
|
-
* @deprecated
|
|
7324
7713
|
* @throws {RequiredError}
|
|
7325
7714
|
*/
|
|
7326
|
-
|
|
7715
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7327
7716
|
/**
|
|
7328
7717
|
*
|
|
7329
7718
|
* @summary Mock login and hand out token.
|
|
@@ -7334,19 +7723,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7334
7723
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7335
7724
|
/**
|
|
7336
7725
|
*
|
|
7337
|
-
* @summary NFC
|
|
7338
|
-
* @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
|
|
7339
7728
|
* @param {*} [options] Override http request option.
|
|
7340
|
-
* @deprecated
|
|
7341
7729
|
* @throws {RequiredError}
|
|
7342
7730
|
*/
|
|
7343
7731
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7344
7732
|
/**
|
|
7345
7733
|
*
|
|
7346
|
-
* @summary PIN
|
|
7347
|
-
* @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
|
|
7348
7736
|
* @param {*} [options] Override http request option.
|
|
7349
|
-
* @deprecated
|
|
7350
7737
|
* @throws {RequiredError}
|
|
7351
7738
|
*/
|
|
7352
7739
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7373,38 +7760,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7373
7760
|
* @throws {RequiredError}
|
|
7374
7761
|
*/
|
|
7375
7762
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7376
|
-
/**
|
|
7377
|
-
*
|
|
7378
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7379
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7380
|
-
* @param {*} [options] Override http request option.
|
|
7381
|
-
* @throws {RequiredError}
|
|
7382
|
-
*/
|
|
7383
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7384
|
-
/**
|
|
7385
|
-
*
|
|
7386
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7387
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7388
|
-
* @param {*} [options] Override http request option.
|
|
7389
|
-
* @throws {RequiredError}
|
|
7390
|
-
*/
|
|
7391
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7392
|
-
/**
|
|
7393
|
-
*
|
|
7394
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7395
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7396
|
-
* @param {*} [options] Override http request option.
|
|
7397
|
-
* @throws {RequiredError}
|
|
7398
|
-
*/
|
|
7399
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7400
|
-
/**
|
|
7401
|
-
*
|
|
7402
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7403
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7404
|
-
* @param {*} [options] Override http request option.
|
|
7405
|
-
* @throws {RequiredError}
|
|
7406
|
-
*/
|
|
7407
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7408
7763
|
};
|
|
7409
7764
|
/**
|
|
7410
7765
|
* AuthenticateApi - factory interface
|
|
@@ -7437,10 +7792,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7437
7792
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7438
7793
|
/**
|
|
7439
7794
|
*
|
|
7440
|
-
* @summary EAN
|
|
7795
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7441
7796
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7442
7797
|
* @param {*} [options] Override http request option.
|
|
7443
|
-
* @deprecated
|
|
7444
7798
|
* @throws {RequiredError}
|
|
7445
7799
|
*/
|
|
7446
7800
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7515,13 +7869,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7515
7869
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7516
7870
|
/**
|
|
7517
7871
|
*
|
|
7518
|
-
* @summary PIN
|
|
7519
|
-
* @param {
|
|
7872
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7873
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7520
7874
|
* @param {*} [options] Override http request option.
|
|
7521
|
-
* @deprecated
|
|
7522
7875
|
* @throws {RequiredError}
|
|
7523
7876
|
*/
|
|
7524
|
-
|
|
7877
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7525
7878
|
/**
|
|
7526
7879
|
*
|
|
7527
7880
|
* @summary Mock login and hand out token.
|
|
@@ -7532,19 +7885,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7532
7885
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7533
7886
|
/**
|
|
7534
7887
|
*
|
|
7535
|
-
* @summary NFC
|
|
7888
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7536
7889
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7537
7890
|
* @param {*} [options] Override http request option.
|
|
7538
|
-
* @deprecated
|
|
7539
7891
|
* @throws {RequiredError}
|
|
7540
7892
|
*/
|
|
7541
7893
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7542
7894
|
/**
|
|
7543
7895
|
*
|
|
7544
|
-
* @summary PIN
|
|
7896
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7545
7897
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7546
7898
|
* @param {*} [options] Override http request option.
|
|
7547
|
-
* @deprecated
|
|
7548
7899
|
* @throws {RequiredError}
|
|
7549
7900
|
*/
|
|
7550
7901
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7571,38 +7922,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7571
7922
|
* @throws {RequiredError}
|
|
7572
7923
|
*/
|
|
7573
7924
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7574
|
-
/**
|
|
7575
|
-
*
|
|
7576
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7577
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7578
|
-
* @param {*} [options] Override http request option.
|
|
7579
|
-
* @throws {RequiredError}
|
|
7580
|
-
*/
|
|
7581
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7582
|
-
/**
|
|
7583
|
-
*
|
|
7584
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7585
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7586
|
-
* @param {*} [options] Override http request option.
|
|
7587
|
-
* @throws {RequiredError}
|
|
7588
|
-
*/
|
|
7589
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7590
|
-
/**
|
|
7591
|
-
*
|
|
7592
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7593
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7594
|
-
* @param {*} [options] Override http request option.
|
|
7595
|
-
* @throws {RequiredError}
|
|
7596
|
-
*/
|
|
7597
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7598
|
-
/**
|
|
7599
|
-
*
|
|
7600
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7601
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7602
|
-
* @param {*} [options] Override http request option.
|
|
7603
|
-
* @throws {RequiredError}
|
|
7604
|
-
*/
|
|
7605
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7606
7925
|
};
|
|
7607
7926
|
/**
|
|
7608
7927
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7650,7 +7969,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7650
7969
|
*/
|
|
7651
7970
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7652
7971
|
/**
|
|
7653
|
-
* The EAN login
|
|
7972
|
+
* The EAN login request with posId
|
|
7654
7973
|
* @type {AuthenticationEanRequest}
|
|
7655
7974
|
* @memberof AuthenticateApiEanAuthentication
|
|
7656
7975
|
*/
|
|
@@ -7735,15 +8054,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7735
8054
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7736
8055
|
}
|
|
7737
8056
|
/**
|
|
7738
|
-
* Request parameters for
|
|
8057
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7739
8058
|
* @export
|
|
7740
|
-
* @interface
|
|
8059
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7741
8060
|
*/
|
|
7742
|
-
export interface
|
|
8061
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7743
8062
|
/**
|
|
7744
|
-
* The PIN login
|
|
8063
|
+
* The PIN login request with posId
|
|
7745
8064
|
* @type {MemberAuthenticationPinRequest}
|
|
7746
|
-
* @memberof
|
|
8065
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7747
8066
|
*/
|
|
7748
8067
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7749
8068
|
}
|
|
@@ -7767,7 +8086,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7767
8086
|
*/
|
|
7768
8087
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7769
8088
|
/**
|
|
7770
|
-
* The NFC login
|
|
8089
|
+
* The NFC login request with posId
|
|
7771
8090
|
* @type {AuthenticationNfcRequest}
|
|
7772
8091
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7773
8092
|
*/
|
|
@@ -7780,7 +8099,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7780
8099
|
*/
|
|
7781
8100
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7782
8101
|
/**
|
|
7783
|
-
* The PIN login
|
|
8102
|
+
* The PIN login request with posId
|
|
7784
8103
|
* @type {AuthenticationPinRequest}
|
|
7785
8104
|
* @memberof AuthenticateApiPinAuthentication
|
|
7786
8105
|
*/
|
|
@@ -7813,62 +8132,10 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7813
8132
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7814
8133
|
}
|
|
7815
8134
|
/**
|
|
7816
|
-
*
|
|
8135
|
+
* AuthenticateApi - object-oriented interface
|
|
7817
8136
|
* @export
|
|
7818
|
-
* @
|
|
7819
|
-
|
|
7820
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7821
|
-
/**
|
|
7822
|
-
* The EAN login request with posId
|
|
7823
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7824
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7825
|
-
*/
|
|
7826
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7827
|
-
}
|
|
7828
|
-
/**
|
|
7829
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7830
|
-
* @export
|
|
7831
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7832
|
-
*/
|
|
7833
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7834
|
-
/**
|
|
7835
|
-
* The PIN login request with posId
|
|
7836
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7837
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7838
|
-
*/
|
|
7839
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7840
|
-
}
|
|
7841
|
-
/**
|
|
7842
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7843
|
-
* @export
|
|
7844
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7845
|
-
*/
|
|
7846
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7847
|
-
/**
|
|
7848
|
-
* The NFC login request with posId
|
|
7849
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7850
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7851
|
-
*/
|
|
7852
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7853
|
-
}
|
|
7854
|
-
/**
|
|
7855
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7856
|
-
* @export
|
|
7857
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7858
|
-
*/
|
|
7859
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7860
|
-
/**
|
|
7861
|
-
* The PIN login request with posId
|
|
7862
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7863
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7864
|
-
*/
|
|
7865
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7866
|
-
}
|
|
7867
|
-
/**
|
|
7868
|
-
* AuthenticateApi - object-oriented interface
|
|
7869
|
-
* @export
|
|
7870
|
-
* @class AuthenticateApi
|
|
7871
|
-
* @extends {BaseAPI}
|
|
8137
|
+
* @class AuthenticateApi
|
|
8138
|
+
* @extends {BaseAPI}
|
|
7872
8139
|
*/
|
|
7873
8140
|
export declare class AuthenticateApi extends BaseAPI {
|
|
7874
8141
|
/**
|
|
@@ -7900,10 +8167,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7900
8167
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7901
8168
|
/**
|
|
7902
8169
|
*
|
|
7903
|
-
* @summary EAN
|
|
8170
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7904
8171
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7905
8172
|
* @param {*} [options] Override http request option.
|
|
7906
|
-
* @deprecated
|
|
7907
8173
|
* @throws {RequiredError}
|
|
7908
8174
|
* @memberof AuthenticateApi
|
|
7909
8175
|
*/
|
|
@@ -7988,14 +8254,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7988
8254
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7989
8255
|
/**
|
|
7990
8256
|
*
|
|
7991
|
-
* @summary PIN
|
|
7992
|
-
* @param {
|
|
8257
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8258
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7993
8259
|
* @param {*} [options] Override http request option.
|
|
7994
|
-
* @deprecated
|
|
7995
8260
|
* @throws {RequiredError}
|
|
7996
8261
|
* @memberof AuthenticateApi
|
|
7997
8262
|
*/
|
|
7998
|
-
|
|
8263
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7999
8264
|
/**
|
|
8000
8265
|
*
|
|
8001
8266
|
* @summary Mock login and hand out token.
|
|
@@ -8007,20 +8272,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8007
8272
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8008
8273
|
/**
|
|
8009
8274
|
*
|
|
8010
|
-
* @summary NFC
|
|
8275
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8011
8276
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8012
8277
|
* @param {*} [options] Override http request option.
|
|
8013
|
-
* @deprecated
|
|
8014
8278
|
* @throws {RequiredError}
|
|
8015
8279
|
* @memberof AuthenticateApi
|
|
8016
8280
|
*/
|
|
8017
8281
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8018
8282
|
/**
|
|
8019
8283
|
*
|
|
8020
|
-
* @summary PIN
|
|
8284
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8021
8285
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8022
8286
|
* @param {*} [options] Override http request option.
|
|
8023
|
-
* @deprecated
|
|
8024
8287
|
* @throws {RequiredError}
|
|
8025
8288
|
* @memberof AuthenticateApi
|
|
8026
8289
|
*/
|
|
@@ -8051,42 +8314,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8051
8314
|
* @memberof AuthenticateApi
|
|
8052
8315
|
*/
|
|
8053
8316
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8054
|
-
/**
|
|
8055
|
-
*
|
|
8056
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
8057
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
8058
|
-
* @param {*} [options] Override http request option.
|
|
8059
|
-
* @throws {RequiredError}
|
|
8060
|
-
* @memberof AuthenticateApi
|
|
8061
|
-
*/
|
|
8062
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8063
|
-
/**
|
|
8064
|
-
*
|
|
8065
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
8066
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8067
|
-
* @param {*} [options] Override http request option.
|
|
8068
|
-
* @throws {RequiredError}
|
|
8069
|
-
* @memberof AuthenticateApi
|
|
8070
|
-
*/
|
|
8071
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8072
|
-
/**
|
|
8073
|
-
*
|
|
8074
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
8075
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8076
|
-
* @param {*} [options] Override http request option.
|
|
8077
|
-
* @throws {RequiredError}
|
|
8078
|
-
* @memberof AuthenticateApi
|
|
8079
|
-
*/
|
|
8080
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8081
|
-
/**
|
|
8082
|
-
*
|
|
8083
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
8084
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
8085
|
-
* @param {*} [options] Override http request option.
|
|
8086
|
-
* @throws {RequiredError}
|
|
8087
|
-
* @memberof AuthenticateApi
|
|
8088
|
-
*/
|
|
8089
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8090
8317
|
}
|
|
8091
8318
|
/**
|
|
8092
8319
|
* BalanceApi - axios parameter creator
|
|
@@ -8111,7 +8338,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8111
8338
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8112
8339
|
* @param {number} [minFine] Minimum fine
|
|
8113
8340
|
* @param {number} [maxFine] Maximum fine
|
|
8114
|
-
* @param {
|
|
8341
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8115
8342
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8116
8343
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8117
8344
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8121,7 +8348,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8121
8348
|
* @param {*} [options] Override http request option.
|
|
8122
8349
|
* @throws {RequiredError}
|
|
8123
8350
|
*/
|
|
8124
|
-
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8351
|
+
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8125
8352
|
/**
|
|
8126
8353
|
*
|
|
8127
8354
|
* @summary Retrieves the requested balance
|
|
@@ -8161,7 +8388,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8161
8388
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8162
8389
|
* @param {number} [minFine] Minimum fine
|
|
8163
8390
|
* @param {number} [maxFine] Maximum fine
|
|
8164
|
-
* @param {
|
|
8391
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8165
8392
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8166
8393
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8167
8394
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8171,7 +8398,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8171
8398
|
* @param {*} [options] Override http request option.
|
|
8172
8399
|
* @throws {RequiredError}
|
|
8173
8400
|
*/
|
|
8174
|
-
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8401
|
+
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBalanceResponse>>;
|
|
8175
8402
|
/**
|
|
8176
8403
|
*
|
|
8177
8404
|
* @summary Retrieves the requested balance
|
|
@@ -8288,10 +8515,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8288
8515
|
readonly maxFine?: number;
|
|
8289
8516
|
/**
|
|
8290
8517
|
* Filter based on user type.
|
|
8291
|
-
* @type {Array<
|
|
8518
|
+
* @type {Array<UserType>}
|
|
8292
8519
|
* @memberof BalanceApiGetAllBalance
|
|
8293
8520
|
*/
|
|
8294
|
-
readonly userTypes?:
|
|
8521
|
+
readonly userTypes?: Array<UserType>;
|
|
8295
8522
|
/**
|
|
8296
8523
|
* Column to order balance by - eg: id,amount
|
|
8297
8524
|
* @type {string}
|
|
@@ -8385,11 +8612,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8385
8612
|
*/
|
|
8386
8613
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8387
8614
|
}
|
|
8388
|
-
/**
|
|
8389
|
-
* @export
|
|
8390
|
-
*/
|
|
8391
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8392
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8393
8615
|
/**
|
|
8394
8616
|
* @export
|
|
8395
8617
|
*/
|
|
@@ -10810,7 +11032,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10810
11032
|
* @param {*} [options] Override http request option.
|
|
10811
11033
|
* @throws {RequiredError}
|
|
10812
11034
|
*/
|
|
10813
|
-
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>>>;
|
|
10814
11036
|
/**
|
|
10815
11037
|
*
|
|
10816
11038
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10888,7 +11110,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10888
11110
|
* @param {*} [options] Override http request option.
|
|
10889
11111
|
* @throws {RequiredError}
|
|
10890
11112
|
*/
|
|
10891
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11113
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10892
11114
|
/**
|
|
10893
11115
|
*
|
|
10894
11116
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11111,7 +11333,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11111
11333
|
* @throws {RequiredError}
|
|
11112
11334
|
* @memberof InactiveAdministrativeCostsApi
|
|
11113
11335
|
*/
|
|
11114
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11336
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11115
11337
|
/**
|
|
11116
11338
|
*
|
|
11117
11339
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11156,7 +11378,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11156
11378
|
* @summary Returns all invoices in the system.
|
|
11157
11379
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11158
11380
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11159
|
-
* @param {
|
|
11381
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11160
11382
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11161
11383
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11162
11384
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11166,7 +11388,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11166
11388
|
* @param {*} [options] Override http request option.
|
|
11167
11389
|
* @throws {RequiredError}
|
|
11168
11390
|
*/
|
|
11169
|
-
getAllInvoices: (toId?: number, invoiceId?: number, currentState?:
|
|
11391
|
+
getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11170
11392
|
/**
|
|
11171
11393
|
*
|
|
11172
11394
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11263,7 +11485,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11263
11485
|
* @summary Returns all invoices in the system.
|
|
11264
11486
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11265
11487
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11266
|
-
* @param {
|
|
11488
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11267
11489
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11268
11490
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11269
11491
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11273,7 +11495,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11273
11495
|
* @param {*} [options] Override http request option.
|
|
11274
11496
|
* @throws {RequiredError}
|
|
11275
11497
|
*/
|
|
11276
|
-
getAllInvoices(toId?: number, invoiceId?: number, currentState?:
|
|
11498
|
+
getAllInvoices(toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
|
|
11277
11499
|
/**
|
|
11278
11500
|
*
|
|
11279
11501
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11283,7 +11505,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11283
11505
|
* @param {*} [options] Override http request option.
|
|
11284
11506
|
* @throws {RequiredError}
|
|
11285
11507
|
*/
|
|
11286
|
-
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>>>;
|
|
11287
11509
|
/**
|
|
11288
11510
|
*
|
|
11289
11511
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11299,7 +11521,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11299
11521
|
* @param {*} [options] Override http request option.
|
|
11300
11522
|
* @throws {RequiredError}
|
|
11301
11523
|
*/
|
|
11302
|
-
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>>;
|
|
11303
11525
|
/**
|
|
11304
11526
|
*
|
|
11305
11527
|
* @summary Returns a single invoice in the system.
|
|
@@ -11380,7 +11602,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11380
11602
|
* @param {*} [options] Override http request option.
|
|
11381
11603
|
* @throws {RequiredError}
|
|
11382
11604
|
*/
|
|
11383
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11605
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11384
11606
|
/**
|
|
11385
11607
|
*
|
|
11386
11608
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11395,7 +11617,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11395
11617
|
* @param {*} [options] Override http request option.
|
|
11396
11618
|
* @throws {RequiredError}
|
|
11397
11619
|
*/
|
|
11398
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11620
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11399
11621
|
/**
|
|
11400
11622
|
*
|
|
11401
11623
|
* @summary Returns a single invoice in the system.
|
|
@@ -11491,7 +11713,7 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11491
11713
|
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11492
11714
|
* @memberof InvoicesApiGetAllInvoices
|
|
11493
11715
|
*/
|
|
11494
|
-
readonly currentState?:
|
|
11716
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11495
11717
|
/**
|
|
11496
11718
|
* Boolean if invoice entries should be returned
|
|
11497
11719
|
* @type {boolean}
|
|
@@ -11694,7 +11916,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11694
11916
|
* @throws {RequiredError}
|
|
11695
11917
|
* @memberof InvoicesApi
|
|
11696
11918
|
*/
|
|
11697
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11919
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11698
11920
|
/**
|
|
11699
11921
|
*
|
|
11700
11922
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11711,7 +11933,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11711
11933
|
* @throws {RequiredError}
|
|
11712
11934
|
* @memberof InvoicesApi
|
|
11713
11935
|
*/
|
|
11714
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11936
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11715
11937
|
/**
|
|
11716
11938
|
*
|
|
11717
11939
|
* @summary Returns a single invoice in the system.
|
|
@@ -11750,332 +11972,813 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11750
11972
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11751
11973
|
}
|
|
11752
11974
|
/**
|
|
11975
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11753
11976
|
* @export
|
|
11754
11977
|
*/
|
|
11755
|
-
export declare const
|
|
11756
|
-
export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
|
|
11757
|
-
/**
|
|
11758
|
-
* PayoutRequestsApi - axios parameter creator
|
|
11759
|
-
* @export
|
|
11760
|
-
*/
|
|
11761
|
-
export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11978
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11762
11979
|
/**
|
|
11763
11980
|
*
|
|
11764
|
-
* @summary
|
|
11765
|
-
* @param {
|
|
11981
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11982
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11766
11983
|
* @param {*} [options] Override http request option.
|
|
11767
11984
|
* @throws {RequiredError}
|
|
11768
11985
|
*/
|
|
11769
|
-
|
|
11986
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11770
11987
|
/**
|
|
11771
11988
|
*
|
|
11772
|
-
* @summary
|
|
11773
|
-
* @param {
|
|
11774
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11775
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11776
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11777
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11778
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11779
|
-
* @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
|
|
11780
11991
|
* @param {*} [options] Override http request option.
|
|
11781
11992
|
* @throws {RequiredError}
|
|
11782
11993
|
*/
|
|
11783
|
-
|
|
11994
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11784
11995
|
/**
|
|
11785
11996
|
*
|
|
11786
|
-
* @summary
|
|
11787
|
-
* @param {number}
|
|
11788
|
-
* @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)
|
|
11789
12005
|
* @param {*} [options] Override http request option.
|
|
11790
12006
|
* @throws {RequiredError}
|
|
11791
12007
|
*/
|
|
11792
|
-
|
|
12008
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11793
12009
|
/**
|
|
11794
12010
|
*
|
|
11795
|
-
* @summary
|
|
11796
|
-
* @param {
|
|
12011
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12012
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11797
12013
|
* @param {*} [options] Override http request option.
|
|
11798
12014
|
* @throws {RequiredError}
|
|
11799
12015
|
*/
|
|
11800
|
-
|
|
12016
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11801
12017
|
/**
|
|
11802
12018
|
*
|
|
11803
|
-
* @summary
|
|
11804
|
-
* @param {
|
|
11805
|
-
* @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
|
|
11806
12022
|
* @param {*} [options] Override http request option.
|
|
11807
12023
|
* @throws {RequiredError}
|
|
11808
12024
|
*/
|
|
11809
|
-
|
|
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>;
|
|
11810
12034
|
};
|
|
11811
12035
|
/**
|
|
11812
|
-
*
|
|
12036
|
+
* PaymentRequestsApi - functional programming interface
|
|
11813
12037
|
* @export
|
|
11814
12038
|
*/
|
|
11815
|
-
export declare const
|
|
12039
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11816
12040
|
/**
|
|
11817
12041
|
*
|
|
11818
|
-
* @summary
|
|
11819
|
-
* @param {
|
|
12042
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12043
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11820
12044
|
* @param {*} [options] Override http request option.
|
|
11821
12045
|
* @throws {RequiredError}
|
|
11822
12046
|
*/
|
|
11823
|
-
|
|
12047
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11824
12048
|
/**
|
|
11825
12049
|
*
|
|
11826
|
-
* @summary
|
|
11827
|
-
* @param {
|
|
11828
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11829
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11830
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11831
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11832
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11833
|
-
* @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
|
|
11834
12052
|
* @param {*} [options] Override http request option.
|
|
11835
12053
|
* @throws {RequiredError}
|
|
11836
12054
|
*/
|
|
11837
|
-
|
|
12055
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11838
12056
|
/**
|
|
11839
12057
|
*
|
|
11840
|
-
* @summary
|
|
11841
|
-
* @param {number}
|
|
11842
|
-
* @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)
|
|
11843
12066
|
* @param {*} [options] Override http request option.
|
|
11844
12067
|
* @throws {RequiredError}
|
|
11845
12068
|
*/
|
|
11846
|
-
|
|
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>>;
|
|
11847
12070
|
/**
|
|
11848
12071
|
*
|
|
11849
|
-
* @summary
|
|
11850
|
-
* @param {
|
|
12072
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12073
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11851
12074
|
* @param {*} [options] Override http request option.
|
|
11852
12075
|
* @throws {RequiredError}
|
|
11853
12076
|
*/
|
|
11854
|
-
|
|
12077
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11855
12078
|
/**
|
|
11856
12079
|
*
|
|
11857
|
-
* @summary
|
|
11858
|
-
* @param {
|
|
11859
|
-
* @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
|
|
11860
12083
|
* @param {*} [options] Override http request option.
|
|
11861
12084
|
* @throws {RequiredError}
|
|
11862
12085
|
*/
|
|
11863
|
-
|
|
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>>;
|
|
11864
12095
|
};
|
|
11865
12096
|
/**
|
|
11866
|
-
*
|
|
12097
|
+
* PaymentRequestsApi - factory interface
|
|
11867
12098
|
* @export
|
|
11868
12099
|
*/
|
|
11869
|
-
export declare const
|
|
12100
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11870
12101
|
/**
|
|
11871
12102
|
*
|
|
11872
|
-
* @summary
|
|
11873
|
-
* @param {
|
|
12103
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12104
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11874
12105
|
* @param {*} [options] Override http request option.
|
|
11875
12106
|
* @throws {RequiredError}
|
|
11876
12107
|
*/
|
|
11877
|
-
|
|
12108
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11878
12109
|
/**
|
|
11879
12110
|
*
|
|
11880
|
-
* @summary
|
|
11881
|
-
* @param {
|
|
12111
|
+
* @summary Create a new PaymentRequest.
|
|
12112
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11882
12113
|
* @param {*} [options] Override http request option.
|
|
11883
12114
|
* @throws {RequiredError}
|
|
11884
12115
|
*/
|
|
11885
|
-
|
|
12116
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11886
12117
|
/**
|
|
11887
12118
|
*
|
|
11888
|
-
* @summary
|
|
11889
|
-
* @param {
|
|
12119
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12120
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11890
12121
|
* @param {*} [options] Override http request option.
|
|
11891
12122
|
* @throws {RequiredError}
|
|
11892
12123
|
*/
|
|
11893
|
-
|
|
12124
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11894
12125
|
/**
|
|
11895
12126
|
*
|
|
11896
|
-
* @summary
|
|
11897
|
-
* @param {
|
|
12127
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12128
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11898
12129
|
* @param {*} [options] Override http request option.
|
|
11899
12130
|
* @throws {RequiredError}
|
|
11900
12131
|
*/
|
|
11901
|
-
|
|
12132
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11902
12133
|
/**
|
|
11903
12134
|
*
|
|
11904
|
-
* @summary
|
|
11905
|
-
* @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.
|
|
11906
12137
|
* @param {*} [options] Override http request option.
|
|
11907
12138
|
* @throws {RequiredError}
|
|
11908
12139
|
*/
|
|
11909
|
-
|
|
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>;
|
|
11910
12149
|
};
|
|
11911
12150
|
/**
|
|
11912
|
-
* Request parameters for
|
|
12151
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11913
12152
|
* @export
|
|
11914
|
-
* @interface
|
|
12153
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11915
12154
|
*/
|
|
11916
|
-
export interface
|
|
12155
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11917
12156
|
/**
|
|
11918
|
-
*
|
|
11919
|
-
* @type {
|
|
11920
|
-
* @memberof
|
|
12157
|
+
* UUID v4 of the payment request.
|
|
12158
|
+
* @type {string}
|
|
12159
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11921
12160
|
*/
|
|
11922
|
-
readonly
|
|
12161
|
+
readonly id: string;
|
|
11923
12162
|
}
|
|
11924
12163
|
/**
|
|
11925
|
-
* Request parameters for
|
|
12164
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11926
12165
|
* @export
|
|
11927
|
-
* @interface
|
|
12166
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11928
12167
|
*/
|
|
11929
|
-
export interface
|
|
12168
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11930
12169
|
/**
|
|
11931
|
-
*
|
|
11932
|
-
* @type {
|
|
11933
|
-
* @memberof
|
|
12170
|
+
* The request to create
|
|
12171
|
+
* @type {CreatePaymentRequestRequest}
|
|
12172
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11934
12173
|
*/
|
|
11935
|
-
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 {
|
|
11936
12182
|
/**
|
|
11937
|
-
*
|
|
11938
|
-
* @type {
|
|
11939
|
-
* @memberof
|
|
12183
|
+
* Filter by beneficiary user id.
|
|
12184
|
+
* @type {number}
|
|
12185
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11940
12186
|
*/
|
|
11941
|
-
readonly
|
|
12187
|
+
readonly forId?: number;
|
|
11942
12188
|
/**
|
|
11943
|
-
*
|
|
11944
|
-
* @type {
|
|
11945
|
-
* @memberof
|
|
12189
|
+
* Filter by creator user id.
|
|
12190
|
+
* @type {number}
|
|
12191
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11946
12192
|
*/
|
|
11947
|
-
readonly
|
|
12193
|
+
readonly createdById?: number;
|
|
11948
12194
|
/**
|
|
11949
|
-
*
|
|
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).
|
|
11950
12202
|
* @type {string}
|
|
11951
|
-
* @memberof
|
|
12203
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11952
12204
|
*/
|
|
11953
|
-
readonly
|
|
12205
|
+
readonly fromDate?: string;
|
|
11954
12206
|
/**
|
|
11955
|
-
*
|
|
12207
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
11956
12208
|
* @type {string}
|
|
11957
|
-
* @memberof
|
|
12209
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11958
12210
|
*/
|
|
11959
|
-
readonly
|
|
12211
|
+
readonly tillDate?: string;
|
|
11960
12212
|
/**
|
|
11961
|
-
* How many
|
|
12213
|
+
* How many rows the endpoint should return
|
|
11962
12214
|
* @type {number}
|
|
11963
|
-
* @memberof
|
|
12215
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11964
12216
|
*/
|
|
11965
12217
|
readonly take?: number;
|
|
11966
12218
|
/**
|
|
11967
|
-
* How many
|
|
12219
|
+
* How many rows to skip (for pagination)
|
|
11968
12220
|
* @type {number}
|
|
11969
|
-
* @memberof
|
|
12221
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11970
12222
|
*/
|
|
11971
12223
|
readonly skip?: number;
|
|
11972
12224
|
}
|
|
11973
12225
|
/**
|
|
11974
|
-
* Request parameters for
|
|
12226
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11975
12227
|
* @export
|
|
11976
|
-
* @interface
|
|
12228
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11977
12229
|
*/
|
|
11978
|
-
export interface
|
|
11979
|
-
/**
|
|
11980
|
-
* The ID of the payout request object that should be returned
|
|
11981
|
-
* @type {number}
|
|
11982
|
-
* @memberof PayoutRequestsApiGetPayoutRequestPdf
|
|
11983
|
-
*/
|
|
11984
|
-
readonly id: number;
|
|
12230
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11985
12231
|
/**
|
|
11986
|
-
*
|
|
11987
|
-
* @type {
|
|
11988
|
-
* @memberof
|
|
12232
|
+
* UUID v4 of the payment request.
|
|
12233
|
+
* @type {string}
|
|
12234
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11989
12235
|
*/
|
|
11990
|
-
readonly
|
|
12236
|
+
readonly id: string;
|
|
11991
12237
|
}
|
|
11992
12238
|
/**
|
|
11993
|
-
* Request parameters for
|
|
12239
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11994
12240
|
* @export
|
|
11995
|
-
* @interface
|
|
12241
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11996
12242
|
*/
|
|
11997
|
-
export interface
|
|
12243
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11998
12244
|
/**
|
|
11999
|
-
*
|
|
12000
|
-
* @type {
|
|
12001
|
-
* @memberof
|
|
12245
|
+
* UUID v4 of the payment request.
|
|
12246
|
+
* @type {string}
|
|
12247
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12002
12248
|
*/
|
|
12003
|
-
readonly id:
|
|
12249
|
+
readonly id: string;
|
|
12250
|
+
/**
|
|
12251
|
+
* The audit reason
|
|
12252
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12253
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12254
|
+
*/
|
|
12255
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12004
12256
|
}
|
|
12005
12257
|
/**
|
|
12006
|
-
* Request parameters for
|
|
12258
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12007
12259
|
* @export
|
|
12008
|
-
* @interface
|
|
12260
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12009
12261
|
*/
|
|
12010
|
-
export interface
|
|
12011
|
-
/**
|
|
12012
|
-
* The ID of the payout request object that should be returned
|
|
12013
|
-
* @type {number}
|
|
12014
|
-
* @memberof PayoutRequestsApiSetPayoutRequestStatus
|
|
12015
|
-
*/
|
|
12016
|
-
readonly id: number;
|
|
12262
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12017
12263
|
/**
|
|
12018
|
-
*
|
|
12019
|
-
* @type {
|
|
12020
|
-
* @memberof
|
|
12264
|
+
* UUID v4 of the payment request.
|
|
12265
|
+
* @type {string}
|
|
12266
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12021
12267
|
*/
|
|
12022
|
-
readonly
|
|
12268
|
+
readonly id: string;
|
|
12023
12269
|
}
|
|
12024
12270
|
/**
|
|
12025
|
-
*
|
|
12271
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12026
12272
|
* @export
|
|
12027
|
-
* @class
|
|
12273
|
+
* @class PaymentRequestsApi
|
|
12028
12274
|
* @extends {BaseAPI}
|
|
12029
12275
|
*/
|
|
12030
|
-
export declare class
|
|
12276
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12031
12277
|
/**
|
|
12032
12278
|
*
|
|
12033
|
-
* @summary
|
|
12034
|
-
* @param {
|
|
12279
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12280
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12035
12281
|
* @param {*} [options] Override http request option.
|
|
12036
12282
|
* @throws {RequiredError}
|
|
12037
|
-
* @memberof
|
|
12283
|
+
* @memberof PaymentRequestsApi
|
|
12038
12284
|
*/
|
|
12039
|
-
|
|
12285
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12040
12286
|
/**
|
|
12041
12287
|
*
|
|
12042
|
-
* @summary
|
|
12043
|
-
* @param {
|
|
12288
|
+
* @summary Create a new PaymentRequest.
|
|
12289
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12044
12290
|
* @param {*} [options] Override http request option.
|
|
12045
12291
|
* @throws {RequiredError}
|
|
12046
|
-
* @memberof
|
|
12292
|
+
* @memberof PaymentRequestsApi
|
|
12047
12293
|
*/
|
|
12048
|
-
|
|
12294
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12049
12295
|
/**
|
|
12050
12296
|
*
|
|
12051
|
-
* @summary
|
|
12052
|
-
* @param {
|
|
12297
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12298
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12053
12299
|
* @param {*} [options] Override http request option.
|
|
12054
12300
|
* @throws {RequiredError}
|
|
12055
|
-
* @memberof
|
|
12301
|
+
* @memberof PaymentRequestsApi
|
|
12056
12302
|
*/
|
|
12057
|
-
|
|
12303
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12058
12304
|
/**
|
|
12059
12305
|
*
|
|
12060
|
-
* @summary
|
|
12061
|
-
* @param {
|
|
12306
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12307
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12062
12308
|
* @param {*} [options] Override http request option.
|
|
12063
12309
|
* @throws {RequiredError}
|
|
12064
|
-
* @memberof
|
|
12310
|
+
* @memberof PaymentRequestsApi
|
|
12065
12311
|
*/
|
|
12066
|
-
|
|
12312
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12067
12313
|
/**
|
|
12068
12314
|
*
|
|
12069
|
-
* @summary
|
|
12070
|
-
* @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.
|
|
12071
12317
|
* @param {*} [options] Override http request option.
|
|
12072
12318
|
* @throws {RequiredError}
|
|
12073
|
-
* @memberof
|
|
12319
|
+
* @memberof PaymentRequestsApi
|
|
12074
12320
|
*/
|
|
12075
|
-
|
|
12076
|
-
|
|
12077
|
-
|
|
12078
|
-
|
|
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, {}>>;
|
|
12779
|
+
}
|
|
12780
|
+
/**
|
|
12781
|
+
* PointofsaleApi - axios parameter creator
|
|
12079
12782
|
* @export
|
|
12080
12783
|
*/
|
|
12081
12784
|
export declare const PointofsaleApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
@@ -14182,201 +14885,480 @@ export declare class ServerSettingsApi extends BaseAPI {
|
|
|
14182
14885
|
getWrappedEnabled(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WrappedEnabledResponse, any, {}>>;
|
|
14183
14886
|
/**
|
|
14184
14887
|
*
|
|
14185
|
-
* @summary Enable/disable maintenance mode
|
|
14186
|
-
* @param {ServerSettingsApiSetMaintenanceModeRequest} requestParameters Request parameters.
|
|
14888
|
+
* @summary Enable/disable maintenance mode
|
|
14889
|
+
* @param {ServerSettingsApiSetMaintenanceModeRequest} requestParameters Request parameters.
|
|
14890
|
+
* @param {*} [options] Override http request option.
|
|
14891
|
+
* @throws {RequiredError}
|
|
14892
|
+
* @memberof ServerSettingsApi
|
|
14893
|
+
*/
|
|
14894
|
+
setMaintenanceMode(requestParameters: ServerSettingsApiSetMaintenanceModeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
14895
|
+
/**
|
|
14896
|
+
*
|
|
14897
|
+
* @summary Set the wrapped-enabled server setting
|
|
14898
|
+
* @param {ServerSettingsApiSetWrappedEnabledRequest} requestParameters Request parameters.
|
|
14899
|
+
* @param {*} [options] Override http request option.
|
|
14900
|
+
* @throws {RequiredError}
|
|
14901
|
+
* @memberof ServerSettingsApi
|
|
14902
|
+
*/
|
|
14903
|
+
setWrappedEnabled(requestParameters: ServerSettingsApiSetWrappedEnabledRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
14904
|
+
}
|
|
14905
|
+
/**
|
|
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
|
|
14187
15147
|
* @param {*} [options] Override http request option.
|
|
14188
15148
|
* @throws {RequiredError}
|
|
14189
|
-
* @memberof ServerSettingsApi
|
|
14190
15149
|
*/
|
|
14191
|
-
|
|
15150
|
+
getStripeTerminals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14192
15151
|
/**
|
|
14193
15152
|
*
|
|
14194
|
-
* @summary
|
|
14195
|
-
* @param {
|
|
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
|
|
14196
15156
|
* @param {*} [options] Override http request option.
|
|
14197
15157
|
* @throws {RequiredError}
|
|
14198
|
-
* @memberof ServerSettingsApi
|
|
14199
15158
|
*/
|
|
14200
|
-
|
|
14201
|
-
}
|
|
15159
|
+
startTerminalPayment: (id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15160
|
+
};
|
|
14202
15161
|
/**
|
|
14203
|
-
*
|
|
15162
|
+
* TerminalPaymentsApi - functional programming interface
|
|
14204
15163
|
* @export
|
|
14205
15164
|
*/
|
|
14206
|
-
export declare const
|
|
15165
|
+
export declare const TerminalPaymentsApiFp: (configuration?: Configuration) => {
|
|
14207
15166
|
/**
|
|
14208
15167
|
*
|
|
14209
|
-
* @summary
|
|
14210
|
-
* @param {
|
|
15168
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15169
|
+
* @param {number} id The ID of the terminal payment
|
|
14211
15170
|
* @param {*} [options] Override http request option.
|
|
14212
15171
|
* @throws {RequiredError}
|
|
14213
15172
|
*/
|
|
14214
|
-
|
|
15173
|
+
cancelTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
14215
15174
|
/**
|
|
14216
15175
|
*
|
|
14217
|
-
* @summary
|
|
15176
|
+
* @summary Create a terminal payment before executing.
|
|
15177
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
14218
15178
|
* @param {*} [options] Override http request option.
|
|
14219
15179
|
* @throws {RequiredError}
|
|
14220
15180
|
*/
|
|
14221
|
-
|
|
14222
|
-
};
|
|
14223
|
-
/**
|
|
14224
|
-
* StripeApi - functional programming interface
|
|
14225
|
-
* @export
|
|
14226
|
-
*/
|
|
14227
|
-
export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
15181
|
+
createTerminalPayment(createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
14228
15182
|
/**
|
|
14229
15183
|
*
|
|
14230
|
-
* @summary
|
|
14231
|
-
* @param {
|
|
15184
|
+
* @summary Get single terminal payment by ID
|
|
15185
|
+
* @param {number} id The ID of the terminal payment
|
|
14232
15186
|
* @param {*} [options] Override http request option.
|
|
14233
15187
|
* @throws {RequiredError}
|
|
14234
15188
|
*/
|
|
14235
|
-
|
|
15189
|
+
getSingleTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
14236
15190
|
/**
|
|
14237
15191
|
*
|
|
14238
|
-
* @summary Get
|
|
15192
|
+
* @summary Get all Stripe terminals
|
|
14239
15193
|
* @param {*} [options] Override http request option.
|
|
14240
15194
|
* @throws {RequiredError}
|
|
14241
15195
|
*/
|
|
14242
|
-
|
|
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>>;
|
|
14243
15206
|
};
|
|
14244
15207
|
/**
|
|
14245
|
-
*
|
|
15208
|
+
* TerminalPaymentsApi - factory interface
|
|
14246
15209
|
* @export
|
|
14247
15210
|
*/
|
|
14248
|
-
export declare const
|
|
15211
|
+
export declare const TerminalPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14249
15212
|
/**
|
|
14250
15213
|
*
|
|
14251
|
-
* @summary
|
|
14252
|
-
* @param {
|
|
15214
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15215
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
14253
15216
|
* @param {*} [options] Override http request option.
|
|
14254
15217
|
* @throws {RequiredError}
|
|
14255
15218
|
*/
|
|
14256
|
-
|
|
15219
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14257
15220
|
/**
|
|
14258
15221
|
*
|
|
14259
|
-
* @summary
|
|
15222
|
+
* @summary Create a terminal payment before executing.
|
|
15223
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
14260
15224
|
* @param {*} [options] Override http request option.
|
|
14261
15225
|
* @throws {RequiredError}
|
|
14262
15226
|
*/
|
|
14263
|
-
|
|
14264
|
-
};
|
|
14265
|
-
/**
|
|
14266
|
-
* Request parameters for deposit operation in StripeApi.
|
|
14267
|
-
* @export
|
|
14268
|
-
* @interface StripeApiDepositRequest
|
|
14269
|
-
*/
|
|
14270
|
-
export interface StripeApiDepositRequest {
|
|
15227
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14271
15228
|
/**
|
|
14272
|
-
*
|
|
14273
|
-
* @
|
|
14274
|
-
* @
|
|
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}
|
|
14275
15234
|
*/
|
|
14276
|
-
|
|
14277
|
-
}
|
|
14278
|
-
/**
|
|
14279
|
-
* StripeApi - object-oriented interface
|
|
14280
|
-
* @export
|
|
14281
|
-
* @class StripeApi
|
|
14282
|
-
* @extends {BaseAPI}
|
|
14283
|
-
*/
|
|
14284
|
-
export declare class StripeApi extends BaseAPI {
|
|
15235
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14285
15236
|
/**
|
|
14286
15237
|
*
|
|
14287
|
-
* @summary
|
|
14288
|
-
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15238
|
+
* @summary Get all Stripe terminals
|
|
14289
15239
|
* @param {*} [options] Override http request option.
|
|
14290
15240
|
* @throws {RequiredError}
|
|
14291
|
-
* @memberof StripeApi
|
|
14292
15241
|
*/
|
|
14293
|
-
|
|
15242
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): AxiosPromise<Array<StripePaymentTerminalResponse>>;
|
|
14294
15243
|
/**
|
|
14295
15244
|
*
|
|
14296
|
-
* @summary
|
|
15245
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15246
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
14297
15247
|
* @param {*} [options] Override http request option.
|
|
14298
15248
|
* @throws {RequiredError}
|
|
14299
|
-
* @memberof StripeApi
|
|
14300
15249
|
*/
|
|
14301
|
-
|
|
14302
|
-
}
|
|
15250
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15251
|
+
};
|
|
14303
15252
|
/**
|
|
14304
|
-
*
|
|
15253
|
+
* Request parameters for cancelTerminalPayment operation in TerminalPaymentsApi.
|
|
14305
15254
|
* @export
|
|
15255
|
+
* @interface TerminalPaymentsApiCancelTerminalPaymentRequest
|
|
14306
15256
|
*/
|
|
14307
|
-
export
|
|
15257
|
+
export interface TerminalPaymentsApiCancelTerminalPaymentRequest {
|
|
14308
15258
|
/**
|
|
14309
|
-
*
|
|
14310
|
-
* @
|
|
14311
|
-
* @
|
|
14312
|
-
* @param {*} [options] Override http request option.
|
|
14313
|
-
* @throws {RequiredError}
|
|
15259
|
+
* The ID of the terminal payment
|
|
15260
|
+
* @type {number}
|
|
15261
|
+
* @memberof TerminalPaymentsApiCancelTerminalPayment
|
|
14314
15262
|
*/
|
|
14315
|
-
|
|
14316
|
-
}
|
|
15263
|
+
readonly id: number;
|
|
15264
|
+
}
|
|
14317
15265
|
/**
|
|
14318
|
-
*
|
|
15266
|
+
* Request parameters for createTerminalPayment operation in TerminalPaymentsApi.
|
|
14319
15267
|
* @export
|
|
15268
|
+
* @interface TerminalPaymentsApiCreateTerminalPaymentRequest
|
|
14320
15269
|
*/
|
|
14321
|
-
export
|
|
15270
|
+
export interface TerminalPaymentsApiCreateTerminalPaymentRequest {
|
|
14322
15271
|
/**
|
|
14323
|
-
*
|
|
14324
|
-
* @
|
|
14325
|
-
* @
|
|
14326
|
-
* @param {*} [options] Override http request option.
|
|
14327
|
-
* @throws {RequiredError}
|
|
15272
|
+
* The terminal payment that should be created.
|
|
15273
|
+
* @type {CreateTerminalPaymentRequest}
|
|
15274
|
+
* @memberof TerminalPaymentsApiCreateTerminalPayment
|
|
14328
15275
|
*/
|
|
14329
|
-
|
|
14330
|
-
}
|
|
15276
|
+
readonly createTerminalPaymentRequest: CreateTerminalPaymentRequest;
|
|
15277
|
+
}
|
|
14331
15278
|
/**
|
|
14332
|
-
*
|
|
15279
|
+
* Request parameters for getSingleTerminalPayment operation in TerminalPaymentsApi.
|
|
14333
15280
|
* @export
|
|
15281
|
+
* @interface TerminalPaymentsApiGetSingleTerminalPaymentRequest
|
|
14334
15282
|
*/
|
|
14335
|
-
export
|
|
15283
|
+
export interface TerminalPaymentsApiGetSingleTerminalPaymentRequest {
|
|
14336
15284
|
/**
|
|
14337
|
-
*
|
|
14338
|
-
* @
|
|
14339
|
-
* @
|
|
14340
|
-
* @param {*} [options] Override http request option.
|
|
14341
|
-
* @throws {RequiredError}
|
|
15285
|
+
* The ID of the terminal payment
|
|
15286
|
+
* @type {number}
|
|
15287
|
+
* @memberof TerminalPaymentsApiGetSingleTerminalPayment
|
|
14342
15288
|
*/
|
|
14343
|
-
|
|
14344
|
-
}
|
|
15289
|
+
readonly id: number;
|
|
15290
|
+
}
|
|
14345
15291
|
/**
|
|
14346
|
-
* Request parameters for
|
|
15292
|
+
* Request parameters for startTerminalPayment operation in TerminalPaymentsApi.
|
|
14347
15293
|
* @export
|
|
14348
|
-
* @interface
|
|
15294
|
+
* @interface TerminalPaymentsApiStartTerminalPaymentRequest
|
|
14349
15295
|
*/
|
|
14350
|
-
export interface
|
|
15296
|
+
export interface TerminalPaymentsApiStartTerminalPaymentRequest {
|
|
14351
15297
|
/**
|
|
14352
|
-
*
|
|
14353
|
-
* @type {
|
|
14354
|
-
* @memberof
|
|
15298
|
+
* The ID of the terminal payment
|
|
15299
|
+
* @type {number}
|
|
15300
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
14355
15301
|
*/
|
|
14356
|
-
readonly
|
|
15302
|
+
readonly id: number;
|
|
15303
|
+
/**
|
|
15304
|
+
* Payment options
|
|
15305
|
+
* @type {ProcessTerminalPaymentRequest}
|
|
15306
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15307
|
+
*/
|
|
15308
|
+
readonly processTerminalPaymentRequest: ProcessTerminalPaymentRequest;
|
|
14357
15309
|
}
|
|
14358
15310
|
/**
|
|
14359
|
-
*
|
|
15311
|
+
* TerminalPaymentsApi - object-oriented interface
|
|
14360
15312
|
* @export
|
|
14361
|
-
* @class
|
|
15313
|
+
* @class TerminalPaymentsApi
|
|
14362
15314
|
* @extends {BaseAPI}
|
|
14363
15315
|
*/
|
|
14364
|
-
export declare class
|
|
15316
|
+
export declare class TerminalPaymentsApi extends BaseAPI {
|
|
14365
15317
|
/**
|
|
14366
|
-
*
|
|
14367
|
-
* @summary
|
|
14368
|
-
* @param {
|
|
15318
|
+
*
|
|
15319
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15320
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
14369
15321
|
* @param {*} [options] Override http request option.
|
|
14370
15322
|
* @throws {RequiredError}
|
|
14371
|
-
* @memberof
|
|
15323
|
+
* @memberof TerminalPaymentsApi
|
|
14372
15324
|
*/
|
|
14373
|
-
|
|
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, {}>>;
|
|
14374
15361
|
}
|
|
14375
|
-
/**
|
|
14376
|
-
* @export
|
|
14377
|
-
*/
|
|
14378
|
-
export declare const GetUserSyncResultsServiceEnum: {};
|
|
14379
|
-
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14380
15362
|
/**
|
|
14381
15363
|
* TermsOfServiceApi - axios parameter creator
|
|
14382
15364
|
* @export
|
|
@@ -15125,12 +16107,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15125
16107
|
* @summary Returns all existing transfers
|
|
15126
16108
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15127
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
|
|
15128
16113
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15129
16114
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15130
16115
|
* @param {*} [options] Override http request option.
|
|
15131
16116
|
* @throws {RequiredError}
|
|
15132
16117
|
*/
|
|
15133
|
-
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>;
|
|
15134
16119
|
/**
|
|
15135
16120
|
*
|
|
15136
16121
|
* @summary Returns the requested transfer
|
|
@@ -15197,12 +16182,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15197
16182
|
* @summary Returns all existing transfers
|
|
15198
16183
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15199
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
|
|
15200
16188
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15201
16189
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15202
16190
|
* @param {*} [options] Override http request option.
|
|
15203
16191
|
* @throws {RequiredError}
|
|
15204
16192
|
*/
|
|
15205
|
-
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>>;
|
|
15206
16194
|
/**
|
|
15207
16195
|
*
|
|
15208
16196
|
* @summary Returns the requested transfer
|
|
@@ -15271,7 +16259,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15271
16259
|
* @param {*} [options] Override http request option.
|
|
15272
16260
|
* @throws {RequiredError}
|
|
15273
16261
|
*/
|
|
15274
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
16262
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15275
16263
|
/**
|
|
15276
16264
|
*
|
|
15277
16265
|
* @summary Returns the requested transfer
|
|
@@ -15349,6 +16337,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15349
16337
|
* @memberof TransfersApiGetAllTransfers
|
|
15350
16338
|
*/
|
|
15351
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;
|
|
15352
16358
|
/**
|
|
15353
16359
|
* How many transfers the endpoint should return
|
|
15354
16360
|
* @type {number}
|
|
@@ -15489,7 +16495,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15489
16495
|
* @throws {RequiredError}
|
|
15490
16496
|
* @memberof TransfersApi
|
|
15491
16497
|
*/
|
|
15492
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16498
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15493
16499
|
/**
|
|
15494
16500
|
*
|
|
15495
16501
|
* @summary Returns the requested transfer
|
|
@@ -15738,7 +16744,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15738
16744
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15739
16745
|
/**
|
|
15740
16746
|
*
|
|
15741
|
-
* @summary Accept the Terms of Service
|
|
16747
|
+
* @summary Accept the current Terms of Service version
|
|
15742
16748
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15743
16749
|
* @param {*} [options] Override http request option.
|
|
15744
16750
|
* @throws {RequiredError}
|
|
@@ -15868,6 +16874,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15868
16874
|
* @throws {RequiredError}
|
|
15869
16875
|
*/
|
|
15870
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>;
|
|
15871
16885
|
/**
|
|
15872
16886
|
*
|
|
15873
16887
|
* @summary Returns the user\'s containers
|
|
@@ -15890,6 +16904,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15890
16904
|
* @throws {RequiredError}
|
|
15891
16905
|
*/
|
|
15892
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>;
|
|
15893
16921
|
/**
|
|
15894
16922
|
*
|
|
15895
16923
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16100,7 +17128,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16100
17128
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
16101
17129
|
/**
|
|
16102
17130
|
*
|
|
16103
|
-
* @summary Accept the Terms of Service
|
|
17131
|
+
* @summary Accept the current Terms of Service version
|
|
16104
17132
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
16105
17133
|
* @param {*} [options] Override http request option.
|
|
16106
17134
|
* @throws {RequiredError}
|
|
@@ -16230,6 +17258,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16230
17258
|
* @throws {RequiredError}
|
|
16231
17259
|
*/
|
|
16232
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>>;
|
|
16233
17269
|
/**
|
|
16234
17270
|
*
|
|
16235
17271
|
* @summary Returns the user\'s containers
|
|
@@ -16252,6 +17288,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16252
17288
|
* @throws {RequiredError}
|
|
16253
17289
|
*/
|
|
16254
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>>;
|
|
16255
17305
|
/**
|
|
16256
17306
|
*
|
|
16257
17307
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16462,7 +17512,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16462
17512
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16463
17513
|
/**
|
|
16464
17514
|
*
|
|
16465
|
-
* @summary Accept the Terms of Service
|
|
17515
|
+
* @summary Accept the current Terms of Service version
|
|
16466
17516
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16467
17517
|
* @param {*} [options] Override http request option.
|
|
16468
17518
|
* @throws {RequiredError}
|
|
@@ -16580,6 +17630,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16580
17630
|
* @throws {RequiredError}
|
|
16581
17631
|
*/
|
|
16582
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>;
|
|
16583
17641
|
/**
|
|
16584
17642
|
*
|
|
16585
17643
|
* @summary Returns the user\'s containers
|
|
@@ -16596,6 +17654,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16596
17654
|
* @throws {RequiredError}
|
|
16597
17655
|
*/
|
|
16598
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>;
|
|
16599
17665
|
/**
|
|
16600
17666
|
*
|
|
16601
17667
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17025,6 +18091,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
17025
18091
|
*/
|
|
17026
18092
|
readonly id: number;
|
|
17027
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
|
+
}
|
|
17028
18107
|
/**
|
|
17029
18108
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
17030
18109
|
* @export
|
|
@@ -17087,6 +18166,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17087
18166
|
*/
|
|
17088
18167
|
readonly skip?: number;
|
|
17089
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
|
+
}
|
|
17090
18218
|
/**
|
|
17091
18219
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17092
18220
|
* @export
|
|
@@ -17602,7 +18730,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17602
18730
|
export declare class UsersApi extends BaseAPI {
|
|
17603
18731
|
/**
|
|
17604
18732
|
*
|
|
17605
|
-
* @summary Accept the Terms of Service
|
|
18733
|
+
* @summary Accept the current Terms of Service version
|
|
17606
18734
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17607
18735
|
* @param {*} [options] Override http request option.
|
|
17608
18736
|
* @throws {RequiredError}
|
|
@@ -17735,6 +18863,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17735
18863
|
* @memberof UsersApi
|
|
17736
18864
|
*/
|
|
17737
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, {}>>;
|
|
17738
18875
|
/**
|
|
17739
18876
|
*
|
|
17740
18877
|
* @summary Returns the user\'s containers
|
|
@@ -17753,6 +18890,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17753
18890
|
* @memberof UsersApi
|
|
17754
18891
|
*/
|
|
17755
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, {}>>;
|
|
17756
18902
|
/**
|
|
17757
18903
|
*
|
|
17758
18904
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17948,6 +19094,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17948
19094
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17949
19095
|
};
|
|
17950
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];
|
|
17951
19107
|
/**
|
|
17952
19108
|
* @export
|
|
17953
19109
|
*/
|