@gewis/sudosos-client 0.0.0-develop.d892faf → 0.0.0-develop.da7bb4b
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 +1941 -549
- package/dist/api.js +1801 -631
- package/dist/base.js +1 -1
- package/dist/common.d.ts +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
|
*/
|
|
@@ -1683,11 +1767,11 @@ export interface CreateContainerRequest {
|
|
|
1683
1767
|
*/
|
|
1684
1768
|
'public': boolean;
|
|
1685
1769
|
/**
|
|
1686
|
-
* Id of the
|
|
1770
|
+
* Id of the organ that will own the container
|
|
1687
1771
|
* @type {number}
|
|
1688
1772
|
* @memberof CreateContainerRequest
|
|
1689
1773
|
*/
|
|
1690
|
-
'ownerId'
|
|
1774
|
+
'ownerId': number;
|
|
1691
1775
|
}
|
|
1692
1776
|
/**
|
|
1693
1777
|
*
|
|
@@ -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
|
|
@@ -2724,6 +2857,37 @@ export interface InactiveAdministrativeCostResponse {
|
|
|
2724
2857
|
*/
|
|
2725
2858
|
'transfer': TransferResponse;
|
|
2726
2859
|
}
|
|
2860
|
+
/**
|
|
2861
|
+
*
|
|
2862
|
+
* @export
|
|
2863
|
+
* @interface InvoiceDriftResponse
|
|
2864
|
+
*/
|
|
2865
|
+
export interface InvoiceDriftResponse {
|
|
2866
|
+
/**
|
|
2867
|
+
*
|
|
2868
|
+
* @type {BaseInvoiceResponse}
|
|
2869
|
+
* @memberof InvoiceDriftResponse
|
|
2870
|
+
*/
|
|
2871
|
+
'invoice': BaseInvoiceResponse;
|
|
2872
|
+
/**
|
|
2873
|
+
*
|
|
2874
|
+
* @type {DineroObjectResponse}
|
|
2875
|
+
* @memberof InvoiceDriftResponse
|
|
2876
|
+
*/
|
|
2877
|
+
'actualAmount': DineroObjectResponse;
|
|
2878
|
+
/**
|
|
2879
|
+
*
|
|
2880
|
+
* @type {DineroObjectResponse}
|
|
2881
|
+
* @memberof InvoiceDriftResponse
|
|
2882
|
+
*/
|
|
2883
|
+
'expectedAmount': DineroObjectResponse;
|
|
2884
|
+
/**
|
|
2885
|
+
*
|
|
2886
|
+
* @type {DineroObjectResponse}
|
|
2887
|
+
* @memberof InvoiceDriftResponse
|
|
2888
|
+
*/
|
|
2889
|
+
'deltaAmount': DineroObjectResponse;
|
|
2890
|
+
}
|
|
2727
2891
|
/**
|
|
2728
2892
|
*
|
|
2729
2893
|
* @export
|
|
@@ -3118,44 +3282,38 @@ export interface InvoiceUserResponse {
|
|
|
3118
3282
|
/**
|
|
3119
3283
|
*
|
|
3120
3284
|
* @export
|
|
3121
|
-
* @interface
|
|
3285
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3122
3286
|
*/
|
|
3123
|
-
export interface
|
|
3124
|
-
/**
|
|
3125
|
-
*
|
|
3126
|
-
* @type {number}
|
|
3127
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3128
|
-
*/
|
|
3129
|
-
'memberId': number;
|
|
3287
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3130
3288
|
/**
|
|
3131
|
-
*
|
|
3289
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3132
3290
|
* @type {string}
|
|
3133
|
-
* @memberof
|
|
3291
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3134
3292
|
*/
|
|
3135
|
-
'
|
|
3293
|
+
'reason': string;
|
|
3136
3294
|
}
|
|
3137
3295
|
/**
|
|
3138
3296
|
*
|
|
3139
3297
|
* @export
|
|
3140
|
-
* @interface
|
|
3298
|
+
* @interface MemberAuthenticationPinRequest
|
|
3141
3299
|
*/
|
|
3142
|
-
export interface
|
|
3300
|
+
export interface MemberAuthenticationPinRequest {
|
|
3143
3301
|
/**
|
|
3144
3302
|
*
|
|
3145
3303
|
* @type {number}
|
|
3146
|
-
* @memberof
|
|
3304
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3147
3305
|
*/
|
|
3148
3306
|
'memberId': number;
|
|
3149
3307
|
/**
|
|
3150
3308
|
*
|
|
3151
3309
|
* @type {string}
|
|
3152
|
-
* @memberof
|
|
3310
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3153
3311
|
*/
|
|
3154
3312
|
'pin': string;
|
|
3155
3313
|
/**
|
|
3156
3314
|
* POS identifier
|
|
3157
3315
|
* @type {number}
|
|
3158
|
-
* @memberof
|
|
3316
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3159
3317
|
*/
|
|
3160
3318
|
'posId': number;
|
|
3161
3319
|
}
|
|
@@ -3183,13 +3341,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3183
3341
|
* @type {PaginationResult}
|
|
3184
3342
|
* @memberof PaginatedBalanceResponse
|
|
3185
3343
|
*/
|
|
3186
|
-
'_pagination'
|
|
3344
|
+
'_pagination': PaginationResult;
|
|
3187
3345
|
/**
|
|
3188
3346
|
* Returned balance responses
|
|
3189
3347
|
* @type {Array<BalanceResponse>}
|
|
3190
3348
|
* @memberof PaginatedBalanceResponse
|
|
3191
3349
|
*/
|
|
3192
|
-
'records'
|
|
3350
|
+
'records': Array<BalanceResponse>;
|
|
3193
3351
|
}
|
|
3194
3352
|
/**
|
|
3195
3353
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3202,13 +3360,13 @@ export interface PaginatedBannerResponse {
|
|
|
3202
3360
|
* @type {PaginationResult}
|
|
3203
3361
|
* @memberof PaginatedBannerResponse
|
|
3204
3362
|
*/
|
|
3205
|
-
'_pagination'
|
|
3363
|
+
'_pagination': PaginationResult;
|
|
3206
3364
|
/**
|
|
3207
3365
|
* Returned banners
|
|
3208
3366
|
* @type {Array<BannerResponse>}
|
|
3209
3367
|
* @memberof PaginatedBannerResponse
|
|
3210
3368
|
*/
|
|
3211
|
-
'records'
|
|
3369
|
+
'records': Array<BannerResponse>;
|
|
3212
3370
|
}
|
|
3213
3371
|
/**
|
|
3214
3372
|
*
|
|
@@ -3229,6 +3387,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3229
3387
|
*/
|
|
3230
3388
|
'records': Array<BaseEventResponse>;
|
|
3231
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
|
+
}
|
|
3232
3409
|
/**
|
|
3233
3410
|
*
|
|
3234
3411
|
* @export
|
|
@@ -3268,7 +3445,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3268
3445
|
'records': Array<BaseTransactionResponse>;
|
|
3269
3446
|
}
|
|
3270
3447
|
/**
|
|
3271
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity.
|
|
3272
3449
|
* @export
|
|
3273
3450
|
* @interface PaginatedContainerResponse
|
|
3274
3451
|
*/
|
|
@@ -3287,7 +3464,7 @@ export interface PaginatedContainerResponse {
|
|
|
3287
3464
|
'records': Array<ContainerResponse>;
|
|
3288
3465
|
}
|
|
3289
3466
|
/**
|
|
3290
|
-
*
|
|
3467
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3291
3468
|
* @export
|
|
3292
3469
|
* @interface PaginatedContainerWithProductResponse
|
|
3293
3470
|
*/
|
|
@@ -3373,13 +3550,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3373
3550
|
* @type {PaginationResult}
|
|
3374
3551
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3375
3552
|
*/
|
|
3376
|
-
'_pagination'
|
|
3553
|
+
'_pagination': PaginationResult;
|
|
3377
3554
|
/**
|
|
3378
3555
|
* Returned InactiveAdministrativeCost
|
|
3379
3556
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3380
3557
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3381
3558
|
*/
|
|
3382
|
-
'records'
|
|
3559
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3383
3560
|
}
|
|
3384
3561
|
/**
|
|
3385
3562
|
*
|
|
@@ -3401,7 +3578,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3401
3578
|
'records': Array<InvoiceResponseTypes>;
|
|
3402
3579
|
}
|
|
3403
3580
|
/**
|
|
3404
|
-
*
|
|
3581
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3405
3582
|
* @export
|
|
3406
3583
|
* @interface PaginatedPointOfSaleResponse
|
|
3407
3584
|
*/
|
|
@@ -3420,7 +3597,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3420
3597
|
'records': Array<PointOfSaleResponse>;
|
|
3421
3598
|
}
|
|
3422
3599
|
/**
|
|
3423
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product category` entity.
|
|
3424
3601
|
* @export
|
|
3425
3602
|
* @interface PaginatedProductCategoryResponse
|
|
3426
3603
|
*/
|
|
@@ -3439,7 +3616,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3439
3616
|
'records': Array<ProductCategoryResponse>;
|
|
3440
3617
|
}
|
|
3441
3618
|
/**
|
|
3442
|
-
*
|
|
3619
|
+
* Paginated API Response for the `product` entity.
|
|
3443
3620
|
* @export
|
|
3444
3621
|
* @interface PaginatedProductResponse
|
|
3445
3622
|
*/
|
|
@@ -3534,7 +3711,7 @@ export interface PaginatedUserResponse {
|
|
|
3534
3711
|
'records': Array<UserResponse>;
|
|
3535
3712
|
}
|
|
3536
3713
|
/**
|
|
3537
|
-
*
|
|
3714
|
+
* Paginated API Response for the `vat group` entity.
|
|
3538
3715
|
* @export
|
|
3539
3716
|
* @interface PaginatedVatGroupResponse
|
|
3540
3717
|
*/
|
|
@@ -3660,13 +3837,38 @@ export interface PatchUserTypeRequest {
|
|
|
3660
3837
|
'userType': string;
|
|
3661
3838
|
}
|
|
3662
3839
|
/**
|
|
3663
|
-
*
|
|
3840
|
+
* Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
|
|
3664
3841
|
* @export
|
|
3665
|
-
* @interface
|
|
3842
|
+
* @interface PaymentRequestStartResponse
|
|
3666
3843
|
*/
|
|
3667
|
-
export interface
|
|
3844
|
+
export interface PaymentRequestStartResponse {
|
|
3668
3845
|
/**
|
|
3669
|
-
*
|
|
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
|
+
}
|
|
3864
|
+
/**
|
|
3865
|
+
*
|
|
3866
|
+
* @export
|
|
3867
|
+
* @interface PayoutRequestRequest
|
|
3868
|
+
*/
|
|
3869
|
+
export interface PayoutRequestRequest {
|
|
3870
|
+
/**
|
|
3871
|
+
*
|
|
3670
3872
|
* @type {DineroObjectRequest}
|
|
3671
3873
|
* @memberof PayoutRequestRequest
|
|
3672
3874
|
*/
|
|
@@ -3866,7 +4068,7 @@ export interface PermissionResponse {
|
|
|
3866
4068
|
'actions': Array<ActionResponse>;
|
|
3867
4069
|
}
|
|
3868
4070
|
/**
|
|
3869
|
-
*
|
|
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).
|
|
3870
4072
|
* @export
|
|
3871
4073
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3872
4074
|
*/
|
|
@@ -4021,6 +4223,19 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4021
4223
|
/**
|
|
4022
4224
|
*
|
|
4023
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
|
|
4024
4239
|
* @interface ProductCategoryRequest
|
|
4025
4240
|
*/
|
|
4026
4241
|
export interface ProductCategoryRequest {
|
|
@@ -4183,6 +4398,56 @@ export interface ProductResponse {
|
|
|
4183
4398
|
*/
|
|
4184
4399
|
'priceList': boolean;
|
|
4185
4400
|
}
|
|
4401
|
+
/**
|
|
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.
|
|
4403
|
+
* @export
|
|
4404
|
+
* @interface PublicPaymentRequestResponse
|
|
4405
|
+
*/
|
|
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];
|
|
4186
4451
|
/**
|
|
4187
4452
|
*
|
|
4188
4453
|
* @export
|
|
@@ -4860,6 +5125,37 @@ export interface StripePaymentIntentStatusResponse {
|
|
|
4860
5125
|
*/
|
|
4861
5126
|
'state': number;
|
|
4862
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
|
+
}
|
|
4863
5159
|
/**
|
|
4864
5160
|
*
|
|
4865
5161
|
* @export
|
|
@@ -5052,6 +5348,67 @@ export interface SubTransactionRowResponse {
|
|
|
5052
5348
|
*/
|
|
5053
5349
|
'totalPriceInclVat': DineroObjectResponse;
|
|
5054
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
|
+
}
|
|
5055
5412
|
/**
|
|
5056
5413
|
*
|
|
5057
5414
|
* @export
|
|
@@ -5064,6 +5421,12 @@ export interface TermsOfServiceResponse {
|
|
|
5064
5421
|
* @memberof TermsOfServiceResponse
|
|
5065
5422
|
*/
|
|
5066
5423
|
'versionNumber': string;
|
|
5424
|
+
/**
|
|
5425
|
+
* The date this version took effect.
|
|
5426
|
+
* @type {string}
|
|
5427
|
+
* @memberof TermsOfServiceResponse
|
|
5428
|
+
*/
|
|
5429
|
+
'date': string;
|
|
5067
5430
|
/**
|
|
5068
5431
|
* The terms of service content.
|
|
5069
5432
|
* @type {string}
|
|
@@ -5071,6 +5434,17 @@ export interface TermsOfServiceResponse {
|
|
|
5071
5434
|
*/
|
|
5072
5435
|
'content': string;
|
|
5073
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];
|
|
5074
5448
|
/**
|
|
5075
5449
|
*
|
|
5076
5450
|
* @export
|
|
@@ -5084,23 +5458,23 @@ export interface TotalBalanceResponse {
|
|
|
5084
5458
|
*/
|
|
5085
5459
|
'date': string;
|
|
5086
5460
|
/**
|
|
5087
|
-
*
|
|
5088
|
-
* @type {
|
|
5461
|
+
*
|
|
5462
|
+
* @type {DineroObjectResponse}
|
|
5089
5463
|
* @memberof TotalBalanceResponse
|
|
5090
5464
|
*/
|
|
5091
|
-
'totalPositive':
|
|
5465
|
+
'totalPositive': DineroObjectResponse;
|
|
5092
5466
|
/**
|
|
5093
|
-
*
|
|
5094
|
-
* @type {
|
|
5467
|
+
*
|
|
5468
|
+
* @type {DineroObjectResponse}
|
|
5095
5469
|
* @memberof TotalBalanceResponse
|
|
5096
5470
|
*/
|
|
5097
|
-
'totalNegative':
|
|
5471
|
+
'totalNegative': DineroObjectResponse;
|
|
5098
5472
|
/**
|
|
5099
|
-
*
|
|
5100
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5473
|
+
* The total balances for the different user types
|
|
5474
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5101
5475
|
* @memberof TotalBalanceResponse
|
|
5102
5476
|
*/
|
|
5103
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5477
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5104
5478
|
}
|
|
5105
5479
|
/**
|
|
5106
5480
|
*
|
|
@@ -5608,6 +5982,85 @@ export interface TransferResponse {
|
|
|
5608
5982
|
/**
|
|
5609
5983
|
*
|
|
5610
5984
|
* @export
|
|
5985
|
+
* @interface TransferSummaryResponse
|
|
5986
|
+
*/
|
|
5987
|
+
export interface TransferSummaryResponse {
|
|
5988
|
+
/**
|
|
5989
|
+
*
|
|
5990
|
+
* @type {TransferAggregateResponse}
|
|
5991
|
+
* @memberof TransferSummaryResponse
|
|
5992
|
+
*/
|
|
5993
|
+
'total': TransferAggregateResponse;
|
|
5994
|
+
/**
|
|
5995
|
+
*
|
|
5996
|
+
* @type {TransferAggregateResponse}
|
|
5997
|
+
* @memberof TransferSummaryResponse
|
|
5998
|
+
*/
|
|
5999
|
+
'deposits': TransferAggregateResponse;
|
|
6000
|
+
/**
|
|
6001
|
+
*
|
|
6002
|
+
* @type {TransferAggregateResponse}
|
|
6003
|
+
* @memberof TransferSummaryResponse
|
|
6004
|
+
*/
|
|
6005
|
+
'payoutRequests': TransferAggregateResponse;
|
|
6006
|
+
/**
|
|
6007
|
+
*
|
|
6008
|
+
* @type {TransferAggregateResponse}
|
|
6009
|
+
* @memberof TransferSummaryResponse
|
|
6010
|
+
*/
|
|
6011
|
+
'sellerPayouts': TransferAggregateResponse;
|
|
6012
|
+
/**
|
|
6013
|
+
*
|
|
6014
|
+
* @type {TransferAggregateResponse}
|
|
6015
|
+
* @memberof TransferSummaryResponse
|
|
6016
|
+
*/
|
|
6017
|
+
'invoices': TransferAggregateResponse;
|
|
6018
|
+
/**
|
|
6019
|
+
*
|
|
6020
|
+
* @type {TransferAggregateResponse}
|
|
6021
|
+
* @memberof TransferSummaryResponse
|
|
6022
|
+
*/
|
|
6023
|
+
'creditInvoices': TransferAggregateResponse;
|
|
6024
|
+
/**
|
|
6025
|
+
*
|
|
6026
|
+
* @type {TransferAggregateResponse}
|
|
6027
|
+
* @memberof TransferSummaryResponse
|
|
6028
|
+
*/
|
|
6029
|
+
'fines': TransferAggregateResponse;
|
|
6030
|
+
/**
|
|
6031
|
+
*
|
|
6032
|
+
* @type {TransferAggregateResponse}
|
|
6033
|
+
* @memberof TransferSummaryResponse
|
|
6034
|
+
*/
|
|
6035
|
+
'waivedFines': TransferAggregateResponse;
|
|
6036
|
+
/**
|
|
6037
|
+
*
|
|
6038
|
+
* @type {TransferAggregateResponse}
|
|
6039
|
+
* @memberof TransferSummaryResponse
|
|
6040
|
+
*/
|
|
6041
|
+
'writeOffs': TransferAggregateResponse;
|
|
6042
|
+
/**
|
|
6043
|
+
*
|
|
6044
|
+
* @type {TransferAggregateResponse}
|
|
6045
|
+
* @memberof TransferSummaryResponse
|
|
6046
|
+
*/
|
|
6047
|
+
'inactiveAdministrativeCosts': TransferAggregateResponse;
|
|
6048
|
+
/**
|
|
6049
|
+
*
|
|
6050
|
+
* @type {TransferAggregateResponse}
|
|
6051
|
+
* @memberof TransferSummaryResponse
|
|
6052
|
+
*/
|
|
6053
|
+
'manualCreations': TransferAggregateResponse;
|
|
6054
|
+
/**
|
|
6055
|
+
*
|
|
6056
|
+
* @type {TransferAggregateResponse}
|
|
6057
|
+
* @memberof TransferSummaryResponse
|
|
6058
|
+
*/
|
|
6059
|
+
'manualDeletions': TransferAggregateResponse;
|
|
6060
|
+
}
|
|
6061
|
+
/**
|
|
6062
|
+
* API Request for updating a `container` entity.
|
|
6063
|
+
* @export
|
|
5611
6064
|
* @interface UpdateContainerRequest
|
|
5612
6065
|
*/
|
|
5613
6066
|
export interface UpdateContainerRequest {
|
|
@@ -5856,7 +6309,7 @@ export interface UpdatePinRequest {
|
|
|
5856
6309
|
'pin': string;
|
|
5857
6310
|
}
|
|
5858
6311
|
/**
|
|
5859
|
-
*
|
|
6312
|
+
* API Request for updating a `point of sale` entity.
|
|
5860
6313
|
* @export
|
|
5861
6314
|
* @interface UpdatePointOfSaleRequest
|
|
5862
6315
|
*/
|
|
@@ -5893,7 +6346,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
5893
6346
|
'cashierRoleIds'?: Array<number>;
|
|
5894
6347
|
}
|
|
5895
6348
|
/**
|
|
5896
|
-
*
|
|
6349
|
+
* API Request for updating a `product` entity.
|
|
5897
6350
|
* @export
|
|
5898
6351
|
* @interface UpdateProductRequest
|
|
5899
6352
|
*/
|
|
@@ -6058,9 +6511,21 @@ export interface UpdateUserRequest {
|
|
|
6058
6511
|
* @memberof UpdateUserRequest
|
|
6059
6512
|
*/
|
|
6060
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;
|
|
6061
6526
|
}
|
|
6062
6527
|
/**
|
|
6063
|
-
*
|
|
6528
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6064
6529
|
* @export
|
|
6065
6530
|
* @interface UpdateVatGroupRequest
|
|
6066
6531
|
*/
|
|
@@ -6233,11 +6698,17 @@ export interface UserResponse {
|
|
|
6233
6698
|
*/
|
|
6234
6699
|
'email'?: string;
|
|
6235
6700
|
/**
|
|
6236
|
-
* Whether this user
|
|
6237
|
-
* @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}
|
|
6238
6709
|
* @memberof UserResponse
|
|
6239
6710
|
*/
|
|
6240
|
-
'acceptedToS'?:
|
|
6711
|
+
'acceptedToS'?: TermsOfServiceStatus;
|
|
6241
6712
|
/**
|
|
6242
6713
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6243
6714
|
* @type {boolean}
|
|
@@ -6274,6 +6745,12 @@ export interface UserResponse {
|
|
|
6274
6745
|
* @memberof UserResponse
|
|
6275
6746
|
*/
|
|
6276
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;
|
|
6277
6754
|
}
|
|
6278
6755
|
/**
|
|
6279
6756
|
*
|
|
@@ -6380,6 +6857,66 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6380
6857
|
*/
|
|
6381
6858
|
'nickname'?: string;
|
|
6382
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];
|
|
6383
6920
|
/**
|
|
6384
6921
|
*
|
|
6385
6922
|
* @export
|
|
@@ -6406,7 +6943,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6406
6943
|
'totalNegative': DineroObjectResponse;
|
|
6407
6944
|
}
|
|
6408
6945
|
/**
|
|
6409
|
-
*
|
|
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.
|
|
6410
6947
|
* @export
|
|
6411
6948
|
* @interface UserWithIndex
|
|
6412
6949
|
*/
|
|
@@ -6421,6 +6958,25 @@ export interface UserWithIndex {
|
|
|
6421
6958
|
/**
|
|
6422
6959
|
*
|
|
6423
6960
|
* @export
|
|
6961
|
+
* @interface ValidationResponse
|
|
6962
|
+
*/
|
|
6963
|
+
export interface ValidationResponse {
|
|
6964
|
+
/**
|
|
6965
|
+
* Whether the request passed validation.
|
|
6966
|
+
* @type {boolean}
|
|
6967
|
+
* @memberof ValidationResponse
|
|
6968
|
+
*/
|
|
6969
|
+
'valid': boolean;
|
|
6970
|
+
/**
|
|
6971
|
+
* List of validation error messages.
|
|
6972
|
+
* @type {Array<string>}
|
|
6973
|
+
* @memberof ValidationResponse
|
|
6974
|
+
*/
|
|
6975
|
+
'errors': Array<string>;
|
|
6976
|
+
}
|
|
6977
|
+
/**
|
|
6978
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6979
|
+
* @export
|
|
6424
6980
|
* @interface VatDeclarationResponse
|
|
6425
6981
|
*/
|
|
6426
6982
|
export interface VatDeclarationResponse {
|
|
@@ -6444,7 +7000,7 @@ export interface VatDeclarationResponse {
|
|
|
6444
7000
|
'rows': Array<VatDeclarationRow>;
|
|
6445
7001
|
}
|
|
6446
7002
|
/**
|
|
6447
|
-
*
|
|
7003
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6448
7004
|
* @export
|
|
6449
7005
|
* @interface VatDeclarationRow
|
|
6450
7006
|
*/
|
|
@@ -6912,10 +7468,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6912
7468
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6913
7469
|
/**
|
|
6914
7470
|
*
|
|
6915
|
-
* @summary EAN
|
|
6916
|
-
* @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
|
|
6917
7473
|
* @param {*} [options] Override http request option.
|
|
6918
|
-
* @deprecated
|
|
6919
7474
|
* @throws {RequiredError}
|
|
6920
7475
|
*/
|
|
6921
7476
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6990,13 +7545,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6990
7545
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6991
7546
|
/**
|
|
6992
7547
|
*
|
|
6993
|
-
* @summary PIN
|
|
6994
|
-
* @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
|
|
6995
7550
|
* @param {*} [options] Override http request option.
|
|
6996
|
-
* @deprecated
|
|
6997
7551
|
* @throws {RequiredError}
|
|
6998
7552
|
*/
|
|
6999
|
-
|
|
7553
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7000
7554
|
/**
|
|
7001
7555
|
*
|
|
7002
7556
|
* @summary Mock login and hand out token.
|
|
@@ -7007,19 +7561,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7007
7561
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7008
7562
|
/**
|
|
7009
7563
|
*
|
|
7010
|
-
* @summary NFC
|
|
7011
|
-
* @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
|
|
7012
7566
|
* @param {*} [options] Override http request option.
|
|
7013
|
-
* @deprecated
|
|
7014
7567
|
* @throws {RequiredError}
|
|
7015
7568
|
*/
|
|
7016
7569
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7017
7570
|
/**
|
|
7018
7571
|
*
|
|
7019
|
-
* @summary PIN
|
|
7020
|
-
* @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
|
|
7021
7574
|
* @param {*} [options] Override http request option.
|
|
7022
|
-
* @deprecated
|
|
7023
7575
|
* @throws {RequiredError}
|
|
7024
7576
|
*/
|
|
7025
7577
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7046,38 +7598,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7046
7598
|
* @throws {RequiredError}
|
|
7047
7599
|
*/
|
|
7048
7600
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7049
|
-
/**
|
|
7050
|
-
*
|
|
7051
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7052
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7053
|
-
* @param {*} [options] Override http request option.
|
|
7054
|
-
* @throws {RequiredError}
|
|
7055
|
-
*/
|
|
7056
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7057
|
-
/**
|
|
7058
|
-
*
|
|
7059
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7060
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7061
|
-
* @param {*} [options] Override http request option.
|
|
7062
|
-
* @throws {RequiredError}
|
|
7063
|
-
*/
|
|
7064
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7065
|
-
/**
|
|
7066
|
-
*
|
|
7067
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7068
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7069
|
-
* @param {*} [options] Override http request option.
|
|
7070
|
-
* @throws {RequiredError}
|
|
7071
|
-
*/
|
|
7072
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7073
|
-
/**
|
|
7074
|
-
*
|
|
7075
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7076
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7077
|
-
* @param {*} [options] Override http request option.
|
|
7078
|
-
* @throws {RequiredError}
|
|
7079
|
-
*/
|
|
7080
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7081
7601
|
};
|
|
7082
7602
|
/**
|
|
7083
7603
|
* AuthenticateApi - functional programming interface
|
|
@@ -7110,10 +7630,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7110
7630
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7111
7631
|
/**
|
|
7112
7632
|
*
|
|
7113
|
-
* @summary EAN
|
|
7114
|
-
* @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
|
|
7115
7635
|
* @param {*} [options] Override http request option.
|
|
7116
|
-
* @deprecated
|
|
7117
7636
|
* @throws {RequiredError}
|
|
7118
7637
|
*/
|
|
7119
7638
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7188,13 +7707,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7188
7707
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7189
7708
|
/**
|
|
7190
7709
|
*
|
|
7191
|
-
* @summary PIN
|
|
7192
|
-
* @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
|
|
7193
7712
|
* @param {*} [options] Override http request option.
|
|
7194
|
-
* @deprecated
|
|
7195
7713
|
* @throws {RequiredError}
|
|
7196
7714
|
*/
|
|
7197
|
-
|
|
7715
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7198
7716
|
/**
|
|
7199
7717
|
*
|
|
7200
7718
|
* @summary Mock login and hand out token.
|
|
@@ -7205,19 +7723,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7205
7723
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7206
7724
|
/**
|
|
7207
7725
|
*
|
|
7208
|
-
* @summary NFC
|
|
7209
|
-
* @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
|
|
7210
7728
|
* @param {*} [options] Override http request option.
|
|
7211
|
-
* @deprecated
|
|
7212
7729
|
* @throws {RequiredError}
|
|
7213
7730
|
*/
|
|
7214
7731
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7215
7732
|
/**
|
|
7216
7733
|
*
|
|
7217
|
-
* @summary PIN
|
|
7218
|
-
* @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
|
|
7219
7736
|
* @param {*} [options] Override http request option.
|
|
7220
|
-
* @deprecated
|
|
7221
7737
|
* @throws {RequiredError}
|
|
7222
7738
|
*/
|
|
7223
7739
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7244,38 +7760,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7244
7760
|
* @throws {RequiredError}
|
|
7245
7761
|
*/
|
|
7246
7762
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7247
|
-
/**
|
|
7248
|
-
*
|
|
7249
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7250
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7251
|
-
* @param {*} [options] Override http request option.
|
|
7252
|
-
* @throws {RequiredError}
|
|
7253
|
-
*/
|
|
7254
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7255
|
-
/**
|
|
7256
|
-
*
|
|
7257
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7258
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7259
|
-
* @param {*} [options] Override http request option.
|
|
7260
|
-
* @throws {RequiredError}
|
|
7261
|
-
*/
|
|
7262
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7263
|
-
/**
|
|
7264
|
-
*
|
|
7265
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7266
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7267
|
-
* @param {*} [options] Override http request option.
|
|
7268
|
-
* @throws {RequiredError}
|
|
7269
|
-
*/
|
|
7270
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7271
|
-
/**
|
|
7272
|
-
*
|
|
7273
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7274
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7275
|
-
* @param {*} [options] Override http request option.
|
|
7276
|
-
* @throws {RequiredError}
|
|
7277
|
-
*/
|
|
7278
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7279
7763
|
};
|
|
7280
7764
|
/**
|
|
7281
7765
|
* AuthenticateApi - factory interface
|
|
@@ -7308,10 +7792,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7308
7792
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7309
7793
|
/**
|
|
7310
7794
|
*
|
|
7311
|
-
* @summary EAN
|
|
7795
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7312
7796
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7313
7797
|
* @param {*} [options] Override http request option.
|
|
7314
|
-
* @deprecated
|
|
7315
7798
|
* @throws {RequiredError}
|
|
7316
7799
|
*/
|
|
7317
7800
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7386,13 +7869,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7386
7869
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7387
7870
|
/**
|
|
7388
7871
|
*
|
|
7389
|
-
* @summary PIN
|
|
7390
|
-
* @param {
|
|
7872
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7873
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7391
7874
|
* @param {*} [options] Override http request option.
|
|
7392
|
-
* @deprecated
|
|
7393
7875
|
* @throws {RequiredError}
|
|
7394
7876
|
*/
|
|
7395
|
-
|
|
7877
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7396
7878
|
/**
|
|
7397
7879
|
*
|
|
7398
7880
|
* @summary Mock login and hand out token.
|
|
@@ -7403,19 +7885,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7403
7885
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7404
7886
|
/**
|
|
7405
7887
|
*
|
|
7406
|
-
* @summary NFC
|
|
7888
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7407
7889
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7408
7890
|
* @param {*} [options] Override http request option.
|
|
7409
|
-
* @deprecated
|
|
7410
7891
|
* @throws {RequiredError}
|
|
7411
7892
|
*/
|
|
7412
7893
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7413
7894
|
/**
|
|
7414
7895
|
*
|
|
7415
|
-
* @summary PIN
|
|
7896
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7416
7897
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7417
7898
|
* @param {*} [options] Override http request option.
|
|
7418
|
-
* @deprecated
|
|
7419
7899
|
* @throws {RequiredError}
|
|
7420
7900
|
*/
|
|
7421
7901
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7442,38 +7922,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7442
7922
|
* @throws {RequiredError}
|
|
7443
7923
|
*/
|
|
7444
7924
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7445
|
-
/**
|
|
7446
|
-
*
|
|
7447
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7448
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7449
|
-
* @param {*} [options] Override http request option.
|
|
7450
|
-
* @throws {RequiredError}
|
|
7451
|
-
*/
|
|
7452
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7453
|
-
/**
|
|
7454
|
-
*
|
|
7455
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7456
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7457
|
-
* @param {*} [options] Override http request option.
|
|
7458
|
-
* @throws {RequiredError}
|
|
7459
|
-
*/
|
|
7460
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7461
|
-
/**
|
|
7462
|
-
*
|
|
7463
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7464
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7465
|
-
* @param {*} [options] Override http request option.
|
|
7466
|
-
* @throws {RequiredError}
|
|
7467
|
-
*/
|
|
7468
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7469
|
-
/**
|
|
7470
|
-
*
|
|
7471
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7472
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7473
|
-
* @param {*} [options] Override http request option.
|
|
7474
|
-
* @throws {RequiredError}
|
|
7475
|
-
*/
|
|
7476
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7477
7925
|
};
|
|
7478
7926
|
/**
|
|
7479
7927
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7521,7 +7969,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7521
7969
|
*/
|
|
7522
7970
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7523
7971
|
/**
|
|
7524
|
-
* The EAN login
|
|
7972
|
+
* The EAN login request with posId
|
|
7525
7973
|
* @type {AuthenticationEanRequest}
|
|
7526
7974
|
* @memberof AuthenticateApiEanAuthentication
|
|
7527
7975
|
*/
|
|
@@ -7606,15 +8054,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7606
8054
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7607
8055
|
}
|
|
7608
8056
|
/**
|
|
7609
|
-
* Request parameters for
|
|
8057
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7610
8058
|
* @export
|
|
7611
|
-
* @interface
|
|
8059
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7612
8060
|
*/
|
|
7613
|
-
export interface
|
|
8061
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7614
8062
|
/**
|
|
7615
|
-
* The PIN login
|
|
8063
|
+
* The PIN login request with posId
|
|
7616
8064
|
* @type {MemberAuthenticationPinRequest}
|
|
7617
|
-
* @memberof
|
|
8065
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7618
8066
|
*/
|
|
7619
8067
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7620
8068
|
}
|
|
@@ -7638,7 +8086,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7638
8086
|
*/
|
|
7639
8087
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7640
8088
|
/**
|
|
7641
|
-
* The NFC login
|
|
8089
|
+
* The NFC login request with posId
|
|
7642
8090
|
* @type {AuthenticationNfcRequest}
|
|
7643
8091
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7644
8092
|
*/
|
|
@@ -7651,7 +8099,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7651
8099
|
*/
|
|
7652
8100
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7653
8101
|
/**
|
|
7654
|
-
* The PIN login
|
|
8102
|
+
* The PIN login request with posId
|
|
7655
8103
|
* @type {AuthenticationPinRequest}
|
|
7656
8104
|
* @memberof AuthenticateApiPinAuthentication
|
|
7657
8105
|
*/
|
|
@@ -7683,58 +8131,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7683
8131
|
*/
|
|
7684
8132
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7685
8133
|
}
|
|
7686
|
-
/**
|
|
7687
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7688
|
-
* @export
|
|
7689
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7690
|
-
*/
|
|
7691
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7692
|
-
/**
|
|
7693
|
-
* The EAN login request with posId
|
|
7694
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7695
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7696
|
-
*/
|
|
7697
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7698
|
-
}
|
|
7699
|
-
/**
|
|
7700
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7701
|
-
* @export
|
|
7702
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7703
|
-
*/
|
|
7704
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7705
|
-
/**
|
|
7706
|
-
* The PIN login request with posId
|
|
7707
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7708
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7709
|
-
*/
|
|
7710
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7711
|
-
}
|
|
7712
|
-
/**
|
|
7713
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7714
|
-
* @export
|
|
7715
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7716
|
-
*/
|
|
7717
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7718
|
-
/**
|
|
7719
|
-
* The NFC login request with posId
|
|
7720
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7721
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7722
|
-
*/
|
|
7723
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7724
|
-
}
|
|
7725
|
-
/**
|
|
7726
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7727
|
-
* @export
|
|
7728
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7729
|
-
*/
|
|
7730
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7731
|
-
/**
|
|
7732
|
-
* The PIN login request with posId
|
|
7733
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7734
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7735
|
-
*/
|
|
7736
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7737
|
-
}
|
|
7738
8134
|
/**
|
|
7739
8135
|
* AuthenticateApi - object-oriented interface
|
|
7740
8136
|
* @export
|
|
@@ -7771,10 +8167,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7771
8167
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7772
8168
|
/**
|
|
7773
8169
|
*
|
|
7774
|
-
* @summary EAN
|
|
8170
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7775
8171
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7776
8172
|
* @param {*} [options] Override http request option.
|
|
7777
|
-
* @deprecated
|
|
7778
8173
|
* @throws {RequiredError}
|
|
7779
8174
|
* @memberof AuthenticateApi
|
|
7780
8175
|
*/
|
|
@@ -7859,14 +8254,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7859
8254
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7860
8255
|
/**
|
|
7861
8256
|
*
|
|
7862
|
-
* @summary PIN
|
|
7863
|
-
* @param {
|
|
8257
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8258
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7864
8259
|
* @param {*} [options] Override http request option.
|
|
7865
|
-
* @deprecated
|
|
7866
8260
|
* @throws {RequiredError}
|
|
7867
8261
|
* @memberof AuthenticateApi
|
|
7868
8262
|
*/
|
|
7869
|
-
|
|
8263
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7870
8264
|
/**
|
|
7871
8265
|
*
|
|
7872
8266
|
* @summary Mock login and hand out token.
|
|
@@ -7878,20 +8272,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7878
8272
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7879
8273
|
/**
|
|
7880
8274
|
*
|
|
7881
|
-
* @summary NFC
|
|
8275
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7882
8276
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7883
8277
|
* @param {*} [options] Override http request option.
|
|
7884
|
-
* @deprecated
|
|
7885
8278
|
* @throws {RequiredError}
|
|
7886
8279
|
* @memberof AuthenticateApi
|
|
7887
8280
|
*/
|
|
7888
8281
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7889
8282
|
/**
|
|
7890
8283
|
*
|
|
7891
|
-
* @summary PIN
|
|
8284
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7892
8285
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7893
8286
|
* @param {*} [options] Override http request option.
|
|
7894
|
-
* @deprecated
|
|
7895
8287
|
* @throws {RequiredError}
|
|
7896
8288
|
* @memberof AuthenticateApi
|
|
7897
8289
|
*/
|
|
@@ -7922,42 +8314,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7922
8314
|
* @memberof AuthenticateApi
|
|
7923
8315
|
*/
|
|
7924
8316
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7925
|
-
/**
|
|
7926
|
-
*
|
|
7927
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7928
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7929
|
-
* @param {*} [options] Override http request option.
|
|
7930
|
-
* @throws {RequiredError}
|
|
7931
|
-
* @memberof AuthenticateApi
|
|
7932
|
-
*/
|
|
7933
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7934
|
-
/**
|
|
7935
|
-
*
|
|
7936
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7937
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7938
|
-
* @param {*} [options] Override http request option.
|
|
7939
|
-
* @throws {RequiredError}
|
|
7940
|
-
* @memberof AuthenticateApi
|
|
7941
|
-
*/
|
|
7942
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7943
|
-
/**
|
|
7944
|
-
*
|
|
7945
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7946
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7947
|
-
* @param {*} [options] Override http request option.
|
|
7948
|
-
* @throws {RequiredError}
|
|
7949
|
-
* @memberof AuthenticateApi
|
|
7950
|
-
*/
|
|
7951
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7952
|
-
/**
|
|
7953
|
-
*
|
|
7954
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7955
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7956
|
-
* @param {*} [options] Override http request option.
|
|
7957
|
-
* @throws {RequiredError}
|
|
7958
|
-
* @memberof AuthenticateApi
|
|
7959
|
-
*/
|
|
7960
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7961
8317
|
}
|
|
7962
8318
|
/**
|
|
7963
8319
|
* BalanceApi - axios parameter creator
|
|
@@ -7982,7 +8338,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7982
8338
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
7983
8339
|
* @param {number} [minFine] Minimum fine
|
|
7984
8340
|
* @param {number} [maxFine] Maximum fine
|
|
7985
|
-
* @param {
|
|
8341
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
7986
8342
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
7987
8343
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
7988
8344
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -7992,7 +8348,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7992
8348
|
* @param {*} [options] Override http request option.
|
|
7993
8349
|
* @throws {RequiredError}
|
|
7994
8350
|
*/
|
|
7995
|
-
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>;
|
|
7996
8352
|
/**
|
|
7997
8353
|
*
|
|
7998
8354
|
* @summary Retrieves the requested balance
|
|
@@ -8032,7 +8388,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8032
8388
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8033
8389
|
* @param {number} [minFine] Minimum fine
|
|
8034
8390
|
* @param {number} [maxFine] Maximum fine
|
|
8035
|
-
* @param {
|
|
8391
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8036
8392
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8037
8393
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8038
8394
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8042,7 +8398,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8042
8398
|
* @param {*} [options] Override http request option.
|
|
8043
8399
|
* @throws {RequiredError}
|
|
8044
8400
|
*/
|
|
8045
|
-
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>>;
|
|
8046
8402
|
/**
|
|
8047
8403
|
*
|
|
8048
8404
|
* @summary Retrieves the requested balance
|
|
@@ -8159,10 +8515,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8159
8515
|
readonly maxFine?: number;
|
|
8160
8516
|
/**
|
|
8161
8517
|
* Filter based on user type.
|
|
8162
|
-
* @type {Array<
|
|
8518
|
+
* @type {Array<UserType>}
|
|
8163
8519
|
* @memberof BalanceApiGetAllBalance
|
|
8164
8520
|
*/
|
|
8165
|
-
readonly userTypes?:
|
|
8521
|
+
readonly userTypes?: Array<UserType>;
|
|
8166
8522
|
/**
|
|
8167
8523
|
* Column to order balance by - eg: id,amount
|
|
8168
8524
|
* @type {string}
|
|
@@ -8256,11 +8612,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8256
8612
|
*/
|
|
8257
8613
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8258
8614
|
}
|
|
8259
|
-
/**
|
|
8260
|
-
* @export
|
|
8261
|
-
*/
|
|
8262
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8263
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8264
8615
|
/**
|
|
8265
8616
|
* @export
|
|
8266
8617
|
*/
|
|
@@ -10681,7 +11032,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10681
11032
|
* @param {*} [options] Override http request option.
|
|
10682
11033
|
* @throws {RequiredError}
|
|
10683
11034
|
*/
|
|
10684
|
-
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>>>;
|
|
10685
11036
|
/**
|
|
10686
11037
|
*
|
|
10687
11038
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10759,7 +11110,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10759
11110
|
* @param {*} [options] Override http request option.
|
|
10760
11111
|
* @throws {RequiredError}
|
|
10761
11112
|
*/
|
|
10762
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11113
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10763
11114
|
/**
|
|
10764
11115
|
*
|
|
10765
11116
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10982,7 +11333,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
10982
11333
|
* @throws {RequiredError}
|
|
10983
11334
|
* @memberof InactiveAdministrativeCostsApi
|
|
10984
11335
|
*/
|
|
10985
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11336
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
10986
11337
|
/**
|
|
10987
11338
|
*
|
|
10988
11339
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11027,16 +11378,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11027
11378
|
* @summary Returns all invoices in the system.
|
|
11028
11379
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11029
11380
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11030
|
-
* @param {
|
|
11381
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11031
11382
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11032
11383
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11033
11384
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
11385
|
+
* @param {string} [description] Filter invoices by description (partial match)
|
|
11034
11386
|
* @param {number} [take] How many entries the endpoint should return
|
|
11035
11387
|
* @param {number} [skip] How many entries should be skipped (for pagination)
|
|
11036
11388
|
* @param {*} [options] Override http request option.
|
|
11037
11389
|
* @throws {RequiredError}
|
|
11038
11390
|
*/
|
|
11039
|
-
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>;
|
|
11040
11392
|
/**
|
|
11041
11393
|
*
|
|
11042
11394
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11047,6 +11399,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11047
11399
|
* @throws {RequiredError}
|
|
11048
11400
|
*/
|
|
11049
11401
|
getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11402
|
+
/**
|
|
11403
|
+
*
|
|
11404
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11405
|
+
* @param {*} [options] Override http request option.
|
|
11406
|
+
* @throws {RequiredError}
|
|
11407
|
+
*/
|
|
11408
|
+
getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11050
11409
|
/**
|
|
11051
11410
|
*
|
|
11052
11411
|
* @summary Get an invoice pdf.
|
|
@@ -11126,16 +11485,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11126
11485
|
* @summary Returns all invoices in the system.
|
|
11127
11486
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11128
11487
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11129
|
-
* @param {
|
|
11488
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11130
11489
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11131
11490
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11132
11491
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
11492
|
+
* @param {string} [description] Filter invoices by description (partial match)
|
|
11133
11493
|
* @param {number} [take] How many entries the endpoint should return
|
|
11134
11494
|
* @param {number} [skip] How many entries should be skipped (for pagination)
|
|
11135
11495
|
* @param {*} [options] Override http request option.
|
|
11136
11496
|
* @throws {RequiredError}
|
|
11137
11497
|
*/
|
|
11138
|
-
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>>;
|
|
11139
11499
|
/**
|
|
11140
11500
|
*
|
|
11141
11501
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11145,7 +11505,14 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11145
11505
|
* @param {*} [options] Override http request option.
|
|
11146
11506
|
* @throws {RequiredError}
|
|
11147
11507
|
*/
|
|
11148
|
-
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>>>;
|
|
11509
|
+
/**
|
|
11510
|
+
*
|
|
11511
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11512
|
+
* @param {*} [options] Override http request option.
|
|
11513
|
+
* @throws {RequiredError}
|
|
11514
|
+
*/
|
|
11515
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
|
|
11149
11516
|
/**
|
|
11150
11517
|
*
|
|
11151
11518
|
* @summary Get an invoice pdf.
|
|
@@ -11154,7 +11521,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11154
11521
|
* @param {*} [options] Override http request option.
|
|
11155
11522
|
* @throws {RequiredError}
|
|
11156
11523
|
*/
|
|
11157
|
-
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>>;
|
|
11158
11525
|
/**
|
|
11159
11526
|
*
|
|
11160
11527
|
* @summary Returns a single invoice in the system.
|
|
@@ -11235,7 +11602,14 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11235
11602
|
* @param {*} [options] Override http request option.
|
|
11236
11603
|
* @throws {RequiredError}
|
|
11237
11604
|
*/
|
|
11238
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11605
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11606
|
+
/**
|
|
11607
|
+
*
|
|
11608
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11609
|
+
* @param {*} [options] Override http request option.
|
|
11610
|
+
* @throws {RequiredError}
|
|
11611
|
+
*/
|
|
11612
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
|
|
11239
11613
|
/**
|
|
11240
11614
|
*
|
|
11241
11615
|
* @summary Get an invoice pdf.
|
|
@@ -11243,7 +11617,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11243
11617
|
* @param {*} [options] Override http request option.
|
|
11244
11618
|
* @throws {RequiredError}
|
|
11245
11619
|
*/
|
|
11246
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11620
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11247
11621
|
/**
|
|
11248
11622
|
*
|
|
11249
11623
|
* @summary Returns a single invoice in the system.
|
|
@@ -11336,10 +11710,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11336
11710
|
readonly invoiceId?: number;
|
|
11337
11711
|
/**
|
|
11338
11712
|
* Filter based on Invoice State.
|
|
11339
|
-
* @type {Array<
|
|
11713
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11340
11714
|
* @memberof InvoicesApiGetAllInvoices
|
|
11341
11715
|
*/
|
|
11342
|
-
readonly currentState?:
|
|
11716
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11343
11717
|
/**
|
|
11344
11718
|
* Boolean if invoice entries should be returned
|
|
11345
11719
|
* @type {boolean}
|
|
@@ -11358,6 +11732,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11358
11732
|
* @memberof InvoicesApiGetAllInvoices
|
|
11359
11733
|
*/
|
|
11360
11734
|
readonly tillDate?: string;
|
|
11735
|
+
/**
|
|
11736
|
+
* Filter invoices by description (partial match)
|
|
11737
|
+
* @type {string}
|
|
11738
|
+
* @memberof InvoicesApiGetAllInvoices
|
|
11739
|
+
*/
|
|
11740
|
+
readonly description?: string;
|
|
11361
11741
|
/**
|
|
11362
11742
|
* How many entries the endpoint should return
|
|
11363
11743
|
* @type {number}
|
|
@@ -11536,7 +11916,15 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11536
11916
|
* @throws {RequiredError}
|
|
11537
11917
|
* @memberof InvoicesApi
|
|
11538
11918
|
*/
|
|
11539
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11919
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11920
|
+
/**
|
|
11921
|
+
*
|
|
11922
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11923
|
+
* @param {*} [options] Override http request option.
|
|
11924
|
+
* @throws {RequiredError}
|
|
11925
|
+
* @memberof InvoicesApi
|
|
11926
|
+
*/
|
|
11927
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11540
11928
|
/**
|
|
11541
11929
|
*
|
|
11542
11930
|
* @summary Get an invoice pdf.
|
|
@@ -11545,7 +11933,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11545
11933
|
* @throws {RequiredError}
|
|
11546
11934
|
* @memberof InvoicesApi
|
|
11547
11935
|
*/
|
|
11548
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11936
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11549
11937
|
/**
|
|
11550
11938
|
*
|
|
11551
11939
|
* @summary Returns a single invoice in the system.
|
|
@@ -11584,191 +11972,672 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11584
11972
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11585
11973
|
}
|
|
11586
11974
|
/**
|
|
11975
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11587
11976
|
* @export
|
|
11588
11977
|
*/
|
|
11589
|
-
export declare const
|
|
11590
|
-
export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
|
|
11591
|
-
/**
|
|
11592
|
-
* PayoutRequestsApi - axios parameter creator
|
|
11593
|
-
* @export
|
|
11594
|
-
*/
|
|
11595
|
-
export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11978
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11596
11979
|
/**
|
|
11597
11980
|
*
|
|
11598
|
-
* @summary
|
|
11599
|
-
* @param {
|
|
11981
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11982
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11600
11983
|
* @param {*} [options] Override http request option.
|
|
11601
11984
|
* @throws {RequiredError}
|
|
11602
11985
|
*/
|
|
11603
|
-
|
|
11986
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11604
11987
|
/**
|
|
11605
11988
|
*
|
|
11606
|
-
* @summary
|
|
11607
|
-
* @param {
|
|
11608
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11609
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11610
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11611
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11612
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11613
|
-
* @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
|
|
11614
11991
|
* @param {*} [options] Override http request option.
|
|
11615
11992
|
* @throws {RequiredError}
|
|
11616
11993
|
*/
|
|
11617
|
-
|
|
11994
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11618
11995
|
/**
|
|
11619
11996
|
*
|
|
11620
|
-
* @summary
|
|
11621
|
-
* @param {number}
|
|
11622
|
-
* @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)
|
|
11623
12005
|
* @param {*} [options] Override http request option.
|
|
11624
12006
|
* @throws {RequiredError}
|
|
11625
12007
|
*/
|
|
11626
|
-
|
|
12008
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11627
12009
|
/**
|
|
11628
12010
|
*
|
|
11629
|
-
* @summary
|
|
11630
|
-
* @param {
|
|
12011
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12012
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11631
12013
|
* @param {*} [options] Override http request option.
|
|
11632
12014
|
* @throws {RequiredError}
|
|
11633
12015
|
*/
|
|
11634
|
-
|
|
12016
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11635
12017
|
/**
|
|
11636
12018
|
*
|
|
11637
|
-
* @summary
|
|
11638
|
-
* @param {
|
|
11639
|
-
* @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
|
|
11640
12022
|
* @param {*} [options] Override http request option.
|
|
11641
12023
|
* @throws {RequiredError}
|
|
11642
12024
|
*/
|
|
11643
|
-
|
|
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>;
|
|
11644
12034
|
};
|
|
11645
12035
|
/**
|
|
11646
|
-
*
|
|
12036
|
+
* PaymentRequestsApi - functional programming interface
|
|
11647
12037
|
* @export
|
|
11648
12038
|
*/
|
|
11649
|
-
export declare const
|
|
12039
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11650
12040
|
/**
|
|
11651
12041
|
*
|
|
11652
|
-
* @summary
|
|
11653
|
-
* @param {
|
|
12042
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12043
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11654
12044
|
* @param {*} [options] Override http request option.
|
|
11655
12045
|
* @throws {RequiredError}
|
|
11656
12046
|
*/
|
|
11657
|
-
|
|
12047
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11658
12048
|
/**
|
|
11659
12049
|
*
|
|
11660
|
-
* @summary
|
|
11661
|
-
* @param {
|
|
11662
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11663
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11664
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11665
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11666
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11667
|
-
* @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
|
|
11668
12052
|
* @param {*} [options] Override http request option.
|
|
11669
12053
|
* @throws {RequiredError}
|
|
11670
12054
|
*/
|
|
11671
|
-
|
|
12055
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11672
12056
|
/**
|
|
11673
12057
|
*
|
|
11674
|
-
* @summary
|
|
11675
|
-
* @param {number}
|
|
11676
|
-
* @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)
|
|
11677
12066
|
* @param {*} [options] Override http request option.
|
|
11678
12067
|
* @throws {RequiredError}
|
|
11679
12068
|
*/
|
|
11680
|
-
|
|
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>>;
|
|
11681
12070
|
/**
|
|
11682
12071
|
*
|
|
11683
|
-
* @summary
|
|
11684
|
-
* @param {
|
|
12072
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12073
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11685
12074
|
* @param {*} [options] Override http request option.
|
|
11686
12075
|
* @throws {RequiredError}
|
|
11687
12076
|
*/
|
|
11688
|
-
|
|
12077
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11689
12078
|
/**
|
|
11690
12079
|
*
|
|
11691
|
-
* @summary
|
|
11692
|
-
* @param {
|
|
11693
|
-
* @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
|
|
11694
12083
|
* @param {*} [options] Override http request option.
|
|
11695
12084
|
* @throws {RequiredError}
|
|
11696
12085
|
*/
|
|
11697
|
-
|
|
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>>;
|
|
11698
12095
|
};
|
|
11699
12096
|
/**
|
|
11700
|
-
*
|
|
12097
|
+
* PaymentRequestsApi - factory interface
|
|
11701
12098
|
* @export
|
|
11702
12099
|
*/
|
|
11703
|
-
export declare const
|
|
12100
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11704
12101
|
/**
|
|
11705
12102
|
*
|
|
11706
|
-
* @summary
|
|
11707
|
-
* @param {
|
|
12103
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12104
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11708
12105
|
* @param {*} [options] Override http request option.
|
|
11709
12106
|
* @throws {RequiredError}
|
|
11710
12107
|
*/
|
|
11711
|
-
|
|
12108
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11712
12109
|
/**
|
|
11713
12110
|
*
|
|
11714
|
-
* @summary
|
|
11715
|
-
* @param {
|
|
12111
|
+
* @summary Create a new PaymentRequest.
|
|
12112
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11716
12113
|
* @param {*} [options] Override http request option.
|
|
11717
12114
|
* @throws {RequiredError}
|
|
11718
12115
|
*/
|
|
11719
|
-
|
|
12116
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11720
12117
|
/**
|
|
11721
12118
|
*
|
|
11722
|
-
* @summary
|
|
11723
|
-
* @param {
|
|
12119
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12120
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11724
12121
|
* @param {*} [options] Override http request option.
|
|
11725
12122
|
* @throws {RequiredError}
|
|
11726
12123
|
*/
|
|
11727
|
-
|
|
12124
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11728
12125
|
/**
|
|
11729
12126
|
*
|
|
11730
|
-
* @summary
|
|
11731
|
-
* @param {
|
|
12127
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12128
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11732
12129
|
* @param {*} [options] Override http request option.
|
|
11733
12130
|
* @throws {RequiredError}
|
|
11734
12131
|
*/
|
|
11735
|
-
|
|
12132
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11736
12133
|
/**
|
|
11737
12134
|
*
|
|
11738
|
-
* @summary
|
|
11739
|
-
* @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.
|
|
11740
12137
|
* @param {*} [options] Override http request option.
|
|
11741
12138
|
* @throws {RequiredError}
|
|
11742
12139
|
*/
|
|
11743
|
-
|
|
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>;
|
|
11744
12149
|
};
|
|
11745
12150
|
/**
|
|
11746
|
-
* Request parameters for
|
|
12151
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11747
12152
|
* @export
|
|
11748
|
-
* @interface
|
|
12153
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11749
12154
|
*/
|
|
11750
|
-
export interface
|
|
12155
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11751
12156
|
/**
|
|
11752
|
-
*
|
|
11753
|
-
* @type {
|
|
11754
|
-
* @memberof
|
|
12157
|
+
* UUID v4 of the payment request.
|
|
12158
|
+
* @type {string}
|
|
12159
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11755
12160
|
*/
|
|
11756
|
-
readonly
|
|
12161
|
+
readonly id: string;
|
|
11757
12162
|
}
|
|
11758
12163
|
/**
|
|
11759
|
-
* Request parameters for
|
|
12164
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11760
12165
|
* @export
|
|
11761
|
-
* @interface
|
|
12166
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11762
12167
|
*/
|
|
11763
|
-
export interface
|
|
12168
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11764
12169
|
/**
|
|
11765
|
-
*
|
|
11766
|
-
* @type {
|
|
11767
|
-
* @memberof
|
|
12170
|
+
* The request to create
|
|
12171
|
+
* @type {CreatePaymentRequestRequest}
|
|
12172
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11768
12173
|
*/
|
|
11769
|
-
readonly
|
|
11770
|
-
|
|
11771
|
-
|
|
12174
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
12175
|
+
}
|
|
12176
|
+
/**
|
|
12177
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
12178
|
+
* @export
|
|
12179
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
12180
|
+
*/
|
|
12181
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
12182
|
+
/**
|
|
12183
|
+
* Filter by beneficiary user id.
|
|
12184
|
+
* @type {number}
|
|
12185
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12186
|
+
*/
|
|
12187
|
+
readonly forId?: number;
|
|
12188
|
+
/**
|
|
12189
|
+
* Filter by creator user id.
|
|
12190
|
+
* @type {number}
|
|
12191
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12192
|
+
*/
|
|
12193
|
+
readonly createdById?: number;
|
|
12194
|
+
/**
|
|
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).
|
|
12202
|
+
* @type {string}
|
|
12203
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12204
|
+
*/
|
|
12205
|
+
readonly fromDate?: string;
|
|
12206
|
+
/**
|
|
12207
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12208
|
+
* @type {string}
|
|
12209
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12210
|
+
*/
|
|
12211
|
+
readonly tillDate?: string;
|
|
12212
|
+
/**
|
|
12213
|
+
* How many rows the endpoint should return
|
|
12214
|
+
* @type {number}
|
|
12215
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12216
|
+
*/
|
|
12217
|
+
readonly take?: number;
|
|
12218
|
+
/**
|
|
12219
|
+
* How many rows to skip (for pagination)
|
|
12220
|
+
* @type {number}
|
|
12221
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12222
|
+
*/
|
|
12223
|
+
readonly skip?: number;
|
|
12224
|
+
}
|
|
12225
|
+
/**
|
|
12226
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
12227
|
+
* @export
|
|
12228
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
12229
|
+
*/
|
|
12230
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
12231
|
+
/**
|
|
12232
|
+
* UUID v4 of the payment request.
|
|
12233
|
+
* @type {string}
|
|
12234
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12235
|
+
*/
|
|
12236
|
+
readonly id: string;
|
|
12237
|
+
}
|
|
12238
|
+
/**
|
|
12239
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12240
|
+
* @export
|
|
12241
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12242
|
+
*/
|
|
12243
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
12244
|
+
/**
|
|
12245
|
+
* UUID v4 of the payment request.
|
|
12246
|
+
* @type {string}
|
|
12247
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12248
|
+
*/
|
|
12249
|
+
readonly id: string;
|
|
12250
|
+
/**
|
|
12251
|
+
* The audit reason
|
|
12252
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12253
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12254
|
+
*/
|
|
12255
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12256
|
+
}
|
|
12257
|
+
/**
|
|
12258
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12259
|
+
* @export
|
|
12260
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12261
|
+
*/
|
|
12262
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12263
|
+
/**
|
|
12264
|
+
* UUID v4 of the payment request.
|
|
12265
|
+
* @type {string}
|
|
12266
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12267
|
+
*/
|
|
12268
|
+
readonly id: string;
|
|
12269
|
+
}
|
|
12270
|
+
/**
|
|
12271
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12272
|
+
* @export
|
|
12273
|
+
* @class PaymentRequestsApi
|
|
12274
|
+
* @extends {BaseAPI}
|
|
12275
|
+
*/
|
|
12276
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12277
|
+
/**
|
|
12278
|
+
*
|
|
12279
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12280
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12281
|
+
* @param {*} [options] Override http request option.
|
|
12282
|
+
* @throws {RequiredError}
|
|
12283
|
+
* @memberof PaymentRequestsApi
|
|
12284
|
+
*/
|
|
12285
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12286
|
+
/**
|
|
12287
|
+
*
|
|
12288
|
+
* @summary Create a new PaymentRequest.
|
|
12289
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12290
|
+
* @param {*} [options] Override http request option.
|
|
12291
|
+
* @throws {RequiredError}
|
|
12292
|
+
* @memberof PaymentRequestsApi
|
|
12293
|
+
*/
|
|
12294
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12295
|
+
/**
|
|
12296
|
+
*
|
|
12297
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12298
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12299
|
+
* @param {*} [options] Override http request option.
|
|
12300
|
+
* @throws {RequiredError}
|
|
12301
|
+
* @memberof PaymentRequestsApi
|
|
12302
|
+
*/
|
|
12303
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12304
|
+
/**
|
|
12305
|
+
*
|
|
12306
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12307
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12308
|
+
* @param {*} [options] Override http request option.
|
|
12309
|
+
* @throws {RequiredError}
|
|
12310
|
+
* @memberof PaymentRequestsApi
|
|
12311
|
+
*/
|
|
12312
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12313
|
+
/**
|
|
12314
|
+
*
|
|
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.
|
|
12317
|
+
* @param {*} [options] Override http request option.
|
|
12318
|
+
* @throws {RequiredError}
|
|
12319
|
+
* @memberof PaymentRequestsApi
|
|
12320
|
+
*/
|
|
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
|
|
11772
12641
|
* @type {GetAllPayoutRequestsRequestedByIdParameter}
|
|
11773
12642
|
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
11774
12643
|
*/
|
|
@@ -14053,6 +14922,13 @@ export declare const StripeApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14053
14922
|
* @throws {RequiredError}
|
|
14054
14923
|
*/
|
|
14055
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>;
|
|
14056
14932
|
};
|
|
14057
14933
|
/**
|
|
14058
14934
|
* StripeApi - functional programming interface
|
|
@@ -14074,6 +14950,13 @@ export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
|
14074
14950
|
* @throws {RequiredError}
|
|
14075
14951
|
*/
|
|
14076
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>>;
|
|
14077
14960
|
};
|
|
14078
14961
|
/**
|
|
14079
14962
|
* StripeApi - factory interface
|
|
@@ -14095,6 +14978,13 @@ export declare const StripeApiFactory: (configuration?: Configuration, basePath?
|
|
|
14095
14978
|
* @throws {RequiredError}
|
|
14096
14979
|
*/
|
|
14097
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>;
|
|
14098
14988
|
};
|
|
14099
14989
|
/**
|
|
14100
14990
|
* Request parameters for deposit operation in StripeApi.
|
|
@@ -14107,110 +14997,368 @@ export interface StripeApiDepositRequest {
|
|
|
14107
14997
|
* @type {StripeRequest}
|
|
14108
14998
|
* @memberof StripeApiDeposit
|
|
14109
14999
|
*/
|
|
14110
|
-
readonly stripeRequest: StripeRequest;
|
|
14111
|
-
}
|
|
14112
|
-
/**
|
|
14113
|
-
* StripeApi - object-oriented interface
|
|
14114
|
-
* @export
|
|
14115
|
-
* @class StripeApi
|
|
14116
|
-
* @extends {BaseAPI}
|
|
14117
|
-
*/
|
|
14118
|
-
export declare class StripeApi extends BaseAPI {
|
|
15000
|
+
readonly stripeRequest: StripeRequest;
|
|
15001
|
+
}
|
|
15002
|
+
/**
|
|
15003
|
+
* StripeApi - object-oriented interface
|
|
15004
|
+
* @export
|
|
15005
|
+
* @class StripeApi
|
|
15006
|
+
* @extends {BaseAPI}
|
|
15007
|
+
*/
|
|
15008
|
+
export declare class StripeApi extends BaseAPI {
|
|
15009
|
+
/**
|
|
15010
|
+
*
|
|
15011
|
+
* @summary Start the stripe deposit flow
|
|
15012
|
+
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15013
|
+
* @param {*} [options] Override http request option.
|
|
15014
|
+
* @throws {RequiredError}
|
|
15015
|
+
* @memberof StripeApi
|
|
15016
|
+
*/
|
|
15017
|
+
deposit(requestParameters: StripeApiDepositRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentIntentResponse, any, {}>>;
|
|
15018
|
+
/**
|
|
15019
|
+
*
|
|
15020
|
+
* @summary Get the Stripe public key
|
|
15021
|
+
* @param {*} [options] Override http request option.
|
|
15022
|
+
* @throws {RequiredError}
|
|
15023
|
+
* @memberof StripeApi
|
|
15024
|
+
*/
|
|
15025
|
+
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
15026
|
+
/**
|
|
15027
|
+
*
|
|
15028
|
+
* @summary Webhook for Stripe event updates
|
|
15029
|
+
* @param {*} [options] Override http request option.
|
|
15030
|
+
* @throws {RequiredError}
|
|
15031
|
+
* @memberof StripeApi
|
|
15032
|
+
*/
|
|
15033
|
+
webhook(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
15034
|
+
}
|
|
15035
|
+
/**
|
|
15036
|
+
* SyncApi - axios parameter creator
|
|
15037
|
+
* @export
|
|
15038
|
+
*/
|
|
15039
|
+
export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15040
|
+
/**
|
|
15041
|
+
* Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
|
|
15042
|
+
* @summary Get dry-run sync results for users
|
|
15043
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15044
|
+
* @param {*} [options] Override http request option.
|
|
15045
|
+
* @throws {RequiredError}
|
|
15046
|
+
*/
|
|
15047
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15048
|
+
};
|
|
15049
|
+
/**
|
|
15050
|
+
* SyncApi - functional programming interface
|
|
15051
|
+
* @export
|
|
15052
|
+
*/
|
|
15053
|
+
export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
15054
|
+
/**
|
|
15055
|
+
* Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
|
|
15056
|
+
* @summary Get dry-run sync results for users
|
|
15057
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15058
|
+
* @param {*} [options] Override http request option.
|
|
15059
|
+
* @throws {RequiredError}
|
|
15060
|
+
*/
|
|
15061
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15062
|
+
};
|
|
15063
|
+
/**
|
|
15064
|
+
* SyncApi - factory interface
|
|
15065
|
+
* @export
|
|
15066
|
+
*/
|
|
15067
|
+
export declare const SyncApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15068
|
+
/**
|
|
15069
|
+
* Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
|
|
15070
|
+
* @summary Get dry-run sync results for users
|
|
15071
|
+
* @param {SyncApiGetUserSyncResultsRequest} requestParameters Request parameters.
|
|
15072
|
+
* @param {*} [options] Override http request option.
|
|
15073
|
+
* @throws {RequiredError}
|
|
15074
|
+
*/
|
|
15075
|
+
getUserSyncResults(requestParameters?: SyncApiGetUserSyncResultsRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15076
|
+
};
|
|
15077
|
+
/**
|
|
15078
|
+
* Request parameters for getUserSyncResults operation in SyncApi.
|
|
15079
|
+
* @export
|
|
15080
|
+
* @interface SyncApiGetUserSyncResultsRequest
|
|
15081
|
+
*/
|
|
15082
|
+
export interface SyncApiGetUserSyncResultsRequest {
|
|
15083
|
+
/**
|
|
15084
|
+
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15085
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
15086
|
+
* @memberof SyncApiGetUserSyncResults
|
|
15087
|
+
*/
|
|
15088
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
15089
|
+
}
|
|
15090
|
+
/**
|
|
15091
|
+
* SyncApi - object-oriented interface
|
|
15092
|
+
* @export
|
|
15093
|
+
* @class SyncApi
|
|
15094
|
+
* @extends {BaseAPI}
|
|
15095
|
+
*/
|
|
15096
|
+
export declare class SyncApi extends BaseAPI {
|
|
15097
|
+
/**
|
|
15098
|
+
* Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
|
|
15099
|
+
* @summary Get dry-run sync results for users
|
|
15100
|
+
* @param {SyncApiGetUserSyncResultsRequest} requestParameters Request parameters.
|
|
15101
|
+
* @param {*} [options] Override http request option.
|
|
15102
|
+
* @throws {RequiredError}
|
|
15103
|
+
* @memberof SyncApi
|
|
15104
|
+
*/
|
|
15105
|
+
getUserSyncResults(requestParameters?: SyncApiGetUserSyncResultsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
15106
|
+
}
|
|
15107
|
+
/**
|
|
15108
|
+
* @export
|
|
15109
|
+
*/
|
|
15110
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
15111
|
+
readonly Ldap: "LDAP";
|
|
15112
|
+
readonly Gewisdb: "GEWISDB";
|
|
15113
|
+
};
|
|
15114
|
+
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
15115
|
+
/**
|
|
15116
|
+
* TerminalPaymentsApi - axios parameter creator
|
|
15117
|
+
* @export
|
|
15118
|
+
*/
|
|
15119
|
+
export declare const TerminalPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15120
|
+
/**
|
|
15121
|
+
*
|
|
15122
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15123
|
+
* @param {number} id The ID of the terminal payment
|
|
15124
|
+
* @param {*} [options] Override http request option.
|
|
15125
|
+
* @throws {RequiredError}
|
|
15126
|
+
*/
|
|
15127
|
+
cancelTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15128
|
+
/**
|
|
15129
|
+
*
|
|
15130
|
+
* @summary Create a terminal payment before executing.
|
|
15131
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15132
|
+
* @param {*} [options] Override http request option.
|
|
15133
|
+
* @throws {RequiredError}
|
|
15134
|
+
*/
|
|
15135
|
+
createTerminalPayment: (createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15136
|
+
/**
|
|
15137
|
+
*
|
|
15138
|
+
* @summary Get single terminal payment by ID
|
|
15139
|
+
* @param {number} id The ID of the terminal payment
|
|
15140
|
+
* @param {*} [options] Override http request option.
|
|
15141
|
+
* @throws {RequiredError}
|
|
15142
|
+
*/
|
|
15143
|
+
getSingleTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15144
|
+
/**
|
|
15145
|
+
*
|
|
15146
|
+
* @summary Get all Stripe terminals
|
|
15147
|
+
* @param {*} [options] Override http request option.
|
|
15148
|
+
* @throws {RequiredError}
|
|
15149
|
+
*/
|
|
15150
|
+
getStripeTerminals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15151
|
+
/**
|
|
15152
|
+
*
|
|
15153
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15154
|
+
* @param {number} id The ID of the terminal payment
|
|
15155
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15156
|
+
* @param {*} [options] Override http request option.
|
|
15157
|
+
* @throws {RequiredError}
|
|
15158
|
+
*/
|
|
15159
|
+
startTerminalPayment: (id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15160
|
+
};
|
|
15161
|
+
/**
|
|
15162
|
+
* TerminalPaymentsApi - functional programming interface
|
|
15163
|
+
* @export
|
|
15164
|
+
*/
|
|
15165
|
+
export declare const TerminalPaymentsApiFp: (configuration?: Configuration) => {
|
|
15166
|
+
/**
|
|
15167
|
+
*
|
|
15168
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15169
|
+
* @param {number} id The ID of the terminal payment
|
|
15170
|
+
* @param {*} [options] Override http request option.
|
|
15171
|
+
* @throws {RequiredError}
|
|
15172
|
+
*/
|
|
15173
|
+
cancelTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15174
|
+
/**
|
|
15175
|
+
*
|
|
15176
|
+
* @summary Create a terminal payment before executing.
|
|
15177
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15178
|
+
* @param {*} [options] Override http request option.
|
|
15179
|
+
* @throws {RequiredError}
|
|
15180
|
+
*/
|
|
15181
|
+
createTerminalPayment(createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15182
|
+
/**
|
|
15183
|
+
*
|
|
15184
|
+
* @summary Get single terminal payment by ID
|
|
15185
|
+
* @param {number} id The ID of the terminal payment
|
|
15186
|
+
* @param {*} [options] Override http request option.
|
|
15187
|
+
* @throws {RequiredError}
|
|
15188
|
+
*/
|
|
15189
|
+
getSingleTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15190
|
+
/**
|
|
15191
|
+
*
|
|
15192
|
+
* @summary Get all Stripe terminals
|
|
15193
|
+
* @param {*} [options] Override http request option.
|
|
15194
|
+
* @throws {RequiredError}
|
|
15195
|
+
*/
|
|
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>>;
|
|
15206
|
+
};
|
|
15207
|
+
/**
|
|
15208
|
+
* TerminalPaymentsApi - factory interface
|
|
15209
|
+
* @export
|
|
15210
|
+
*/
|
|
15211
|
+
export declare const TerminalPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15212
|
+
/**
|
|
15213
|
+
*
|
|
15214
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15215
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
15216
|
+
* @param {*} [options] Override http request option.
|
|
15217
|
+
* @throws {RequiredError}
|
|
15218
|
+
*/
|
|
15219
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15220
|
+
/**
|
|
15221
|
+
*
|
|
15222
|
+
* @summary Create a terminal payment before executing.
|
|
15223
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15224
|
+
* @param {*} [options] Override http request option.
|
|
15225
|
+
* @throws {RequiredError}
|
|
15226
|
+
*/
|
|
15227
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15228
|
+
/**
|
|
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}
|
|
15234
|
+
*/
|
|
15235
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14119
15236
|
/**
|
|
14120
15237
|
*
|
|
14121
|
-
* @summary
|
|
14122
|
-
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15238
|
+
* @summary Get all Stripe terminals
|
|
14123
15239
|
* @param {*} [options] Override http request option.
|
|
14124
15240
|
* @throws {RequiredError}
|
|
14125
|
-
* @memberof StripeApi
|
|
14126
15241
|
*/
|
|
14127
|
-
|
|
15242
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): AxiosPromise<Array<StripePaymentTerminalResponse>>;
|
|
14128
15243
|
/**
|
|
14129
15244
|
*
|
|
14130
|
-
* @summary
|
|
15245
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15246
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
14131
15247
|
* @param {*} [options] Override http request option.
|
|
14132
15248
|
* @throws {RequiredError}
|
|
14133
|
-
* @memberof StripeApi
|
|
14134
15249
|
*/
|
|
14135
|
-
|
|
14136
|
-
}
|
|
15250
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15251
|
+
};
|
|
14137
15252
|
/**
|
|
14138
|
-
*
|
|
15253
|
+
* Request parameters for cancelTerminalPayment operation in TerminalPaymentsApi.
|
|
14139
15254
|
* @export
|
|
15255
|
+
* @interface TerminalPaymentsApiCancelTerminalPaymentRequest
|
|
14140
15256
|
*/
|
|
14141
|
-
export
|
|
15257
|
+
export interface TerminalPaymentsApiCancelTerminalPaymentRequest {
|
|
14142
15258
|
/**
|
|
14143
|
-
*
|
|
14144
|
-
* @
|
|
14145
|
-
* @
|
|
14146
|
-
* @param {*} [options] Override http request option.
|
|
14147
|
-
* @throws {RequiredError}
|
|
15259
|
+
* The ID of the terminal payment
|
|
15260
|
+
* @type {number}
|
|
15261
|
+
* @memberof TerminalPaymentsApiCancelTerminalPayment
|
|
14148
15262
|
*/
|
|
14149
|
-
|
|
14150
|
-
}
|
|
15263
|
+
readonly id: number;
|
|
15264
|
+
}
|
|
14151
15265
|
/**
|
|
14152
|
-
*
|
|
15266
|
+
* Request parameters for createTerminalPayment operation in TerminalPaymentsApi.
|
|
14153
15267
|
* @export
|
|
15268
|
+
* @interface TerminalPaymentsApiCreateTerminalPaymentRequest
|
|
14154
15269
|
*/
|
|
14155
|
-
export
|
|
15270
|
+
export interface TerminalPaymentsApiCreateTerminalPaymentRequest {
|
|
14156
15271
|
/**
|
|
14157
|
-
*
|
|
14158
|
-
* @
|
|
14159
|
-
* @
|
|
14160
|
-
* @param {*} [options] Override http request option.
|
|
14161
|
-
* @throws {RequiredError}
|
|
15272
|
+
* The terminal payment that should be created.
|
|
15273
|
+
* @type {CreateTerminalPaymentRequest}
|
|
15274
|
+
* @memberof TerminalPaymentsApiCreateTerminalPayment
|
|
14162
15275
|
*/
|
|
14163
|
-
|
|
14164
|
-
}
|
|
15276
|
+
readonly createTerminalPaymentRequest: CreateTerminalPaymentRequest;
|
|
15277
|
+
}
|
|
14165
15278
|
/**
|
|
14166
|
-
*
|
|
15279
|
+
* Request parameters for getSingleTerminalPayment operation in TerminalPaymentsApi.
|
|
14167
15280
|
* @export
|
|
15281
|
+
* @interface TerminalPaymentsApiGetSingleTerminalPaymentRequest
|
|
14168
15282
|
*/
|
|
14169
|
-
export
|
|
15283
|
+
export interface TerminalPaymentsApiGetSingleTerminalPaymentRequest {
|
|
14170
15284
|
/**
|
|
14171
|
-
*
|
|
14172
|
-
* @
|
|
14173
|
-
* @
|
|
14174
|
-
* @param {*} [options] Override http request option.
|
|
14175
|
-
* @throws {RequiredError}
|
|
15285
|
+
* The ID of the terminal payment
|
|
15286
|
+
* @type {number}
|
|
15287
|
+
* @memberof TerminalPaymentsApiGetSingleTerminalPayment
|
|
14176
15288
|
*/
|
|
14177
|
-
|
|
14178
|
-
}
|
|
15289
|
+
readonly id: number;
|
|
15290
|
+
}
|
|
14179
15291
|
/**
|
|
14180
|
-
* Request parameters for
|
|
15292
|
+
* Request parameters for startTerminalPayment operation in TerminalPaymentsApi.
|
|
14181
15293
|
* @export
|
|
14182
|
-
* @interface
|
|
15294
|
+
* @interface TerminalPaymentsApiStartTerminalPaymentRequest
|
|
14183
15295
|
*/
|
|
14184
|
-
export interface
|
|
15296
|
+
export interface TerminalPaymentsApiStartTerminalPaymentRequest {
|
|
14185
15297
|
/**
|
|
14186
|
-
*
|
|
14187
|
-
* @type {
|
|
14188
|
-
* @memberof
|
|
15298
|
+
* The ID of the terminal payment
|
|
15299
|
+
* @type {number}
|
|
15300
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15301
|
+
*/
|
|
15302
|
+
readonly id: number;
|
|
15303
|
+
/**
|
|
15304
|
+
* Payment options
|
|
15305
|
+
* @type {ProcessTerminalPaymentRequest}
|
|
15306
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
14189
15307
|
*/
|
|
14190
|
-
readonly
|
|
15308
|
+
readonly processTerminalPaymentRequest: ProcessTerminalPaymentRequest;
|
|
14191
15309
|
}
|
|
14192
15310
|
/**
|
|
14193
|
-
*
|
|
15311
|
+
* TerminalPaymentsApi - object-oriented interface
|
|
14194
15312
|
* @export
|
|
14195
|
-
* @class
|
|
15313
|
+
* @class TerminalPaymentsApi
|
|
14196
15314
|
* @extends {BaseAPI}
|
|
14197
15315
|
*/
|
|
14198
|
-
export declare class
|
|
15316
|
+
export declare class TerminalPaymentsApi extends BaseAPI {
|
|
14199
15317
|
/**
|
|
14200
|
-
*
|
|
14201
|
-
* @summary
|
|
14202
|
-
* @param {
|
|
15318
|
+
*
|
|
15319
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15320
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
14203
15321
|
* @param {*} [options] Override http request option.
|
|
14204
15322
|
* @throws {RequiredError}
|
|
14205
|
-
* @memberof
|
|
15323
|
+
* @memberof TerminalPaymentsApi
|
|
14206
15324
|
*/
|
|
14207
|
-
|
|
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, {}>>;
|
|
14208
15361
|
}
|
|
14209
|
-
/**
|
|
14210
|
-
* @export
|
|
14211
|
-
*/
|
|
14212
|
-
export declare const GetUserSyncResultsServiceEnum: {};
|
|
14213
|
-
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14214
15362
|
/**
|
|
14215
15363
|
* TermsOfServiceApi - axios parameter creator
|
|
14216
15364
|
* @export
|
|
@@ -14959,12 +16107,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14959
16107
|
* @summary Returns all existing transfers
|
|
14960
16108
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
14961
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
|
|
14962
16113
|
* @param {number} [take] How many transfers the endpoint should return
|
|
14963
16114
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
14964
16115
|
* @param {*} [options] Override http request option.
|
|
14965
16116
|
* @throws {RequiredError}
|
|
14966
16117
|
*/
|
|
14967
|
-
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>;
|
|
14968
16119
|
/**
|
|
14969
16120
|
*
|
|
14970
16121
|
* @summary Returns the requested transfer
|
|
@@ -14980,7 +16131,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14980
16131
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
14981
16132
|
* @param {number} [fromId] Filter transfers from this user ID
|
|
14982
16133
|
* @param {number} [toId] Filter transfers to this user ID
|
|
14983
|
-
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
16134
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
14984
16135
|
* @param {*} [options] Override http request option.
|
|
14985
16136
|
* @throws {RequiredError}
|
|
14986
16137
|
*/
|
|
@@ -14993,6 +16144,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14993
16144
|
* @throws {RequiredError}
|
|
14994
16145
|
*/
|
|
14995
16146
|
getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16147
|
+
/**
|
|
16148
|
+
*
|
|
16149
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16150
|
+
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
16151
|
+
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16152
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16153
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16154
|
+
* @param {*} [options] Override http request option.
|
|
16155
|
+
* @throws {RequiredError}
|
|
16156
|
+
*/
|
|
16157
|
+
getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14996
16158
|
};
|
|
14997
16159
|
/**
|
|
14998
16160
|
* TransfersApi - functional programming interface
|
|
@@ -15020,12 +16182,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15020
16182
|
* @summary Returns all existing transfers
|
|
15021
16183
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15022
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
|
|
15023
16188
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15024
16189
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15025
16190
|
* @param {*} [options] Override http request option.
|
|
15026
16191
|
* @throws {RequiredError}
|
|
15027
16192
|
*/
|
|
15028
|
-
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>>;
|
|
15029
16194
|
/**
|
|
15030
16195
|
*
|
|
15031
16196
|
* @summary Returns the requested transfer
|
|
@@ -15041,7 +16206,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15041
16206
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15042
16207
|
* @param {number} [fromId] Filter transfers from this user ID
|
|
15043
16208
|
* @param {number} [toId] Filter transfers to this user ID
|
|
15044
|
-
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
16209
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15045
16210
|
* @param {*} [options] Override http request option.
|
|
15046
16211
|
* @throws {RequiredError}
|
|
15047
16212
|
*/
|
|
@@ -15054,6 +16219,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15054
16219
|
* @throws {RequiredError}
|
|
15055
16220
|
*/
|
|
15056
16221
|
getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
16222
|
+
/**
|
|
16223
|
+
*
|
|
16224
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16225
|
+
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
16226
|
+
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16227
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16228
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16229
|
+
* @param {*} [options] Override http request option.
|
|
16230
|
+
* @throws {RequiredError}
|
|
16231
|
+
*/
|
|
16232
|
+
getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
|
|
15057
16233
|
};
|
|
15058
16234
|
/**
|
|
15059
16235
|
* TransfersApi - factory interface
|
|
@@ -15083,7 +16259,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15083
16259
|
* @param {*} [options] Override http request option.
|
|
15084
16260
|
* @throws {RequiredError}
|
|
15085
16261
|
*/
|
|
15086
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
16262
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15087
16263
|
/**
|
|
15088
16264
|
*
|
|
15089
16265
|
* @summary Returns the requested transfer
|
|
@@ -15108,6 +16284,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15108
16284
|
* @throws {RequiredError}
|
|
15109
16285
|
*/
|
|
15110
16286
|
getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
16287
|
+
/**
|
|
16288
|
+
*
|
|
16289
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16290
|
+
* @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
|
|
16291
|
+
* @param {*} [options] Override http request option.
|
|
16292
|
+
* @throws {RequiredError}
|
|
16293
|
+
*/
|
|
16294
|
+
getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
|
|
15111
16295
|
};
|
|
15112
16296
|
/**
|
|
15113
16297
|
* Request parameters for createTransfer operation in TransfersApi.
|
|
@@ -15153,6 +16337,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15153
16337
|
* @memberof TransfersApiGetAllTransfers
|
|
15154
16338
|
*/
|
|
15155
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;
|
|
15156
16358
|
/**
|
|
15157
16359
|
* How many transfers the endpoint should return
|
|
15158
16360
|
* @type {number}
|
|
@@ -15210,7 +16412,7 @@ export interface TransfersApiGetTransferAggregateRequest {
|
|
|
15210
16412
|
*/
|
|
15211
16413
|
readonly toId?: number;
|
|
15212
16414
|
/**
|
|
15213
|
-
* Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
16415
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15214
16416
|
* @type {string}
|
|
15215
16417
|
* @memberof TransfersApiGetTransferAggregate
|
|
15216
16418
|
*/
|
|
@@ -15229,6 +16431,37 @@ export interface TransfersApiGetTransferPdfRequest {
|
|
|
15229
16431
|
*/
|
|
15230
16432
|
readonly id: number;
|
|
15231
16433
|
}
|
|
16434
|
+
/**
|
|
16435
|
+
* Request parameters for getTransferSummary operation in TransfersApi.
|
|
16436
|
+
* @export
|
|
16437
|
+
* @interface TransfersApiGetTransferSummaryRequest
|
|
16438
|
+
*/
|
|
16439
|
+
export interface TransfersApiGetTransferSummaryRequest {
|
|
16440
|
+
/**
|
|
16441
|
+
* Start date for selected transfers (inclusive)
|
|
16442
|
+
* @type {string}
|
|
16443
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16444
|
+
*/
|
|
16445
|
+
readonly fromDate?: string;
|
|
16446
|
+
/**
|
|
16447
|
+
* End date for selected transfers (exclusive)
|
|
16448
|
+
* @type {string}
|
|
16449
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16450
|
+
*/
|
|
16451
|
+
readonly tillDate?: string;
|
|
16452
|
+
/**
|
|
16453
|
+
* Filter transfers from this user ID
|
|
16454
|
+
* @type {number}
|
|
16455
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16456
|
+
*/
|
|
16457
|
+
readonly fromId?: number;
|
|
16458
|
+
/**
|
|
16459
|
+
* Filter transfers to this user ID
|
|
16460
|
+
* @type {number}
|
|
16461
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16462
|
+
*/
|
|
16463
|
+
readonly toId?: number;
|
|
16464
|
+
}
|
|
15232
16465
|
/**
|
|
15233
16466
|
* TransfersApi - object-oriented interface
|
|
15234
16467
|
* @export
|
|
@@ -15262,7 +16495,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15262
16495
|
* @throws {RequiredError}
|
|
15263
16496
|
* @memberof TransfersApi
|
|
15264
16497
|
*/
|
|
15265
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16498
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15266
16499
|
/**
|
|
15267
16500
|
*
|
|
15268
16501
|
* @summary Returns the requested transfer
|
|
@@ -15290,6 +16523,15 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15290
16523
|
* @memberof TransfersApi
|
|
15291
16524
|
*/
|
|
15292
16525
|
getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
16526
|
+
/**
|
|
16527
|
+
*
|
|
16528
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16529
|
+
* @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
|
|
16530
|
+
* @param {*} [options] Override http request option.
|
|
16531
|
+
* @throws {RequiredError}
|
|
16532
|
+
* @memberof TransfersApi
|
|
16533
|
+
*/
|
|
16534
|
+
getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
|
|
15293
16535
|
}
|
|
15294
16536
|
/**
|
|
15295
16537
|
* UserNotificationPreferencesApi - axios parameter creator
|
|
@@ -15502,7 +16744,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15502
16744
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15503
16745
|
/**
|
|
15504
16746
|
*
|
|
15505
|
-
* @summary Accept the Terms of Service
|
|
16747
|
+
* @summary Accept the current Terms of Service version
|
|
15506
16748
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15507
16749
|
* @param {*} [options] Override http request option.
|
|
15508
16750
|
* @throws {RequiredError}
|
|
@@ -15632,6 +16874,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15632
16874
|
* @throws {RequiredError}
|
|
15633
16875
|
*/
|
|
15634
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>;
|
|
15635
16885
|
/**
|
|
15636
16886
|
*
|
|
15637
16887
|
* @summary Returns the user\'s containers
|
|
@@ -15654,6 +16904,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15654
16904
|
* @throws {RequiredError}
|
|
15655
16905
|
*/
|
|
15656
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>;
|
|
15657
16921
|
/**
|
|
15658
16922
|
*
|
|
15659
16923
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -15864,7 +17128,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15864
17128
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
15865
17129
|
/**
|
|
15866
17130
|
*
|
|
15867
|
-
* @summary Accept the Terms of Service
|
|
17131
|
+
* @summary Accept the current Terms of Service version
|
|
15868
17132
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15869
17133
|
* @param {*} [options] Override http request option.
|
|
15870
17134
|
* @throws {RequiredError}
|
|
@@ -15994,6 +17258,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
15994
17258
|
* @throws {RequiredError}
|
|
15995
17259
|
*/
|
|
15996
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>>;
|
|
15997
17269
|
/**
|
|
15998
17270
|
*
|
|
15999
17271
|
* @summary Returns the user\'s containers
|
|
@@ -16016,6 +17288,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16016
17288
|
* @throws {RequiredError}
|
|
16017
17289
|
*/
|
|
16018
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>>;
|
|
16019
17305
|
/**
|
|
16020
17306
|
*
|
|
16021
17307
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16226,7 +17512,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16226
17512
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16227
17513
|
/**
|
|
16228
17514
|
*
|
|
16229
|
-
* @summary Accept the Terms of Service
|
|
17515
|
+
* @summary Accept the current Terms of Service version
|
|
16230
17516
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16231
17517
|
* @param {*} [options] Override http request option.
|
|
16232
17518
|
* @throws {RequiredError}
|
|
@@ -16344,6 +17630,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16344
17630
|
* @throws {RequiredError}
|
|
16345
17631
|
*/
|
|
16346
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>;
|
|
16347
17641
|
/**
|
|
16348
17642
|
*
|
|
16349
17643
|
* @summary Returns the user\'s containers
|
|
@@ -16360,6 +17654,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16360
17654
|
* @throws {RequiredError}
|
|
16361
17655
|
*/
|
|
16362
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>;
|
|
16363
17665
|
/**
|
|
16364
17666
|
*
|
|
16365
17667
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16789,6 +18091,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
16789
18091
|
*/
|
|
16790
18092
|
readonly id: number;
|
|
16791
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
|
+
}
|
|
16792
18107
|
/**
|
|
16793
18108
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
16794
18109
|
* @export
|
|
@@ -16851,6 +18166,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16851
18166
|
*/
|
|
16852
18167
|
readonly skip?: number;
|
|
16853
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
|
+
}
|
|
16854
18218
|
/**
|
|
16855
18219
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16856
18220
|
* @export
|
|
@@ -17366,7 +18730,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17366
18730
|
export declare class UsersApi extends BaseAPI {
|
|
17367
18731
|
/**
|
|
17368
18732
|
*
|
|
17369
|
-
* @summary Accept the Terms of Service
|
|
18733
|
+
* @summary Accept the current Terms of Service version
|
|
17370
18734
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17371
18735
|
* @param {*} [options] Override http request option.
|
|
17372
18736
|
* @throws {RequiredError}
|
|
@@ -17499,6 +18863,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17499
18863
|
* @memberof UsersApi
|
|
17500
18864
|
*/
|
|
17501
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, {}>>;
|
|
17502
18875
|
/**
|
|
17503
18876
|
*
|
|
17504
18877
|
* @summary Returns the user\'s containers
|
|
@@ -17517,6 +18890,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17517
18890
|
* @memberof UsersApi
|
|
17518
18891
|
*/
|
|
17519
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, {}>>;
|
|
17520
18902
|
/**
|
|
17521
18903
|
*
|
|
17522
18904
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17712,6 +19094,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17712
19094
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17713
19095
|
};
|
|
17714
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];
|
|
17715
19107
|
/**
|
|
17716
19108
|
* @export
|
|
17717
19109
|
*/
|