@gewis/sudosos-client 0.0.0-develop.375954e → 0.0.0-develop.382d35f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +1618 -248
- package/dist/api.js +1527 -266
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface AcceptTosRequest {
|
|
|
25
25
|
* @memberof AcceptTosRequest
|
|
26
26
|
*/
|
|
27
27
|
'extensiveDataProcessing': boolean;
|
|
28
|
+
/**
|
|
29
|
+
* The TOS version being accepted.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AcceptTosRequest
|
|
32
|
+
*/
|
|
33
|
+
'version': string;
|
|
28
34
|
}
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
@@ -58,6 +64,25 @@ export interface AddRoleRequest {
|
|
|
58
64
|
*/
|
|
59
65
|
'roleId': number;
|
|
60
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @export
|
|
70
|
+
* @interface AuthenticationEanRequest
|
|
71
|
+
*/
|
|
72
|
+
export interface AuthenticationEanRequest {
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @type {string}
|
|
76
|
+
* @memberof AuthenticationEanRequest
|
|
77
|
+
*/
|
|
78
|
+
'eanCode': string;
|
|
79
|
+
/**
|
|
80
|
+
* POS identifier
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof AuthenticationEanRequest
|
|
83
|
+
*/
|
|
84
|
+
'posId': number;
|
|
85
|
+
}
|
|
61
86
|
/**
|
|
62
87
|
*
|
|
63
88
|
* @export
|
|
@@ -134,6 +159,50 @@ export interface AuthenticationMockRequest {
|
|
|
134
159
|
*/
|
|
135
160
|
'nonce': string;
|
|
136
161
|
}
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @export
|
|
165
|
+
* @interface AuthenticationNfcRequest
|
|
166
|
+
*/
|
|
167
|
+
export interface AuthenticationNfcRequest {
|
|
168
|
+
/**
|
|
169
|
+
*
|
|
170
|
+
* @type {string}
|
|
171
|
+
* @memberof AuthenticationNfcRequest
|
|
172
|
+
*/
|
|
173
|
+
'nfcCode': string;
|
|
174
|
+
/**
|
|
175
|
+
* POS identifier
|
|
176
|
+
* @type {number}
|
|
177
|
+
* @memberof AuthenticationNfcRequest
|
|
178
|
+
*/
|
|
179
|
+
'posId': number;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @export
|
|
184
|
+
* @interface AuthenticationPinRequest
|
|
185
|
+
*/
|
|
186
|
+
export interface AuthenticationPinRequest {
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @type {number}
|
|
190
|
+
* @memberof AuthenticationPinRequest
|
|
191
|
+
*/
|
|
192
|
+
'userId': number;
|
|
193
|
+
/**
|
|
194
|
+
*
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof AuthenticationPinRequest
|
|
197
|
+
*/
|
|
198
|
+
'pin': string;
|
|
199
|
+
/**
|
|
200
|
+
* POS identifier
|
|
201
|
+
* @type {number}
|
|
202
|
+
* @memberof AuthenticationPinRequest
|
|
203
|
+
*/
|
|
204
|
+
'posId': number;
|
|
205
|
+
}
|
|
137
206
|
/**
|
|
138
207
|
*
|
|
139
208
|
* @export
|
|
@@ -215,69 +284,6 @@ export interface AuthenticationResponse {
|
|
|
215
284
|
*/
|
|
216
285
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
217
286
|
}
|
|
218
|
-
/**
|
|
219
|
-
*
|
|
220
|
-
* @export
|
|
221
|
-
* @interface AuthenticationSecureEanRequest
|
|
222
|
-
*/
|
|
223
|
-
export interface AuthenticationSecureEanRequest {
|
|
224
|
-
/**
|
|
225
|
-
*
|
|
226
|
-
* @type {string}
|
|
227
|
-
* @memberof AuthenticationSecureEanRequest
|
|
228
|
-
*/
|
|
229
|
-
'eanCode': string;
|
|
230
|
-
/**
|
|
231
|
-
* POS identifier
|
|
232
|
-
* @type {number}
|
|
233
|
-
* @memberof AuthenticationSecureEanRequest
|
|
234
|
-
*/
|
|
235
|
-
'posId': number;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
*
|
|
239
|
-
* @export
|
|
240
|
-
* @interface AuthenticationSecureNfcRequest
|
|
241
|
-
*/
|
|
242
|
-
export interface AuthenticationSecureNfcRequest {
|
|
243
|
-
/**
|
|
244
|
-
*
|
|
245
|
-
* @type {string}
|
|
246
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
247
|
-
*/
|
|
248
|
-
'nfcCode': string;
|
|
249
|
-
/**
|
|
250
|
-
* POS identifier
|
|
251
|
-
* @type {number}
|
|
252
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
253
|
-
*/
|
|
254
|
-
'posId': number;
|
|
255
|
-
}
|
|
256
|
-
/**
|
|
257
|
-
*
|
|
258
|
-
* @export
|
|
259
|
-
* @interface AuthenticationSecurePinRequest
|
|
260
|
-
*/
|
|
261
|
-
export interface AuthenticationSecurePinRequest {
|
|
262
|
-
/**
|
|
263
|
-
*
|
|
264
|
-
* @type {number}
|
|
265
|
-
* @memberof AuthenticationSecurePinRequest
|
|
266
|
-
*/
|
|
267
|
-
'userId': number;
|
|
268
|
-
/**
|
|
269
|
-
*
|
|
270
|
-
* @type {string}
|
|
271
|
-
* @memberof AuthenticationSecurePinRequest
|
|
272
|
-
*/
|
|
273
|
-
'pin': string;
|
|
274
|
-
/**
|
|
275
|
-
* POS identifier (required for secure authentication)
|
|
276
|
-
* @type {number}
|
|
277
|
-
* @memberof AuthenticationSecurePinRequest
|
|
278
|
-
*/
|
|
279
|
-
'posId': number;
|
|
280
|
-
}
|
|
281
287
|
/**
|
|
282
288
|
*
|
|
283
289
|
* @export
|
|
@@ -901,6 +907,104 @@ export interface BaseInvoiceResponse {
|
|
|
901
907
|
*/
|
|
902
908
|
'totalInclVat': DineroObjectResponse;
|
|
903
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];
|
|
904
1008
|
/**
|
|
905
1009
|
*
|
|
906
1010
|
* @export
|
|
@@ -1141,6 +1245,31 @@ export interface BaseResponse {
|
|
|
1141
1245
|
*/
|
|
1142
1246
|
'version'?: number;
|
|
1143
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
|
+
}
|
|
1144
1273
|
/**
|
|
1145
1274
|
*
|
|
1146
1275
|
* @export
|
|
@@ -1779,6 +1908,37 @@ export interface CreateInvoiceRequest {
|
|
|
1779
1908
|
*/
|
|
1780
1909
|
'amount': DineroObjectRequest;
|
|
1781
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
|
+
}
|
|
1782
1942
|
/**
|
|
1783
1943
|
*
|
|
1784
1944
|
* @export
|
|
@@ -1958,6 +2118,19 @@ export interface CreateShiftRequest {
|
|
|
1958
2118
|
*/
|
|
1959
2119
|
'roles': Array<string>;
|
|
1960
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
|
+
}
|
|
1961
2134
|
/**
|
|
1962
2135
|
*
|
|
1963
2136
|
* @export
|
|
@@ -3109,25 +3282,38 @@ export interface InvoiceUserResponse {
|
|
|
3109
3282
|
/**
|
|
3110
3283
|
*
|
|
3111
3284
|
* @export
|
|
3112
|
-
* @interface
|
|
3285
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3286
|
+
*/
|
|
3287
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3288
|
+
/**
|
|
3289
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3290
|
+
* @type {string}
|
|
3291
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3292
|
+
*/
|
|
3293
|
+
'reason': string;
|
|
3294
|
+
}
|
|
3295
|
+
/**
|
|
3296
|
+
*
|
|
3297
|
+
* @export
|
|
3298
|
+
* @interface MemberAuthenticationPinRequest
|
|
3113
3299
|
*/
|
|
3114
|
-
export interface
|
|
3300
|
+
export interface MemberAuthenticationPinRequest {
|
|
3115
3301
|
/**
|
|
3116
3302
|
*
|
|
3117
3303
|
* @type {number}
|
|
3118
|
-
* @memberof
|
|
3304
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3119
3305
|
*/
|
|
3120
3306
|
'memberId': number;
|
|
3121
3307
|
/**
|
|
3122
3308
|
*
|
|
3123
3309
|
* @type {string}
|
|
3124
|
-
* @memberof
|
|
3310
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3125
3311
|
*/
|
|
3126
3312
|
'pin': string;
|
|
3127
3313
|
/**
|
|
3128
3314
|
* POS identifier
|
|
3129
3315
|
* @type {number}
|
|
3130
|
-
* @memberof
|
|
3316
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3131
3317
|
*/
|
|
3132
3318
|
'posId': number;
|
|
3133
3319
|
}
|
|
@@ -3201,6 +3387,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3201
3387
|
*/
|
|
3202
3388
|
'records': Array<BaseEventResponse>;
|
|
3203
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
|
+
}
|
|
3204
3409
|
/**
|
|
3205
3410
|
*
|
|
3206
3411
|
* @export
|
|
@@ -3631,6 +3836,31 @@ export interface PatchUserTypeRequest {
|
|
|
3631
3836
|
*/
|
|
3632
3837
|
'userType': string;
|
|
3633
3838
|
}
|
|
3839
|
+
/**
|
|
3840
|
+
* Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
|
|
3841
|
+
* @export
|
|
3842
|
+
* @interface PaymentRequestStartResponse
|
|
3843
|
+
*/
|
|
3844
|
+
export interface PaymentRequestStartResponse {
|
|
3845
|
+
/**
|
|
3846
|
+
* The PaymentRequest id the intent is linked to.
|
|
3847
|
+
* @type {string}
|
|
3848
|
+
* @memberof PaymentRequestStartResponse
|
|
3849
|
+
*/
|
|
3850
|
+
'paymentRequestId': string;
|
|
3851
|
+
/**
|
|
3852
|
+
* Stripe payment intent id.
|
|
3853
|
+
* @type {string}
|
|
3854
|
+
* @memberof PaymentRequestStartResponse
|
|
3855
|
+
*/
|
|
3856
|
+
'stripeId': string;
|
|
3857
|
+
/**
|
|
3858
|
+
* Stripe client secret for the intent.
|
|
3859
|
+
* @type {string}
|
|
3860
|
+
* @memberof PaymentRequestStartResponse
|
|
3861
|
+
*/
|
|
3862
|
+
'clientSecret': string;
|
|
3863
|
+
}
|
|
3634
3864
|
/**
|
|
3635
3865
|
*
|
|
3636
3866
|
* @export
|
|
@@ -3991,13 +4221,26 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
3991
4221
|
'containers': Array<ContainerWithProductsResponse>;
|
|
3992
4222
|
}
|
|
3993
4223
|
/**
|
|
3994
|
-
*
|
|
4224
|
+
*
|
|
3995
4225
|
* @export
|
|
3996
|
-
* @interface
|
|
4226
|
+
* @interface ProcessTerminalPaymentRequest
|
|
3997
4227
|
*/
|
|
3998
|
-
export interface
|
|
4228
|
+
export interface ProcessTerminalPaymentRequest {
|
|
3999
4229
|
/**
|
|
4000
|
-
*
|
|
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
|
|
4239
|
+
* @interface ProductCategoryRequest
|
|
4240
|
+
*/
|
|
4241
|
+
export interface ProductCategoryRequest {
|
|
4242
|
+
/**
|
|
4243
|
+
* Name/label of the productCategory
|
|
4001
4244
|
* @type {string}
|
|
4002
4245
|
* @memberof ProductCategoryRequest
|
|
4003
4246
|
*/
|
|
@@ -4155,6 +4398,56 @@ export interface ProductResponse {
|
|
|
4155
4398
|
*/
|
|
4156
4399
|
'priceList': boolean;
|
|
4157
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];
|
|
4158
4451
|
/**
|
|
4159
4452
|
*
|
|
4160
4453
|
* @export
|
|
@@ -4832,6 +5125,37 @@ export interface StripePaymentIntentStatusResponse {
|
|
|
4832
5125
|
*/
|
|
4833
5126
|
'state': number;
|
|
4834
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
|
+
}
|
|
4835
5159
|
/**
|
|
4836
5160
|
*
|
|
4837
5161
|
* @export
|
|
@@ -5024,6 +5348,67 @@ export interface SubTransactionRowResponse {
|
|
|
5024
5348
|
*/
|
|
5025
5349
|
'totalPriceInclVat': DineroObjectResponse;
|
|
5026
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
|
+
}
|
|
5027
5412
|
/**
|
|
5028
5413
|
*
|
|
5029
5414
|
* @export
|
|
@@ -5036,6 +5421,12 @@ export interface TermsOfServiceResponse {
|
|
|
5036
5421
|
* @memberof TermsOfServiceResponse
|
|
5037
5422
|
*/
|
|
5038
5423
|
'versionNumber': string;
|
|
5424
|
+
/**
|
|
5425
|
+
* The date this version took effect.
|
|
5426
|
+
* @type {string}
|
|
5427
|
+
* @memberof TermsOfServiceResponse
|
|
5428
|
+
*/
|
|
5429
|
+
'date': string;
|
|
5039
5430
|
/**
|
|
5040
5431
|
* The terms of service content.
|
|
5041
5432
|
* @type {string}
|
|
@@ -5043,6 +5434,17 @@ export interface TermsOfServiceResponse {
|
|
|
5043
5434
|
*/
|
|
5044
5435
|
'content': string;
|
|
5045
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];
|
|
5046
5448
|
/**
|
|
5047
5449
|
*
|
|
5048
5450
|
* @export
|
|
@@ -6109,6 +6511,12 @@ export interface UpdateUserRequest {
|
|
|
6109
6511
|
* @memberof UpdateUserRequest
|
|
6110
6512
|
*/
|
|
6111
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;
|
|
6112
6520
|
}
|
|
6113
6521
|
/**
|
|
6114
6522
|
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
@@ -6284,11 +6692,11 @@ export interface UserResponse {
|
|
|
6284
6692
|
*/
|
|
6285
6693
|
'email'?: string;
|
|
6286
6694
|
/**
|
|
6287
|
-
* Whether this user
|
|
6288
|
-
* @type {
|
|
6695
|
+
* Whether this user is required to accept the TOS
|
|
6696
|
+
* @type {boolean}
|
|
6289
6697
|
* @memberof UserResponse
|
|
6290
6698
|
*/
|
|
6291
|
-
'
|
|
6699
|
+
'tosRequired'?: boolean;
|
|
6292
6700
|
/**
|
|
6293
6701
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6294
6702
|
* @type {boolean}
|
|
@@ -6325,6 +6733,12 @@ export interface UserResponse {
|
|
|
6325
6733
|
* @memberof UserResponse
|
|
6326
6734
|
*/
|
|
6327
6735
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6736
|
+
/**
|
|
6737
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6738
|
+
* @type {string}
|
|
6739
|
+
* @memberof UserResponse
|
|
6740
|
+
*/
|
|
6741
|
+
'expiryDate'?: string | null;
|
|
6328
6742
|
}
|
|
6329
6743
|
/**
|
|
6330
6744
|
*
|
|
@@ -6431,6 +6845,50 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6431
6845
|
*/
|
|
6432
6846
|
'nickname'?: string;
|
|
6433
6847
|
}
|
|
6848
|
+
/**
|
|
6849
|
+
*
|
|
6850
|
+
* @export
|
|
6851
|
+
* @interface UserTosAcceptanceResponse
|
|
6852
|
+
*/
|
|
6853
|
+
export interface UserTosAcceptanceResponse {
|
|
6854
|
+
/**
|
|
6855
|
+
* The accepted terms of service version number.
|
|
6856
|
+
* @type {string}
|
|
6857
|
+
* @memberof UserTosAcceptanceResponse
|
|
6858
|
+
*/
|
|
6859
|
+
'versionNumber': string;
|
|
6860
|
+
/**
|
|
6861
|
+
* The date at which this version was accepted.
|
|
6862
|
+
* @type {string}
|
|
6863
|
+
* @memberof UserTosAcceptanceResponse
|
|
6864
|
+
*/
|
|
6865
|
+
'acceptedAt': string;
|
|
6866
|
+
}
|
|
6867
|
+
/**
|
|
6868
|
+
*
|
|
6869
|
+
* @export
|
|
6870
|
+
* @interface UserTosResponse
|
|
6871
|
+
*/
|
|
6872
|
+
export interface UserTosResponse {
|
|
6873
|
+
/**
|
|
6874
|
+
*
|
|
6875
|
+
* @type {TermsOfServiceStatus}
|
|
6876
|
+
* @memberof UserTosResponse
|
|
6877
|
+
*/
|
|
6878
|
+
'status': TermsOfServiceStatus;
|
|
6879
|
+
/**
|
|
6880
|
+
* The current terms of service version number.
|
|
6881
|
+
* @type {string}
|
|
6882
|
+
* @memberof UserTosResponse
|
|
6883
|
+
*/
|
|
6884
|
+
'currentVersion': string;
|
|
6885
|
+
/**
|
|
6886
|
+
* All TOS versions the user has accepted.
|
|
6887
|
+
* @type {Array<UserTosAcceptanceResponse>}
|
|
6888
|
+
* @memberof UserTosResponse
|
|
6889
|
+
*/
|
|
6890
|
+
'acceptances': Array<UserTosAcceptanceResponse>;
|
|
6891
|
+
}
|
|
6434
6892
|
/**
|
|
6435
6893
|
* The type of a user
|
|
6436
6894
|
* @export
|
|
@@ -6996,6 +7454,14 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6996
7454
|
* @throws {RequiredError}
|
|
6997
7455
|
*/
|
|
6998
7456
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7457
|
+
/**
|
|
7458
|
+
*
|
|
7459
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7460
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7461
|
+
* @param {*} [options] Override http request option.
|
|
7462
|
+
* @throws {RequiredError}
|
|
7463
|
+
*/
|
|
7464
|
+
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6999
7465
|
/**
|
|
7000
7466
|
*
|
|
7001
7467
|
* @summary Generate a QR code for authentication
|
|
@@ -7067,67 +7533,59 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7067
7533
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7068
7534
|
/**
|
|
7069
7535
|
*
|
|
7070
|
-
* @summary
|
|
7071
|
-
* @param {
|
|
7072
|
-
* @param {*} [options] Override http request option.
|
|
7073
|
-
* @throws {RequiredError}
|
|
7074
|
-
*/
|
|
7075
|
-
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7076
|
-
/**
|
|
7077
|
-
*
|
|
7078
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7536
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7537
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7079
7538
|
* @param {*} [options] Override http request option.
|
|
7080
7539
|
* @throws {RequiredError}
|
|
7081
7540
|
*/
|
|
7082
|
-
|
|
7541
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7083
7542
|
/**
|
|
7084
7543
|
*
|
|
7085
|
-
* @summary
|
|
7086
|
-
* @param {
|
|
7544
|
+
* @summary Mock login and hand out token.
|
|
7545
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7087
7546
|
* @param {*} [options] Override http request option.
|
|
7088
7547
|
* @throws {RequiredError}
|
|
7089
7548
|
*/
|
|
7090
|
-
|
|
7549
|
+
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7091
7550
|
/**
|
|
7092
7551
|
*
|
|
7093
|
-
* @summary
|
|
7094
|
-
* @param {
|
|
7552
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7553
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7095
7554
|
* @param {*} [options] Override http request option.
|
|
7096
7555
|
* @throws {RequiredError}
|
|
7097
7556
|
*/
|
|
7098
|
-
|
|
7557
|
+
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7099
7558
|
/**
|
|
7100
7559
|
*
|
|
7101
|
-
* @summary
|
|
7102
|
-
* @param {
|
|
7560
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7561
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7103
7562
|
* @param {*} [options] Override http request option.
|
|
7104
7563
|
* @throws {RequiredError}
|
|
7105
7564
|
*/
|
|
7106
|
-
|
|
7565
|
+
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7107
7566
|
/**
|
|
7108
7567
|
*
|
|
7109
|
-
* @summary
|
|
7110
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7568
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7111
7569
|
* @param {*} [options] Override http request option.
|
|
7112
7570
|
* @throws {RequiredError}
|
|
7113
7571
|
*/
|
|
7114
|
-
|
|
7572
|
+
refreshToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7115
7573
|
/**
|
|
7116
7574
|
*
|
|
7117
|
-
* @summary
|
|
7118
|
-
* @param {
|
|
7575
|
+
* @summary Creates a reset token for the local authentication
|
|
7576
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7119
7577
|
* @param {*} [options] Override http request option.
|
|
7120
7578
|
* @throws {RequiredError}
|
|
7121
7579
|
*/
|
|
7122
|
-
|
|
7580
|
+
resetLocal: (resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7123
7581
|
/**
|
|
7124
7582
|
*
|
|
7125
|
-
* @summary
|
|
7126
|
-
* @param {
|
|
7583
|
+
* @summary Reset local authentication using the provided token
|
|
7584
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7127
7585
|
* @param {*} [options] Override http request option.
|
|
7128
7586
|
* @throws {RequiredError}
|
|
7129
7587
|
*/
|
|
7130
|
-
|
|
7588
|
+
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7131
7589
|
};
|
|
7132
7590
|
/**
|
|
7133
7591
|
* AuthenticateApi - functional programming interface
|
|
@@ -7158,6 +7616,14 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7158
7616
|
* @throws {RequiredError}
|
|
7159
7617
|
*/
|
|
7160
7618
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7619
|
+
/**
|
|
7620
|
+
*
|
|
7621
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7622
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7623
|
+
* @param {*} [options] Override http request option.
|
|
7624
|
+
* @throws {RequiredError}
|
|
7625
|
+
*/
|
|
7626
|
+
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7161
7627
|
/**
|
|
7162
7628
|
*
|
|
7163
7629
|
* @summary Generate a QR code for authentication
|
|
@@ -7229,67 +7695,59 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7229
7695
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7230
7696
|
/**
|
|
7231
7697
|
*
|
|
7232
|
-
* @summary
|
|
7233
|
-
* @param {
|
|
7234
|
-
* @param {*} [options] Override http request option.
|
|
7235
|
-
* @throws {RequiredError}
|
|
7236
|
-
*/
|
|
7237
|
-
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7238
|
-
/**
|
|
7239
|
-
*
|
|
7240
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7698
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7699
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7241
7700
|
* @param {*} [options] Override http request option.
|
|
7242
7701
|
* @throws {RequiredError}
|
|
7243
7702
|
*/
|
|
7244
|
-
|
|
7703
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7245
7704
|
/**
|
|
7246
7705
|
*
|
|
7247
|
-
* @summary
|
|
7248
|
-
* @param {
|
|
7706
|
+
* @summary Mock login and hand out token.
|
|
7707
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7249
7708
|
* @param {*} [options] Override http request option.
|
|
7250
7709
|
* @throws {RequiredError}
|
|
7251
7710
|
*/
|
|
7252
|
-
|
|
7711
|
+
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7253
7712
|
/**
|
|
7254
7713
|
*
|
|
7255
|
-
* @summary
|
|
7256
|
-
* @param {
|
|
7714
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7715
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7257
7716
|
* @param {*} [options] Override http request option.
|
|
7258
7717
|
* @throws {RequiredError}
|
|
7259
7718
|
*/
|
|
7260
|
-
|
|
7719
|
+
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7261
7720
|
/**
|
|
7262
7721
|
*
|
|
7263
|
-
* @summary
|
|
7264
|
-
* @param {
|
|
7722
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7723
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7265
7724
|
* @param {*} [options] Override http request option.
|
|
7266
7725
|
* @throws {RequiredError}
|
|
7267
7726
|
*/
|
|
7268
|
-
|
|
7727
|
+
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7269
7728
|
/**
|
|
7270
7729
|
*
|
|
7271
|
-
* @summary
|
|
7272
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7730
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7273
7731
|
* @param {*} [options] Override http request option.
|
|
7274
7732
|
* @throws {RequiredError}
|
|
7275
7733
|
*/
|
|
7276
|
-
|
|
7734
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7277
7735
|
/**
|
|
7278
7736
|
*
|
|
7279
|
-
* @summary
|
|
7280
|
-
* @param {
|
|
7737
|
+
* @summary Creates a reset token for the local authentication
|
|
7738
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7281
7739
|
* @param {*} [options] Override http request option.
|
|
7282
7740
|
* @throws {RequiredError}
|
|
7283
7741
|
*/
|
|
7284
|
-
|
|
7742
|
+
resetLocal(resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7285
7743
|
/**
|
|
7286
7744
|
*
|
|
7287
|
-
* @summary
|
|
7288
|
-
* @param {
|
|
7745
|
+
* @summary Reset local authentication using the provided token
|
|
7746
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7289
7747
|
* @param {*} [options] Override http request option.
|
|
7290
7748
|
* @throws {RequiredError}
|
|
7291
7749
|
*/
|
|
7292
|
-
|
|
7750
|
+
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7293
7751
|
};
|
|
7294
7752
|
/**
|
|
7295
7753
|
* AuthenticateApi - factory interface
|
|
@@ -7320,6 +7778,14 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7320
7778
|
* @throws {RequiredError}
|
|
7321
7779
|
*/
|
|
7322
7780
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7781
|
+
/**
|
|
7782
|
+
*
|
|
7783
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7784
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7785
|
+
* @param {*} [options] Override http request option.
|
|
7786
|
+
* @throws {RequiredError}
|
|
7787
|
+
*/
|
|
7788
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7323
7789
|
/**
|
|
7324
7790
|
*
|
|
7325
7791
|
* @summary Generate a QR code for authentication
|
|
@@ -7391,67 +7857,59 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7391
7857
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7392
7858
|
/**
|
|
7393
7859
|
*
|
|
7394
|
-
* @summary
|
|
7395
|
-
* @param {
|
|
7396
|
-
* @param {*} [options] Override http request option.
|
|
7397
|
-
* @throws {RequiredError}
|
|
7398
|
-
*/
|
|
7399
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7400
|
-
/**
|
|
7401
|
-
*
|
|
7402
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7860
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7861
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7403
7862
|
* @param {*} [options] Override http request option.
|
|
7404
7863
|
* @throws {RequiredError}
|
|
7405
7864
|
*/
|
|
7406
|
-
|
|
7865
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7407
7866
|
/**
|
|
7408
7867
|
*
|
|
7409
|
-
* @summary
|
|
7410
|
-
* @param {
|
|
7868
|
+
* @summary Mock login and hand out token.
|
|
7869
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7411
7870
|
* @param {*} [options] Override http request option.
|
|
7412
7871
|
* @throws {RequiredError}
|
|
7413
7872
|
*/
|
|
7414
|
-
|
|
7873
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7415
7874
|
/**
|
|
7416
7875
|
*
|
|
7417
|
-
* @summary
|
|
7418
|
-
* @param {
|
|
7876
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7877
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7419
7878
|
* @param {*} [options] Override http request option.
|
|
7420
7879
|
* @throws {RequiredError}
|
|
7421
7880
|
*/
|
|
7422
|
-
|
|
7881
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7423
7882
|
/**
|
|
7424
7883
|
*
|
|
7425
|
-
* @summary
|
|
7426
|
-
* @param {
|
|
7884
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7885
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7427
7886
|
* @param {*} [options] Override http request option.
|
|
7428
7887
|
* @throws {RequiredError}
|
|
7429
7888
|
*/
|
|
7430
|
-
|
|
7889
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7431
7890
|
/**
|
|
7432
7891
|
*
|
|
7433
|
-
* @summary
|
|
7434
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7892
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7435
7893
|
* @param {*} [options] Override http request option.
|
|
7436
7894
|
* @throws {RequiredError}
|
|
7437
7895
|
*/
|
|
7438
|
-
|
|
7896
|
+
refreshToken(options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7439
7897
|
/**
|
|
7440
7898
|
*
|
|
7441
|
-
* @summary
|
|
7442
|
-
* @param {
|
|
7899
|
+
* @summary Creates a reset token for the local authentication
|
|
7900
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7443
7901
|
* @param {*} [options] Override http request option.
|
|
7444
7902
|
* @throws {RequiredError}
|
|
7445
7903
|
*/
|
|
7446
|
-
|
|
7904
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7447
7905
|
/**
|
|
7448
7906
|
*
|
|
7449
|
-
* @summary
|
|
7450
|
-
* @param {
|
|
7907
|
+
* @summary Reset local authentication using the provided token
|
|
7908
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7451
7909
|
* @param {*} [options] Override http request option.
|
|
7452
7910
|
* @throws {RequiredError}
|
|
7453
7911
|
*/
|
|
7454
|
-
|
|
7912
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7455
7913
|
};
|
|
7456
7914
|
/**
|
|
7457
7915
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7492,6 +7950,19 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7492
7950
|
*/
|
|
7493
7951
|
readonly sessionId: string;
|
|
7494
7952
|
}
|
|
7953
|
+
/**
|
|
7954
|
+
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7955
|
+
* @export
|
|
7956
|
+
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7957
|
+
*/
|
|
7958
|
+
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7959
|
+
/**
|
|
7960
|
+
* The EAN login request with posId
|
|
7961
|
+
* @type {AuthenticationEanRequest}
|
|
7962
|
+
* @memberof AuthenticateApiEanAuthentication
|
|
7963
|
+
*/
|
|
7964
|
+
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7965
|
+
}
|
|
7495
7966
|
/**
|
|
7496
7967
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7497
7968
|
* @export
|
|
@@ -7571,7 +8042,20 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7571
8042
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7572
8043
|
}
|
|
7573
8044
|
/**
|
|
7574
|
-
* Request parameters for
|
|
8045
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
8046
|
+
* @export
|
|
8047
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
8048
|
+
*/
|
|
8049
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
8050
|
+
/**
|
|
8051
|
+
* The PIN login request with posId
|
|
8052
|
+
* @type {MemberAuthenticationPinRequest}
|
|
8053
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
8054
|
+
*/
|
|
8055
|
+
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
8056
|
+
}
|
|
8057
|
+
/**
|
|
8058
|
+
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7575
8059
|
* @export
|
|
7576
8060
|
* @interface AuthenticateApiMockAuthenticationRequest
|
|
7577
8061
|
*/
|
|
@@ -7583,6 +8067,32 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7583
8067
|
*/
|
|
7584
8068
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7585
8069
|
}
|
|
8070
|
+
/**
|
|
8071
|
+
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
8072
|
+
* @export
|
|
8073
|
+
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
8074
|
+
*/
|
|
8075
|
+
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
8076
|
+
/**
|
|
8077
|
+
* The NFC login request with posId
|
|
8078
|
+
* @type {AuthenticationNfcRequest}
|
|
8079
|
+
* @memberof AuthenticateApiNfcAuthentication
|
|
8080
|
+
*/
|
|
8081
|
+
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
8082
|
+
}
|
|
8083
|
+
/**
|
|
8084
|
+
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
8085
|
+
* @export
|
|
8086
|
+
* @interface AuthenticateApiPinAuthenticationRequest
|
|
8087
|
+
*/
|
|
8088
|
+
export interface AuthenticateApiPinAuthenticationRequest {
|
|
8089
|
+
/**
|
|
8090
|
+
* The PIN login request with posId
|
|
8091
|
+
* @type {AuthenticationPinRequest}
|
|
8092
|
+
* @memberof AuthenticateApiPinAuthentication
|
|
8093
|
+
*/
|
|
8094
|
+
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
8095
|
+
}
|
|
7586
8096
|
/**
|
|
7587
8097
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7588
8098
|
* @export
|
|
@@ -7609,58 +8119,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7609
8119
|
*/
|
|
7610
8120
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7611
8121
|
}
|
|
7612
|
-
/**
|
|
7613
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7614
|
-
* @export
|
|
7615
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7616
|
-
*/
|
|
7617
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7618
|
-
/**
|
|
7619
|
-
* The EAN login request with posId
|
|
7620
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7621
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7622
|
-
*/
|
|
7623
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7624
|
-
}
|
|
7625
|
-
/**
|
|
7626
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7627
|
-
* @export
|
|
7628
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7629
|
-
*/
|
|
7630
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7631
|
-
/**
|
|
7632
|
-
* The PIN login request with posId
|
|
7633
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7634
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7635
|
-
*/
|
|
7636
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7637
|
-
}
|
|
7638
|
-
/**
|
|
7639
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7640
|
-
* @export
|
|
7641
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7642
|
-
*/
|
|
7643
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7644
|
-
/**
|
|
7645
|
-
* The NFC login request with posId
|
|
7646
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7647
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7648
|
-
*/
|
|
7649
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7650
|
-
}
|
|
7651
|
-
/**
|
|
7652
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7653
|
-
* @export
|
|
7654
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7655
|
-
*/
|
|
7656
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7657
|
-
/**
|
|
7658
|
-
* The PIN login request with posId
|
|
7659
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7660
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7661
|
-
*/
|
|
7662
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7663
|
-
}
|
|
7664
8122
|
/**
|
|
7665
8123
|
* AuthenticateApi - object-oriented interface
|
|
7666
8124
|
* @export
|
|
@@ -7695,6 +8153,15 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7695
8153
|
* @memberof AuthenticateApi
|
|
7696
8154
|
*/
|
|
7697
8155
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8156
|
+
/**
|
|
8157
|
+
*
|
|
8158
|
+
* @summary EAN authentication that requires POS user authentication
|
|
8159
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
8160
|
+
* @param {*} [options] Override http request option.
|
|
8161
|
+
* @throws {RequiredError}
|
|
8162
|
+
* @memberof AuthenticateApi
|
|
8163
|
+
*/
|
|
8164
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7698
8165
|
/**
|
|
7699
8166
|
*
|
|
7700
8167
|
* @summary Generate a QR code for authentication
|
|
@@ -7775,75 +8242,66 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7775
8242
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7776
8243
|
/**
|
|
7777
8244
|
*
|
|
7778
|
-
* @summary
|
|
7779
|
-
* @param {
|
|
8245
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8246
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7780
8247
|
* @param {*} [options] Override http request option.
|
|
7781
8248
|
* @throws {RequiredError}
|
|
7782
8249
|
* @memberof AuthenticateApi
|
|
7783
8250
|
*/
|
|
7784
|
-
|
|
8251
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7785
8252
|
/**
|
|
7786
8253
|
*
|
|
7787
|
-
* @summary
|
|
7788
|
-
* @param {
|
|
7789
|
-
* @throws {RequiredError}
|
|
7790
|
-
* @memberof AuthenticateApi
|
|
7791
|
-
*/
|
|
7792
|
-
refreshToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7793
|
-
/**
|
|
7794
|
-
*
|
|
7795
|
-
* @summary Creates a reset token for the local authentication
|
|
7796
|
-
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
8254
|
+
* @summary Mock login and hand out token.
|
|
8255
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7797
8256
|
* @param {*} [options] Override http request option.
|
|
7798
8257
|
* @throws {RequiredError}
|
|
7799
8258
|
* @memberof AuthenticateApi
|
|
7800
8259
|
*/
|
|
7801
|
-
|
|
8260
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7802
8261
|
/**
|
|
7803
8262
|
*
|
|
7804
|
-
* @summary
|
|
7805
|
-
* @param {
|
|
8263
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8264
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7806
8265
|
* @param {*} [options] Override http request option.
|
|
7807
8266
|
* @throws {RequiredError}
|
|
7808
8267
|
* @memberof AuthenticateApi
|
|
7809
8268
|
*/
|
|
7810
|
-
|
|
8269
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7811
8270
|
/**
|
|
7812
8271
|
*
|
|
7813
|
-
* @summary
|
|
7814
|
-
* @param {
|
|
8272
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8273
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7815
8274
|
* @param {*} [options] Override http request option.
|
|
7816
8275
|
* @throws {RequiredError}
|
|
7817
8276
|
* @memberof AuthenticateApi
|
|
7818
8277
|
*/
|
|
7819
|
-
|
|
8278
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7820
8279
|
/**
|
|
7821
8280
|
*
|
|
7822
|
-
* @summary
|
|
7823
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8281
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7824
8282
|
* @param {*} [options] Override http request option.
|
|
7825
8283
|
* @throws {RequiredError}
|
|
7826
8284
|
* @memberof AuthenticateApi
|
|
7827
8285
|
*/
|
|
7828
|
-
|
|
8286
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7829
8287
|
/**
|
|
7830
8288
|
*
|
|
7831
|
-
* @summary
|
|
7832
|
-
* @param {
|
|
8289
|
+
* @summary Creates a reset token for the local authentication
|
|
8290
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7833
8291
|
* @param {*} [options] Override http request option.
|
|
7834
8292
|
* @throws {RequiredError}
|
|
7835
8293
|
* @memberof AuthenticateApi
|
|
7836
8294
|
*/
|
|
7837
|
-
|
|
8295
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7838
8296
|
/**
|
|
7839
8297
|
*
|
|
7840
|
-
* @summary
|
|
7841
|
-
* @param {
|
|
8298
|
+
* @summary Reset local authentication using the provided token
|
|
8299
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7842
8300
|
* @param {*} [options] Override http request option.
|
|
7843
8301
|
* @throws {RequiredError}
|
|
7844
8302
|
* @memberof AuthenticateApi
|
|
7845
8303
|
*/
|
|
7846
|
-
|
|
8304
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7847
8305
|
}
|
|
7848
8306
|
/**
|
|
7849
8307
|
* BalanceApi - axios parameter creator
|
|
@@ -11035,7 +11493,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11035
11493
|
* @param {*} [options] Override http request option.
|
|
11036
11494
|
* @throws {RequiredError}
|
|
11037
11495
|
*/
|
|
11038
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11496
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11039
11497
|
/**
|
|
11040
11498
|
*
|
|
11041
11499
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11132,7 +11590,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11132
11590
|
* @param {*} [options] Override http request option.
|
|
11133
11591
|
* @throws {RequiredError}
|
|
11134
11592
|
*/
|
|
11135
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11593
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11136
11594
|
/**
|
|
11137
11595
|
*
|
|
11138
11596
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11446,7 +11904,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11446
11904
|
* @throws {RequiredError}
|
|
11447
11905
|
* @memberof InvoicesApi
|
|
11448
11906
|
*/
|
|
11449
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
|
|
11907
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11450
11908
|
/**
|
|
11451
11909
|
*
|
|
11452
11910
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11501,6 +11959,492 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11501
11959
|
*/
|
|
11502
11960
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11503
11961
|
}
|
|
11962
|
+
/**
|
|
11963
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11964
|
+
* @export
|
|
11965
|
+
*/
|
|
11966
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11967
|
+
/**
|
|
11968
|
+
*
|
|
11969
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11970
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11971
|
+
* @param {*} [options] Override http request option.
|
|
11972
|
+
* @throws {RequiredError}
|
|
11973
|
+
*/
|
|
11974
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11975
|
+
/**
|
|
11976
|
+
*
|
|
11977
|
+
* @summary Create a new PaymentRequest.
|
|
11978
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11979
|
+
* @param {*} [options] Override http request option.
|
|
11980
|
+
* @throws {RequiredError}
|
|
11981
|
+
*/
|
|
11982
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11983
|
+
/**
|
|
11984
|
+
*
|
|
11985
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11986
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11987
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11988
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11989
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11990
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11991
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11992
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11993
|
+
* @param {*} [options] Override http request option.
|
|
11994
|
+
* @throws {RequiredError}
|
|
11995
|
+
*/
|
|
11996
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11997
|
+
/**
|
|
11998
|
+
*
|
|
11999
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12000
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12001
|
+
* @param {*} [options] Override http request option.
|
|
12002
|
+
* @throws {RequiredError}
|
|
12003
|
+
*/
|
|
12004
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12005
|
+
/**
|
|
12006
|
+
*
|
|
12007
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12008
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12009
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
12010
|
+
* @param {*} [options] Override http request option.
|
|
12011
|
+
* @throws {RequiredError}
|
|
12012
|
+
*/
|
|
12013
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12014
|
+
/**
|
|
12015
|
+
*
|
|
12016
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12017
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12018
|
+
* @param {*} [options] Override http request option.
|
|
12019
|
+
* @throws {RequiredError}
|
|
12020
|
+
*/
|
|
12021
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12022
|
+
};
|
|
12023
|
+
/**
|
|
12024
|
+
* PaymentRequestsApi - functional programming interface
|
|
12025
|
+
* @export
|
|
12026
|
+
*/
|
|
12027
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
12028
|
+
/**
|
|
12029
|
+
*
|
|
12030
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12031
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12032
|
+
* @param {*} [options] Override http request option.
|
|
12033
|
+
* @throws {RequiredError}
|
|
12034
|
+
*/
|
|
12035
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12036
|
+
/**
|
|
12037
|
+
*
|
|
12038
|
+
* @summary Create a new PaymentRequest.
|
|
12039
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
12040
|
+
* @param {*} [options] Override http request option.
|
|
12041
|
+
* @throws {RequiredError}
|
|
12042
|
+
*/
|
|
12043
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12044
|
+
/**
|
|
12045
|
+
*
|
|
12046
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12047
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
12048
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
12049
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
12050
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
12051
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
12052
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
12053
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
12054
|
+
* @param {*} [options] Override http request option.
|
|
12055
|
+
* @throws {RequiredError}
|
|
12056
|
+
*/
|
|
12057
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
12058
|
+
/**
|
|
12059
|
+
*
|
|
12060
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12061
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12062
|
+
* @param {*} [options] Override http request option.
|
|
12063
|
+
* @throws {RequiredError}
|
|
12064
|
+
*/
|
|
12065
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12066
|
+
/**
|
|
12067
|
+
*
|
|
12068
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12069
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12070
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
12071
|
+
* @param {*} [options] Override http request option.
|
|
12072
|
+
* @throws {RequiredError}
|
|
12073
|
+
*/
|
|
12074
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12075
|
+
/**
|
|
12076
|
+
*
|
|
12077
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12078
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12079
|
+
* @param {*} [options] Override http request option.
|
|
12080
|
+
* @throws {RequiredError}
|
|
12081
|
+
*/
|
|
12082
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12083
|
+
};
|
|
12084
|
+
/**
|
|
12085
|
+
* PaymentRequestsApi - factory interface
|
|
12086
|
+
* @export
|
|
12087
|
+
*/
|
|
12088
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12089
|
+
/**
|
|
12090
|
+
*
|
|
12091
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12092
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12093
|
+
* @param {*} [options] Override http request option.
|
|
12094
|
+
* @throws {RequiredError}
|
|
12095
|
+
*/
|
|
12096
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12097
|
+
/**
|
|
12098
|
+
*
|
|
12099
|
+
* @summary Create a new PaymentRequest.
|
|
12100
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12101
|
+
* @param {*} [options] Override http request option.
|
|
12102
|
+
* @throws {RequiredError}
|
|
12103
|
+
*/
|
|
12104
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12105
|
+
/**
|
|
12106
|
+
*
|
|
12107
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12108
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12109
|
+
* @param {*} [options] Override http request option.
|
|
12110
|
+
* @throws {RequiredError}
|
|
12111
|
+
*/
|
|
12112
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
12113
|
+
/**
|
|
12114
|
+
*
|
|
12115
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12116
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12117
|
+
* @param {*} [options] Override http request option.
|
|
12118
|
+
* @throws {RequiredError}
|
|
12119
|
+
*/
|
|
12120
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12121
|
+
/**
|
|
12122
|
+
*
|
|
12123
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12124
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12125
|
+
* @param {*} [options] Override http request option.
|
|
12126
|
+
* @throws {RequiredError}
|
|
12127
|
+
*/
|
|
12128
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12129
|
+
/**
|
|
12130
|
+
*
|
|
12131
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12132
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12133
|
+
* @param {*} [options] Override http request option.
|
|
12134
|
+
* @throws {RequiredError}
|
|
12135
|
+
*/
|
|
12136
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12137
|
+
};
|
|
12138
|
+
/**
|
|
12139
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
12140
|
+
* @export
|
|
12141
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
12142
|
+
*/
|
|
12143
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
12144
|
+
/**
|
|
12145
|
+
* UUID v4 of the payment request.
|
|
12146
|
+
* @type {string}
|
|
12147
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
12148
|
+
*/
|
|
12149
|
+
readonly id: string;
|
|
12150
|
+
}
|
|
12151
|
+
/**
|
|
12152
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
12153
|
+
* @export
|
|
12154
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
12155
|
+
*/
|
|
12156
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
12157
|
+
/**
|
|
12158
|
+
* The request to create
|
|
12159
|
+
* @type {CreatePaymentRequestRequest}
|
|
12160
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
12161
|
+
*/
|
|
12162
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
12163
|
+
}
|
|
12164
|
+
/**
|
|
12165
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
12166
|
+
* @export
|
|
12167
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
12168
|
+
*/
|
|
12169
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
12170
|
+
/**
|
|
12171
|
+
* Filter by beneficiary user id.
|
|
12172
|
+
* @type {number}
|
|
12173
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12174
|
+
*/
|
|
12175
|
+
readonly forId?: number;
|
|
12176
|
+
/**
|
|
12177
|
+
* Filter by creator user id.
|
|
12178
|
+
* @type {number}
|
|
12179
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12180
|
+
*/
|
|
12181
|
+
readonly createdById?: number;
|
|
12182
|
+
/**
|
|
12183
|
+
* Comma-separated list of derived statuses.
|
|
12184
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12185
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12186
|
+
*/
|
|
12187
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12188
|
+
/**
|
|
12189
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12190
|
+
* @type {string}
|
|
12191
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12192
|
+
*/
|
|
12193
|
+
readonly fromDate?: string;
|
|
12194
|
+
/**
|
|
12195
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12196
|
+
* @type {string}
|
|
12197
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12198
|
+
*/
|
|
12199
|
+
readonly tillDate?: string;
|
|
12200
|
+
/**
|
|
12201
|
+
* How many rows the endpoint should return
|
|
12202
|
+
* @type {number}
|
|
12203
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12204
|
+
*/
|
|
12205
|
+
readonly take?: number;
|
|
12206
|
+
/**
|
|
12207
|
+
* How many rows to skip (for pagination)
|
|
12208
|
+
* @type {number}
|
|
12209
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12210
|
+
*/
|
|
12211
|
+
readonly skip?: number;
|
|
12212
|
+
}
|
|
12213
|
+
/**
|
|
12214
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
12215
|
+
* @export
|
|
12216
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
12217
|
+
*/
|
|
12218
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
12219
|
+
/**
|
|
12220
|
+
* UUID v4 of the payment request.
|
|
12221
|
+
* @type {string}
|
|
12222
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12223
|
+
*/
|
|
12224
|
+
readonly id: string;
|
|
12225
|
+
}
|
|
12226
|
+
/**
|
|
12227
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12228
|
+
* @export
|
|
12229
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12230
|
+
*/
|
|
12231
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
12232
|
+
/**
|
|
12233
|
+
* UUID v4 of the payment request.
|
|
12234
|
+
* @type {string}
|
|
12235
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12236
|
+
*/
|
|
12237
|
+
readonly id: string;
|
|
12238
|
+
/**
|
|
12239
|
+
* The audit reason
|
|
12240
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12241
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12242
|
+
*/
|
|
12243
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12244
|
+
}
|
|
12245
|
+
/**
|
|
12246
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12247
|
+
* @export
|
|
12248
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12249
|
+
*/
|
|
12250
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12251
|
+
/**
|
|
12252
|
+
* UUID v4 of the payment request.
|
|
12253
|
+
* @type {string}
|
|
12254
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12255
|
+
*/
|
|
12256
|
+
readonly id: string;
|
|
12257
|
+
}
|
|
12258
|
+
/**
|
|
12259
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12260
|
+
* @export
|
|
12261
|
+
* @class PaymentRequestsApi
|
|
12262
|
+
* @extends {BaseAPI}
|
|
12263
|
+
*/
|
|
12264
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12265
|
+
/**
|
|
12266
|
+
*
|
|
12267
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12268
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12269
|
+
* @param {*} [options] Override http request option.
|
|
12270
|
+
* @throws {RequiredError}
|
|
12271
|
+
* @memberof PaymentRequestsApi
|
|
12272
|
+
*/
|
|
12273
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12274
|
+
/**
|
|
12275
|
+
*
|
|
12276
|
+
* @summary Create a new PaymentRequest.
|
|
12277
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12278
|
+
* @param {*} [options] Override http request option.
|
|
12279
|
+
* @throws {RequiredError}
|
|
12280
|
+
* @memberof PaymentRequestsApi
|
|
12281
|
+
*/
|
|
12282
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12283
|
+
/**
|
|
12284
|
+
*
|
|
12285
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12286
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12287
|
+
* @param {*} [options] Override http request option.
|
|
12288
|
+
* @throws {RequiredError}
|
|
12289
|
+
* @memberof PaymentRequestsApi
|
|
12290
|
+
*/
|
|
12291
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12292
|
+
/**
|
|
12293
|
+
*
|
|
12294
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12295
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12296
|
+
* @param {*} [options] Override http request option.
|
|
12297
|
+
* @throws {RequiredError}
|
|
12298
|
+
* @memberof PaymentRequestsApi
|
|
12299
|
+
*/
|
|
12300
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12301
|
+
/**
|
|
12302
|
+
*
|
|
12303
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12304
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12305
|
+
* @param {*} [options] Override http request option.
|
|
12306
|
+
* @throws {RequiredError}
|
|
12307
|
+
* @memberof PaymentRequestsApi
|
|
12308
|
+
*/
|
|
12309
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12310
|
+
/**
|
|
12311
|
+
*
|
|
12312
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12313
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12314
|
+
* @param {*} [options] Override http request option.
|
|
12315
|
+
* @throws {RequiredError}
|
|
12316
|
+
* @memberof PaymentRequestsApi
|
|
12317
|
+
*/
|
|
12318
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12319
|
+
}
|
|
12320
|
+
/**
|
|
12321
|
+
* @export
|
|
12322
|
+
*/
|
|
12323
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12324
|
+
readonly Pending: "PENDING";
|
|
12325
|
+
readonly Paid: "PAID";
|
|
12326
|
+
readonly Expired: "EXPIRED";
|
|
12327
|
+
readonly Cancelled: "CANCELLED";
|
|
12328
|
+
};
|
|
12329
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12330
|
+
/**
|
|
12331
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12332
|
+
* @export
|
|
12333
|
+
*/
|
|
12334
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12335
|
+
/**
|
|
12336
|
+
*
|
|
12337
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12338
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12339
|
+
* @param {*} [options] Override http request option.
|
|
12340
|
+
* @throws {RequiredError}
|
|
12341
|
+
*/
|
|
12342
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12343
|
+
/**
|
|
12344
|
+
*
|
|
12345
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12346
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12347
|
+
* @param {*} [options] Override http request option.
|
|
12348
|
+
* @throws {RequiredError}
|
|
12349
|
+
*/
|
|
12350
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12351
|
+
};
|
|
12352
|
+
/**
|
|
12353
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12354
|
+
* @export
|
|
12355
|
+
*/
|
|
12356
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
12357
|
+
/**
|
|
12358
|
+
*
|
|
12359
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12360
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12361
|
+
* @param {*} [options] Override http request option.
|
|
12362
|
+
* @throws {RequiredError}
|
|
12363
|
+
*/
|
|
12364
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
12365
|
+
/**
|
|
12366
|
+
*
|
|
12367
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12368
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12369
|
+
* @param {*} [options] Override http request option.
|
|
12370
|
+
* @throws {RequiredError}
|
|
12371
|
+
*/
|
|
12372
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12373
|
+
};
|
|
12374
|
+
/**
|
|
12375
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12376
|
+
* @export
|
|
12377
|
+
*/
|
|
12378
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12379
|
+
/**
|
|
12380
|
+
*
|
|
12381
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12382
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12383
|
+
* @param {*} [options] Override http request option.
|
|
12384
|
+
* @throws {RequiredError}
|
|
12385
|
+
*/
|
|
12386
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12387
|
+
/**
|
|
12388
|
+
*
|
|
12389
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12390
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12391
|
+
* @param {*} [options] Override http request option.
|
|
12392
|
+
* @throws {RequiredError}
|
|
12393
|
+
*/
|
|
12394
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12395
|
+
};
|
|
12396
|
+
/**
|
|
12397
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12398
|
+
* @export
|
|
12399
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12400
|
+
*/
|
|
12401
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12402
|
+
/**
|
|
12403
|
+
* UUID v4 of the payment request.
|
|
12404
|
+
* @type {string}
|
|
12405
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12406
|
+
*/
|
|
12407
|
+
readonly id: string;
|
|
12408
|
+
}
|
|
12409
|
+
/**
|
|
12410
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12411
|
+
* @export
|
|
12412
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12413
|
+
*/
|
|
12414
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12415
|
+
/**
|
|
12416
|
+
* UUID v4 of the payment request.
|
|
12417
|
+
* @type {string}
|
|
12418
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12419
|
+
*/
|
|
12420
|
+
readonly id: string;
|
|
12421
|
+
}
|
|
12422
|
+
/**
|
|
12423
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12424
|
+
* @export
|
|
12425
|
+
* @class PaymentRequestsPublicApi
|
|
12426
|
+
* @extends {BaseAPI}
|
|
12427
|
+
*/
|
|
12428
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12429
|
+
/**
|
|
12430
|
+
*
|
|
12431
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12432
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12433
|
+
* @param {*} [options] Override http request option.
|
|
12434
|
+
* @throws {RequiredError}
|
|
12435
|
+
* @memberof PaymentRequestsPublicApi
|
|
12436
|
+
*/
|
|
12437
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12438
|
+
/**
|
|
12439
|
+
*
|
|
12440
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12441
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12442
|
+
* @param {*} [options] Override http request option.
|
|
12443
|
+
* @throws {RequiredError}
|
|
12444
|
+
* @memberof PaymentRequestsPublicApi
|
|
12445
|
+
*/
|
|
12446
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12447
|
+
}
|
|
11504
12448
|
/**
|
|
11505
12449
|
* PayoutRequestsApi - axios parameter creator
|
|
11506
12450
|
* @export
|
|
@@ -13966,6 +14910,13 @@ export declare const StripeApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
13966
14910
|
* @throws {RequiredError}
|
|
13967
14911
|
*/
|
|
13968
14912
|
getStripePublicKey: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14913
|
+
/**
|
|
14914
|
+
*
|
|
14915
|
+
* @summary Webhook for Stripe event updates
|
|
14916
|
+
* @param {*} [options] Override http request option.
|
|
14917
|
+
* @throws {RequiredError}
|
|
14918
|
+
*/
|
|
14919
|
+
webhook: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13969
14920
|
};
|
|
13970
14921
|
/**
|
|
13971
14922
|
* StripeApi - functional programming interface
|
|
@@ -13987,6 +14938,13 @@ export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
|
13987
14938
|
* @throws {RequiredError}
|
|
13988
14939
|
*/
|
|
13989
14940
|
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14941
|
+
/**
|
|
14942
|
+
*
|
|
14943
|
+
* @summary Webhook for Stripe event updates
|
|
14944
|
+
* @param {*} [options] Override http request option.
|
|
14945
|
+
* @throws {RequiredError}
|
|
14946
|
+
*/
|
|
14947
|
+
webhook(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
13990
14948
|
};
|
|
13991
14949
|
/**
|
|
13992
14950
|
* StripeApi - factory interface
|
|
@@ -14008,6 +14966,13 @@ export declare const StripeApiFactory: (configuration?: Configuration, basePath?
|
|
|
14008
14966
|
* @throws {RequiredError}
|
|
14009
14967
|
*/
|
|
14010
14968
|
getStripePublicKey(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
14969
|
+
/**
|
|
14970
|
+
*
|
|
14971
|
+
* @summary Webhook for Stripe event updates
|
|
14972
|
+
* @param {*} [options] Override http request option.
|
|
14973
|
+
* @throws {RequiredError}
|
|
14974
|
+
*/
|
|
14975
|
+
webhook(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
14011
14976
|
};
|
|
14012
14977
|
/**
|
|
14013
14978
|
* Request parameters for deposit operation in StripeApi.
|
|
@@ -14046,6 +15011,14 @@ export declare class StripeApi extends BaseAPI {
|
|
|
14046
15011
|
* @memberof StripeApi
|
|
14047
15012
|
*/
|
|
14048
15013
|
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
15014
|
+
/**
|
|
15015
|
+
*
|
|
15016
|
+
* @summary Webhook for Stripe event updates
|
|
15017
|
+
* @param {*} [options] Override http request option.
|
|
15018
|
+
* @throws {RequiredError}
|
|
15019
|
+
* @memberof StripeApi
|
|
15020
|
+
*/
|
|
15021
|
+
webhook(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
14049
15022
|
}
|
|
14050
15023
|
/**
|
|
14051
15024
|
* SyncApi - axios parameter creator
|
|
@@ -14127,6 +15100,253 @@ export declare const GetUserSyncResultsServiceEnum: {
|
|
|
14127
15100
|
readonly Gewisdb: "GEWISDB";
|
|
14128
15101
|
};
|
|
14129
15102
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
15103
|
+
/**
|
|
15104
|
+
* TerminalPaymentsApi - axios parameter creator
|
|
15105
|
+
* @export
|
|
15106
|
+
*/
|
|
15107
|
+
export declare const TerminalPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15108
|
+
/**
|
|
15109
|
+
*
|
|
15110
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15111
|
+
* @param {number} id The ID of the terminal payment
|
|
15112
|
+
* @param {*} [options] Override http request option.
|
|
15113
|
+
* @throws {RequiredError}
|
|
15114
|
+
*/
|
|
15115
|
+
cancelTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15116
|
+
/**
|
|
15117
|
+
*
|
|
15118
|
+
* @summary Create a terminal payment before executing.
|
|
15119
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15120
|
+
* @param {*} [options] Override http request option.
|
|
15121
|
+
* @throws {RequiredError}
|
|
15122
|
+
*/
|
|
15123
|
+
createTerminalPayment: (createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15124
|
+
/**
|
|
15125
|
+
*
|
|
15126
|
+
* @summary Get single terminal payment by ID
|
|
15127
|
+
* @param {number} id The ID of the terminal payment
|
|
15128
|
+
* @param {*} [options] Override http request option.
|
|
15129
|
+
* @throws {RequiredError}
|
|
15130
|
+
*/
|
|
15131
|
+
getSingleTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15132
|
+
/**
|
|
15133
|
+
*
|
|
15134
|
+
* @summary Get all Stripe terminals
|
|
15135
|
+
* @param {*} [options] Override http request option.
|
|
15136
|
+
* @throws {RequiredError}
|
|
15137
|
+
*/
|
|
15138
|
+
getStripeTerminals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15139
|
+
/**
|
|
15140
|
+
*
|
|
15141
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15142
|
+
* @param {number} id The ID of the terminal payment
|
|
15143
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15144
|
+
* @param {*} [options] Override http request option.
|
|
15145
|
+
* @throws {RequiredError}
|
|
15146
|
+
*/
|
|
15147
|
+
startTerminalPayment: (id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15148
|
+
};
|
|
15149
|
+
/**
|
|
15150
|
+
* TerminalPaymentsApi - functional programming interface
|
|
15151
|
+
* @export
|
|
15152
|
+
*/
|
|
15153
|
+
export declare const TerminalPaymentsApiFp: (configuration?: Configuration) => {
|
|
15154
|
+
/**
|
|
15155
|
+
*
|
|
15156
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15157
|
+
* @param {number} id The ID of the terminal payment
|
|
15158
|
+
* @param {*} [options] Override http request option.
|
|
15159
|
+
* @throws {RequiredError}
|
|
15160
|
+
*/
|
|
15161
|
+
cancelTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15162
|
+
/**
|
|
15163
|
+
*
|
|
15164
|
+
* @summary Create a terminal payment before executing.
|
|
15165
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15166
|
+
* @param {*} [options] Override http request option.
|
|
15167
|
+
* @throws {RequiredError}
|
|
15168
|
+
*/
|
|
15169
|
+
createTerminalPayment(createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15170
|
+
/**
|
|
15171
|
+
*
|
|
15172
|
+
* @summary Get single terminal payment by ID
|
|
15173
|
+
* @param {number} id The ID of the terminal payment
|
|
15174
|
+
* @param {*} [options] Override http request option.
|
|
15175
|
+
* @throws {RequiredError}
|
|
15176
|
+
*/
|
|
15177
|
+
getSingleTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15178
|
+
/**
|
|
15179
|
+
*
|
|
15180
|
+
* @summary Get all Stripe terminals
|
|
15181
|
+
* @param {*} [options] Override http request option.
|
|
15182
|
+
* @throws {RequiredError}
|
|
15183
|
+
*/
|
|
15184
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<StripePaymentTerminalResponse>>>;
|
|
15185
|
+
/**
|
|
15186
|
+
*
|
|
15187
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15188
|
+
* @param {number} id The ID of the terminal payment
|
|
15189
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15190
|
+
* @param {*} [options] Override http request option.
|
|
15191
|
+
* @throws {RequiredError}
|
|
15192
|
+
*/
|
|
15193
|
+
startTerminalPayment(id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15194
|
+
};
|
|
15195
|
+
/**
|
|
15196
|
+
* TerminalPaymentsApi - factory interface
|
|
15197
|
+
* @export
|
|
15198
|
+
*/
|
|
15199
|
+
export declare const TerminalPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15200
|
+
/**
|
|
15201
|
+
*
|
|
15202
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15203
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
15204
|
+
* @param {*} [options] Override http request option.
|
|
15205
|
+
* @throws {RequiredError}
|
|
15206
|
+
*/
|
|
15207
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15208
|
+
/**
|
|
15209
|
+
*
|
|
15210
|
+
* @summary Create a terminal payment before executing.
|
|
15211
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15212
|
+
* @param {*} [options] Override http request option.
|
|
15213
|
+
* @throws {RequiredError}
|
|
15214
|
+
*/
|
|
15215
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15216
|
+
/**
|
|
15217
|
+
*
|
|
15218
|
+
* @summary Get single terminal payment by ID
|
|
15219
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15220
|
+
* @param {*} [options] Override http request option.
|
|
15221
|
+
* @throws {RequiredError}
|
|
15222
|
+
*/
|
|
15223
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15224
|
+
/**
|
|
15225
|
+
*
|
|
15226
|
+
* @summary Get all Stripe terminals
|
|
15227
|
+
* @param {*} [options] Override http request option.
|
|
15228
|
+
* @throws {RequiredError}
|
|
15229
|
+
*/
|
|
15230
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): AxiosPromise<Array<StripePaymentTerminalResponse>>;
|
|
15231
|
+
/**
|
|
15232
|
+
*
|
|
15233
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15234
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
15235
|
+
* @param {*} [options] Override http request option.
|
|
15236
|
+
* @throws {RequiredError}
|
|
15237
|
+
*/
|
|
15238
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15239
|
+
};
|
|
15240
|
+
/**
|
|
15241
|
+
* Request parameters for cancelTerminalPayment operation in TerminalPaymentsApi.
|
|
15242
|
+
* @export
|
|
15243
|
+
* @interface TerminalPaymentsApiCancelTerminalPaymentRequest
|
|
15244
|
+
*/
|
|
15245
|
+
export interface TerminalPaymentsApiCancelTerminalPaymentRequest {
|
|
15246
|
+
/**
|
|
15247
|
+
* The ID of the terminal payment
|
|
15248
|
+
* @type {number}
|
|
15249
|
+
* @memberof TerminalPaymentsApiCancelTerminalPayment
|
|
15250
|
+
*/
|
|
15251
|
+
readonly id: number;
|
|
15252
|
+
}
|
|
15253
|
+
/**
|
|
15254
|
+
* Request parameters for createTerminalPayment operation in TerminalPaymentsApi.
|
|
15255
|
+
* @export
|
|
15256
|
+
* @interface TerminalPaymentsApiCreateTerminalPaymentRequest
|
|
15257
|
+
*/
|
|
15258
|
+
export interface TerminalPaymentsApiCreateTerminalPaymentRequest {
|
|
15259
|
+
/**
|
|
15260
|
+
* The terminal payment that should be created.
|
|
15261
|
+
* @type {CreateTerminalPaymentRequest}
|
|
15262
|
+
* @memberof TerminalPaymentsApiCreateTerminalPayment
|
|
15263
|
+
*/
|
|
15264
|
+
readonly createTerminalPaymentRequest: CreateTerminalPaymentRequest;
|
|
15265
|
+
}
|
|
15266
|
+
/**
|
|
15267
|
+
* Request parameters for getSingleTerminalPayment operation in TerminalPaymentsApi.
|
|
15268
|
+
* @export
|
|
15269
|
+
* @interface TerminalPaymentsApiGetSingleTerminalPaymentRequest
|
|
15270
|
+
*/
|
|
15271
|
+
export interface TerminalPaymentsApiGetSingleTerminalPaymentRequest {
|
|
15272
|
+
/**
|
|
15273
|
+
* The ID of the terminal payment
|
|
15274
|
+
* @type {number}
|
|
15275
|
+
* @memberof TerminalPaymentsApiGetSingleTerminalPayment
|
|
15276
|
+
*/
|
|
15277
|
+
readonly id: number;
|
|
15278
|
+
}
|
|
15279
|
+
/**
|
|
15280
|
+
* Request parameters for startTerminalPayment operation in TerminalPaymentsApi.
|
|
15281
|
+
* @export
|
|
15282
|
+
* @interface TerminalPaymentsApiStartTerminalPaymentRequest
|
|
15283
|
+
*/
|
|
15284
|
+
export interface TerminalPaymentsApiStartTerminalPaymentRequest {
|
|
15285
|
+
/**
|
|
15286
|
+
* The ID of the terminal payment
|
|
15287
|
+
* @type {number}
|
|
15288
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15289
|
+
*/
|
|
15290
|
+
readonly id: number;
|
|
15291
|
+
/**
|
|
15292
|
+
* Payment options
|
|
15293
|
+
* @type {ProcessTerminalPaymentRequest}
|
|
15294
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15295
|
+
*/
|
|
15296
|
+
readonly processTerminalPaymentRequest: ProcessTerminalPaymentRequest;
|
|
15297
|
+
}
|
|
15298
|
+
/**
|
|
15299
|
+
* TerminalPaymentsApi - object-oriented interface
|
|
15300
|
+
* @export
|
|
15301
|
+
* @class TerminalPaymentsApi
|
|
15302
|
+
* @extends {BaseAPI}
|
|
15303
|
+
*/
|
|
15304
|
+
export declare class TerminalPaymentsApi extends BaseAPI {
|
|
15305
|
+
/**
|
|
15306
|
+
*
|
|
15307
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15308
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
15309
|
+
* @param {*} [options] Override http request option.
|
|
15310
|
+
* @throws {RequiredError}
|
|
15311
|
+
* @memberof TerminalPaymentsApi
|
|
15312
|
+
*/
|
|
15313
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15314
|
+
/**
|
|
15315
|
+
*
|
|
15316
|
+
* @summary Create a terminal payment before executing.
|
|
15317
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15318
|
+
* @param {*} [options] Override http request option.
|
|
15319
|
+
* @throws {RequiredError}
|
|
15320
|
+
* @memberof TerminalPaymentsApi
|
|
15321
|
+
*/
|
|
15322
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15323
|
+
/**
|
|
15324
|
+
*
|
|
15325
|
+
* @summary Get single terminal payment by ID
|
|
15326
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15327
|
+
* @param {*} [options] Override http request option.
|
|
15328
|
+
* @throws {RequiredError}
|
|
15329
|
+
* @memberof TerminalPaymentsApi
|
|
15330
|
+
*/
|
|
15331
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15332
|
+
/**
|
|
15333
|
+
*
|
|
15334
|
+
* @summary Get all Stripe terminals
|
|
15335
|
+
* @param {*} [options] Override http request option.
|
|
15336
|
+
* @throws {RequiredError}
|
|
15337
|
+
* @memberof TerminalPaymentsApi
|
|
15338
|
+
*/
|
|
15339
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentTerminalResponse[], any, {}>>;
|
|
15340
|
+
/**
|
|
15341
|
+
*
|
|
15342
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15343
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
15344
|
+
* @param {*} [options] Override http request option.
|
|
15345
|
+
* @throws {RequiredError}
|
|
15346
|
+
* @memberof TerminalPaymentsApi
|
|
15347
|
+
*/
|
|
15348
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
15349
|
+
}
|
|
14130
15350
|
/**
|
|
14131
15351
|
* TermsOfServiceApi - axios parameter creator
|
|
14132
15352
|
* @export
|
|
@@ -15512,7 +16732,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15512
16732
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15513
16733
|
/**
|
|
15514
16734
|
*
|
|
15515
|
-
* @summary Accept the Terms of Service
|
|
16735
|
+
* @summary Accept the current Terms of Service version
|
|
15516
16736
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15517
16737
|
* @param {*} [options] Override http request option.
|
|
15518
16738
|
* @throws {RequiredError}
|
|
@@ -15642,6 +16862,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15642
16862
|
* @throws {RequiredError}
|
|
15643
16863
|
*/
|
|
15644
16864
|
getUserSettings: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16865
|
+
/**
|
|
16866
|
+
*
|
|
16867
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
16868
|
+
* @param {number} id The id of the user
|
|
16869
|
+
* @param {*} [options] Override http request option.
|
|
16870
|
+
* @throws {RequiredError}
|
|
16871
|
+
*/
|
|
16872
|
+
getUserTos: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15645
16873
|
/**
|
|
15646
16874
|
*
|
|
15647
16875
|
* @summary Returns the user\'s containers
|
|
@@ -15664,6 +16892,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15664
16892
|
* @throws {RequiredError}
|
|
15665
16893
|
*/
|
|
15666
16894
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16895
|
+
/**
|
|
16896
|
+
*
|
|
16897
|
+
* @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.
|
|
16898
|
+
* @param {number} id The id of the beneficiary user.
|
|
16899
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16900
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16901
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16902
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16903
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16904
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16905
|
+
* @param {*} [options] Override http request option.
|
|
16906
|
+
* @throws {RequiredError}
|
|
16907
|
+
*/
|
|
16908
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15667
16909
|
/**
|
|
15668
16910
|
*
|
|
15669
16911
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -15874,7 +17116,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15874
17116
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
15875
17117
|
/**
|
|
15876
17118
|
*
|
|
15877
|
-
* @summary Accept the Terms of Service
|
|
17119
|
+
* @summary Accept the current Terms of Service version
|
|
15878
17120
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15879
17121
|
* @param {*} [options] Override http request option.
|
|
15880
17122
|
* @throws {RequiredError}
|
|
@@ -16004,6 +17246,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16004
17246
|
* @throws {RequiredError}
|
|
16005
17247
|
*/
|
|
16006
17248
|
getUserSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettingsResponse>>;
|
|
17249
|
+
/**
|
|
17250
|
+
*
|
|
17251
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17252
|
+
* @param {number} id The id of the user
|
|
17253
|
+
* @param {*} [options] Override http request option.
|
|
17254
|
+
* @throws {RequiredError}
|
|
17255
|
+
*/
|
|
17256
|
+
getUserTos(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserTosResponse>>;
|
|
16007
17257
|
/**
|
|
16008
17258
|
*
|
|
16009
17259
|
* @summary Returns the user\'s containers
|
|
@@ -16026,6 +17276,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16026
17276
|
* @throws {RequiredError}
|
|
16027
17277
|
*/
|
|
16028
17278
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
17279
|
+
/**
|
|
17280
|
+
*
|
|
17281
|
+
* @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.
|
|
17282
|
+
* @param {number} id The id of the beneficiary user.
|
|
17283
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
17284
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
17285
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
17286
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
17287
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
17288
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
17289
|
+
* @param {*} [options] Override http request option.
|
|
17290
|
+
* @throws {RequiredError}
|
|
17291
|
+
*/
|
|
17292
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16029
17293
|
/**
|
|
16030
17294
|
*
|
|
16031
17295
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16236,7 +17500,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16236
17500
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16237
17501
|
/**
|
|
16238
17502
|
*
|
|
16239
|
-
* @summary Accept the Terms of Service
|
|
17503
|
+
* @summary Accept the current Terms of Service version
|
|
16240
17504
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16241
17505
|
* @param {*} [options] Override http request option.
|
|
16242
17506
|
* @throws {RequiredError}
|
|
@@ -16354,6 +17618,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16354
17618
|
* @throws {RequiredError}
|
|
16355
17619
|
*/
|
|
16356
17620
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserSettingsResponse>;
|
|
17621
|
+
/**
|
|
17622
|
+
*
|
|
17623
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17624
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
17625
|
+
* @param {*} [options] Override http request option.
|
|
17626
|
+
* @throws {RequiredError}
|
|
17627
|
+
*/
|
|
17628
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserTosResponse>;
|
|
16357
17629
|
/**
|
|
16358
17630
|
*
|
|
16359
17631
|
* @summary Returns the user\'s containers
|
|
@@ -16370,6 +17642,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16370
17642
|
* @throws {RequiredError}
|
|
16371
17643
|
*/
|
|
16372
17644
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17645
|
+
/**
|
|
17646
|
+
*
|
|
17647
|
+
* @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.
|
|
17648
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17649
|
+
* @param {*} [options] Override http request option.
|
|
17650
|
+
* @throws {RequiredError}
|
|
17651
|
+
*/
|
|
17652
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16373
17653
|
/**
|
|
16374
17654
|
*
|
|
16375
17655
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16799,6 +18079,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
16799
18079
|
*/
|
|
16800
18080
|
readonly id: number;
|
|
16801
18081
|
}
|
|
18082
|
+
/**
|
|
18083
|
+
* Request parameters for getUserTos operation in UsersApi.
|
|
18084
|
+
* @export
|
|
18085
|
+
* @interface UsersApiGetUserTosRequest
|
|
18086
|
+
*/
|
|
18087
|
+
export interface UsersApiGetUserTosRequest {
|
|
18088
|
+
/**
|
|
18089
|
+
* The id of the user
|
|
18090
|
+
* @type {number}
|
|
18091
|
+
* @memberof UsersApiGetUserTos
|
|
18092
|
+
*/
|
|
18093
|
+
readonly id: number;
|
|
18094
|
+
}
|
|
16802
18095
|
/**
|
|
16803
18096
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
16804
18097
|
* @export
|
|
@@ -16861,6 +18154,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16861
18154
|
*/
|
|
16862
18155
|
readonly skip?: number;
|
|
16863
18156
|
}
|
|
18157
|
+
/**
|
|
18158
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
18159
|
+
* @export
|
|
18160
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
18161
|
+
*/
|
|
18162
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
18163
|
+
/**
|
|
18164
|
+
* The id of the beneficiary user.
|
|
18165
|
+
* @type {number}
|
|
18166
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18167
|
+
*/
|
|
18168
|
+
readonly id: number;
|
|
18169
|
+
/**
|
|
18170
|
+
* Filter by creator user id.
|
|
18171
|
+
* @type {number}
|
|
18172
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18173
|
+
*/
|
|
18174
|
+
readonly createdById?: number;
|
|
18175
|
+
/**
|
|
18176
|
+
* Comma-separated list of derived statuses.
|
|
18177
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
18178
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18179
|
+
*/
|
|
18180
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
18181
|
+
/**
|
|
18182
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
18183
|
+
* @type {string}
|
|
18184
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18185
|
+
*/
|
|
18186
|
+
readonly fromDate?: string;
|
|
18187
|
+
/**
|
|
18188
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
18189
|
+
* @type {string}
|
|
18190
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18191
|
+
*/
|
|
18192
|
+
readonly tillDate?: string;
|
|
18193
|
+
/**
|
|
18194
|
+
* How many rows the endpoint should return
|
|
18195
|
+
* @type {number}
|
|
18196
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18197
|
+
*/
|
|
18198
|
+
readonly take?: number;
|
|
18199
|
+
/**
|
|
18200
|
+
* How many rows to skip (for pagination)
|
|
18201
|
+
* @type {number}
|
|
18202
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18203
|
+
*/
|
|
18204
|
+
readonly skip?: number;
|
|
18205
|
+
}
|
|
16864
18206
|
/**
|
|
16865
18207
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16866
18208
|
* @export
|
|
@@ -17376,7 +18718,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17376
18718
|
export declare class UsersApi extends BaseAPI {
|
|
17377
18719
|
/**
|
|
17378
18720
|
*
|
|
17379
|
-
* @summary Accept the Terms of Service
|
|
18721
|
+
* @summary Accept the current Terms of Service version
|
|
17380
18722
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17381
18723
|
* @param {*} [options] Override http request option.
|
|
17382
18724
|
* @throws {RequiredError}
|
|
@@ -17509,6 +18851,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17509
18851
|
* @memberof UsersApi
|
|
17510
18852
|
*/
|
|
17511
18853
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserSettingsResponse, any, {}>>;
|
|
18854
|
+
/**
|
|
18855
|
+
*
|
|
18856
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
18857
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
18858
|
+
* @param {*} [options] Override http request option.
|
|
18859
|
+
* @throws {RequiredError}
|
|
18860
|
+
* @memberof UsersApi
|
|
18861
|
+
*/
|
|
18862
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserTosResponse, any, {}>>;
|
|
17512
18863
|
/**
|
|
17513
18864
|
*
|
|
17514
18865
|
* @summary Returns the user\'s containers
|
|
@@ -17527,6 +18878,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17527
18878
|
* @memberof UsersApi
|
|
17528
18879
|
*/
|
|
17529
18880
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18881
|
+
/**
|
|
18882
|
+
*
|
|
18883
|
+
* @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.
|
|
18884
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18885
|
+
* @param {*} [options] Override http request option.
|
|
18886
|
+
* @throws {RequiredError}
|
|
18887
|
+
* @memberof UsersApi
|
|
18888
|
+
*/
|
|
18889
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17530
18890
|
/**
|
|
17531
18891
|
*
|
|
17532
18892
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17722,6 +19082,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17722
19082
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17723
19083
|
};
|
|
17724
19084
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
19085
|
+
/**
|
|
19086
|
+
* @export
|
|
19087
|
+
*/
|
|
19088
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
19089
|
+
readonly Pending: "PENDING";
|
|
19090
|
+
readonly Paid: "PAID";
|
|
19091
|
+
readonly Expired: "EXPIRED";
|
|
19092
|
+
readonly Cancelled: "CANCELLED";
|
|
19093
|
+
};
|
|
19094
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17725
19095
|
/**
|
|
17726
19096
|
* @export
|
|
17727
19097
|
*/
|