@gewis/sudosos-client 0.0.0-develop.dabdc9d → 0.0.0-develop.dd2a25a
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 +1930 -552
- package/dist/api.js +1793 -628
- package/dist/base.js +1 -1
- package/package.json +4 -4
package/dist/api.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface AcceptTosRequest {
|
|
|
25
25
|
* @memberof AcceptTosRequest
|
|
26
26
|
*/
|
|
27
27
|
'extensiveDataProcessing': boolean;
|
|
28
|
+
/**
|
|
29
|
+
* The TOS version being accepted.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AcceptTosRequest
|
|
32
|
+
*/
|
|
33
|
+
'version': string;
|
|
28
34
|
}
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
@@ -70,6 +76,12 @@ export interface AuthenticationEanRequest {
|
|
|
70
76
|
* @memberof AuthenticationEanRequest
|
|
71
77
|
*/
|
|
72
78
|
'eanCode': string;
|
|
79
|
+
/**
|
|
80
|
+
* POS identifier
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof AuthenticationEanRequest
|
|
83
|
+
*/
|
|
84
|
+
'posId': number;
|
|
73
85
|
}
|
|
74
86
|
/**
|
|
75
87
|
*
|
|
@@ -159,6 +171,12 @@ export interface AuthenticationNfcRequest {
|
|
|
159
171
|
* @memberof AuthenticationNfcRequest
|
|
160
172
|
*/
|
|
161
173
|
'nfcCode': string;
|
|
174
|
+
/**
|
|
175
|
+
* POS identifier
|
|
176
|
+
* @type {number}
|
|
177
|
+
* @memberof AuthenticationNfcRequest
|
|
178
|
+
*/
|
|
179
|
+
'posId': number;
|
|
162
180
|
}
|
|
163
181
|
/**
|
|
164
182
|
*
|
|
@@ -178,6 +196,12 @@ export interface AuthenticationPinRequest {
|
|
|
178
196
|
* @memberof AuthenticationPinRequest
|
|
179
197
|
*/
|
|
180
198
|
'pin': string;
|
|
199
|
+
/**
|
|
200
|
+
* POS identifier
|
|
201
|
+
* @type {number}
|
|
202
|
+
* @memberof AuthenticationPinRequest
|
|
203
|
+
*/
|
|
204
|
+
'posId': number;
|
|
181
205
|
}
|
|
182
206
|
/**
|
|
183
207
|
*
|
|
@@ -260,69 +284,6 @@ export interface AuthenticationResponse {
|
|
|
260
284
|
*/
|
|
261
285
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
262
286
|
}
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @export
|
|
266
|
-
* @interface AuthenticationSecureEanRequest
|
|
267
|
-
*/
|
|
268
|
-
export interface AuthenticationSecureEanRequest {
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {string}
|
|
272
|
-
* @memberof AuthenticationSecureEanRequest
|
|
273
|
-
*/
|
|
274
|
-
'eanCode': string;
|
|
275
|
-
/**
|
|
276
|
-
* POS identifier
|
|
277
|
-
* @type {number}
|
|
278
|
-
* @memberof AuthenticationSecureEanRequest
|
|
279
|
-
*/
|
|
280
|
-
'posId': number;
|
|
281
|
-
}
|
|
282
|
-
/**
|
|
283
|
-
*
|
|
284
|
-
* @export
|
|
285
|
-
* @interface AuthenticationSecureNfcRequest
|
|
286
|
-
*/
|
|
287
|
-
export interface AuthenticationSecureNfcRequest {
|
|
288
|
-
/**
|
|
289
|
-
*
|
|
290
|
-
* @type {string}
|
|
291
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
292
|
-
*/
|
|
293
|
-
'nfcCode': string;
|
|
294
|
-
/**
|
|
295
|
-
* POS identifier
|
|
296
|
-
* @type {number}
|
|
297
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
298
|
-
*/
|
|
299
|
-
'posId': number;
|
|
300
|
-
}
|
|
301
|
-
/**
|
|
302
|
-
*
|
|
303
|
-
* @export
|
|
304
|
-
* @interface AuthenticationSecurePinRequest
|
|
305
|
-
*/
|
|
306
|
-
export interface AuthenticationSecurePinRequest {
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @type {number}
|
|
310
|
-
* @memberof AuthenticationSecurePinRequest
|
|
311
|
-
*/
|
|
312
|
-
'userId': number;
|
|
313
|
-
/**
|
|
314
|
-
*
|
|
315
|
-
* @type {string}
|
|
316
|
-
* @memberof AuthenticationSecurePinRequest
|
|
317
|
-
*/
|
|
318
|
-
'pin': string;
|
|
319
|
-
/**
|
|
320
|
-
* POS identifier (required for secure authentication)
|
|
321
|
-
* @type {number}
|
|
322
|
-
* @memberof AuthenticationSecurePinRequest
|
|
323
|
-
*/
|
|
324
|
-
'posId': number;
|
|
325
|
-
}
|
|
326
287
|
/**
|
|
327
288
|
*
|
|
328
289
|
* @export
|
|
@@ -946,6 +907,104 @@ export interface BaseInvoiceResponse {
|
|
|
946
907
|
*/
|
|
947
908
|
'totalInclVat': DineroObjectResponse;
|
|
948
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* PaymentRequest is UUID-keyed. To avoid overloading the `id` slot (which on other responses is the numeric DB id), the UUID is exposed under a semantically named field, mirroring how `QRAuthenticator` exposes its UUID as `sessionId`. The response therefore extends `BaseResponseWithoutId` (timestamps + version, no `id`) and declares a `uuid` of its own.
|
|
912
|
+
* @export
|
|
913
|
+
* @interface BasePaymentRequestResponse
|
|
914
|
+
*/
|
|
915
|
+
export interface BasePaymentRequestResponse {
|
|
916
|
+
/**
|
|
917
|
+
* UUID v4 identifier (also the public share-link id).
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof BasePaymentRequestResponse
|
|
920
|
+
*/
|
|
921
|
+
'uuid': string;
|
|
922
|
+
/**
|
|
923
|
+
* ISO-8601 creation timestamp.
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof BasePaymentRequestResponse
|
|
926
|
+
*/
|
|
927
|
+
'createdAt'?: string;
|
|
928
|
+
/**
|
|
929
|
+
* ISO-8601 last update timestamp.
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof BasePaymentRequestResponse
|
|
932
|
+
*/
|
|
933
|
+
'updatedAt'?: string;
|
|
934
|
+
/**
|
|
935
|
+
* Optimistic-locking version.
|
|
936
|
+
* @type {number}
|
|
937
|
+
* @memberof BasePaymentRequestResponse
|
|
938
|
+
*/
|
|
939
|
+
'version'?: number;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {BaseUserResponse}
|
|
943
|
+
* @memberof BasePaymentRequestResponse
|
|
944
|
+
*/
|
|
945
|
+
'for': BaseUserResponse;
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {BaseUserResponse}
|
|
949
|
+
* @memberof BasePaymentRequestResponse
|
|
950
|
+
*/
|
|
951
|
+
'createdBy': BaseUserResponse;
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {DineroObjectResponse}
|
|
955
|
+
* @memberof BasePaymentRequestResponse
|
|
956
|
+
*/
|
|
957
|
+
'amount': DineroObjectResponse;
|
|
958
|
+
/**
|
|
959
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof BasePaymentRequestResponse
|
|
962
|
+
*/
|
|
963
|
+
'expiresAt': string;
|
|
964
|
+
/**
|
|
965
|
+
* ISO-8601 timestamp the request was marked paid (null if not paid).
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof BasePaymentRequestResponse
|
|
968
|
+
*/
|
|
969
|
+
'paidAt'?: string;
|
|
970
|
+
/**
|
|
971
|
+
* ISO-8601 timestamp the request was cancelled (null if not cancelled).
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof BasePaymentRequestResponse
|
|
974
|
+
*/
|
|
975
|
+
'cancelledAt'?: string;
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {BaseUserResponse}
|
|
979
|
+
* @memberof BasePaymentRequestResponse
|
|
980
|
+
*/
|
|
981
|
+
'cancelledBy'?: BaseUserResponse;
|
|
982
|
+
/**
|
|
983
|
+
*
|
|
984
|
+
* @type {BaseUserResponse}
|
|
985
|
+
* @memberof BasePaymentRequestResponse
|
|
986
|
+
*/
|
|
987
|
+
'fulfilledBy'?: BaseUserResponse;
|
|
988
|
+
/**
|
|
989
|
+
* Optional human-readable description.
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof BasePaymentRequestResponse
|
|
992
|
+
*/
|
|
993
|
+
'description'?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Derived lifecycle status.
|
|
996
|
+
* @type {string}
|
|
997
|
+
* @memberof BasePaymentRequestResponse
|
|
998
|
+
*/
|
|
999
|
+
'status': BasePaymentRequestResponseStatusEnum;
|
|
1000
|
+
}
|
|
1001
|
+
export declare const BasePaymentRequestResponseStatusEnum: {
|
|
1002
|
+
readonly Pending: "PENDING";
|
|
1003
|
+
readonly Paid: "PAID";
|
|
1004
|
+
readonly Expired: "EXPIRED";
|
|
1005
|
+
readonly Cancelled: "CANCELLED";
|
|
1006
|
+
};
|
|
1007
|
+
export type BasePaymentRequestResponseStatusEnum = typeof BasePaymentRequestResponseStatusEnum[keyof typeof BasePaymentRequestResponseStatusEnum];
|
|
949
1008
|
/**
|
|
950
1009
|
*
|
|
951
1010
|
* @export
|
|
@@ -1186,6 +1245,31 @@ export interface BaseResponse {
|
|
|
1186
1245
|
*/
|
|
1187
1246
|
'version'?: number;
|
|
1188
1247
|
}
|
|
1248
|
+
/**
|
|
1249
|
+
* Standard timestamp/version fields every response shares, without an `id`. Responses that key on a UUID (or any non-integer identifier) extend this and add their own `id` field. Responses keyed on an integer id extend `BaseResponse` instead, which adds `id: number`. Parallel to `BaseEntityWithoutId` on the entity side.
|
|
1250
|
+
* @export
|
|
1251
|
+
* @interface BaseResponseWithoutId
|
|
1252
|
+
*/
|
|
1253
|
+
export interface BaseResponseWithoutId {
|
|
1254
|
+
/**
|
|
1255
|
+
* The creation Date of the entity.
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof BaseResponseWithoutId
|
|
1258
|
+
*/
|
|
1259
|
+
'createdAt'?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The last update Date of the entity.
|
|
1262
|
+
* @type {string}
|
|
1263
|
+
* @memberof BaseResponseWithoutId
|
|
1264
|
+
*/
|
|
1265
|
+
'updatedAt'?: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* The version of the entity.
|
|
1268
|
+
* @type {number}
|
|
1269
|
+
* @memberof BaseResponseWithoutId
|
|
1270
|
+
*/
|
|
1271
|
+
'version'?: number;
|
|
1272
|
+
}
|
|
1189
1273
|
/**
|
|
1190
1274
|
*
|
|
1191
1275
|
* @export
|
|
@@ -1659,7 +1743,7 @@ export interface ContainerWithProductsResponse {
|
|
|
1659
1743
|
'products': Array<ProductResponse>;
|
|
1660
1744
|
}
|
|
1661
1745
|
/**
|
|
1662
|
-
*
|
|
1746
|
+
* API Request for creating a `container` entity.
|
|
1663
1747
|
* @export
|
|
1664
1748
|
* @interface CreateContainerRequest
|
|
1665
1749
|
*/
|
|
@@ -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,15 @@ 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;
|
|
6061
6520
|
}
|
|
6062
6521
|
/**
|
|
6063
|
-
*
|
|
6522
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6064
6523
|
* @export
|
|
6065
6524
|
* @interface UpdateVatGroupRequest
|
|
6066
6525
|
*/
|
|
@@ -6233,11 +6692,17 @@ export interface UserResponse {
|
|
|
6233
6692
|
*/
|
|
6234
6693
|
'email'?: string;
|
|
6235
6694
|
/**
|
|
6236
|
-
* Whether this user
|
|
6237
|
-
* @type {
|
|
6695
|
+
* Whether this user is required to accept the TOS
|
|
6696
|
+
* @type {boolean}
|
|
6697
|
+
* @memberof UserResponse
|
|
6698
|
+
*/
|
|
6699
|
+
'tosRequired'?: boolean;
|
|
6700
|
+
/**
|
|
6701
|
+
*
|
|
6702
|
+
* @type {TermsOfServiceStatus}
|
|
6238
6703
|
* @memberof UserResponse
|
|
6239
6704
|
*/
|
|
6240
|
-
'acceptedToS'?:
|
|
6705
|
+
'acceptedToS'?: TermsOfServiceStatus;
|
|
6241
6706
|
/**
|
|
6242
6707
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6243
6708
|
* @type {boolean}
|
|
@@ -6274,6 +6739,12 @@ export interface UserResponse {
|
|
|
6274
6739
|
* @memberof UserResponse
|
|
6275
6740
|
*/
|
|
6276
6741
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6742
|
+
/**
|
|
6743
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6744
|
+
* @type {string}
|
|
6745
|
+
* @memberof UserResponse
|
|
6746
|
+
*/
|
|
6747
|
+
'expiryDate'?: string | null;
|
|
6277
6748
|
}
|
|
6278
6749
|
/**
|
|
6279
6750
|
*
|
|
@@ -6380,6 +6851,66 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6380
6851
|
*/
|
|
6381
6852
|
'nickname'?: string;
|
|
6382
6853
|
}
|
|
6854
|
+
/**
|
|
6855
|
+
*
|
|
6856
|
+
* @export
|
|
6857
|
+
* @interface UserTosAcceptanceResponse
|
|
6858
|
+
*/
|
|
6859
|
+
export interface UserTosAcceptanceResponse {
|
|
6860
|
+
/**
|
|
6861
|
+
* The accepted terms of service version number.
|
|
6862
|
+
* @type {string}
|
|
6863
|
+
* @memberof UserTosAcceptanceResponse
|
|
6864
|
+
*/
|
|
6865
|
+
'versionNumber': string;
|
|
6866
|
+
/**
|
|
6867
|
+
* The date at which this version was accepted.
|
|
6868
|
+
* @type {string}
|
|
6869
|
+
* @memberof UserTosAcceptanceResponse
|
|
6870
|
+
*/
|
|
6871
|
+
'acceptedAt': string;
|
|
6872
|
+
}
|
|
6873
|
+
/**
|
|
6874
|
+
*
|
|
6875
|
+
* @export
|
|
6876
|
+
* @interface UserTosResponse
|
|
6877
|
+
*/
|
|
6878
|
+
export interface UserTosResponse {
|
|
6879
|
+
/**
|
|
6880
|
+
*
|
|
6881
|
+
* @type {TermsOfServiceStatus}
|
|
6882
|
+
* @memberof UserTosResponse
|
|
6883
|
+
*/
|
|
6884
|
+
'status': TermsOfServiceStatus;
|
|
6885
|
+
/**
|
|
6886
|
+
* The current terms of service version number.
|
|
6887
|
+
* @type {string}
|
|
6888
|
+
* @memberof UserTosResponse
|
|
6889
|
+
*/
|
|
6890
|
+
'currentVersion': string;
|
|
6891
|
+
/**
|
|
6892
|
+
* All TOS versions the user has accepted.
|
|
6893
|
+
* @type {Array<UserTosAcceptanceResponse>}
|
|
6894
|
+
* @memberof UserTosResponse
|
|
6895
|
+
*/
|
|
6896
|
+
'acceptances': Array<UserTosAcceptanceResponse>;
|
|
6897
|
+
}
|
|
6898
|
+
/**
|
|
6899
|
+
* The type of a user
|
|
6900
|
+
* @export
|
|
6901
|
+
* @enum {string}
|
|
6902
|
+
*/
|
|
6903
|
+
export declare const UserType: {
|
|
6904
|
+
readonly Member: "MEMBER";
|
|
6905
|
+
readonly Organ: "ORGAN";
|
|
6906
|
+
readonly Voucher: "VOUCHER";
|
|
6907
|
+
readonly LocalUser: "LOCAL_USER";
|
|
6908
|
+
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6909
|
+
readonly Invoice: "INVOICE";
|
|
6910
|
+
readonly PointOfSale: "POINT_OF_SALE";
|
|
6911
|
+
readonly Integration: "INTEGRATION";
|
|
6912
|
+
};
|
|
6913
|
+
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6383
6914
|
/**
|
|
6384
6915
|
*
|
|
6385
6916
|
* @export
|
|
@@ -6406,7 +6937,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6406
6937
|
'totalNegative': DineroObjectResponse;
|
|
6407
6938
|
}
|
|
6408
6939
|
/**
|
|
6409
|
-
*
|
|
6940
|
+
* 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
6941
|
* @export
|
|
6411
6942
|
* @interface UserWithIndex
|
|
6412
6943
|
*/
|
|
@@ -6421,6 +6952,25 @@ export interface UserWithIndex {
|
|
|
6421
6952
|
/**
|
|
6422
6953
|
*
|
|
6423
6954
|
* @export
|
|
6955
|
+
* @interface ValidationResponse
|
|
6956
|
+
*/
|
|
6957
|
+
export interface ValidationResponse {
|
|
6958
|
+
/**
|
|
6959
|
+
* Whether the request passed validation.
|
|
6960
|
+
* @type {boolean}
|
|
6961
|
+
* @memberof ValidationResponse
|
|
6962
|
+
*/
|
|
6963
|
+
'valid': boolean;
|
|
6964
|
+
/**
|
|
6965
|
+
* List of validation error messages.
|
|
6966
|
+
* @type {Array<string>}
|
|
6967
|
+
* @memberof ValidationResponse
|
|
6968
|
+
*/
|
|
6969
|
+
'errors': Array<string>;
|
|
6970
|
+
}
|
|
6971
|
+
/**
|
|
6972
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6973
|
+
* @export
|
|
6424
6974
|
* @interface VatDeclarationResponse
|
|
6425
6975
|
*/
|
|
6426
6976
|
export interface VatDeclarationResponse {
|
|
@@ -6444,7 +6994,7 @@ export interface VatDeclarationResponse {
|
|
|
6444
6994
|
'rows': Array<VatDeclarationRow>;
|
|
6445
6995
|
}
|
|
6446
6996
|
/**
|
|
6447
|
-
*
|
|
6997
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6448
6998
|
* @export
|
|
6449
6999
|
* @interface VatDeclarationRow
|
|
6450
7000
|
*/
|
|
@@ -6912,10 +7462,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6912
7462
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6913
7463
|
/**
|
|
6914
7464
|
*
|
|
6915
|
-
* @summary EAN
|
|
6916
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7465
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7466
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
6917
7467
|
* @param {*} [options] Override http request option.
|
|
6918
|
-
* @deprecated
|
|
6919
7468
|
* @throws {RequiredError}
|
|
6920
7469
|
*/
|
|
6921
7470
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6990,13 +7539,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6990
7539
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6991
7540
|
/**
|
|
6992
7541
|
*
|
|
6993
|
-
* @summary PIN
|
|
6994
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7542
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7543
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
6995
7544
|
* @param {*} [options] Override http request option.
|
|
6996
|
-
* @deprecated
|
|
6997
7545
|
* @throws {RequiredError}
|
|
6998
7546
|
*/
|
|
6999
|
-
|
|
7547
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7000
7548
|
/**
|
|
7001
7549
|
*
|
|
7002
7550
|
* @summary Mock login and hand out token.
|
|
@@ -7007,19 +7555,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7007
7555
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7008
7556
|
/**
|
|
7009
7557
|
*
|
|
7010
|
-
* @summary NFC
|
|
7011
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7558
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7559
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7012
7560
|
* @param {*} [options] Override http request option.
|
|
7013
|
-
* @deprecated
|
|
7014
7561
|
* @throws {RequiredError}
|
|
7015
7562
|
*/
|
|
7016
7563
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7017
7564
|
/**
|
|
7018
7565
|
*
|
|
7019
|
-
* @summary PIN
|
|
7020
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7566
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7567
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7021
7568
|
* @param {*} [options] Override http request option.
|
|
7022
|
-
* @deprecated
|
|
7023
7569
|
* @throws {RequiredError}
|
|
7024
7570
|
*/
|
|
7025
7571
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7046,44 +7592,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7046
7592
|
* @throws {RequiredError}
|
|
7047
7593
|
*/
|
|
7048
7594
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7049
|
-
|
|
7050
|
-
|
|
7051
|
-
|
|
7052
|
-
|
|
7053
|
-
|
|
7054
|
-
|
|
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
|
-
};
|
|
7082
|
-
/**
|
|
7083
|
-
* AuthenticateApi - functional programming interface
|
|
7084
|
-
* @export
|
|
7085
|
-
*/
|
|
7086
|
-
export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
7595
|
+
};
|
|
7596
|
+
/**
|
|
7597
|
+
* AuthenticateApi - functional programming interface
|
|
7598
|
+
* @export
|
|
7599
|
+
*/
|
|
7600
|
+
export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
7087
7601
|
/**
|
|
7088
7602
|
*
|
|
7089
7603
|
* @summary Get a JWT token for the given POS
|
|
@@ -7110,10 +7624,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7110
7624
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7111
7625
|
/**
|
|
7112
7626
|
*
|
|
7113
|
-
* @summary EAN
|
|
7114
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7627
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7628
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7115
7629
|
* @param {*} [options] Override http request option.
|
|
7116
|
-
* @deprecated
|
|
7117
7630
|
* @throws {RequiredError}
|
|
7118
7631
|
*/
|
|
7119
7632
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7188,13 +7701,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7188
7701
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7189
7702
|
/**
|
|
7190
7703
|
*
|
|
7191
|
-
* @summary PIN
|
|
7192
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7704
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7705
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7193
7706
|
* @param {*} [options] Override http request option.
|
|
7194
|
-
* @deprecated
|
|
7195
7707
|
* @throws {RequiredError}
|
|
7196
7708
|
*/
|
|
7197
|
-
|
|
7709
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7198
7710
|
/**
|
|
7199
7711
|
*
|
|
7200
7712
|
* @summary Mock login and hand out token.
|
|
@@ -7205,19 +7717,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7205
7717
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7206
7718
|
/**
|
|
7207
7719
|
*
|
|
7208
|
-
* @summary NFC
|
|
7209
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7720
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7721
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7210
7722
|
* @param {*} [options] Override http request option.
|
|
7211
|
-
* @deprecated
|
|
7212
7723
|
* @throws {RequiredError}
|
|
7213
7724
|
*/
|
|
7214
7725
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7215
7726
|
/**
|
|
7216
7727
|
*
|
|
7217
|
-
* @summary PIN
|
|
7218
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7728
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7729
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7219
7730
|
* @param {*} [options] Override http request option.
|
|
7220
|
-
* @deprecated
|
|
7221
7731
|
* @throws {RequiredError}
|
|
7222
7732
|
*/
|
|
7223
7733
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7244,38 +7754,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7244
7754
|
* @throws {RequiredError}
|
|
7245
7755
|
*/
|
|
7246
7756
|
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
7757
|
};
|
|
7280
7758
|
/**
|
|
7281
7759
|
* AuthenticateApi - factory interface
|
|
@@ -7308,10 +7786,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7308
7786
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7309
7787
|
/**
|
|
7310
7788
|
*
|
|
7311
|
-
* @summary EAN
|
|
7789
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7312
7790
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7313
7791
|
* @param {*} [options] Override http request option.
|
|
7314
|
-
* @deprecated
|
|
7315
7792
|
* @throws {RequiredError}
|
|
7316
7793
|
*/
|
|
7317
7794
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7386,13 +7863,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7386
7863
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7387
7864
|
/**
|
|
7388
7865
|
*
|
|
7389
|
-
* @summary PIN
|
|
7390
|
-
* @param {
|
|
7866
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7867
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7391
7868
|
* @param {*} [options] Override http request option.
|
|
7392
|
-
* @deprecated
|
|
7393
7869
|
* @throws {RequiredError}
|
|
7394
7870
|
*/
|
|
7395
|
-
|
|
7871
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7396
7872
|
/**
|
|
7397
7873
|
*
|
|
7398
7874
|
* @summary Mock login and hand out token.
|
|
@@ -7403,19 +7879,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7403
7879
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7404
7880
|
/**
|
|
7405
7881
|
*
|
|
7406
|
-
* @summary NFC
|
|
7882
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7407
7883
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7408
7884
|
* @param {*} [options] Override http request option.
|
|
7409
|
-
* @deprecated
|
|
7410
7885
|
* @throws {RequiredError}
|
|
7411
7886
|
*/
|
|
7412
7887
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7413
7888
|
/**
|
|
7414
7889
|
*
|
|
7415
|
-
* @summary PIN
|
|
7890
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7416
7891
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7417
7892
|
* @param {*} [options] Override http request option.
|
|
7418
|
-
* @deprecated
|
|
7419
7893
|
* @throws {RequiredError}
|
|
7420
7894
|
*/
|
|
7421
7895
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7442,38 +7916,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7442
7916
|
* @throws {RequiredError}
|
|
7443
7917
|
*/
|
|
7444
7918
|
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
7919
|
};
|
|
7478
7920
|
/**
|
|
7479
7921
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7521,7 +7963,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7521
7963
|
*/
|
|
7522
7964
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7523
7965
|
/**
|
|
7524
|
-
* The EAN login
|
|
7966
|
+
* The EAN login request with posId
|
|
7525
7967
|
* @type {AuthenticationEanRequest}
|
|
7526
7968
|
* @memberof AuthenticateApiEanAuthentication
|
|
7527
7969
|
*/
|
|
@@ -7606,15 +8048,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7606
8048
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7607
8049
|
}
|
|
7608
8050
|
/**
|
|
7609
|
-
* Request parameters for
|
|
8051
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7610
8052
|
* @export
|
|
7611
|
-
* @interface
|
|
8053
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7612
8054
|
*/
|
|
7613
|
-
export interface
|
|
8055
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7614
8056
|
/**
|
|
7615
|
-
* The PIN login
|
|
8057
|
+
* The PIN login request with posId
|
|
7616
8058
|
* @type {MemberAuthenticationPinRequest}
|
|
7617
|
-
* @memberof
|
|
8059
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7618
8060
|
*/
|
|
7619
8061
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7620
8062
|
}
|
|
@@ -7638,7 +8080,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7638
8080
|
*/
|
|
7639
8081
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7640
8082
|
/**
|
|
7641
|
-
* The NFC login
|
|
8083
|
+
* The NFC login request with posId
|
|
7642
8084
|
* @type {AuthenticationNfcRequest}
|
|
7643
8085
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7644
8086
|
*/
|
|
@@ -7651,7 +8093,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7651
8093
|
*/
|
|
7652
8094
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7653
8095
|
/**
|
|
7654
|
-
* The PIN login
|
|
8096
|
+
* The PIN login request with posId
|
|
7655
8097
|
* @type {AuthenticationPinRequest}
|
|
7656
8098
|
* @memberof AuthenticateApiPinAuthentication
|
|
7657
8099
|
*/
|
|
@@ -7683,58 +8125,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7683
8125
|
*/
|
|
7684
8126
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7685
8127
|
}
|
|
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
8128
|
/**
|
|
7739
8129
|
* AuthenticateApi - object-oriented interface
|
|
7740
8130
|
* @export
|
|
@@ -7771,10 +8161,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7771
8161
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7772
8162
|
/**
|
|
7773
8163
|
*
|
|
7774
|
-
* @summary EAN
|
|
8164
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7775
8165
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7776
8166
|
* @param {*} [options] Override http request option.
|
|
7777
|
-
* @deprecated
|
|
7778
8167
|
* @throws {RequiredError}
|
|
7779
8168
|
* @memberof AuthenticateApi
|
|
7780
8169
|
*/
|
|
@@ -7859,14 +8248,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7859
8248
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7860
8249
|
/**
|
|
7861
8250
|
*
|
|
7862
|
-
* @summary PIN
|
|
7863
|
-
* @param {
|
|
8251
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8252
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7864
8253
|
* @param {*} [options] Override http request option.
|
|
7865
|
-
* @deprecated
|
|
7866
8254
|
* @throws {RequiredError}
|
|
7867
8255
|
* @memberof AuthenticateApi
|
|
7868
8256
|
*/
|
|
7869
|
-
|
|
8257
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7870
8258
|
/**
|
|
7871
8259
|
*
|
|
7872
8260
|
* @summary Mock login and hand out token.
|
|
@@ -7878,20 +8266,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7878
8266
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7879
8267
|
/**
|
|
7880
8268
|
*
|
|
7881
|
-
* @summary NFC
|
|
8269
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7882
8270
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7883
8271
|
* @param {*} [options] Override http request option.
|
|
7884
|
-
* @deprecated
|
|
7885
8272
|
* @throws {RequiredError}
|
|
7886
8273
|
* @memberof AuthenticateApi
|
|
7887
8274
|
*/
|
|
7888
8275
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7889
8276
|
/**
|
|
7890
8277
|
*
|
|
7891
|
-
* @summary PIN
|
|
8278
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7892
8279
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7893
8280
|
* @param {*} [options] Override http request option.
|
|
7894
|
-
* @deprecated
|
|
7895
8281
|
* @throws {RequiredError}
|
|
7896
8282
|
* @memberof AuthenticateApi
|
|
7897
8283
|
*/
|
|
@@ -7922,42 +8308,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7922
8308
|
* @memberof AuthenticateApi
|
|
7923
8309
|
*/
|
|
7924
8310
|
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
8311
|
}
|
|
7962
8312
|
/**
|
|
7963
8313
|
* BalanceApi - axios parameter creator
|
|
@@ -7982,7 +8332,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7982
8332
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
7983
8333
|
* @param {number} [minFine] Minimum fine
|
|
7984
8334
|
* @param {number} [maxFine] Maximum fine
|
|
7985
|
-
* @param {
|
|
8335
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
7986
8336
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
7987
8337
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
7988
8338
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -7992,7 +8342,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7992
8342
|
* @param {*} [options] Override http request option.
|
|
7993
8343
|
* @throws {RequiredError}
|
|
7994
8344
|
*/
|
|
7995
|
-
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8345
|
+
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
8346
|
/**
|
|
7997
8347
|
*
|
|
7998
8348
|
* @summary Retrieves the requested balance
|
|
@@ -8032,7 +8382,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8032
8382
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8033
8383
|
* @param {number} [minFine] Minimum fine
|
|
8034
8384
|
* @param {number} [maxFine] Maximum fine
|
|
8035
|
-
* @param {
|
|
8385
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8036
8386
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8037
8387
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8038
8388
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8042,7 +8392,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8042
8392
|
* @param {*} [options] Override http request option.
|
|
8043
8393
|
* @throws {RequiredError}
|
|
8044
8394
|
*/
|
|
8045
|
-
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8395
|
+
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
8396
|
/**
|
|
8047
8397
|
*
|
|
8048
8398
|
* @summary Retrieves the requested balance
|
|
@@ -8159,10 +8509,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8159
8509
|
readonly maxFine?: number;
|
|
8160
8510
|
/**
|
|
8161
8511
|
* Filter based on user type.
|
|
8162
|
-
* @type {Array<
|
|
8512
|
+
* @type {Array<UserType>}
|
|
8163
8513
|
* @memberof BalanceApiGetAllBalance
|
|
8164
8514
|
*/
|
|
8165
|
-
readonly userTypes?:
|
|
8515
|
+
readonly userTypes?: Array<UserType>;
|
|
8166
8516
|
/**
|
|
8167
8517
|
* Column to order balance by - eg: id,amount
|
|
8168
8518
|
* @type {string}
|
|
@@ -8256,11 +8606,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8256
8606
|
*/
|
|
8257
8607
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8258
8608
|
}
|
|
8259
|
-
/**
|
|
8260
|
-
* @export
|
|
8261
|
-
*/
|
|
8262
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8263
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8264
8609
|
/**
|
|
8265
8610
|
* @export
|
|
8266
8611
|
*/
|
|
@@ -10681,7 +11026,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10681
11026
|
* @param {*} [options] Override http request option.
|
|
10682
11027
|
* @throws {RequiredError}
|
|
10683
11028
|
*/
|
|
10684
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11029
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10685
11030
|
/**
|
|
10686
11031
|
*
|
|
10687
11032
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10759,7 +11104,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10759
11104
|
* @param {*} [options] Override http request option.
|
|
10760
11105
|
* @throws {RequiredError}
|
|
10761
11106
|
*/
|
|
10762
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11107
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10763
11108
|
/**
|
|
10764
11109
|
*
|
|
10765
11110
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10982,7 +11327,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
10982
11327
|
* @throws {RequiredError}
|
|
10983
11328
|
* @memberof InactiveAdministrativeCostsApi
|
|
10984
11329
|
*/
|
|
10985
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11330
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
10986
11331
|
/**
|
|
10987
11332
|
*
|
|
10988
11333
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11027,7 +11372,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11027
11372
|
* @summary Returns all invoices in the system.
|
|
11028
11373
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11029
11374
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11030
|
-
* @param {
|
|
11375
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11031
11376
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11032
11377
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11033
11378
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11037,7 +11382,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11037
11382
|
* @param {*} [options] Override http request option.
|
|
11038
11383
|
* @throws {RequiredError}
|
|
11039
11384
|
*/
|
|
11040
|
-
getAllInvoices: (toId?: number, invoiceId?: number, currentState?:
|
|
11385
|
+
getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11041
11386
|
/**
|
|
11042
11387
|
*
|
|
11043
11388
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11048,6 +11393,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11048
11393
|
* @throws {RequiredError}
|
|
11049
11394
|
*/
|
|
11050
11395
|
getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11396
|
+
/**
|
|
11397
|
+
*
|
|
11398
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11399
|
+
* @param {*} [options] Override http request option.
|
|
11400
|
+
* @throws {RequiredError}
|
|
11401
|
+
*/
|
|
11402
|
+
getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11051
11403
|
/**
|
|
11052
11404
|
*
|
|
11053
11405
|
* @summary Get an invoice pdf.
|
|
@@ -11127,7 +11479,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11127
11479
|
* @summary Returns all invoices in the system.
|
|
11128
11480
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11129
11481
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11130
|
-
* @param {
|
|
11482
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11131
11483
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11132
11484
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11133
11485
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11137,7 +11489,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11137
11489
|
* @param {*} [options] Override http request option.
|
|
11138
11490
|
* @throws {RequiredError}
|
|
11139
11491
|
*/
|
|
11140
|
-
getAllInvoices(toId?: number, invoiceId?: number, currentState?:
|
|
11492
|
+
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>>;
|
|
11141
11493
|
/**
|
|
11142
11494
|
*
|
|
11143
11495
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11147,7 +11499,14 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11147
11499
|
* @param {*} [options] Override http request option.
|
|
11148
11500
|
* @throws {RequiredError}
|
|
11149
11501
|
*/
|
|
11150
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11502
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11503
|
+
/**
|
|
11504
|
+
*
|
|
11505
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11506
|
+
* @param {*} [options] Override http request option.
|
|
11507
|
+
* @throws {RequiredError}
|
|
11508
|
+
*/
|
|
11509
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
|
|
11151
11510
|
/**
|
|
11152
11511
|
*
|
|
11153
11512
|
* @summary Get an invoice pdf.
|
|
@@ -11156,7 +11515,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11156
11515
|
* @param {*} [options] Override http request option.
|
|
11157
11516
|
* @throws {RequiredError}
|
|
11158
11517
|
*/
|
|
11159
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11518
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11160
11519
|
/**
|
|
11161
11520
|
*
|
|
11162
11521
|
* @summary Returns a single invoice in the system.
|
|
@@ -11237,7 +11596,14 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11237
11596
|
* @param {*} [options] Override http request option.
|
|
11238
11597
|
* @throws {RequiredError}
|
|
11239
11598
|
*/
|
|
11240
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11599
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11600
|
+
/**
|
|
11601
|
+
*
|
|
11602
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11603
|
+
* @param {*} [options] Override http request option.
|
|
11604
|
+
* @throws {RequiredError}
|
|
11605
|
+
*/
|
|
11606
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
|
|
11241
11607
|
/**
|
|
11242
11608
|
*
|
|
11243
11609
|
* @summary Get an invoice pdf.
|
|
@@ -11245,7 +11611,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11245
11611
|
* @param {*} [options] Override http request option.
|
|
11246
11612
|
* @throws {RequiredError}
|
|
11247
11613
|
*/
|
|
11248
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11614
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11249
11615
|
/**
|
|
11250
11616
|
*
|
|
11251
11617
|
* @summary Returns a single invoice in the system.
|
|
@@ -11338,10 +11704,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11338
11704
|
readonly invoiceId?: number;
|
|
11339
11705
|
/**
|
|
11340
11706
|
* Filter based on Invoice State.
|
|
11341
|
-
* @type {Array<
|
|
11707
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11342
11708
|
* @memberof InvoicesApiGetAllInvoices
|
|
11343
11709
|
*/
|
|
11344
|
-
readonly currentState?:
|
|
11710
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11345
11711
|
/**
|
|
11346
11712
|
* Boolean if invoice entries should be returned
|
|
11347
11713
|
* @type {boolean}
|
|
@@ -11544,7 +11910,15 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11544
11910
|
* @throws {RequiredError}
|
|
11545
11911
|
* @memberof InvoicesApi
|
|
11546
11912
|
*/
|
|
11547
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11913
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11914
|
+
/**
|
|
11915
|
+
*
|
|
11916
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11917
|
+
* @param {*} [options] Override http request option.
|
|
11918
|
+
* @throws {RequiredError}
|
|
11919
|
+
* @memberof InvoicesApi
|
|
11920
|
+
*/
|
|
11921
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11548
11922
|
/**
|
|
11549
11923
|
*
|
|
11550
11924
|
* @summary Get an invoice pdf.
|
|
@@ -11553,7 +11927,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11553
11927
|
* @throws {RequiredError}
|
|
11554
11928
|
* @memberof InvoicesApi
|
|
11555
11929
|
*/
|
|
11556
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11930
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11557
11931
|
/**
|
|
11558
11932
|
*
|
|
11559
11933
|
* @summary Returns a single invoice in the system.
|
|
@@ -11592,187 +11966,668 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11592
11966
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11593
11967
|
}
|
|
11594
11968
|
/**
|
|
11969
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11595
11970
|
* @export
|
|
11596
11971
|
*/
|
|
11597
|
-
export declare const
|
|
11598
|
-
export type GetAllInvoicesCurrentStateEnum = typeof GetAllInvoicesCurrentStateEnum[keyof typeof GetAllInvoicesCurrentStateEnum];
|
|
11599
|
-
/**
|
|
11600
|
-
* PayoutRequestsApi - axios parameter creator
|
|
11601
|
-
* @export
|
|
11602
|
-
*/
|
|
11603
|
-
export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11972
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11604
11973
|
/**
|
|
11605
11974
|
*
|
|
11606
|
-
* @summary
|
|
11607
|
-
* @param {
|
|
11975
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11976
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11608
11977
|
* @param {*} [options] Override http request option.
|
|
11609
11978
|
* @throws {RequiredError}
|
|
11610
11979
|
*/
|
|
11611
|
-
|
|
11980
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11612
11981
|
/**
|
|
11613
11982
|
*
|
|
11614
|
-
* @summary
|
|
11615
|
-
* @param {
|
|
11616
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11617
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11618
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11619
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11620
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11621
|
-
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
11983
|
+
* @summary Create a new PaymentRequest.
|
|
11984
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11622
11985
|
* @param {*} [options] Override http request option.
|
|
11623
11986
|
* @throws {RequiredError}
|
|
11624
11987
|
*/
|
|
11625
|
-
|
|
11988
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11626
11989
|
/**
|
|
11627
11990
|
*
|
|
11628
|
-
* @summary
|
|
11629
|
-
* @param {number}
|
|
11630
|
-
* @param {
|
|
11991
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11992
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11993
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11994
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11995
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11996
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11997
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11998
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11631
11999
|
* @param {*} [options] Override http request option.
|
|
11632
12000
|
* @throws {RequiredError}
|
|
11633
12001
|
*/
|
|
11634
|
-
|
|
12002
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11635
12003
|
/**
|
|
11636
12004
|
*
|
|
11637
|
-
* @summary
|
|
11638
|
-
* @param {
|
|
12005
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12006
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11639
12007
|
* @param {*} [options] Override http request option.
|
|
11640
12008
|
* @throws {RequiredError}
|
|
11641
12009
|
*/
|
|
11642
|
-
|
|
12010
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11643
12011
|
/**
|
|
11644
12012
|
*
|
|
11645
|
-
* @summary
|
|
11646
|
-
* @param {
|
|
11647
|
-
* @param {
|
|
12013
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12014
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12015
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11648
12016
|
* @param {*} [options] Override http request option.
|
|
11649
12017
|
* @throws {RequiredError}
|
|
11650
12018
|
*/
|
|
11651
|
-
|
|
12019
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12020
|
+
/**
|
|
12021
|
+
*
|
|
12022
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12023
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12024
|
+
* @param {*} [options] Override http request option.
|
|
12025
|
+
* @throws {RequiredError}
|
|
12026
|
+
*/
|
|
12027
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11652
12028
|
};
|
|
11653
12029
|
/**
|
|
11654
|
-
*
|
|
12030
|
+
* PaymentRequestsApi - functional programming interface
|
|
11655
12031
|
* @export
|
|
11656
12032
|
*/
|
|
11657
|
-
export declare const
|
|
12033
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11658
12034
|
/**
|
|
11659
12035
|
*
|
|
11660
|
-
* @summary
|
|
11661
|
-
* @param {
|
|
12036
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12037
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11662
12038
|
* @param {*} [options] Override http request option.
|
|
11663
12039
|
* @throws {RequiredError}
|
|
11664
12040
|
*/
|
|
11665
|
-
|
|
12041
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11666
12042
|
/**
|
|
11667
12043
|
*
|
|
11668
|
-
* @summary
|
|
11669
|
-
* @param {
|
|
11670
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11671
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11672
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11673
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11674
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11675
|
-
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12044
|
+
* @summary Create a new PaymentRequest.
|
|
12045
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11676
12046
|
* @param {*} [options] Override http request option.
|
|
11677
12047
|
* @throws {RequiredError}
|
|
11678
12048
|
*/
|
|
11679
|
-
|
|
12049
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11680
12050
|
/**
|
|
11681
12051
|
*
|
|
11682
|
-
* @summary
|
|
11683
|
-
* @param {number}
|
|
11684
|
-
* @param {
|
|
12052
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12053
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
12054
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
12055
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
12056
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
12057
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
12058
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
12059
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11685
12060
|
* @param {*} [options] Override http request option.
|
|
11686
12061
|
* @throws {RequiredError}
|
|
11687
12062
|
*/
|
|
11688
|
-
|
|
12063
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11689
12064
|
/**
|
|
11690
12065
|
*
|
|
11691
|
-
* @summary
|
|
11692
|
-
* @param {
|
|
12066
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12067
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11693
12068
|
* @param {*} [options] Override http request option.
|
|
11694
12069
|
* @throws {RequiredError}
|
|
11695
12070
|
*/
|
|
11696
|
-
|
|
12071
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11697
12072
|
/**
|
|
11698
12073
|
*
|
|
11699
|
-
* @summary
|
|
11700
|
-
* @param {
|
|
11701
|
-
* @param {
|
|
12074
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12075
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12076
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11702
12077
|
* @param {*} [options] Override http request option.
|
|
11703
12078
|
* @throws {RequiredError}
|
|
11704
12079
|
*/
|
|
11705
|
-
|
|
12080
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12081
|
+
/**
|
|
12082
|
+
*
|
|
12083
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12084
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12085
|
+
* @param {*} [options] Override http request option.
|
|
12086
|
+
* @throws {RequiredError}
|
|
12087
|
+
*/
|
|
12088
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11706
12089
|
};
|
|
11707
12090
|
/**
|
|
11708
|
-
*
|
|
12091
|
+
* PaymentRequestsApi - factory interface
|
|
11709
12092
|
* @export
|
|
11710
12093
|
*/
|
|
11711
|
-
export declare const
|
|
12094
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11712
12095
|
/**
|
|
11713
12096
|
*
|
|
11714
|
-
* @summary
|
|
11715
|
-
* @param {
|
|
12097
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12098
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11716
12099
|
* @param {*} [options] Override http request option.
|
|
11717
12100
|
* @throws {RequiredError}
|
|
11718
12101
|
*/
|
|
11719
|
-
|
|
12102
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11720
12103
|
/**
|
|
11721
12104
|
*
|
|
11722
|
-
* @summary
|
|
11723
|
-
* @param {
|
|
12105
|
+
* @summary Create a new PaymentRequest.
|
|
12106
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11724
12107
|
* @param {*} [options] Override http request option.
|
|
11725
12108
|
* @throws {RequiredError}
|
|
11726
12109
|
*/
|
|
11727
|
-
|
|
12110
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11728
12111
|
/**
|
|
11729
12112
|
*
|
|
11730
|
-
* @summary
|
|
11731
|
-
* @param {
|
|
12113
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12114
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11732
12115
|
* @param {*} [options] Override http request option.
|
|
11733
12116
|
* @throws {RequiredError}
|
|
11734
12117
|
*/
|
|
11735
|
-
|
|
12118
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11736
12119
|
/**
|
|
11737
12120
|
*
|
|
11738
|
-
* @summary
|
|
11739
|
-
* @param {
|
|
12121
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12122
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11740
12123
|
* @param {*} [options] Override http request option.
|
|
11741
12124
|
* @throws {RequiredError}
|
|
11742
12125
|
*/
|
|
11743
|
-
|
|
12126
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11744
12127
|
/**
|
|
11745
12128
|
*
|
|
11746
|
-
* @summary
|
|
11747
|
-
* @param {
|
|
12129
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12130
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11748
12131
|
* @param {*} [options] Override http request option.
|
|
11749
12132
|
* @throws {RequiredError}
|
|
11750
12133
|
*/
|
|
11751
|
-
|
|
12134
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12135
|
+
/**
|
|
12136
|
+
*
|
|
12137
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12138
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12139
|
+
* @param {*} [options] Override http request option.
|
|
12140
|
+
* @throws {RequiredError}
|
|
12141
|
+
*/
|
|
12142
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11752
12143
|
};
|
|
11753
12144
|
/**
|
|
11754
|
-
* Request parameters for
|
|
12145
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11755
12146
|
* @export
|
|
11756
|
-
* @interface
|
|
12147
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11757
12148
|
*/
|
|
11758
|
-
export interface
|
|
12149
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11759
12150
|
/**
|
|
11760
|
-
*
|
|
11761
|
-
* @type {
|
|
11762
|
-
* @memberof
|
|
12151
|
+
* UUID v4 of the payment request.
|
|
12152
|
+
* @type {string}
|
|
12153
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11763
12154
|
*/
|
|
11764
|
-
readonly
|
|
12155
|
+
readonly id: string;
|
|
11765
12156
|
}
|
|
11766
12157
|
/**
|
|
11767
|
-
* Request parameters for
|
|
12158
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11768
12159
|
* @export
|
|
11769
|
-
* @interface
|
|
12160
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11770
12161
|
*/
|
|
11771
|
-
export interface
|
|
12162
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11772
12163
|
/**
|
|
11773
|
-
*
|
|
11774
|
-
* @type {
|
|
11775
|
-
* @memberof
|
|
12164
|
+
* The request to create
|
|
12165
|
+
* @type {CreatePaymentRequestRequest}
|
|
12166
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
12167
|
+
*/
|
|
12168
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
12169
|
+
}
|
|
12170
|
+
/**
|
|
12171
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
12172
|
+
* @export
|
|
12173
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
12174
|
+
*/
|
|
12175
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
12176
|
+
/**
|
|
12177
|
+
* Filter by beneficiary user id.
|
|
12178
|
+
* @type {number}
|
|
12179
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12180
|
+
*/
|
|
12181
|
+
readonly forId?: number;
|
|
12182
|
+
/**
|
|
12183
|
+
* Filter by creator user id.
|
|
12184
|
+
* @type {number}
|
|
12185
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12186
|
+
*/
|
|
12187
|
+
readonly createdById?: number;
|
|
12188
|
+
/**
|
|
12189
|
+
* Comma-separated list of derived statuses.
|
|
12190
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12191
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12192
|
+
*/
|
|
12193
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12194
|
+
/**
|
|
12195
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12196
|
+
* @type {string}
|
|
12197
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12198
|
+
*/
|
|
12199
|
+
readonly fromDate?: string;
|
|
12200
|
+
/**
|
|
12201
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12202
|
+
* @type {string}
|
|
12203
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12204
|
+
*/
|
|
12205
|
+
readonly tillDate?: string;
|
|
12206
|
+
/**
|
|
12207
|
+
* How many rows the endpoint should return
|
|
12208
|
+
* @type {number}
|
|
12209
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12210
|
+
*/
|
|
12211
|
+
readonly take?: number;
|
|
12212
|
+
/**
|
|
12213
|
+
* How many rows to skip (for pagination)
|
|
12214
|
+
* @type {number}
|
|
12215
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12216
|
+
*/
|
|
12217
|
+
readonly skip?: number;
|
|
12218
|
+
}
|
|
12219
|
+
/**
|
|
12220
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
12221
|
+
* @export
|
|
12222
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
12223
|
+
*/
|
|
12224
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
12225
|
+
/**
|
|
12226
|
+
* UUID v4 of the payment request.
|
|
12227
|
+
* @type {string}
|
|
12228
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12229
|
+
*/
|
|
12230
|
+
readonly id: string;
|
|
12231
|
+
}
|
|
12232
|
+
/**
|
|
12233
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12234
|
+
* @export
|
|
12235
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12236
|
+
*/
|
|
12237
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
12238
|
+
/**
|
|
12239
|
+
* UUID v4 of the payment request.
|
|
12240
|
+
* @type {string}
|
|
12241
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12242
|
+
*/
|
|
12243
|
+
readonly id: string;
|
|
12244
|
+
/**
|
|
12245
|
+
* The audit reason
|
|
12246
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12247
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12248
|
+
*/
|
|
12249
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12250
|
+
}
|
|
12251
|
+
/**
|
|
12252
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12253
|
+
* @export
|
|
12254
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12255
|
+
*/
|
|
12256
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12257
|
+
/**
|
|
12258
|
+
* UUID v4 of the payment request.
|
|
12259
|
+
* @type {string}
|
|
12260
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12261
|
+
*/
|
|
12262
|
+
readonly id: string;
|
|
12263
|
+
}
|
|
12264
|
+
/**
|
|
12265
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12266
|
+
* @export
|
|
12267
|
+
* @class PaymentRequestsApi
|
|
12268
|
+
* @extends {BaseAPI}
|
|
12269
|
+
*/
|
|
12270
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12271
|
+
/**
|
|
12272
|
+
*
|
|
12273
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12274
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12275
|
+
* @param {*} [options] Override http request option.
|
|
12276
|
+
* @throws {RequiredError}
|
|
12277
|
+
* @memberof PaymentRequestsApi
|
|
12278
|
+
*/
|
|
12279
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12280
|
+
/**
|
|
12281
|
+
*
|
|
12282
|
+
* @summary Create a new PaymentRequest.
|
|
12283
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12284
|
+
* @param {*} [options] Override http request option.
|
|
12285
|
+
* @throws {RequiredError}
|
|
12286
|
+
* @memberof PaymentRequestsApi
|
|
12287
|
+
*/
|
|
12288
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12289
|
+
/**
|
|
12290
|
+
*
|
|
12291
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12292
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12293
|
+
* @param {*} [options] Override http request option.
|
|
12294
|
+
* @throws {RequiredError}
|
|
12295
|
+
* @memberof PaymentRequestsApi
|
|
12296
|
+
*/
|
|
12297
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12298
|
+
/**
|
|
12299
|
+
*
|
|
12300
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12301
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12302
|
+
* @param {*} [options] Override http request option.
|
|
12303
|
+
* @throws {RequiredError}
|
|
12304
|
+
* @memberof PaymentRequestsApi
|
|
12305
|
+
*/
|
|
12306
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12307
|
+
/**
|
|
12308
|
+
*
|
|
12309
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12310
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12311
|
+
* @param {*} [options] Override http request option.
|
|
12312
|
+
* @throws {RequiredError}
|
|
12313
|
+
* @memberof PaymentRequestsApi
|
|
12314
|
+
*/
|
|
12315
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12316
|
+
/**
|
|
12317
|
+
*
|
|
12318
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12319
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12320
|
+
* @param {*} [options] Override http request option.
|
|
12321
|
+
* @throws {RequiredError}
|
|
12322
|
+
* @memberof PaymentRequestsApi
|
|
12323
|
+
*/
|
|
12324
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12325
|
+
}
|
|
12326
|
+
/**
|
|
12327
|
+
* @export
|
|
12328
|
+
*/
|
|
12329
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12330
|
+
readonly Pending: "PENDING";
|
|
12331
|
+
readonly Paid: "PAID";
|
|
12332
|
+
readonly Expired: "EXPIRED";
|
|
12333
|
+
readonly Cancelled: "CANCELLED";
|
|
12334
|
+
};
|
|
12335
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12336
|
+
/**
|
|
12337
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12338
|
+
* @export
|
|
12339
|
+
*/
|
|
12340
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12341
|
+
/**
|
|
12342
|
+
*
|
|
12343
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12344
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12345
|
+
* @param {*} [options] Override http request option.
|
|
12346
|
+
* @throws {RequiredError}
|
|
12347
|
+
*/
|
|
12348
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12349
|
+
/**
|
|
12350
|
+
*
|
|
12351
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12352
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12353
|
+
* @param {*} [options] Override http request option.
|
|
12354
|
+
* @throws {RequiredError}
|
|
12355
|
+
*/
|
|
12356
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12357
|
+
};
|
|
12358
|
+
/**
|
|
12359
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12360
|
+
* @export
|
|
12361
|
+
*/
|
|
12362
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
12363
|
+
/**
|
|
12364
|
+
*
|
|
12365
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12366
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12367
|
+
* @param {*} [options] Override http request option.
|
|
12368
|
+
* @throws {RequiredError}
|
|
12369
|
+
*/
|
|
12370
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
12371
|
+
/**
|
|
12372
|
+
*
|
|
12373
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12374
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12375
|
+
* @param {*} [options] Override http request option.
|
|
12376
|
+
* @throws {RequiredError}
|
|
12377
|
+
*/
|
|
12378
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12379
|
+
};
|
|
12380
|
+
/**
|
|
12381
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12382
|
+
* @export
|
|
12383
|
+
*/
|
|
12384
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12385
|
+
/**
|
|
12386
|
+
*
|
|
12387
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12388
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12389
|
+
* @param {*} [options] Override http request option.
|
|
12390
|
+
* @throws {RequiredError}
|
|
12391
|
+
*/
|
|
12392
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12393
|
+
/**
|
|
12394
|
+
*
|
|
12395
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12396
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12397
|
+
* @param {*} [options] Override http request option.
|
|
12398
|
+
* @throws {RequiredError}
|
|
12399
|
+
*/
|
|
12400
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12401
|
+
};
|
|
12402
|
+
/**
|
|
12403
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12404
|
+
* @export
|
|
12405
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12406
|
+
*/
|
|
12407
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12408
|
+
/**
|
|
12409
|
+
* UUID v4 of the payment request.
|
|
12410
|
+
* @type {string}
|
|
12411
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12412
|
+
*/
|
|
12413
|
+
readonly id: string;
|
|
12414
|
+
}
|
|
12415
|
+
/**
|
|
12416
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12417
|
+
* @export
|
|
12418
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12419
|
+
*/
|
|
12420
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12421
|
+
/**
|
|
12422
|
+
* UUID v4 of the payment request.
|
|
12423
|
+
* @type {string}
|
|
12424
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12425
|
+
*/
|
|
12426
|
+
readonly id: string;
|
|
12427
|
+
}
|
|
12428
|
+
/**
|
|
12429
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12430
|
+
* @export
|
|
12431
|
+
* @class PaymentRequestsPublicApi
|
|
12432
|
+
* @extends {BaseAPI}
|
|
12433
|
+
*/
|
|
12434
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12435
|
+
/**
|
|
12436
|
+
*
|
|
12437
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12438
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12439
|
+
* @param {*} [options] Override http request option.
|
|
12440
|
+
* @throws {RequiredError}
|
|
12441
|
+
* @memberof PaymentRequestsPublicApi
|
|
12442
|
+
*/
|
|
12443
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12444
|
+
/**
|
|
12445
|
+
*
|
|
12446
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12447
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12448
|
+
* @param {*} [options] Override http request option.
|
|
12449
|
+
* @throws {RequiredError}
|
|
12450
|
+
* @memberof PaymentRequestsPublicApi
|
|
12451
|
+
*/
|
|
12452
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12453
|
+
}
|
|
12454
|
+
/**
|
|
12455
|
+
* PayoutRequestsApi - axios parameter creator
|
|
12456
|
+
* @export
|
|
12457
|
+
*/
|
|
12458
|
+
export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12459
|
+
/**
|
|
12460
|
+
*
|
|
12461
|
+
* @summary Create a new payout request
|
|
12462
|
+
* @param {PayoutRequestRequest} payoutRequestRequest New payout request
|
|
12463
|
+
* @param {*} [options] Override http request option.
|
|
12464
|
+
* @throws {RequiredError}
|
|
12465
|
+
*/
|
|
12466
|
+
createPayoutRequest: (payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12467
|
+
/**
|
|
12468
|
+
*
|
|
12469
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12470
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
|
|
12471
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
12472
|
+
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
12473
|
+
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
12474
|
+
* @param {string} [status] Status of the payout requests (OR relation)
|
|
12475
|
+
* @param {number} [take] How many payout requests the endpoint should return
|
|
12476
|
+
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12477
|
+
* @param {*} [options] Override http request option.
|
|
12478
|
+
* @throws {RequiredError}
|
|
12479
|
+
*/
|
|
12480
|
+
getAllPayoutRequests: (requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12481
|
+
/**
|
|
12482
|
+
*
|
|
12483
|
+
* @summary Get a payout request pdf
|
|
12484
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12485
|
+
* @param {boolean} [force] Whether to force regeneration of the pdf
|
|
12486
|
+
* @param {*} [options] Override http request option.
|
|
12487
|
+
* @throws {RequiredError}
|
|
12488
|
+
*/
|
|
12489
|
+
getPayoutRequestPdf: (id: number, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12490
|
+
/**
|
|
12491
|
+
*
|
|
12492
|
+
* @summary Get a single payout request
|
|
12493
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12494
|
+
* @param {*} [options] Override http request option.
|
|
12495
|
+
* @throws {RequiredError}
|
|
12496
|
+
*/
|
|
12497
|
+
getSinglePayoutRequest: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12498
|
+
/**
|
|
12499
|
+
*
|
|
12500
|
+
* @summary Create a new status for a payout request
|
|
12501
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12502
|
+
* @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
|
|
12503
|
+
* @param {*} [options] Override http request option.
|
|
12504
|
+
* @throws {RequiredError}
|
|
12505
|
+
*/
|
|
12506
|
+
setPayoutRequestStatus: (id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12507
|
+
};
|
|
12508
|
+
/**
|
|
12509
|
+
* PayoutRequestsApi - functional programming interface
|
|
12510
|
+
* @export
|
|
12511
|
+
*/
|
|
12512
|
+
export declare const PayoutRequestsApiFp: (configuration?: Configuration) => {
|
|
12513
|
+
/**
|
|
12514
|
+
*
|
|
12515
|
+
* @summary Create a new payout request
|
|
12516
|
+
* @param {PayoutRequestRequest} payoutRequestRequest New payout request
|
|
12517
|
+
* @param {*} [options] Override http request option.
|
|
12518
|
+
* @throws {RequiredError}
|
|
12519
|
+
*/
|
|
12520
|
+
createPayoutRequest(payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
|
|
12521
|
+
/**
|
|
12522
|
+
*
|
|
12523
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12524
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
|
|
12525
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
12526
|
+
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
12527
|
+
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
12528
|
+
* @param {string} [status] Status of the payout requests (OR relation)
|
|
12529
|
+
* @param {number} [take] How many payout requests the endpoint should return
|
|
12530
|
+
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12531
|
+
* @param {*} [options] Override http request option.
|
|
12532
|
+
* @throws {RequiredError}
|
|
12533
|
+
*/
|
|
12534
|
+
getAllPayoutRequests(requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePayoutRequestResponse>>;
|
|
12535
|
+
/**
|
|
12536
|
+
*
|
|
12537
|
+
* @summary Get a payout request pdf
|
|
12538
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12539
|
+
* @param {boolean} [force] Whether to force regeneration of the pdf
|
|
12540
|
+
* @param {*} [options] Override http request option.
|
|
12541
|
+
* @throws {RequiredError}
|
|
12542
|
+
*/
|
|
12543
|
+
getPayoutRequestPdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
12544
|
+
/**
|
|
12545
|
+
*
|
|
12546
|
+
* @summary Get a single payout request
|
|
12547
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12548
|
+
* @param {*} [options] Override http request option.
|
|
12549
|
+
* @throws {RequiredError}
|
|
12550
|
+
*/
|
|
12551
|
+
getSinglePayoutRequest(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
|
|
12552
|
+
/**
|
|
12553
|
+
*
|
|
12554
|
+
* @summary Create a new status for a payout request
|
|
12555
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12556
|
+
* @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
|
|
12557
|
+
* @param {*} [options] Override http request option.
|
|
12558
|
+
* @throws {RequiredError}
|
|
12559
|
+
*/
|
|
12560
|
+
setPayoutRequestStatus(id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
|
|
12561
|
+
};
|
|
12562
|
+
/**
|
|
12563
|
+
* PayoutRequestsApi - factory interface
|
|
12564
|
+
* @export
|
|
12565
|
+
*/
|
|
12566
|
+
export declare const PayoutRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12567
|
+
/**
|
|
12568
|
+
*
|
|
12569
|
+
* @summary Create a new payout request
|
|
12570
|
+
* @param {PayoutRequestsApiCreatePayoutRequestRequest} requestParameters Request parameters.
|
|
12571
|
+
* @param {*} [options] Override http request option.
|
|
12572
|
+
* @throws {RequiredError}
|
|
12573
|
+
*/
|
|
12574
|
+
createPayoutRequest(requestParameters: PayoutRequestsApiCreatePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
|
|
12575
|
+
/**
|
|
12576
|
+
*
|
|
12577
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12578
|
+
* @param {PayoutRequestsApiGetAllPayoutRequestsRequest} requestParameters Request parameters.
|
|
12579
|
+
* @param {*} [options] Override http request option.
|
|
12580
|
+
* @throws {RequiredError}
|
|
12581
|
+
*/
|
|
12582
|
+
getAllPayoutRequests(requestParameters?: PayoutRequestsApiGetAllPayoutRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePayoutRequestResponse>;
|
|
12583
|
+
/**
|
|
12584
|
+
*
|
|
12585
|
+
* @summary Get a payout request pdf
|
|
12586
|
+
* @param {PayoutRequestsApiGetPayoutRequestPdfRequest} requestParameters Request parameters.
|
|
12587
|
+
* @param {*} [options] Override http request option.
|
|
12588
|
+
* @throws {RequiredError}
|
|
12589
|
+
*/
|
|
12590
|
+
getPayoutRequestPdf(requestParameters: PayoutRequestsApiGetPayoutRequestPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
12591
|
+
/**
|
|
12592
|
+
*
|
|
12593
|
+
* @summary Get a single payout request
|
|
12594
|
+
* @param {PayoutRequestsApiGetSinglePayoutRequestRequest} requestParameters Request parameters.
|
|
12595
|
+
* @param {*} [options] Override http request option.
|
|
12596
|
+
* @throws {RequiredError}
|
|
12597
|
+
*/
|
|
12598
|
+
getSinglePayoutRequest(requestParameters: PayoutRequestsApiGetSinglePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
|
|
12599
|
+
/**
|
|
12600
|
+
*
|
|
12601
|
+
* @summary Create a new status for a payout request
|
|
12602
|
+
* @param {PayoutRequestsApiSetPayoutRequestStatusRequest} requestParameters Request parameters.
|
|
12603
|
+
* @param {*} [options] Override http request option.
|
|
12604
|
+
* @throws {RequiredError}
|
|
12605
|
+
*/
|
|
12606
|
+
setPayoutRequestStatus(requestParameters: PayoutRequestsApiSetPayoutRequestStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
|
|
12607
|
+
};
|
|
12608
|
+
/**
|
|
12609
|
+
* Request parameters for createPayoutRequest operation in PayoutRequestsApi.
|
|
12610
|
+
* @export
|
|
12611
|
+
* @interface PayoutRequestsApiCreatePayoutRequestRequest
|
|
12612
|
+
*/
|
|
12613
|
+
export interface PayoutRequestsApiCreatePayoutRequestRequest {
|
|
12614
|
+
/**
|
|
12615
|
+
* New payout request
|
|
12616
|
+
* @type {PayoutRequestRequest}
|
|
12617
|
+
* @memberof PayoutRequestsApiCreatePayoutRequest
|
|
12618
|
+
*/
|
|
12619
|
+
readonly payoutRequestRequest: PayoutRequestRequest;
|
|
12620
|
+
}
|
|
12621
|
+
/**
|
|
12622
|
+
* Request parameters for getAllPayoutRequests operation in PayoutRequestsApi.
|
|
12623
|
+
* @export
|
|
12624
|
+
* @interface PayoutRequestsApiGetAllPayoutRequestsRequest
|
|
12625
|
+
*/
|
|
12626
|
+
export interface PayoutRequestsApiGetAllPayoutRequestsRequest {
|
|
12627
|
+
/**
|
|
12628
|
+
* ID of user(s) who requested a payout
|
|
12629
|
+
* @type {GetAllPayoutRequestsRequestedByIdParameter}
|
|
12630
|
+
* @memberof PayoutRequestsApiGetAllPayoutRequests
|
|
11776
12631
|
*/
|
|
11777
12632
|
readonly requestedById?: GetAllPayoutRequestsRequestedByIdParameter;
|
|
11778
12633
|
/**
|
|
@@ -14061,6 +14916,13 @@ export declare const StripeApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14061
14916
|
* @throws {RequiredError}
|
|
14062
14917
|
*/
|
|
14063
14918
|
getStripePublicKey: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14919
|
+
/**
|
|
14920
|
+
*
|
|
14921
|
+
* @summary Webhook for Stripe event updates
|
|
14922
|
+
* @param {*} [options] Override http request option.
|
|
14923
|
+
* @throws {RequiredError}
|
|
14924
|
+
*/
|
|
14925
|
+
webhook: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14064
14926
|
};
|
|
14065
14927
|
/**
|
|
14066
14928
|
* StripeApi - functional programming interface
|
|
@@ -14082,6 +14944,13 @@ export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
|
14082
14944
|
* @throws {RequiredError}
|
|
14083
14945
|
*/
|
|
14084
14946
|
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14947
|
+
/**
|
|
14948
|
+
*
|
|
14949
|
+
* @summary Webhook for Stripe event updates
|
|
14950
|
+
* @param {*} [options] Override http request option.
|
|
14951
|
+
* @throws {RequiredError}
|
|
14952
|
+
*/
|
|
14953
|
+
webhook(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14085
14954
|
};
|
|
14086
14955
|
/**
|
|
14087
14956
|
* StripeApi - factory interface
|
|
@@ -14103,6 +14972,13 @@ export declare const StripeApiFactory: (configuration?: Configuration, basePath?
|
|
|
14103
14972
|
* @throws {RequiredError}
|
|
14104
14973
|
*/
|
|
14105
14974
|
getStripePublicKey(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
14975
|
+
/**
|
|
14976
|
+
*
|
|
14977
|
+
* @summary Webhook for Stripe event updates
|
|
14978
|
+
* @param {*} [options] Override http request option.
|
|
14979
|
+
* @throws {RequiredError}
|
|
14980
|
+
*/
|
|
14981
|
+
webhook(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
14106
14982
|
};
|
|
14107
14983
|
/**
|
|
14108
14984
|
* Request parameters for deposit operation in StripeApi.
|
|
@@ -14115,110 +14991,368 @@ export interface StripeApiDepositRequest {
|
|
|
14115
14991
|
* @type {StripeRequest}
|
|
14116
14992
|
* @memberof StripeApiDeposit
|
|
14117
14993
|
*/
|
|
14118
|
-
readonly stripeRequest: StripeRequest;
|
|
14119
|
-
}
|
|
14120
|
-
/**
|
|
14121
|
-
* StripeApi - object-oriented interface
|
|
14122
|
-
* @export
|
|
14123
|
-
* @class StripeApi
|
|
14124
|
-
* @extends {BaseAPI}
|
|
14125
|
-
*/
|
|
14126
|
-
export declare class StripeApi extends BaseAPI {
|
|
14994
|
+
readonly stripeRequest: StripeRequest;
|
|
14995
|
+
}
|
|
14996
|
+
/**
|
|
14997
|
+
* StripeApi - object-oriented interface
|
|
14998
|
+
* @export
|
|
14999
|
+
* @class StripeApi
|
|
15000
|
+
* @extends {BaseAPI}
|
|
15001
|
+
*/
|
|
15002
|
+
export declare class StripeApi extends BaseAPI {
|
|
15003
|
+
/**
|
|
15004
|
+
*
|
|
15005
|
+
* @summary Start the stripe deposit flow
|
|
15006
|
+
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15007
|
+
* @param {*} [options] Override http request option.
|
|
15008
|
+
* @throws {RequiredError}
|
|
15009
|
+
* @memberof StripeApi
|
|
15010
|
+
*/
|
|
15011
|
+
deposit(requestParameters: StripeApiDepositRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentIntentResponse, any, {}>>;
|
|
15012
|
+
/**
|
|
15013
|
+
*
|
|
15014
|
+
* @summary Get the Stripe public key
|
|
15015
|
+
* @param {*} [options] Override http request option.
|
|
15016
|
+
* @throws {RequiredError}
|
|
15017
|
+
* @memberof StripeApi
|
|
15018
|
+
*/
|
|
15019
|
+
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
15020
|
+
/**
|
|
15021
|
+
*
|
|
15022
|
+
* @summary Webhook for Stripe event updates
|
|
15023
|
+
* @param {*} [options] Override http request option.
|
|
15024
|
+
* @throws {RequiredError}
|
|
15025
|
+
* @memberof StripeApi
|
|
15026
|
+
*/
|
|
15027
|
+
webhook(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
15028
|
+
}
|
|
15029
|
+
/**
|
|
15030
|
+
* SyncApi - axios parameter creator
|
|
15031
|
+
* @export
|
|
15032
|
+
*/
|
|
15033
|
+
export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15034
|
+
/**
|
|
15035
|
+
* 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.
|
|
15036
|
+
* @summary Get dry-run sync results for users
|
|
15037
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15038
|
+
* @param {*} [options] Override http request option.
|
|
15039
|
+
* @throws {RequiredError}
|
|
15040
|
+
*/
|
|
15041
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15042
|
+
};
|
|
15043
|
+
/**
|
|
15044
|
+
* SyncApi - functional programming interface
|
|
15045
|
+
* @export
|
|
15046
|
+
*/
|
|
15047
|
+
export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
15048
|
+
/**
|
|
15049
|
+
* 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.
|
|
15050
|
+
* @summary Get dry-run sync results for users
|
|
15051
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15052
|
+
* @param {*} [options] Override http request option.
|
|
15053
|
+
* @throws {RequiredError}
|
|
15054
|
+
*/
|
|
15055
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15056
|
+
};
|
|
15057
|
+
/**
|
|
15058
|
+
* SyncApi - factory interface
|
|
15059
|
+
* @export
|
|
15060
|
+
*/
|
|
15061
|
+
export declare const SyncApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15062
|
+
/**
|
|
15063
|
+
* 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.
|
|
15064
|
+
* @summary Get dry-run sync results for users
|
|
15065
|
+
* @param {SyncApiGetUserSyncResultsRequest} requestParameters Request parameters.
|
|
15066
|
+
* @param {*} [options] Override http request option.
|
|
15067
|
+
* @throws {RequiredError}
|
|
15068
|
+
*/
|
|
15069
|
+
getUserSyncResults(requestParameters?: SyncApiGetUserSyncResultsRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15070
|
+
};
|
|
15071
|
+
/**
|
|
15072
|
+
* Request parameters for getUserSyncResults operation in SyncApi.
|
|
15073
|
+
* @export
|
|
15074
|
+
* @interface SyncApiGetUserSyncResultsRequest
|
|
15075
|
+
*/
|
|
15076
|
+
export interface SyncApiGetUserSyncResultsRequest {
|
|
15077
|
+
/**
|
|
15078
|
+
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
15079
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
15080
|
+
* @memberof SyncApiGetUserSyncResults
|
|
15081
|
+
*/
|
|
15082
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
15083
|
+
}
|
|
15084
|
+
/**
|
|
15085
|
+
* SyncApi - object-oriented interface
|
|
15086
|
+
* @export
|
|
15087
|
+
* @class SyncApi
|
|
15088
|
+
* @extends {BaseAPI}
|
|
15089
|
+
*/
|
|
15090
|
+
export declare class SyncApi extends BaseAPI {
|
|
15091
|
+
/**
|
|
15092
|
+
* 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.
|
|
15093
|
+
* @summary Get dry-run sync results for users
|
|
15094
|
+
* @param {SyncApiGetUserSyncResultsRequest} requestParameters Request parameters.
|
|
15095
|
+
* @param {*} [options] Override http request option.
|
|
15096
|
+
* @throws {RequiredError}
|
|
15097
|
+
* @memberof SyncApi
|
|
15098
|
+
*/
|
|
15099
|
+
getUserSyncResults(requestParameters?: SyncApiGetUserSyncResultsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
15100
|
+
}
|
|
15101
|
+
/**
|
|
15102
|
+
* @export
|
|
15103
|
+
*/
|
|
15104
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
15105
|
+
readonly Ldap: "LDAP";
|
|
15106
|
+
readonly Gewisdb: "GEWISDB";
|
|
15107
|
+
};
|
|
15108
|
+
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
15109
|
+
/**
|
|
15110
|
+
* TerminalPaymentsApi - axios parameter creator
|
|
15111
|
+
* @export
|
|
15112
|
+
*/
|
|
15113
|
+
export declare const TerminalPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15114
|
+
/**
|
|
15115
|
+
*
|
|
15116
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15117
|
+
* @param {number} id The ID of the terminal payment
|
|
15118
|
+
* @param {*} [options] Override http request option.
|
|
15119
|
+
* @throws {RequiredError}
|
|
15120
|
+
*/
|
|
15121
|
+
cancelTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15122
|
+
/**
|
|
15123
|
+
*
|
|
15124
|
+
* @summary Create a terminal payment before executing.
|
|
15125
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15126
|
+
* @param {*} [options] Override http request option.
|
|
15127
|
+
* @throws {RequiredError}
|
|
15128
|
+
*/
|
|
15129
|
+
createTerminalPayment: (createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15130
|
+
/**
|
|
15131
|
+
*
|
|
15132
|
+
* @summary Get single terminal payment by ID
|
|
15133
|
+
* @param {number} id The ID of the terminal payment
|
|
15134
|
+
* @param {*} [options] Override http request option.
|
|
15135
|
+
* @throws {RequiredError}
|
|
15136
|
+
*/
|
|
15137
|
+
getSingleTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15138
|
+
/**
|
|
15139
|
+
*
|
|
15140
|
+
* @summary Get all Stripe terminals
|
|
15141
|
+
* @param {*} [options] Override http request option.
|
|
15142
|
+
* @throws {RequiredError}
|
|
15143
|
+
*/
|
|
15144
|
+
getStripeTerminals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15145
|
+
/**
|
|
15146
|
+
*
|
|
15147
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15148
|
+
* @param {number} id The ID of the terminal payment
|
|
15149
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15150
|
+
* @param {*} [options] Override http request option.
|
|
15151
|
+
* @throws {RequiredError}
|
|
15152
|
+
*/
|
|
15153
|
+
startTerminalPayment: (id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15154
|
+
};
|
|
15155
|
+
/**
|
|
15156
|
+
* TerminalPaymentsApi - functional programming interface
|
|
15157
|
+
* @export
|
|
15158
|
+
*/
|
|
15159
|
+
export declare const TerminalPaymentsApiFp: (configuration?: Configuration) => {
|
|
15160
|
+
/**
|
|
15161
|
+
*
|
|
15162
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15163
|
+
* @param {number} id The ID of the terminal payment
|
|
15164
|
+
* @param {*} [options] Override http request option.
|
|
15165
|
+
* @throws {RequiredError}
|
|
15166
|
+
*/
|
|
15167
|
+
cancelTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15168
|
+
/**
|
|
15169
|
+
*
|
|
15170
|
+
* @summary Create a terminal payment before executing.
|
|
15171
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15172
|
+
* @param {*} [options] Override http request option.
|
|
15173
|
+
* @throws {RequiredError}
|
|
15174
|
+
*/
|
|
15175
|
+
createTerminalPayment(createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15176
|
+
/**
|
|
15177
|
+
*
|
|
15178
|
+
* @summary Get single terminal payment by ID
|
|
15179
|
+
* @param {number} id The ID of the terminal payment
|
|
15180
|
+
* @param {*} [options] Override http request option.
|
|
15181
|
+
* @throws {RequiredError}
|
|
15182
|
+
*/
|
|
15183
|
+
getSingleTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15184
|
+
/**
|
|
15185
|
+
*
|
|
15186
|
+
* @summary Get all Stripe terminals
|
|
15187
|
+
* @param {*} [options] Override http request option.
|
|
15188
|
+
* @throws {RequiredError}
|
|
15189
|
+
*/
|
|
15190
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<StripePaymentTerminalResponse>>>;
|
|
15191
|
+
/**
|
|
15192
|
+
*
|
|
15193
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15194
|
+
* @param {number} id The ID of the terminal payment
|
|
15195
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15196
|
+
* @param {*} [options] Override http request option.
|
|
15197
|
+
* @throws {RequiredError}
|
|
15198
|
+
*/
|
|
15199
|
+
startTerminalPayment(id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15200
|
+
};
|
|
15201
|
+
/**
|
|
15202
|
+
* TerminalPaymentsApi - factory interface
|
|
15203
|
+
* @export
|
|
15204
|
+
*/
|
|
15205
|
+
export declare const TerminalPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15206
|
+
/**
|
|
15207
|
+
*
|
|
15208
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15209
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
15210
|
+
* @param {*} [options] Override http request option.
|
|
15211
|
+
* @throws {RequiredError}
|
|
15212
|
+
*/
|
|
15213
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15214
|
+
/**
|
|
15215
|
+
*
|
|
15216
|
+
* @summary Create a terminal payment before executing.
|
|
15217
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15218
|
+
* @param {*} [options] Override http request option.
|
|
15219
|
+
* @throws {RequiredError}
|
|
15220
|
+
*/
|
|
15221
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15222
|
+
/**
|
|
15223
|
+
*
|
|
15224
|
+
* @summary Get single terminal payment by ID
|
|
15225
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15226
|
+
* @param {*} [options] Override http request option.
|
|
15227
|
+
* @throws {RequiredError}
|
|
15228
|
+
*/
|
|
15229
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
14127
15230
|
/**
|
|
14128
15231
|
*
|
|
14129
|
-
* @summary
|
|
14130
|
-
* @param {StripeApiDepositRequest} requestParameters Request parameters.
|
|
15232
|
+
* @summary Get all Stripe terminals
|
|
14131
15233
|
* @param {*} [options] Override http request option.
|
|
14132
15234
|
* @throws {RequiredError}
|
|
14133
|
-
* @memberof StripeApi
|
|
14134
15235
|
*/
|
|
14135
|
-
|
|
15236
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): AxiosPromise<Array<StripePaymentTerminalResponse>>;
|
|
14136
15237
|
/**
|
|
14137
15238
|
*
|
|
14138
|
-
* @summary
|
|
15239
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15240
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
14139
15241
|
* @param {*} [options] Override http request option.
|
|
14140
15242
|
* @throws {RequiredError}
|
|
14141
|
-
* @memberof StripeApi
|
|
14142
15243
|
*/
|
|
14143
|
-
|
|
14144
|
-
}
|
|
15244
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15245
|
+
};
|
|
14145
15246
|
/**
|
|
14146
|
-
*
|
|
15247
|
+
* Request parameters for cancelTerminalPayment operation in TerminalPaymentsApi.
|
|
14147
15248
|
* @export
|
|
15249
|
+
* @interface TerminalPaymentsApiCancelTerminalPaymentRequest
|
|
14148
15250
|
*/
|
|
14149
|
-
export
|
|
15251
|
+
export interface TerminalPaymentsApiCancelTerminalPaymentRequest {
|
|
14150
15252
|
/**
|
|
14151
|
-
*
|
|
14152
|
-
* @
|
|
14153
|
-
* @
|
|
14154
|
-
* @param {*} [options] Override http request option.
|
|
14155
|
-
* @throws {RequiredError}
|
|
15253
|
+
* The ID of the terminal payment
|
|
15254
|
+
* @type {number}
|
|
15255
|
+
* @memberof TerminalPaymentsApiCancelTerminalPayment
|
|
14156
15256
|
*/
|
|
14157
|
-
|
|
14158
|
-
}
|
|
15257
|
+
readonly id: number;
|
|
15258
|
+
}
|
|
14159
15259
|
/**
|
|
14160
|
-
*
|
|
15260
|
+
* Request parameters for createTerminalPayment operation in TerminalPaymentsApi.
|
|
14161
15261
|
* @export
|
|
15262
|
+
* @interface TerminalPaymentsApiCreateTerminalPaymentRequest
|
|
14162
15263
|
*/
|
|
14163
|
-
export
|
|
15264
|
+
export interface TerminalPaymentsApiCreateTerminalPaymentRequest {
|
|
14164
15265
|
/**
|
|
14165
|
-
*
|
|
14166
|
-
* @
|
|
14167
|
-
* @
|
|
14168
|
-
* @param {*} [options] Override http request option.
|
|
14169
|
-
* @throws {RequiredError}
|
|
15266
|
+
* The terminal payment that should be created.
|
|
15267
|
+
* @type {CreateTerminalPaymentRequest}
|
|
15268
|
+
* @memberof TerminalPaymentsApiCreateTerminalPayment
|
|
14170
15269
|
*/
|
|
14171
|
-
|
|
14172
|
-
}
|
|
15270
|
+
readonly createTerminalPaymentRequest: CreateTerminalPaymentRequest;
|
|
15271
|
+
}
|
|
14173
15272
|
/**
|
|
14174
|
-
*
|
|
15273
|
+
* Request parameters for getSingleTerminalPayment operation in TerminalPaymentsApi.
|
|
14175
15274
|
* @export
|
|
15275
|
+
* @interface TerminalPaymentsApiGetSingleTerminalPaymentRequest
|
|
14176
15276
|
*/
|
|
14177
|
-
export
|
|
15277
|
+
export interface TerminalPaymentsApiGetSingleTerminalPaymentRequest {
|
|
14178
15278
|
/**
|
|
14179
|
-
*
|
|
14180
|
-
* @
|
|
14181
|
-
* @
|
|
14182
|
-
* @param {*} [options] Override http request option.
|
|
14183
|
-
* @throws {RequiredError}
|
|
15279
|
+
* The ID of the terminal payment
|
|
15280
|
+
* @type {number}
|
|
15281
|
+
* @memberof TerminalPaymentsApiGetSingleTerminalPayment
|
|
14184
15282
|
*/
|
|
14185
|
-
|
|
14186
|
-
}
|
|
15283
|
+
readonly id: number;
|
|
15284
|
+
}
|
|
14187
15285
|
/**
|
|
14188
|
-
* Request parameters for
|
|
15286
|
+
* Request parameters for startTerminalPayment operation in TerminalPaymentsApi.
|
|
14189
15287
|
* @export
|
|
14190
|
-
* @interface
|
|
15288
|
+
* @interface TerminalPaymentsApiStartTerminalPaymentRequest
|
|
14191
15289
|
*/
|
|
14192
|
-
export interface
|
|
15290
|
+
export interface TerminalPaymentsApiStartTerminalPaymentRequest {
|
|
14193
15291
|
/**
|
|
14194
|
-
*
|
|
14195
|
-
* @type {
|
|
14196
|
-
* @memberof
|
|
15292
|
+
* The ID of the terminal payment
|
|
15293
|
+
* @type {number}
|
|
15294
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15295
|
+
*/
|
|
15296
|
+
readonly id: number;
|
|
15297
|
+
/**
|
|
15298
|
+
* Payment options
|
|
15299
|
+
* @type {ProcessTerminalPaymentRequest}
|
|
15300
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
14197
15301
|
*/
|
|
14198
|
-
readonly
|
|
15302
|
+
readonly processTerminalPaymentRequest: ProcessTerminalPaymentRequest;
|
|
14199
15303
|
}
|
|
14200
15304
|
/**
|
|
14201
|
-
*
|
|
15305
|
+
* TerminalPaymentsApi - object-oriented interface
|
|
14202
15306
|
* @export
|
|
14203
|
-
* @class
|
|
15307
|
+
* @class TerminalPaymentsApi
|
|
14204
15308
|
* @extends {BaseAPI}
|
|
14205
15309
|
*/
|
|
14206
|
-
export declare class
|
|
15310
|
+
export declare class TerminalPaymentsApi extends BaseAPI {
|
|
14207
15311
|
/**
|
|
14208
|
-
*
|
|
14209
|
-
* @summary
|
|
14210
|
-
* @param {
|
|
15312
|
+
*
|
|
15313
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15314
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
14211
15315
|
* @param {*} [options] Override http request option.
|
|
14212
15316
|
* @throws {RequiredError}
|
|
14213
|
-
* @memberof
|
|
15317
|
+
* @memberof TerminalPaymentsApi
|
|
14214
15318
|
*/
|
|
14215
|
-
|
|
15319
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15320
|
+
/**
|
|
15321
|
+
*
|
|
15322
|
+
* @summary Create a terminal payment before executing.
|
|
15323
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15324
|
+
* @param {*} [options] Override http request option.
|
|
15325
|
+
* @throws {RequiredError}
|
|
15326
|
+
* @memberof TerminalPaymentsApi
|
|
15327
|
+
*/
|
|
15328
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15329
|
+
/**
|
|
15330
|
+
*
|
|
15331
|
+
* @summary Get single terminal payment by ID
|
|
15332
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15333
|
+
* @param {*} [options] Override http request option.
|
|
15334
|
+
* @throws {RequiredError}
|
|
15335
|
+
* @memberof TerminalPaymentsApi
|
|
15336
|
+
*/
|
|
15337
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15338
|
+
/**
|
|
15339
|
+
*
|
|
15340
|
+
* @summary Get all Stripe terminals
|
|
15341
|
+
* @param {*} [options] Override http request option.
|
|
15342
|
+
* @throws {RequiredError}
|
|
15343
|
+
* @memberof TerminalPaymentsApi
|
|
15344
|
+
*/
|
|
15345
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentTerminalResponse[], any, {}>>;
|
|
15346
|
+
/**
|
|
15347
|
+
*
|
|
15348
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15349
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
15350
|
+
* @param {*} [options] Override http request option.
|
|
15351
|
+
* @throws {RequiredError}
|
|
15352
|
+
* @memberof TerminalPaymentsApi
|
|
15353
|
+
*/
|
|
15354
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
14216
15355
|
}
|
|
14217
|
-
/**
|
|
14218
|
-
* @export
|
|
14219
|
-
*/
|
|
14220
|
-
export declare const GetUserSyncResultsServiceEnum: {};
|
|
14221
|
-
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14222
15356
|
/**
|
|
14223
15357
|
* TermsOfServiceApi - axios parameter creator
|
|
14224
15358
|
* @export
|
|
@@ -14967,12 +16101,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14967
16101
|
* @summary Returns all existing transfers
|
|
14968
16102
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
14969
16103
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16104
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16105
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16106
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
14970
16107
|
* @param {number} [take] How many transfers the endpoint should return
|
|
14971
16108
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
14972
16109
|
* @param {*} [options] Override http request option.
|
|
14973
16110
|
* @throws {RequiredError}
|
|
14974
16111
|
*/
|
|
14975
|
-
getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16112
|
+
getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14976
16113
|
/**
|
|
14977
16114
|
*
|
|
14978
16115
|
* @summary Returns the requested transfer
|
|
@@ -14988,7 +16125,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14988
16125
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
14989
16126
|
* @param {number} [fromId] Filter transfers from this user ID
|
|
14990
16127
|
* @param {number} [toId] Filter transfers to this user ID
|
|
14991
|
-
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
16128
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
14992
16129
|
* @param {*} [options] Override http request option.
|
|
14993
16130
|
* @throws {RequiredError}
|
|
14994
16131
|
*/
|
|
@@ -15001,6 +16138,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15001
16138
|
* @throws {RequiredError}
|
|
15002
16139
|
*/
|
|
15003
16140
|
getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16141
|
+
/**
|
|
16142
|
+
*
|
|
16143
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16144
|
+
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
16145
|
+
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16146
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16147
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16148
|
+
* @param {*} [options] Override http request option.
|
|
16149
|
+
* @throws {RequiredError}
|
|
16150
|
+
*/
|
|
16151
|
+
getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15004
16152
|
};
|
|
15005
16153
|
/**
|
|
15006
16154
|
* TransfersApi - functional programming interface
|
|
@@ -15028,12 +16176,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15028
16176
|
* @summary Returns all existing transfers
|
|
15029
16177
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15030
16178
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16179
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16180
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16181
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15031
16182
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15032
16183
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15033
16184
|
* @param {*} [options] Override http request option.
|
|
15034
16185
|
* @throws {RequiredError}
|
|
15035
16186
|
*/
|
|
15036
|
-
getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
16187
|
+
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTransferResponse>>;
|
|
15037
16188
|
/**
|
|
15038
16189
|
*
|
|
15039
16190
|
* @summary Returns the requested transfer
|
|
@@ -15049,7 +16200,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15049
16200
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15050
16201
|
* @param {number} [fromId] Filter transfers from this user ID
|
|
15051
16202
|
* @param {number} [toId] Filter transfers to this user ID
|
|
15052
|
-
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
16203
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15053
16204
|
* @param {*} [options] Override http request option.
|
|
15054
16205
|
* @throws {RequiredError}
|
|
15055
16206
|
*/
|
|
@@ -15062,6 +16213,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15062
16213
|
* @throws {RequiredError}
|
|
15063
16214
|
*/
|
|
15064
16215
|
getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
16216
|
+
/**
|
|
16217
|
+
*
|
|
16218
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16219
|
+
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
16220
|
+
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
16221
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
16222
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
16223
|
+
* @param {*} [options] Override http request option.
|
|
16224
|
+
* @throws {RequiredError}
|
|
16225
|
+
*/
|
|
16226
|
+
getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
|
|
15065
16227
|
};
|
|
15066
16228
|
/**
|
|
15067
16229
|
* TransfersApi - factory interface
|
|
@@ -15091,7 +16253,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15091
16253
|
* @param {*} [options] Override http request option.
|
|
15092
16254
|
* @throws {RequiredError}
|
|
15093
16255
|
*/
|
|
15094
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
16256
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15095
16257
|
/**
|
|
15096
16258
|
*
|
|
15097
16259
|
* @summary Returns the requested transfer
|
|
@@ -15116,6 +16278,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15116
16278
|
* @throws {RequiredError}
|
|
15117
16279
|
*/
|
|
15118
16280
|
getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
16281
|
+
/**
|
|
16282
|
+
*
|
|
16283
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16284
|
+
* @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
|
|
16285
|
+
* @param {*} [options] Override http request option.
|
|
16286
|
+
* @throws {RequiredError}
|
|
16287
|
+
*/
|
|
16288
|
+
getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
|
|
15119
16289
|
};
|
|
15120
16290
|
/**
|
|
15121
16291
|
* Request parameters for createTransfer operation in TransfersApi.
|
|
@@ -15161,6 +16331,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15161
16331
|
* @memberof TransfersApiGetAllTransfers
|
|
15162
16332
|
*/
|
|
15163
16333
|
readonly tillDate?: string;
|
|
16334
|
+
/**
|
|
16335
|
+
* Filter transfers from this user ID
|
|
16336
|
+
* @type {number}
|
|
16337
|
+
* @memberof TransfersApiGetAllTransfers
|
|
16338
|
+
*/
|
|
16339
|
+
readonly fromId?: number;
|
|
16340
|
+
/**
|
|
16341
|
+
* Filter transfers to this user ID
|
|
16342
|
+
* @type {number}
|
|
16343
|
+
* @memberof TransfersApiGetAllTransfers
|
|
16344
|
+
*/
|
|
16345
|
+
readonly toId?: number;
|
|
16346
|
+
/**
|
|
16347
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
16348
|
+
* @type {string}
|
|
16349
|
+
* @memberof TransfersApiGetAllTransfers
|
|
16350
|
+
*/
|
|
16351
|
+
readonly category?: string;
|
|
15164
16352
|
/**
|
|
15165
16353
|
* How many transfers the endpoint should return
|
|
15166
16354
|
* @type {number}
|
|
@@ -15218,7 +16406,7 @@ export interface TransfersApiGetTransferAggregateRequest {
|
|
|
15218
16406
|
*/
|
|
15219
16407
|
readonly toId?: number;
|
|
15220
16408
|
/**
|
|
15221
|
-
* Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
16409
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15222
16410
|
* @type {string}
|
|
15223
16411
|
* @memberof TransfersApiGetTransferAggregate
|
|
15224
16412
|
*/
|
|
@@ -15237,6 +16425,37 @@ export interface TransfersApiGetTransferPdfRequest {
|
|
|
15237
16425
|
*/
|
|
15238
16426
|
readonly id: number;
|
|
15239
16427
|
}
|
|
16428
|
+
/**
|
|
16429
|
+
* Request parameters for getTransferSummary operation in TransfersApi.
|
|
16430
|
+
* @export
|
|
16431
|
+
* @interface TransfersApiGetTransferSummaryRequest
|
|
16432
|
+
*/
|
|
16433
|
+
export interface TransfersApiGetTransferSummaryRequest {
|
|
16434
|
+
/**
|
|
16435
|
+
* Start date for selected transfers (inclusive)
|
|
16436
|
+
* @type {string}
|
|
16437
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16438
|
+
*/
|
|
16439
|
+
readonly fromDate?: string;
|
|
16440
|
+
/**
|
|
16441
|
+
* End date for selected transfers (exclusive)
|
|
16442
|
+
* @type {string}
|
|
16443
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16444
|
+
*/
|
|
16445
|
+
readonly tillDate?: string;
|
|
16446
|
+
/**
|
|
16447
|
+
* Filter transfers from this user ID
|
|
16448
|
+
* @type {number}
|
|
16449
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16450
|
+
*/
|
|
16451
|
+
readonly fromId?: number;
|
|
16452
|
+
/**
|
|
16453
|
+
* Filter transfers to this user ID
|
|
16454
|
+
* @type {number}
|
|
16455
|
+
* @memberof TransfersApiGetTransferSummary
|
|
16456
|
+
*/
|
|
16457
|
+
readonly toId?: number;
|
|
16458
|
+
}
|
|
15240
16459
|
/**
|
|
15241
16460
|
* TransfersApi - object-oriented interface
|
|
15242
16461
|
* @export
|
|
@@ -15270,7 +16489,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15270
16489
|
* @throws {RequiredError}
|
|
15271
16490
|
* @memberof TransfersApi
|
|
15272
16491
|
*/
|
|
15273
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16492
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15274
16493
|
/**
|
|
15275
16494
|
*
|
|
15276
16495
|
* @summary Returns the requested transfer
|
|
@@ -15298,6 +16517,15 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15298
16517
|
* @memberof TransfersApi
|
|
15299
16518
|
*/
|
|
15300
16519
|
getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
16520
|
+
/**
|
|
16521
|
+
*
|
|
16522
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16523
|
+
* @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
|
|
16524
|
+
* @param {*} [options] Override http request option.
|
|
16525
|
+
* @throws {RequiredError}
|
|
16526
|
+
* @memberof TransfersApi
|
|
16527
|
+
*/
|
|
16528
|
+
getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
|
|
15301
16529
|
}
|
|
15302
16530
|
/**
|
|
15303
16531
|
* UserNotificationPreferencesApi - axios parameter creator
|
|
@@ -15510,7 +16738,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15510
16738
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15511
16739
|
/**
|
|
15512
16740
|
*
|
|
15513
|
-
* @summary Accept the Terms of Service
|
|
16741
|
+
* @summary Accept the current Terms of Service version
|
|
15514
16742
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15515
16743
|
* @param {*} [options] Override http request option.
|
|
15516
16744
|
* @throws {RequiredError}
|
|
@@ -15640,6 +16868,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15640
16868
|
* @throws {RequiredError}
|
|
15641
16869
|
*/
|
|
15642
16870
|
getUserSettings: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16871
|
+
/**
|
|
16872
|
+
*
|
|
16873
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
16874
|
+
* @param {number} id The id of the user
|
|
16875
|
+
* @param {*} [options] Override http request option.
|
|
16876
|
+
* @throws {RequiredError}
|
|
16877
|
+
*/
|
|
16878
|
+
getUserTos: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15643
16879
|
/**
|
|
15644
16880
|
*
|
|
15645
16881
|
* @summary Returns the user\'s containers
|
|
@@ -15662,6 +16898,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15662
16898
|
* @throws {RequiredError}
|
|
15663
16899
|
*/
|
|
15664
16900
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16901
|
+
/**
|
|
16902
|
+
*
|
|
16903
|
+
* @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.
|
|
16904
|
+
* @param {number} id The id of the beneficiary user.
|
|
16905
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16906
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16907
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16908
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16909
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16910
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16911
|
+
* @param {*} [options] Override http request option.
|
|
16912
|
+
* @throws {RequiredError}
|
|
16913
|
+
*/
|
|
16914
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15665
16915
|
/**
|
|
15666
16916
|
*
|
|
15667
16917
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -15872,7 +17122,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15872
17122
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
15873
17123
|
/**
|
|
15874
17124
|
*
|
|
15875
|
-
* @summary Accept the Terms of Service
|
|
17125
|
+
* @summary Accept the current Terms of Service version
|
|
15876
17126
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15877
17127
|
* @param {*} [options] Override http request option.
|
|
15878
17128
|
* @throws {RequiredError}
|
|
@@ -16002,6 +17252,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16002
17252
|
* @throws {RequiredError}
|
|
16003
17253
|
*/
|
|
16004
17254
|
getUserSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettingsResponse>>;
|
|
17255
|
+
/**
|
|
17256
|
+
*
|
|
17257
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17258
|
+
* @param {number} id The id of the user
|
|
17259
|
+
* @param {*} [options] Override http request option.
|
|
17260
|
+
* @throws {RequiredError}
|
|
17261
|
+
*/
|
|
17262
|
+
getUserTos(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserTosResponse>>;
|
|
16005
17263
|
/**
|
|
16006
17264
|
*
|
|
16007
17265
|
* @summary Returns the user\'s containers
|
|
@@ -16024,6 +17282,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16024
17282
|
* @throws {RequiredError}
|
|
16025
17283
|
*/
|
|
16026
17284
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
17285
|
+
/**
|
|
17286
|
+
*
|
|
17287
|
+
* @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.
|
|
17288
|
+
* @param {number} id The id of the beneficiary user.
|
|
17289
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
17290
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
17291
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
17292
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
17293
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
17294
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
17295
|
+
* @param {*} [options] Override http request option.
|
|
17296
|
+
* @throws {RequiredError}
|
|
17297
|
+
*/
|
|
17298
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16027
17299
|
/**
|
|
16028
17300
|
*
|
|
16029
17301
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16234,7 +17506,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16234
17506
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16235
17507
|
/**
|
|
16236
17508
|
*
|
|
16237
|
-
* @summary Accept the Terms of Service
|
|
17509
|
+
* @summary Accept the current Terms of Service version
|
|
16238
17510
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16239
17511
|
* @param {*} [options] Override http request option.
|
|
16240
17512
|
* @throws {RequiredError}
|
|
@@ -16352,6 +17624,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16352
17624
|
* @throws {RequiredError}
|
|
16353
17625
|
*/
|
|
16354
17626
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserSettingsResponse>;
|
|
17627
|
+
/**
|
|
17628
|
+
*
|
|
17629
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17630
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
17631
|
+
* @param {*} [options] Override http request option.
|
|
17632
|
+
* @throws {RequiredError}
|
|
17633
|
+
*/
|
|
17634
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserTosResponse>;
|
|
16355
17635
|
/**
|
|
16356
17636
|
*
|
|
16357
17637
|
* @summary Returns the user\'s containers
|
|
@@ -16368,6 +17648,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16368
17648
|
* @throws {RequiredError}
|
|
16369
17649
|
*/
|
|
16370
17650
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17651
|
+
/**
|
|
17652
|
+
*
|
|
17653
|
+
* @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.
|
|
17654
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17655
|
+
* @param {*} [options] Override http request option.
|
|
17656
|
+
* @throws {RequiredError}
|
|
17657
|
+
*/
|
|
17658
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16371
17659
|
/**
|
|
16372
17660
|
*
|
|
16373
17661
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16797,6 +18085,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
16797
18085
|
*/
|
|
16798
18086
|
readonly id: number;
|
|
16799
18087
|
}
|
|
18088
|
+
/**
|
|
18089
|
+
* Request parameters for getUserTos operation in UsersApi.
|
|
18090
|
+
* @export
|
|
18091
|
+
* @interface UsersApiGetUserTosRequest
|
|
18092
|
+
*/
|
|
18093
|
+
export interface UsersApiGetUserTosRequest {
|
|
18094
|
+
/**
|
|
18095
|
+
* The id of the user
|
|
18096
|
+
* @type {number}
|
|
18097
|
+
* @memberof UsersApiGetUserTos
|
|
18098
|
+
*/
|
|
18099
|
+
readonly id: number;
|
|
18100
|
+
}
|
|
16800
18101
|
/**
|
|
16801
18102
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
16802
18103
|
* @export
|
|
@@ -16859,6 +18160,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16859
18160
|
*/
|
|
16860
18161
|
readonly skip?: number;
|
|
16861
18162
|
}
|
|
18163
|
+
/**
|
|
18164
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
18165
|
+
* @export
|
|
18166
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
18167
|
+
*/
|
|
18168
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
18169
|
+
/**
|
|
18170
|
+
* The id of the beneficiary user.
|
|
18171
|
+
* @type {number}
|
|
18172
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18173
|
+
*/
|
|
18174
|
+
readonly id: number;
|
|
18175
|
+
/**
|
|
18176
|
+
* Filter by creator user id.
|
|
18177
|
+
* @type {number}
|
|
18178
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18179
|
+
*/
|
|
18180
|
+
readonly createdById?: number;
|
|
18181
|
+
/**
|
|
18182
|
+
* Comma-separated list of derived statuses.
|
|
18183
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
18184
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18185
|
+
*/
|
|
18186
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
18187
|
+
/**
|
|
18188
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
18189
|
+
* @type {string}
|
|
18190
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18191
|
+
*/
|
|
18192
|
+
readonly fromDate?: string;
|
|
18193
|
+
/**
|
|
18194
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
18195
|
+
* @type {string}
|
|
18196
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18197
|
+
*/
|
|
18198
|
+
readonly tillDate?: string;
|
|
18199
|
+
/**
|
|
18200
|
+
* How many rows the endpoint should return
|
|
18201
|
+
* @type {number}
|
|
18202
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18203
|
+
*/
|
|
18204
|
+
readonly take?: number;
|
|
18205
|
+
/**
|
|
18206
|
+
* How many rows to skip (for pagination)
|
|
18207
|
+
* @type {number}
|
|
18208
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18209
|
+
*/
|
|
18210
|
+
readonly skip?: number;
|
|
18211
|
+
}
|
|
16862
18212
|
/**
|
|
16863
18213
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16864
18214
|
* @export
|
|
@@ -17374,7 +18724,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17374
18724
|
export declare class UsersApi extends BaseAPI {
|
|
17375
18725
|
/**
|
|
17376
18726
|
*
|
|
17377
|
-
* @summary Accept the Terms of Service
|
|
18727
|
+
* @summary Accept the current Terms of Service version
|
|
17378
18728
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17379
18729
|
* @param {*} [options] Override http request option.
|
|
17380
18730
|
* @throws {RequiredError}
|
|
@@ -17507,6 +18857,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17507
18857
|
* @memberof UsersApi
|
|
17508
18858
|
*/
|
|
17509
18859
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserSettingsResponse, any, {}>>;
|
|
18860
|
+
/**
|
|
18861
|
+
*
|
|
18862
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
18863
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
18864
|
+
* @param {*} [options] Override http request option.
|
|
18865
|
+
* @throws {RequiredError}
|
|
18866
|
+
* @memberof UsersApi
|
|
18867
|
+
*/
|
|
18868
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserTosResponse, any, {}>>;
|
|
17510
18869
|
/**
|
|
17511
18870
|
*
|
|
17512
18871
|
* @summary Returns the user\'s containers
|
|
@@ -17525,6 +18884,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17525
18884
|
* @memberof UsersApi
|
|
17526
18885
|
*/
|
|
17527
18886
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18887
|
+
/**
|
|
18888
|
+
*
|
|
18889
|
+
* @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.
|
|
18890
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18891
|
+
* @param {*} [options] Override http request option.
|
|
18892
|
+
* @throws {RequiredError}
|
|
18893
|
+
* @memberof UsersApi
|
|
18894
|
+
*/
|
|
18895
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17528
18896
|
/**
|
|
17529
18897
|
*
|
|
17530
18898
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17720,6 +19088,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17720
19088
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17721
19089
|
};
|
|
17722
19090
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
19091
|
+
/**
|
|
19092
|
+
* @export
|
|
19093
|
+
*/
|
|
19094
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
19095
|
+
readonly Pending: "PENDING";
|
|
19096
|
+
readonly Paid: "PAID";
|
|
19097
|
+
readonly Expired: "EXPIRED";
|
|
19098
|
+
readonly Cancelled: "CANCELLED";
|
|
19099
|
+
};
|
|
19100
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17723
19101
|
/**
|
|
17724
19102
|
* @export
|
|
17725
19103
|
*/
|