@gewis/sudosos-client 0.0.0-develop.fcdff9b → 0.0.0-develop.ff396b7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +1438 -285
- package/dist/api.js +1509 -260
- 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
|
|
@@ -1902,6 +1908,37 @@ export interface CreateInvoiceRequest {
|
|
|
1902
1908
|
*/
|
|
1903
1909
|
'amount': DineroObjectRequest;
|
|
1904
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
|
+
}
|
|
1905
1942
|
/**
|
|
1906
1943
|
*
|
|
1907
1944
|
* @export
|
|
@@ -2081,6 +2118,19 @@ export interface CreateShiftRequest {
|
|
|
2081
2118
|
*/
|
|
2082
2119
|
'roles': Array<string>;
|
|
2083
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
|
+
}
|
|
2084
2134
|
/**
|
|
2085
2135
|
*
|
|
2086
2136
|
* @export
|
|
@@ -3232,25 +3282,38 @@ export interface InvoiceUserResponse {
|
|
|
3232
3282
|
/**
|
|
3233
3283
|
*
|
|
3234
3284
|
* @export
|
|
3235
|
-
* @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
|
|
3236
3299
|
*/
|
|
3237
|
-
export interface
|
|
3300
|
+
export interface MemberAuthenticationPinRequest {
|
|
3238
3301
|
/**
|
|
3239
3302
|
*
|
|
3240
3303
|
* @type {number}
|
|
3241
|
-
* @memberof
|
|
3304
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3242
3305
|
*/
|
|
3243
3306
|
'memberId': number;
|
|
3244
3307
|
/**
|
|
3245
3308
|
*
|
|
3246
3309
|
* @type {string}
|
|
3247
|
-
* @memberof
|
|
3310
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3248
3311
|
*/
|
|
3249
3312
|
'pin': string;
|
|
3250
3313
|
/**
|
|
3251
3314
|
* POS identifier
|
|
3252
3315
|
* @type {number}
|
|
3253
|
-
* @memberof
|
|
3316
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3254
3317
|
*/
|
|
3255
3318
|
'posId': number;
|
|
3256
3319
|
}
|
|
@@ -4157,6 +4220,19 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4157
4220
|
*/
|
|
4158
4221
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4159
4222
|
}
|
|
4223
|
+
/**
|
|
4224
|
+
*
|
|
4225
|
+
* @export
|
|
4226
|
+
* @interface ProcessTerminalPaymentRequest
|
|
4227
|
+
*/
|
|
4228
|
+
export interface ProcessTerminalPaymentRequest {
|
|
4229
|
+
/**
|
|
4230
|
+
* The ID of the Stripe terminal to perform the payment with
|
|
4231
|
+
* @type {string}
|
|
4232
|
+
* @memberof ProcessTerminalPaymentRequest
|
|
4233
|
+
*/
|
|
4234
|
+
'stripeTerminalId': string;
|
|
4235
|
+
}
|
|
4160
4236
|
/**
|
|
4161
4237
|
* API Request for creating or updating a `product category` entity.
|
|
4162
4238
|
* @export
|
|
@@ -5049,6 +5125,37 @@ export interface StripePaymentIntentStatusResponse {
|
|
|
5049
5125
|
*/
|
|
5050
5126
|
'state': number;
|
|
5051
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
|
+
}
|
|
5052
5159
|
/**
|
|
5053
5160
|
*
|
|
5054
5161
|
* @export
|
|
@@ -5241,6 +5348,67 @@ export interface SubTransactionRowResponse {
|
|
|
5241
5348
|
*/
|
|
5242
5349
|
'totalPriceInclVat': DineroObjectResponse;
|
|
5243
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
|
+
}
|
|
5244
5412
|
/**
|
|
5245
5413
|
*
|
|
5246
5414
|
* @export
|
|
@@ -5253,6 +5421,12 @@ export interface TermsOfServiceResponse {
|
|
|
5253
5421
|
* @memberof TermsOfServiceResponse
|
|
5254
5422
|
*/
|
|
5255
5423
|
'versionNumber': string;
|
|
5424
|
+
/**
|
|
5425
|
+
* The date this version took effect.
|
|
5426
|
+
* @type {string}
|
|
5427
|
+
* @memberof TermsOfServiceResponse
|
|
5428
|
+
*/
|
|
5429
|
+
'date': string;
|
|
5256
5430
|
/**
|
|
5257
5431
|
* The terms of service content.
|
|
5258
5432
|
* @type {string}
|
|
@@ -5260,6 +5434,17 @@ export interface TermsOfServiceResponse {
|
|
|
5260
5434
|
*/
|
|
5261
5435
|
'content': string;
|
|
5262
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];
|
|
5263
5448
|
/**
|
|
5264
5449
|
*
|
|
5265
5450
|
* @export
|
|
@@ -6332,6 +6517,12 @@ export interface UpdateUserRequest {
|
|
|
6332
6517
|
* @memberof UpdateUserRequest
|
|
6333
6518
|
*/
|
|
6334
6519
|
'expiryDate'?: string | null;
|
|
6520
|
+
/**
|
|
6521
|
+
* Whether organ members can manage this organ\'s products and containers without BAC/GEWIS PM. Only meaningful for organ users.
|
|
6522
|
+
* @type {boolean}
|
|
6523
|
+
* @memberof UpdateUserRequest
|
|
6524
|
+
*/
|
|
6525
|
+
'productSelfService'?: boolean;
|
|
6335
6526
|
}
|
|
6336
6527
|
/**
|
|
6337
6528
|
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
@@ -6507,11 +6698,17 @@ export interface UserResponse {
|
|
|
6507
6698
|
*/
|
|
6508
6699
|
'email'?: string;
|
|
6509
6700
|
/**
|
|
6510
|
-
* Whether this user
|
|
6511
|
-
* @type {
|
|
6701
|
+
* Whether this user is required to accept the TOS
|
|
6702
|
+
* @type {boolean}
|
|
6703
|
+
* @memberof UserResponse
|
|
6704
|
+
*/
|
|
6705
|
+
'tosRequired'?: boolean;
|
|
6706
|
+
/**
|
|
6707
|
+
*
|
|
6708
|
+
* @type {TermsOfServiceStatus}
|
|
6512
6709
|
* @memberof UserResponse
|
|
6513
6710
|
*/
|
|
6514
|
-
'acceptedToS'?:
|
|
6711
|
+
'acceptedToS'?: TermsOfServiceStatus;
|
|
6515
6712
|
/**
|
|
6516
6713
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6517
6714
|
* @type {boolean}
|
|
@@ -6660,34 +6857,78 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6660
6857
|
*/
|
|
6661
6858
|
'nickname'?: string;
|
|
6662
6859
|
}
|
|
6663
|
-
/**
|
|
6664
|
-
* The type of a user
|
|
6665
|
-
* @export
|
|
6666
|
-
* @enum {string}
|
|
6667
|
-
*/
|
|
6668
|
-
export declare const UserType: {
|
|
6669
|
-
readonly Member: "MEMBER";
|
|
6670
|
-
readonly Organ: "ORGAN";
|
|
6671
|
-
readonly Voucher: "VOUCHER";
|
|
6672
|
-
readonly LocalUser: "LOCAL_USER";
|
|
6673
|
-
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6674
|
-
readonly Invoice: "INVOICE";
|
|
6675
|
-
readonly PointOfSale: "POINT_OF_SALE";
|
|
6676
|
-
readonly Integration: "INTEGRATION";
|
|
6677
|
-
};
|
|
6678
|
-
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6679
6860
|
/**
|
|
6680
6861
|
*
|
|
6681
6862
|
* @export
|
|
6682
|
-
* @interface
|
|
6863
|
+
* @interface UserTosAcceptanceResponse
|
|
6683
6864
|
*/
|
|
6684
|
-
export interface
|
|
6865
|
+
export interface UserTosAcceptanceResponse {
|
|
6685
6866
|
/**
|
|
6686
|
-
* The
|
|
6867
|
+
* The accepted terms of service version number.
|
|
6687
6868
|
* @type {string}
|
|
6688
|
-
* @memberof
|
|
6869
|
+
* @memberof UserTosAcceptanceResponse
|
|
6689
6870
|
*/
|
|
6690
|
-
'
|
|
6871
|
+
'versionNumber': string;
|
|
6872
|
+
/**
|
|
6873
|
+
* The date at which this version was accepted.
|
|
6874
|
+
* @type {string}
|
|
6875
|
+
* @memberof UserTosAcceptanceResponse
|
|
6876
|
+
*/
|
|
6877
|
+
'acceptedAt': string;
|
|
6878
|
+
}
|
|
6879
|
+
/**
|
|
6880
|
+
*
|
|
6881
|
+
* @export
|
|
6882
|
+
* @interface UserTosResponse
|
|
6883
|
+
*/
|
|
6884
|
+
export interface UserTosResponse {
|
|
6885
|
+
/**
|
|
6886
|
+
*
|
|
6887
|
+
* @type {TermsOfServiceStatus}
|
|
6888
|
+
* @memberof UserTosResponse
|
|
6889
|
+
*/
|
|
6890
|
+
'status': TermsOfServiceStatus;
|
|
6891
|
+
/**
|
|
6892
|
+
* The current terms of service version number.
|
|
6893
|
+
* @type {string}
|
|
6894
|
+
* @memberof UserTosResponse
|
|
6895
|
+
*/
|
|
6896
|
+
'currentVersion': string;
|
|
6897
|
+
/**
|
|
6898
|
+
* All TOS versions the user has accepted.
|
|
6899
|
+
* @type {Array<UserTosAcceptanceResponse>}
|
|
6900
|
+
* @memberof UserTosResponse
|
|
6901
|
+
*/
|
|
6902
|
+
'acceptances': Array<UserTosAcceptanceResponse>;
|
|
6903
|
+
}
|
|
6904
|
+
/**
|
|
6905
|
+
* The type of a user
|
|
6906
|
+
* @export
|
|
6907
|
+
* @enum {string}
|
|
6908
|
+
*/
|
|
6909
|
+
export declare const UserType: {
|
|
6910
|
+
readonly Member: "MEMBER";
|
|
6911
|
+
readonly Organ: "ORGAN";
|
|
6912
|
+
readonly Voucher: "VOUCHER";
|
|
6913
|
+
readonly LocalUser: "LOCAL_USER";
|
|
6914
|
+
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6915
|
+
readonly Invoice: "INVOICE";
|
|
6916
|
+
readonly PointOfSale: "POINT_OF_SALE";
|
|
6917
|
+
readonly Integration: "INTEGRATION";
|
|
6918
|
+
};
|
|
6919
|
+
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6920
|
+
/**
|
|
6921
|
+
*
|
|
6922
|
+
* @export
|
|
6923
|
+
* @interface UserTypeTotalBalanceResponse
|
|
6924
|
+
*/
|
|
6925
|
+
export interface UserTypeTotalBalanceResponse {
|
|
6926
|
+
/**
|
|
6927
|
+
* The user type
|
|
6928
|
+
* @type {string}
|
|
6929
|
+
* @memberof UserTypeTotalBalanceResponse
|
|
6930
|
+
*/
|
|
6931
|
+
'userType': string;
|
|
6691
6932
|
/**
|
|
6692
6933
|
*
|
|
6693
6934
|
* @type {DineroObjectResponse}
|
|
@@ -7225,6 +7466,14 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7225
7466
|
* @throws {RequiredError}
|
|
7226
7467
|
*/
|
|
7227
7468
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7469
|
+
/**
|
|
7470
|
+
*
|
|
7471
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7472
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7473
|
+
* @param {*} [options] Override http request option.
|
|
7474
|
+
* @throws {RequiredError}
|
|
7475
|
+
*/
|
|
7476
|
+
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7228
7477
|
/**
|
|
7229
7478
|
*
|
|
7230
7479
|
* @summary Generate a QR code for authentication
|
|
@@ -7296,67 +7545,59 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7296
7545
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7297
7546
|
/**
|
|
7298
7547
|
*
|
|
7299
|
-
* @summary
|
|
7300
|
-
* @param {
|
|
7301
|
-
* @param {*} [options] Override http request option.
|
|
7302
|
-
* @throws {RequiredError}
|
|
7303
|
-
*/
|
|
7304
|
-
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7305
|
-
/**
|
|
7306
|
-
*
|
|
7307
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7548
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7549
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7308
7550
|
* @param {*} [options] Override http request option.
|
|
7309
7551
|
* @throws {RequiredError}
|
|
7310
7552
|
*/
|
|
7311
|
-
|
|
7553
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7312
7554
|
/**
|
|
7313
7555
|
*
|
|
7314
|
-
* @summary
|
|
7315
|
-
* @param {
|
|
7556
|
+
* @summary Mock login and hand out token.
|
|
7557
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7316
7558
|
* @param {*} [options] Override http request option.
|
|
7317
7559
|
* @throws {RequiredError}
|
|
7318
7560
|
*/
|
|
7319
|
-
|
|
7561
|
+
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7320
7562
|
/**
|
|
7321
7563
|
*
|
|
7322
|
-
* @summary
|
|
7323
|
-
* @param {
|
|
7564
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7565
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7324
7566
|
* @param {*} [options] Override http request option.
|
|
7325
7567
|
* @throws {RequiredError}
|
|
7326
7568
|
*/
|
|
7327
|
-
|
|
7569
|
+
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7328
7570
|
/**
|
|
7329
7571
|
*
|
|
7330
|
-
* @summary
|
|
7331
|
-
* @param {
|
|
7572
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7573
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7332
7574
|
* @param {*} [options] Override http request option.
|
|
7333
7575
|
* @throws {RequiredError}
|
|
7334
7576
|
*/
|
|
7335
|
-
|
|
7577
|
+
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7336
7578
|
/**
|
|
7337
7579
|
*
|
|
7338
|
-
* @summary
|
|
7339
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7580
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7340
7581
|
* @param {*} [options] Override http request option.
|
|
7341
7582
|
* @throws {RequiredError}
|
|
7342
7583
|
*/
|
|
7343
|
-
|
|
7584
|
+
refreshToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7344
7585
|
/**
|
|
7345
7586
|
*
|
|
7346
|
-
* @summary
|
|
7347
|
-
* @param {
|
|
7587
|
+
* @summary Creates a reset token for the local authentication
|
|
7588
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7348
7589
|
* @param {*} [options] Override http request option.
|
|
7349
7590
|
* @throws {RequiredError}
|
|
7350
7591
|
*/
|
|
7351
|
-
|
|
7592
|
+
resetLocal: (resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7352
7593
|
/**
|
|
7353
7594
|
*
|
|
7354
|
-
* @summary
|
|
7355
|
-
* @param {
|
|
7595
|
+
* @summary Reset local authentication using the provided token
|
|
7596
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7356
7597
|
* @param {*} [options] Override http request option.
|
|
7357
7598
|
* @throws {RequiredError}
|
|
7358
7599
|
*/
|
|
7359
|
-
|
|
7600
|
+
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7360
7601
|
};
|
|
7361
7602
|
/**
|
|
7362
7603
|
* AuthenticateApi - functional programming interface
|
|
@@ -7387,6 +7628,14 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7387
7628
|
* @throws {RequiredError}
|
|
7388
7629
|
*/
|
|
7389
7630
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7631
|
+
/**
|
|
7632
|
+
*
|
|
7633
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7634
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7635
|
+
* @param {*} [options] Override http request option.
|
|
7636
|
+
* @throws {RequiredError}
|
|
7637
|
+
*/
|
|
7638
|
+
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7390
7639
|
/**
|
|
7391
7640
|
*
|
|
7392
7641
|
* @summary Generate a QR code for authentication
|
|
@@ -7458,67 +7707,59 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7458
7707
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7459
7708
|
/**
|
|
7460
7709
|
*
|
|
7461
|
-
* @summary
|
|
7462
|
-
* @param {
|
|
7463
|
-
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @throws {RequiredError}
|
|
7465
|
-
*/
|
|
7466
|
-
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7467
|
-
/**
|
|
7468
|
-
*
|
|
7469
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7710
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7711
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7470
7712
|
* @param {*} [options] Override http request option.
|
|
7471
7713
|
* @throws {RequiredError}
|
|
7472
7714
|
*/
|
|
7473
|
-
|
|
7715
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7474
7716
|
/**
|
|
7475
7717
|
*
|
|
7476
|
-
* @summary
|
|
7477
|
-
* @param {
|
|
7718
|
+
* @summary Mock login and hand out token.
|
|
7719
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7478
7720
|
* @param {*} [options] Override http request option.
|
|
7479
7721
|
* @throws {RequiredError}
|
|
7480
7722
|
*/
|
|
7481
|
-
|
|
7723
|
+
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7482
7724
|
/**
|
|
7483
7725
|
*
|
|
7484
|
-
* @summary
|
|
7485
|
-
* @param {
|
|
7726
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7727
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7486
7728
|
* @param {*} [options] Override http request option.
|
|
7487
7729
|
* @throws {RequiredError}
|
|
7488
7730
|
*/
|
|
7489
|
-
|
|
7731
|
+
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7490
7732
|
/**
|
|
7491
7733
|
*
|
|
7492
|
-
* @summary
|
|
7493
|
-
* @param {
|
|
7734
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7735
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7494
7736
|
* @param {*} [options] Override http request option.
|
|
7495
7737
|
* @throws {RequiredError}
|
|
7496
7738
|
*/
|
|
7497
|
-
|
|
7739
|
+
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7498
7740
|
/**
|
|
7499
7741
|
*
|
|
7500
|
-
* @summary
|
|
7501
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7742
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7502
7743
|
* @param {*} [options] Override http request option.
|
|
7503
7744
|
* @throws {RequiredError}
|
|
7504
7745
|
*/
|
|
7505
|
-
|
|
7746
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7506
7747
|
/**
|
|
7507
7748
|
*
|
|
7508
|
-
* @summary
|
|
7509
|
-
* @param {
|
|
7749
|
+
* @summary Creates a reset token for the local authentication
|
|
7750
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7510
7751
|
* @param {*} [options] Override http request option.
|
|
7511
7752
|
* @throws {RequiredError}
|
|
7512
7753
|
*/
|
|
7513
|
-
|
|
7754
|
+
resetLocal(resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7514
7755
|
/**
|
|
7515
7756
|
*
|
|
7516
|
-
* @summary
|
|
7517
|
-
* @param {
|
|
7757
|
+
* @summary Reset local authentication using the provided token
|
|
7758
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7518
7759
|
* @param {*} [options] Override http request option.
|
|
7519
7760
|
* @throws {RequiredError}
|
|
7520
7761
|
*/
|
|
7521
|
-
|
|
7762
|
+
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7522
7763
|
};
|
|
7523
7764
|
/**
|
|
7524
7765
|
* AuthenticateApi - factory interface
|
|
@@ -7549,6 +7790,14 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7549
7790
|
* @throws {RequiredError}
|
|
7550
7791
|
*/
|
|
7551
7792
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7793
|
+
/**
|
|
7794
|
+
*
|
|
7795
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7796
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7797
|
+
* @param {*} [options] Override http request option.
|
|
7798
|
+
* @throws {RequiredError}
|
|
7799
|
+
*/
|
|
7800
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7552
7801
|
/**
|
|
7553
7802
|
*
|
|
7554
7803
|
* @summary Generate a QR code for authentication
|
|
@@ -7620,67 +7869,59 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7620
7869
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7621
7870
|
/**
|
|
7622
7871
|
*
|
|
7623
|
-
* @summary
|
|
7624
|
-
* @param {
|
|
7625
|
-
* @param {*} [options] Override http request option.
|
|
7626
|
-
* @throws {RequiredError}
|
|
7627
|
-
*/
|
|
7628
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7629
|
-
/**
|
|
7630
|
-
*
|
|
7631
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7872
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7873
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7632
7874
|
* @param {*} [options] Override http request option.
|
|
7633
7875
|
* @throws {RequiredError}
|
|
7634
7876
|
*/
|
|
7635
|
-
|
|
7877
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7636
7878
|
/**
|
|
7637
7879
|
*
|
|
7638
|
-
* @summary
|
|
7639
|
-
* @param {
|
|
7880
|
+
* @summary Mock login and hand out token.
|
|
7881
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7640
7882
|
* @param {*} [options] Override http request option.
|
|
7641
7883
|
* @throws {RequiredError}
|
|
7642
7884
|
*/
|
|
7643
|
-
|
|
7885
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7644
7886
|
/**
|
|
7645
7887
|
*
|
|
7646
|
-
* @summary
|
|
7647
|
-
* @param {
|
|
7888
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7889
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7648
7890
|
* @param {*} [options] Override http request option.
|
|
7649
7891
|
* @throws {RequiredError}
|
|
7650
7892
|
*/
|
|
7651
|
-
|
|
7893
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7652
7894
|
/**
|
|
7653
7895
|
*
|
|
7654
|
-
* @summary
|
|
7655
|
-
* @param {
|
|
7896
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7897
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7656
7898
|
* @param {*} [options] Override http request option.
|
|
7657
7899
|
* @throws {RequiredError}
|
|
7658
7900
|
*/
|
|
7659
|
-
|
|
7901
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7660
7902
|
/**
|
|
7661
7903
|
*
|
|
7662
|
-
* @summary
|
|
7663
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7904
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7664
7905
|
* @param {*} [options] Override http request option.
|
|
7665
7906
|
* @throws {RequiredError}
|
|
7666
7907
|
*/
|
|
7667
|
-
|
|
7908
|
+
refreshToken(options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7668
7909
|
/**
|
|
7669
7910
|
*
|
|
7670
|
-
* @summary
|
|
7671
|
-
* @param {
|
|
7911
|
+
* @summary Creates a reset token for the local authentication
|
|
7912
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7672
7913
|
* @param {*} [options] Override http request option.
|
|
7673
7914
|
* @throws {RequiredError}
|
|
7674
7915
|
*/
|
|
7675
|
-
|
|
7916
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7676
7917
|
/**
|
|
7677
7918
|
*
|
|
7678
|
-
* @summary
|
|
7679
|
-
* @param {
|
|
7919
|
+
* @summary Reset local authentication using the provided token
|
|
7920
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7680
7921
|
* @param {*} [options] Override http request option.
|
|
7681
7922
|
* @throws {RequiredError}
|
|
7682
7923
|
*/
|
|
7683
|
-
|
|
7924
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7684
7925
|
};
|
|
7685
7926
|
/**
|
|
7686
7927
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7721,6 +7962,19 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7721
7962
|
*/
|
|
7722
7963
|
readonly sessionId: string;
|
|
7723
7964
|
}
|
|
7965
|
+
/**
|
|
7966
|
+
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7967
|
+
* @export
|
|
7968
|
+
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7969
|
+
*/
|
|
7970
|
+
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7971
|
+
/**
|
|
7972
|
+
* The EAN login request with posId
|
|
7973
|
+
* @type {AuthenticationEanRequest}
|
|
7974
|
+
* @memberof AuthenticateApiEanAuthentication
|
|
7975
|
+
*/
|
|
7976
|
+
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7977
|
+
}
|
|
7724
7978
|
/**
|
|
7725
7979
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7726
7980
|
* @export
|
|
@@ -7799,6 +8053,19 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7799
8053
|
*/
|
|
7800
8054
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7801
8055
|
}
|
|
8056
|
+
/**
|
|
8057
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
8058
|
+
* @export
|
|
8059
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
8060
|
+
*/
|
|
8061
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
8062
|
+
/**
|
|
8063
|
+
* The PIN login request with posId
|
|
8064
|
+
* @type {MemberAuthenticationPinRequest}
|
|
8065
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
8066
|
+
*/
|
|
8067
|
+
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
8068
|
+
}
|
|
7802
8069
|
/**
|
|
7803
8070
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7804
8071
|
* @export
|
|
@@ -7812,6 +8079,32 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7812
8079
|
*/
|
|
7813
8080
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7814
8081
|
}
|
|
8082
|
+
/**
|
|
8083
|
+
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
8084
|
+
* @export
|
|
8085
|
+
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
8086
|
+
*/
|
|
8087
|
+
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
8088
|
+
/**
|
|
8089
|
+
* The NFC login request with posId
|
|
8090
|
+
* @type {AuthenticationNfcRequest}
|
|
8091
|
+
* @memberof AuthenticateApiNfcAuthentication
|
|
8092
|
+
*/
|
|
8093
|
+
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
8094
|
+
}
|
|
8095
|
+
/**
|
|
8096
|
+
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
8097
|
+
* @export
|
|
8098
|
+
* @interface AuthenticateApiPinAuthenticationRequest
|
|
8099
|
+
*/
|
|
8100
|
+
export interface AuthenticateApiPinAuthenticationRequest {
|
|
8101
|
+
/**
|
|
8102
|
+
* The PIN login request with posId
|
|
8103
|
+
* @type {AuthenticationPinRequest}
|
|
8104
|
+
* @memberof AuthenticateApiPinAuthentication
|
|
8105
|
+
*/
|
|
8106
|
+
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
8107
|
+
}
|
|
7815
8108
|
/**
|
|
7816
8109
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7817
8110
|
* @export
|
|
@@ -7838,58 +8131,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7838
8131
|
*/
|
|
7839
8132
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7840
8133
|
}
|
|
7841
|
-
/**
|
|
7842
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7843
|
-
* @export
|
|
7844
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7845
|
-
*/
|
|
7846
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7847
|
-
/**
|
|
7848
|
-
* The EAN login request with posId
|
|
7849
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7850
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7851
|
-
*/
|
|
7852
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7853
|
-
}
|
|
7854
|
-
/**
|
|
7855
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7856
|
-
* @export
|
|
7857
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7858
|
-
*/
|
|
7859
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7860
|
-
/**
|
|
7861
|
-
* The PIN login request with posId
|
|
7862
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7863
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7864
|
-
*/
|
|
7865
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7866
|
-
}
|
|
7867
|
-
/**
|
|
7868
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7869
|
-
* @export
|
|
7870
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7871
|
-
*/
|
|
7872
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7873
|
-
/**
|
|
7874
|
-
* The NFC login request with posId
|
|
7875
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7876
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7877
|
-
*/
|
|
7878
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7879
|
-
}
|
|
7880
|
-
/**
|
|
7881
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7882
|
-
* @export
|
|
7883
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7884
|
-
*/
|
|
7885
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7886
|
-
/**
|
|
7887
|
-
* The PIN login request with posId
|
|
7888
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7889
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7890
|
-
*/
|
|
7891
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7892
|
-
}
|
|
7893
8134
|
/**
|
|
7894
8135
|
* AuthenticateApi - object-oriented interface
|
|
7895
8136
|
* @export
|
|
@@ -7924,6 +8165,15 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7924
8165
|
* @memberof AuthenticateApi
|
|
7925
8166
|
*/
|
|
7926
8167
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8168
|
+
/**
|
|
8169
|
+
*
|
|
8170
|
+
* @summary EAN authentication that requires POS user authentication
|
|
8171
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
8172
|
+
* @param {*} [options] Override http request option.
|
|
8173
|
+
* @throws {RequiredError}
|
|
8174
|
+
* @memberof AuthenticateApi
|
|
8175
|
+
*/
|
|
8176
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7927
8177
|
/**
|
|
7928
8178
|
*
|
|
7929
8179
|
* @summary Generate a QR code for authentication
|
|
@@ -8004,75 +8254,66 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8004
8254
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8005
8255
|
/**
|
|
8006
8256
|
*
|
|
8007
|
-
* @summary
|
|
8008
|
-
* @param {
|
|
8009
|
-
* @param {*} [options] Override http request option.
|
|
8010
|
-
* @throws {RequiredError}
|
|
8011
|
-
* @memberof AuthenticateApi
|
|
8012
|
-
*/
|
|
8013
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8014
|
-
/**
|
|
8015
|
-
*
|
|
8016
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
8257
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8258
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8017
8259
|
* @param {*} [options] Override http request option.
|
|
8018
8260
|
* @throws {RequiredError}
|
|
8019
8261
|
* @memberof AuthenticateApi
|
|
8020
8262
|
*/
|
|
8021
|
-
|
|
8263
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8022
8264
|
/**
|
|
8023
8265
|
*
|
|
8024
|
-
* @summary
|
|
8025
|
-
* @param {
|
|
8266
|
+
* @summary Mock login and hand out token.
|
|
8267
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
8026
8268
|
* @param {*} [options] Override http request option.
|
|
8027
8269
|
* @throws {RequiredError}
|
|
8028
8270
|
* @memberof AuthenticateApi
|
|
8029
8271
|
*/
|
|
8030
|
-
|
|
8272
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8031
8273
|
/**
|
|
8032
8274
|
*
|
|
8033
|
-
* @summary
|
|
8034
|
-
* @param {
|
|
8275
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8276
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8035
8277
|
* @param {*} [options] Override http request option.
|
|
8036
8278
|
* @throws {RequiredError}
|
|
8037
8279
|
* @memberof AuthenticateApi
|
|
8038
8280
|
*/
|
|
8039
|
-
|
|
8281
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8040
8282
|
/**
|
|
8041
8283
|
*
|
|
8042
|
-
* @summary
|
|
8043
|
-
* @param {
|
|
8284
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8285
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8044
8286
|
* @param {*} [options] Override http request option.
|
|
8045
8287
|
* @throws {RequiredError}
|
|
8046
8288
|
* @memberof AuthenticateApi
|
|
8047
8289
|
*/
|
|
8048
|
-
|
|
8290
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8049
8291
|
/**
|
|
8050
8292
|
*
|
|
8051
|
-
* @summary
|
|
8052
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8293
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
8053
8294
|
* @param {*} [options] Override http request option.
|
|
8054
8295
|
* @throws {RequiredError}
|
|
8055
8296
|
* @memberof AuthenticateApi
|
|
8056
8297
|
*/
|
|
8057
|
-
|
|
8298
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8058
8299
|
/**
|
|
8059
8300
|
*
|
|
8060
|
-
* @summary
|
|
8061
|
-
* @param {
|
|
8301
|
+
* @summary Creates a reset token for the local authentication
|
|
8302
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
8062
8303
|
* @param {*} [options] Override http request option.
|
|
8063
8304
|
* @throws {RequiredError}
|
|
8064
8305
|
* @memberof AuthenticateApi
|
|
8065
8306
|
*/
|
|
8066
|
-
|
|
8307
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8067
8308
|
/**
|
|
8068
8309
|
*
|
|
8069
|
-
* @summary
|
|
8070
|
-
* @param {
|
|
8310
|
+
* @summary Reset local authentication using the provided token
|
|
8311
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
8071
8312
|
* @param {*} [options] Override http request option.
|
|
8072
8313
|
* @throws {RequiredError}
|
|
8073
8314
|
* @memberof AuthenticateApi
|
|
8074
8315
|
*/
|
|
8075
|
-
|
|
8316
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8076
8317
|
}
|
|
8077
8318
|
/**
|
|
8078
8319
|
* BalanceApi - axios parameter creator
|
|
@@ -11731,54 +11972,540 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11731
11972
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11732
11973
|
}
|
|
11733
11974
|
/**
|
|
11734
|
-
*
|
|
11975
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11735
11976
|
* @export
|
|
11736
11977
|
*/
|
|
11737
|
-
export declare const
|
|
11978
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11738
11979
|
/**
|
|
11739
11980
|
*
|
|
11740
|
-
* @summary
|
|
11741
|
-
* @param {
|
|
11981
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11982
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11742
11983
|
* @param {*} [options] Override http request option.
|
|
11743
11984
|
* @throws {RequiredError}
|
|
11744
11985
|
*/
|
|
11745
|
-
|
|
11986
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11746
11987
|
/**
|
|
11747
11988
|
*
|
|
11748
|
-
* @summary
|
|
11749
|
-
* @param {
|
|
11750
|
-
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
11751
|
-
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
11752
|
-
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
11753
|
-
* @param {string} [status] Status of the payout requests (OR relation)
|
|
11754
|
-
* @param {number} [take] How many payout requests the endpoint should return
|
|
11755
|
-
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
11989
|
+
* @summary Create a new PaymentRequest.
|
|
11990
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11756
11991
|
* @param {*} [options] Override http request option.
|
|
11757
11992
|
* @throws {RequiredError}
|
|
11758
11993
|
*/
|
|
11759
|
-
|
|
11994
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11760
11995
|
/**
|
|
11761
11996
|
*
|
|
11762
|
-
* @summary
|
|
11763
|
-
* @param {number}
|
|
11764
|
-
* @param {
|
|
11997
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11998
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11999
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
12000
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
12001
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
12002
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
12003
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
12004
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11765
12005
|
* @param {*} [options] Override http request option.
|
|
11766
12006
|
* @throws {RequiredError}
|
|
11767
12007
|
*/
|
|
11768
|
-
|
|
12008
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11769
12009
|
/**
|
|
11770
12010
|
*
|
|
11771
|
-
* @summary
|
|
11772
|
-
* @param {
|
|
12011
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12012
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11773
12013
|
* @param {*} [options] Override http request option.
|
|
11774
12014
|
* @throws {RequiredError}
|
|
11775
12015
|
*/
|
|
11776
|
-
|
|
12016
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11777
12017
|
/**
|
|
11778
12018
|
*
|
|
11779
|
-
* @summary
|
|
11780
|
-
* @param {
|
|
11781
|
-
* @param {
|
|
12019
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12020
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12021
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
12022
|
+
* @param {*} [options] Override http request option.
|
|
12023
|
+
* @throws {RequiredError}
|
|
12024
|
+
*/
|
|
12025
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12026
|
+
/**
|
|
12027
|
+
*
|
|
12028
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12029
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12030
|
+
* @param {*} [options] Override http request option.
|
|
12031
|
+
* @throws {RequiredError}
|
|
12032
|
+
*/
|
|
12033
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12034
|
+
};
|
|
12035
|
+
/**
|
|
12036
|
+
* PaymentRequestsApi - functional programming interface
|
|
12037
|
+
* @export
|
|
12038
|
+
*/
|
|
12039
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
12040
|
+
/**
|
|
12041
|
+
*
|
|
12042
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12043
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12044
|
+
* @param {*} [options] Override http request option.
|
|
12045
|
+
* @throws {RequiredError}
|
|
12046
|
+
*/
|
|
12047
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12048
|
+
/**
|
|
12049
|
+
*
|
|
12050
|
+
* @summary Create a new PaymentRequest.
|
|
12051
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
12052
|
+
* @param {*} [options] Override http request option.
|
|
12053
|
+
* @throws {RequiredError}
|
|
12054
|
+
*/
|
|
12055
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12056
|
+
/**
|
|
12057
|
+
*
|
|
12058
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12059
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
12060
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
12061
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
12062
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
12063
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
12064
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
12065
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
12066
|
+
* @param {*} [options] Override http request option.
|
|
12067
|
+
* @throws {RequiredError}
|
|
12068
|
+
*/
|
|
12069
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
12070
|
+
/**
|
|
12071
|
+
*
|
|
12072
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12073
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12074
|
+
* @param {*} [options] Override http request option.
|
|
12075
|
+
* @throws {RequiredError}
|
|
12076
|
+
*/
|
|
12077
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12078
|
+
/**
|
|
12079
|
+
*
|
|
12080
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12081
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12082
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
12083
|
+
* @param {*} [options] Override http request option.
|
|
12084
|
+
* @throws {RequiredError}
|
|
12085
|
+
*/
|
|
12086
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
12087
|
+
/**
|
|
12088
|
+
*
|
|
12089
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12090
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12091
|
+
* @param {*} [options] Override http request option.
|
|
12092
|
+
* @throws {RequiredError}
|
|
12093
|
+
*/
|
|
12094
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12095
|
+
};
|
|
12096
|
+
/**
|
|
12097
|
+
* PaymentRequestsApi - factory interface
|
|
12098
|
+
* @export
|
|
12099
|
+
*/
|
|
12100
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12101
|
+
/**
|
|
12102
|
+
*
|
|
12103
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12104
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12105
|
+
* @param {*} [options] Override http request option.
|
|
12106
|
+
* @throws {RequiredError}
|
|
12107
|
+
*/
|
|
12108
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12109
|
+
/**
|
|
12110
|
+
*
|
|
12111
|
+
* @summary Create a new PaymentRequest.
|
|
12112
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12113
|
+
* @param {*} [options] Override http request option.
|
|
12114
|
+
* @throws {RequiredError}
|
|
12115
|
+
*/
|
|
12116
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12117
|
+
/**
|
|
12118
|
+
*
|
|
12119
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12120
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12121
|
+
* @param {*} [options] Override http request option.
|
|
12122
|
+
* @throws {RequiredError}
|
|
12123
|
+
*/
|
|
12124
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
12125
|
+
/**
|
|
12126
|
+
*
|
|
12127
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12128
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12129
|
+
* @param {*} [options] Override http request option.
|
|
12130
|
+
* @throws {RequiredError}
|
|
12131
|
+
*/
|
|
12132
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12133
|
+
/**
|
|
12134
|
+
*
|
|
12135
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12136
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12137
|
+
* @param {*} [options] Override http request option.
|
|
12138
|
+
* @throws {RequiredError}
|
|
12139
|
+
*/
|
|
12140
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12141
|
+
/**
|
|
12142
|
+
*
|
|
12143
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12144
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12145
|
+
* @param {*} [options] Override http request option.
|
|
12146
|
+
* @throws {RequiredError}
|
|
12147
|
+
*/
|
|
12148
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12149
|
+
};
|
|
12150
|
+
/**
|
|
12151
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
12152
|
+
* @export
|
|
12153
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
12154
|
+
*/
|
|
12155
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
12156
|
+
/**
|
|
12157
|
+
* UUID v4 of the payment request.
|
|
12158
|
+
* @type {string}
|
|
12159
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
12160
|
+
*/
|
|
12161
|
+
readonly id: string;
|
|
12162
|
+
}
|
|
12163
|
+
/**
|
|
12164
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
12165
|
+
* @export
|
|
12166
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
12167
|
+
*/
|
|
12168
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
12169
|
+
/**
|
|
12170
|
+
* The request to create
|
|
12171
|
+
* @type {CreatePaymentRequestRequest}
|
|
12172
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
12173
|
+
*/
|
|
12174
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
12175
|
+
}
|
|
12176
|
+
/**
|
|
12177
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
12178
|
+
* @export
|
|
12179
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
12180
|
+
*/
|
|
12181
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
12182
|
+
/**
|
|
12183
|
+
* Filter by beneficiary user id.
|
|
12184
|
+
* @type {number}
|
|
12185
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12186
|
+
*/
|
|
12187
|
+
readonly forId?: number;
|
|
12188
|
+
/**
|
|
12189
|
+
* Filter by creator user id.
|
|
12190
|
+
* @type {number}
|
|
12191
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12192
|
+
*/
|
|
12193
|
+
readonly createdById?: number;
|
|
12194
|
+
/**
|
|
12195
|
+
* Comma-separated list of derived statuses.
|
|
12196
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12197
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12198
|
+
*/
|
|
12199
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12200
|
+
/**
|
|
12201
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12202
|
+
* @type {string}
|
|
12203
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12204
|
+
*/
|
|
12205
|
+
readonly fromDate?: string;
|
|
12206
|
+
/**
|
|
12207
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12208
|
+
* @type {string}
|
|
12209
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12210
|
+
*/
|
|
12211
|
+
readonly tillDate?: string;
|
|
12212
|
+
/**
|
|
12213
|
+
* How many rows the endpoint should return
|
|
12214
|
+
* @type {number}
|
|
12215
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12216
|
+
*/
|
|
12217
|
+
readonly take?: number;
|
|
12218
|
+
/**
|
|
12219
|
+
* How many rows to skip (for pagination)
|
|
12220
|
+
* @type {number}
|
|
12221
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12222
|
+
*/
|
|
12223
|
+
readonly skip?: number;
|
|
12224
|
+
}
|
|
12225
|
+
/**
|
|
12226
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
12227
|
+
* @export
|
|
12228
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
12229
|
+
*/
|
|
12230
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
12231
|
+
/**
|
|
12232
|
+
* UUID v4 of the payment request.
|
|
12233
|
+
* @type {string}
|
|
12234
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12235
|
+
*/
|
|
12236
|
+
readonly id: string;
|
|
12237
|
+
}
|
|
12238
|
+
/**
|
|
12239
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12240
|
+
* @export
|
|
12241
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12242
|
+
*/
|
|
12243
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
12244
|
+
/**
|
|
12245
|
+
* UUID v4 of the payment request.
|
|
12246
|
+
* @type {string}
|
|
12247
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12248
|
+
*/
|
|
12249
|
+
readonly id: string;
|
|
12250
|
+
/**
|
|
12251
|
+
* The audit reason
|
|
12252
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12253
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
12254
|
+
*/
|
|
12255
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
12256
|
+
}
|
|
12257
|
+
/**
|
|
12258
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
12259
|
+
* @export
|
|
12260
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
12261
|
+
*/
|
|
12262
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
12263
|
+
/**
|
|
12264
|
+
* UUID v4 of the payment request.
|
|
12265
|
+
* @type {string}
|
|
12266
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
12267
|
+
*/
|
|
12268
|
+
readonly id: string;
|
|
12269
|
+
}
|
|
12270
|
+
/**
|
|
12271
|
+
* PaymentRequestsApi - object-oriented interface
|
|
12272
|
+
* @export
|
|
12273
|
+
* @class PaymentRequestsApi
|
|
12274
|
+
* @extends {BaseAPI}
|
|
12275
|
+
*/
|
|
12276
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
12277
|
+
/**
|
|
12278
|
+
*
|
|
12279
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12280
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
12281
|
+
* @param {*} [options] Override http request option.
|
|
12282
|
+
* @throws {RequiredError}
|
|
12283
|
+
* @memberof PaymentRequestsApi
|
|
12284
|
+
*/
|
|
12285
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12286
|
+
/**
|
|
12287
|
+
*
|
|
12288
|
+
* @summary Create a new PaymentRequest.
|
|
12289
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
12290
|
+
* @param {*} [options] Override http request option.
|
|
12291
|
+
* @throws {RequiredError}
|
|
12292
|
+
* @memberof PaymentRequestsApi
|
|
12293
|
+
*/
|
|
12294
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12295
|
+
/**
|
|
12296
|
+
*
|
|
12297
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12298
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
12299
|
+
* @param {*} [options] Override http request option.
|
|
12300
|
+
* @throws {RequiredError}
|
|
12301
|
+
* @memberof PaymentRequestsApi
|
|
12302
|
+
*/
|
|
12303
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
12304
|
+
/**
|
|
12305
|
+
*
|
|
12306
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12307
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
12308
|
+
* @param {*} [options] Override http request option.
|
|
12309
|
+
* @throws {RequiredError}
|
|
12310
|
+
* @memberof PaymentRequestsApi
|
|
12311
|
+
*/
|
|
12312
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12313
|
+
/**
|
|
12314
|
+
*
|
|
12315
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12316
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12317
|
+
* @param {*} [options] Override http request option.
|
|
12318
|
+
* @throws {RequiredError}
|
|
12319
|
+
* @memberof PaymentRequestsApi
|
|
12320
|
+
*/
|
|
12321
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
12322
|
+
/**
|
|
12323
|
+
*
|
|
12324
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12325
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12326
|
+
* @param {*} [options] Override http request option.
|
|
12327
|
+
* @throws {RequiredError}
|
|
12328
|
+
* @memberof PaymentRequestsApi
|
|
12329
|
+
*/
|
|
12330
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12331
|
+
}
|
|
12332
|
+
/**
|
|
12333
|
+
* @export
|
|
12334
|
+
*/
|
|
12335
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12336
|
+
readonly Pending: "PENDING";
|
|
12337
|
+
readonly Paid: "PAID";
|
|
12338
|
+
readonly Expired: "EXPIRED";
|
|
12339
|
+
readonly Cancelled: "CANCELLED";
|
|
12340
|
+
};
|
|
12341
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12342
|
+
/**
|
|
12343
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12344
|
+
* @export
|
|
12345
|
+
*/
|
|
12346
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12347
|
+
/**
|
|
12348
|
+
*
|
|
12349
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12350
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12351
|
+
* @param {*} [options] Override http request option.
|
|
12352
|
+
* @throws {RequiredError}
|
|
12353
|
+
*/
|
|
12354
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12355
|
+
/**
|
|
12356
|
+
*
|
|
12357
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12358
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12359
|
+
* @param {*} [options] Override http request option.
|
|
12360
|
+
* @throws {RequiredError}
|
|
12361
|
+
*/
|
|
12362
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12363
|
+
};
|
|
12364
|
+
/**
|
|
12365
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12366
|
+
* @export
|
|
12367
|
+
*/
|
|
12368
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
12369
|
+
/**
|
|
12370
|
+
*
|
|
12371
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12372
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12373
|
+
* @param {*} [options] Override http request option.
|
|
12374
|
+
* @throws {RequiredError}
|
|
12375
|
+
*/
|
|
12376
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
12377
|
+
/**
|
|
12378
|
+
*
|
|
12379
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12380
|
+
* @param {string} id UUID v4 of the payment request.
|
|
12381
|
+
* @param {*} [options] Override http request option.
|
|
12382
|
+
* @throws {RequiredError}
|
|
12383
|
+
*/
|
|
12384
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12385
|
+
};
|
|
12386
|
+
/**
|
|
12387
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12388
|
+
* @export
|
|
12389
|
+
*/
|
|
12390
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12391
|
+
/**
|
|
12392
|
+
*
|
|
12393
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12394
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12395
|
+
* @param {*} [options] Override http request option.
|
|
12396
|
+
* @throws {RequiredError}
|
|
12397
|
+
*/
|
|
12398
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12399
|
+
/**
|
|
12400
|
+
*
|
|
12401
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12402
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12403
|
+
* @param {*} [options] Override http request option.
|
|
12404
|
+
* @throws {RequiredError}
|
|
12405
|
+
*/
|
|
12406
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12407
|
+
};
|
|
12408
|
+
/**
|
|
12409
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12410
|
+
* @export
|
|
12411
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12412
|
+
*/
|
|
12413
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12414
|
+
/**
|
|
12415
|
+
* UUID v4 of the payment request.
|
|
12416
|
+
* @type {string}
|
|
12417
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12418
|
+
*/
|
|
12419
|
+
readonly id: string;
|
|
12420
|
+
}
|
|
12421
|
+
/**
|
|
12422
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12423
|
+
* @export
|
|
12424
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12425
|
+
*/
|
|
12426
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12427
|
+
/**
|
|
12428
|
+
* UUID v4 of the payment request.
|
|
12429
|
+
* @type {string}
|
|
12430
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12431
|
+
*/
|
|
12432
|
+
readonly id: string;
|
|
12433
|
+
}
|
|
12434
|
+
/**
|
|
12435
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12436
|
+
* @export
|
|
12437
|
+
* @class PaymentRequestsPublicApi
|
|
12438
|
+
* @extends {BaseAPI}
|
|
12439
|
+
*/
|
|
12440
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12441
|
+
/**
|
|
12442
|
+
*
|
|
12443
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12444
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12445
|
+
* @param {*} [options] Override http request option.
|
|
12446
|
+
* @throws {RequiredError}
|
|
12447
|
+
* @memberof PaymentRequestsPublicApi
|
|
12448
|
+
*/
|
|
12449
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12450
|
+
/**
|
|
12451
|
+
*
|
|
12452
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12453
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12454
|
+
* @param {*} [options] Override http request option.
|
|
12455
|
+
* @throws {RequiredError}
|
|
12456
|
+
* @memberof PaymentRequestsPublicApi
|
|
12457
|
+
*/
|
|
12458
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12459
|
+
}
|
|
12460
|
+
/**
|
|
12461
|
+
* PayoutRequestsApi - axios parameter creator
|
|
12462
|
+
* @export
|
|
12463
|
+
*/
|
|
12464
|
+
export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12465
|
+
/**
|
|
12466
|
+
*
|
|
12467
|
+
* @summary Create a new payout request
|
|
12468
|
+
* @param {PayoutRequestRequest} payoutRequestRequest New payout request
|
|
12469
|
+
* @param {*} [options] Override http request option.
|
|
12470
|
+
* @throws {RequiredError}
|
|
12471
|
+
*/
|
|
12472
|
+
createPayoutRequest: (payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12473
|
+
/**
|
|
12474
|
+
*
|
|
12475
|
+
* @summary Returns all payout requests given the filter parameters
|
|
12476
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
|
|
12477
|
+
* @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
|
|
12478
|
+
* @param {string} [fromDate] Start date for selected transactions (inclusive)
|
|
12479
|
+
* @param {string} [tillDate] End date for selected transactions (exclusive)
|
|
12480
|
+
* @param {string} [status] Status of the payout requests (OR relation)
|
|
12481
|
+
* @param {number} [take] How many payout requests the endpoint should return
|
|
12482
|
+
* @param {number} [skip] How many payout requests should be skipped (for pagination)
|
|
12483
|
+
* @param {*} [options] Override http request option.
|
|
12484
|
+
* @throws {RequiredError}
|
|
12485
|
+
*/
|
|
12486
|
+
getAllPayoutRequests: (requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12487
|
+
/**
|
|
12488
|
+
*
|
|
12489
|
+
* @summary Get a payout request pdf
|
|
12490
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12491
|
+
* @param {boolean} [force] Whether to force regeneration of the pdf
|
|
12492
|
+
* @param {*} [options] Override http request option.
|
|
12493
|
+
* @throws {RequiredError}
|
|
12494
|
+
*/
|
|
12495
|
+
getPayoutRequestPdf: (id: number, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12496
|
+
/**
|
|
12497
|
+
*
|
|
12498
|
+
* @summary Get a single payout request
|
|
12499
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12500
|
+
* @param {*} [options] Override http request option.
|
|
12501
|
+
* @throws {RequiredError}
|
|
12502
|
+
*/
|
|
12503
|
+
getSinglePayoutRequest: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12504
|
+
/**
|
|
12505
|
+
*
|
|
12506
|
+
* @summary Create a new status for a payout request
|
|
12507
|
+
* @param {number} id The ID of the payout request object that should be returned
|
|
12508
|
+
* @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
|
|
11782
12509
|
* @param {*} [options] Override http request option.
|
|
11783
12510
|
* @throws {RequiredError}
|
|
11784
12511
|
*/
|
|
@@ -14195,6 +14922,13 @@ export declare const StripeApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
14195
14922
|
* @throws {RequiredError}
|
|
14196
14923
|
*/
|
|
14197
14924
|
getStripePublicKey: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14925
|
+
/**
|
|
14926
|
+
*
|
|
14927
|
+
* @summary Webhook for Stripe event updates
|
|
14928
|
+
* @param {*} [options] Override http request option.
|
|
14929
|
+
* @throws {RequiredError}
|
|
14930
|
+
*/
|
|
14931
|
+
webhook: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14198
14932
|
};
|
|
14199
14933
|
/**
|
|
14200
14934
|
* StripeApi - functional programming interface
|
|
@@ -14216,6 +14950,13 @@ export declare const StripeApiFp: (configuration?: Configuration) => {
|
|
|
14216
14950
|
* @throws {RequiredError}
|
|
14217
14951
|
*/
|
|
14218
14952
|
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
14953
|
+
/**
|
|
14954
|
+
*
|
|
14955
|
+
* @summary Webhook for Stripe event updates
|
|
14956
|
+
* @param {*} [options] Override http request option.
|
|
14957
|
+
* @throws {RequiredError}
|
|
14958
|
+
*/
|
|
14959
|
+
webhook(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14219
14960
|
};
|
|
14220
14961
|
/**
|
|
14221
14962
|
* StripeApi - factory interface
|
|
@@ -14237,6 +14978,13 @@ export declare const StripeApiFactory: (configuration?: Configuration, basePath?
|
|
|
14237
14978
|
* @throws {RequiredError}
|
|
14238
14979
|
*/
|
|
14239
14980
|
getStripePublicKey(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
14981
|
+
/**
|
|
14982
|
+
*
|
|
14983
|
+
* @summary Webhook for Stripe event updates
|
|
14984
|
+
* @param {*} [options] Override http request option.
|
|
14985
|
+
* @throws {RequiredError}
|
|
14986
|
+
*/
|
|
14987
|
+
webhook(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
14240
14988
|
};
|
|
14241
14989
|
/**
|
|
14242
14990
|
* Request parameters for deposit operation in StripeApi.
|
|
@@ -14275,6 +15023,14 @@ export declare class StripeApi extends BaseAPI {
|
|
|
14275
15023
|
* @memberof StripeApi
|
|
14276
15024
|
*/
|
|
14277
15025
|
getStripePublicKey(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
15026
|
+
/**
|
|
15027
|
+
*
|
|
15028
|
+
* @summary Webhook for Stripe event updates
|
|
15029
|
+
* @param {*} [options] Override http request option.
|
|
15030
|
+
* @throws {RequiredError}
|
|
15031
|
+
* @memberof StripeApi
|
|
15032
|
+
*/
|
|
15033
|
+
webhook(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
14278
15034
|
}
|
|
14279
15035
|
/**
|
|
14280
15036
|
* SyncApi - axios parameter creator
|
|
@@ -14356,6 +15112,253 @@ export declare const GetUserSyncResultsServiceEnum: {
|
|
|
14356
15112
|
readonly Gewisdb: "GEWISDB";
|
|
14357
15113
|
};
|
|
14358
15114
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
15115
|
+
/**
|
|
15116
|
+
* TerminalPaymentsApi - axios parameter creator
|
|
15117
|
+
* @export
|
|
15118
|
+
*/
|
|
15119
|
+
export declare const TerminalPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15120
|
+
/**
|
|
15121
|
+
*
|
|
15122
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15123
|
+
* @param {number} id The ID of the terminal payment
|
|
15124
|
+
* @param {*} [options] Override http request option.
|
|
15125
|
+
* @throws {RequiredError}
|
|
15126
|
+
*/
|
|
15127
|
+
cancelTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15128
|
+
/**
|
|
15129
|
+
*
|
|
15130
|
+
* @summary Create a terminal payment before executing.
|
|
15131
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15132
|
+
* @param {*} [options] Override http request option.
|
|
15133
|
+
* @throws {RequiredError}
|
|
15134
|
+
*/
|
|
15135
|
+
createTerminalPayment: (createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15136
|
+
/**
|
|
15137
|
+
*
|
|
15138
|
+
* @summary Get single terminal payment by ID
|
|
15139
|
+
* @param {number} id The ID of the terminal payment
|
|
15140
|
+
* @param {*} [options] Override http request option.
|
|
15141
|
+
* @throws {RequiredError}
|
|
15142
|
+
*/
|
|
15143
|
+
getSingleTerminalPayment: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15144
|
+
/**
|
|
15145
|
+
*
|
|
15146
|
+
* @summary Get all Stripe terminals
|
|
15147
|
+
* @param {*} [options] Override http request option.
|
|
15148
|
+
* @throws {RequiredError}
|
|
15149
|
+
*/
|
|
15150
|
+
getStripeTerminals: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15151
|
+
/**
|
|
15152
|
+
*
|
|
15153
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15154
|
+
* @param {number} id The ID of the terminal payment
|
|
15155
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15156
|
+
* @param {*} [options] Override http request option.
|
|
15157
|
+
* @throws {RequiredError}
|
|
15158
|
+
*/
|
|
15159
|
+
startTerminalPayment: (id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15160
|
+
};
|
|
15161
|
+
/**
|
|
15162
|
+
* TerminalPaymentsApi - functional programming interface
|
|
15163
|
+
* @export
|
|
15164
|
+
*/
|
|
15165
|
+
export declare const TerminalPaymentsApiFp: (configuration?: Configuration) => {
|
|
15166
|
+
/**
|
|
15167
|
+
*
|
|
15168
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15169
|
+
* @param {number} id The ID of the terminal payment
|
|
15170
|
+
* @param {*} [options] Override http request option.
|
|
15171
|
+
* @throws {RequiredError}
|
|
15172
|
+
*/
|
|
15173
|
+
cancelTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15174
|
+
/**
|
|
15175
|
+
*
|
|
15176
|
+
* @summary Create a terminal payment before executing.
|
|
15177
|
+
* @param {CreateTerminalPaymentRequest} createTerminalPaymentRequest The terminal payment that should be created.
|
|
15178
|
+
* @param {*} [options] Override http request option.
|
|
15179
|
+
* @throws {RequiredError}
|
|
15180
|
+
*/
|
|
15181
|
+
createTerminalPayment(createTerminalPaymentRequest: CreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15182
|
+
/**
|
|
15183
|
+
*
|
|
15184
|
+
* @summary Get single terminal payment by ID
|
|
15185
|
+
* @param {number} id The ID of the terminal payment
|
|
15186
|
+
* @param {*} [options] Override http request option.
|
|
15187
|
+
* @throws {RequiredError}
|
|
15188
|
+
*/
|
|
15189
|
+
getSingleTerminalPayment(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminalPaymentResponse>>;
|
|
15190
|
+
/**
|
|
15191
|
+
*
|
|
15192
|
+
* @summary Get all Stripe terminals
|
|
15193
|
+
* @param {*} [options] Override http request option.
|
|
15194
|
+
* @throws {RequiredError}
|
|
15195
|
+
*/
|
|
15196
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<StripePaymentTerminalResponse>>>;
|
|
15197
|
+
/**
|
|
15198
|
+
*
|
|
15199
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15200
|
+
* @param {number} id The ID of the terminal payment
|
|
15201
|
+
* @param {ProcessTerminalPaymentRequest} processTerminalPaymentRequest Payment options
|
|
15202
|
+
* @param {*} [options] Override http request option.
|
|
15203
|
+
* @throws {RequiredError}
|
|
15204
|
+
*/
|
|
15205
|
+
startTerminalPayment(id: number, processTerminalPaymentRequest: ProcessTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
15206
|
+
};
|
|
15207
|
+
/**
|
|
15208
|
+
* TerminalPaymentsApi - factory interface
|
|
15209
|
+
* @export
|
|
15210
|
+
*/
|
|
15211
|
+
export declare const TerminalPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15212
|
+
/**
|
|
15213
|
+
*
|
|
15214
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15215
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
15216
|
+
* @param {*} [options] Override http request option.
|
|
15217
|
+
* @throws {RequiredError}
|
|
15218
|
+
*/
|
|
15219
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15220
|
+
/**
|
|
15221
|
+
*
|
|
15222
|
+
* @summary Create a terminal payment before executing.
|
|
15223
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15224
|
+
* @param {*} [options] Override http request option.
|
|
15225
|
+
* @throws {RequiredError}
|
|
15226
|
+
*/
|
|
15227
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15228
|
+
/**
|
|
15229
|
+
*
|
|
15230
|
+
* @summary Get single terminal payment by ID
|
|
15231
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15232
|
+
* @param {*} [options] Override http request option.
|
|
15233
|
+
* @throws {RequiredError}
|
|
15234
|
+
*/
|
|
15235
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<TerminalPaymentResponse>;
|
|
15236
|
+
/**
|
|
15237
|
+
*
|
|
15238
|
+
* @summary Get all Stripe terminals
|
|
15239
|
+
* @param {*} [options] Override http request option.
|
|
15240
|
+
* @throws {RequiredError}
|
|
15241
|
+
*/
|
|
15242
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): AxiosPromise<Array<StripePaymentTerminalResponse>>;
|
|
15243
|
+
/**
|
|
15244
|
+
*
|
|
15245
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15246
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
15247
|
+
* @param {*} [options] Override http request option.
|
|
15248
|
+
* @throws {RequiredError}
|
|
15249
|
+
*/
|
|
15250
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
15251
|
+
};
|
|
15252
|
+
/**
|
|
15253
|
+
* Request parameters for cancelTerminalPayment operation in TerminalPaymentsApi.
|
|
15254
|
+
* @export
|
|
15255
|
+
* @interface TerminalPaymentsApiCancelTerminalPaymentRequest
|
|
15256
|
+
*/
|
|
15257
|
+
export interface TerminalPaymentsApiCancelTerminalPaymentRequest {
|
|
15258
|
+
/**
|
|
15259
|
+
* The ID of the terminal payment
|
|
15260
|
+
* @type {number}
|
|
15261
|
+
* @memberof TerminalPaymentsApiCancelTerminalPayment
|
|
15262
|
+
*/
|
|
15263
|
+
readonly id: number;
|
|
15264
|
+
}
|
|
15265
|
+
/**
|
|
15266
|
+
* Request parameters for createTerminalPayment operation in TerminalPaymentsApi.
|
|
15267
|
+
* @export
|
|
15268
|
+
* @interface TerminalPaymentsApiCreateTerminalPaymentRequest
|
|
15269
|
+
*/
|
|
15270
|
+
export interface TerminalPaymentsApiCreateTerminalPaymentRequest {
|
|
15271
|
+
/**
|
|
15272
|
+
* The terminal payment that should be created.
|
|
15273
|
+
* @type {CreateTerminalPaymentRequest}
|
|
15274
|
+
* @memberof TerminalPaymentsApiCreateTerminalPayment
|
|
15275
|
+
*/
|
|
15276
|
+
readonly createTerminalPaymentRequest: CreateTerminalPaymentRequest;
|
|
15277
|
+
}
|
|
15278
|
+
/**
|
|
15279
|
+
* Request parameters for getSingleTerminalPayment operation in TerminalPaymentsApi.
|
|
15280
|
+
* @export
|
|
15281
|
+
* @interface TerminalPaymentsApiGetSingleTerminalPaymentRequest
|
|
15282
|
+
*/
|
|
15283
|
+
export interface TerminalPaymentsApiGetSingleTerminalPaymentRequest {
|
|
15284
|
+
/**
|
|
15285
|
+
* The ID of the terminal payment
|
|
15286
|
+
* @type {number}
|
|
15287
|
+
* @memberof TerminalPaymentsApiGetSingleTerminalPayment
|
|
15288
|
+
*/
|
|
15289
|
+
readonly id: number;
|
|
15290
|
+
}
|
|
15291
|
+
/**
|
|
15292
|
+
* Request parameters for startTerminalPayment operation in TerminalPaymentsApi.
|
|
15293
|
+
* @export
|
|
15294
|
+
* @interface TerminalPaymentsApiStartTerminalPaymentRequest
|
|
15295
|
+
*/
|
|
15296
|
+
export interface TerminalPaymentsApiStartTerminalPaymentRequest {
|
|
15297
|
+
/**
|
|
15298
|
+
* The ID of the terminal payment
|
|
15299
|
+
* @type {number}
|
|
15300
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15301
|
+
*/
|
|
15302
|
+
readonly id: number;
|
|
15303
|
+
/**
|
|
15304
|
+
* Payment options
|
|
15305
|
+
* @type {ProcessTerminalPaymentRequest}
|
|
15306
|
+
* @memberof TerminalPaymentsApiStartTerminalPayment
|
|
15307
|
+
*/
|
|
15308
|
+
readonly processTerminalPaymentRequest: ProcessTerminalPaymentRequest;
|
|
15309
|
+
}
|
|
15310
|
+
/**
|
|
15311
|
+
* TerminalPaymentsApi - object-oriented interface
|
|
15312
|
+
* @export
|
|
15313
|
+
* @class TerminalPaymentsApi
|
|
15314
|
+
* @extends {BaseAPI}
|
|
15315
|
+
*/
|
|
15316
|
+
export declare class TerminalPaymentsApi extends BaseAPI {
|
|
15317
|
+
/**
|
|
15318
|
+
*
|
|
15319
|
+
* @summary Cancel a Terminal Payment that is created/processing
|
|
15320
|
+
* @param {TerminalPaymentsApiCancelTerminalPaymentRequest} requestParameters Request parameters.
|
|
15321
|
+
* @param {*} [options] Override http request option.
|
|
15322
|
+
* @throws {RequiredError}
|
|
15323
|
+
* @memberof TerminalPaymentsApi
|
|
15324
|
+
*/
|
|
15325
|
+
cancelTerminalPayment(requestParameters: TerminalPaymentsApiCancelTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15326
|
+
/**
|
|
15327
|
+
*
|
|
15328
|
+
* @summary Create a terminal payment before executing.
|
|
15329
|
+
* @param {TerminalPaymentsApiCreateTerminalPaymentRequest} requestParameters Request parameters.
|
|
15330
|
+
* @param {*} [options] Override http request option.
|
|
15331
|
+
* @throws {RequiredError}
|
|
15332
|
+
* @memberof TerminalPaymentsApi
|
|
15333
|
+
*/
|
|
15334
|
+
createTerminalPayment(requestParameters: TerminalPaymentsApiCreateTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15335
|
+
/**
|
|
15336
|
+
*
|
|
15337
|
+
* @summary Get single terminal payment by ID
|
|
15338
|
+
* @param {TerminalPaymentsApiGetSingleTerminalPaymentRequest} requestParameters Request parameters.
|
|
15339
|
+
* @param {*} [options] Override http request option.
|
|
15340
|
+
* @throws {RequiredError}
|
|
15341
|
+
* @memberof TerminalPaymentsApi
|
|
15342
|
+
*/
|
|
15343
|
+
getSingleTerminalPayment(requestParameters: TerminalPaymentsApiGetSingleTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalPaymentResponse, any, {}>>;
|
|
15344
|
+
/**
|
|
15345
|
+
*
|
|
15346
|
+
* @summary Get all Stripe terminals
|
|
15347
|
+
* @param {*} [options] Override http request option.
|
|
15348
|
+
* @throws {RequiredError}
|
|
15349
|
+
* @memberof TerminalPaymentsApi
|
|
15350
|
+
*/
|
|
15351
|
+
getStripeTerminals(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripePaymentTerminalResponse[], any, {}>>;
|
|
15352
|
+
/**
|
|
15353
|
+
*
|
|
15354
|
+
* @summary Start the payment process on the terminal for the TerminalPayment with the given ID
|
|
15355
|
+
* @param {TerminalPaymentsApiStartTerminalPaymentRequest} requestParameters Request parameters.
|
|
15356
|
+
* @param {*} [options] Override http request option.
|
|
15357
|
+
* @throws {RequiredError}
|
|
15358
|
+
* @memberof TerminalPaymentsApi
|
|
15359
|
+
*/
|
|
15360
|
+
startTerminalPayment(requestParameters: TerminalPaymentsApiStartTerminalPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
15361
|
+
}
|
|
14359
15362
|
/**
|
|
14360
15363
|
* TermsOfServiceApi - axios parameter creator
|
|
14361
15364
|
* @export
|
|
@@ -15741,7 +16744,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15741
16744
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15742
16745
|
/**
|
|
15743
16746
|
*
|
|
15744
|
-
* @summary Accept the Terms of Service
|
|
16747
|
+
* @summary Accept the current Terms of Service version
|
|
15745
16748
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15746
16749
|
* @param {*} [options] Override http request option.
|
|
15747
16750
|
* @throws {RequiredError}
|
|
@@ -15871,6 +16874,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15871
16874
|
* @throws {RequiredError}
|
|
15872
16875
|
*/
|
|
15873
16876
|
getUserSettings: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16877
|
+
/**
|
|
16878
|
+
*
|
|
16879
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
16880
|
+
* @param {number} id The id of the user
|
|
16881
|
+
* @param {*} [options] Override http request option.
|
|
16882
|
+
* @throws {RequiredError}
|
|
16883
|
+
*/
|
|
16884
|
+
getUserTos: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15874
16885
|
/**
|
|
15875
16886
|
*
|
|
15876
16887
|
* @summary Returns the user\'s containers
|
|
@@ -15893,6 +16904,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15893
16904
|
* @throws {RequiredError}
|
|
15894
16905
|
*/
|
|
15895
16906
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16907
|
+
/**
|
|
16908
|
+
*
|
|
16909
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
16910
|
+
* @param {number} id The id of the beneficiary user.
|
|
16911
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16912
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16913
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16914
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16915
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16916
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16917
|
+
* @param {*} [options] Override http request option.
|
|
16918
|
+
* @throws {RequiredError}
|
|
16919
|
+
*/
|
|
16920
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15896
16921
|
/**
|
|
15897
16922
|
*
|
|
15898
16923
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16103,7 +17128,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16103
17128
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
16104
17129
|
/**
|
|
16105
17130
|
*
|
|
16106
|
-
* @summary Accept the Terms of Service
|
|
17131
|
+
* @summary Accept the current Terms of Service version
|
|
16107
17132
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
16108
17133
|
* @param {*} [options] Override http request option.
|
|
16109
17134
|
* @throws {RequiredError}
|
|
@@ -16233,6 +17258,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16233
17258
|
* @throws {RequiredError}
|
|
16234
17259
|
*/
|
|
16235
17260
|
getUserSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettingsResponse>>;
|
|
17261
|
+
/**
|
|
17262
|
+
*
|
|
17263
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17264
|
+
* @param {number} id The id of the user
|
|
17265
|
+
* @param {*} [options] Override http request option.
|
|
17266
|
+
* @throws {RequiredError}
|
|
17267
|
+
*/
|
|
17268
|
+
getUserTos(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserTosResponse>>;
|
|
16236
17269
|
/**
|
|
16237
17270
|
*
|
|
16238
17271
|
* @summary Returns the user\'s containers
|
|
@@ -16255,6 +17288,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16255
17288
|
* @throws {RequiredError}
|
|
16256
17289
|
*/
|
|
16257
17290
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
17291
|
+
/**
|
|
17292
|
+
*
|
|
17293
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
17294
|
+
* @param {number} id The id of the beneficiary user.
|
|
17295
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
17296
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
17297
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
17298
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
17299
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
17300
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
17301
|
+
* @param {*} [options] Override http request option.
|
|
17302
|
+
* @throws {RequiredError}
|
|
17303
|
+
*/
|
|
17304
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16258
17305
|
/**
|
|
16259
17306
|
*
|
|
16260
17307
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16465,7 +17512,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16465
17512
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16466
17513
|
/**
|
|
16467
17514
|
*
|
|
16468
|
-
* @summary Accept the Terms of Service
|
|
17515
|
+
* @summary Accept the current Terms of Service version
|
|
16469
17516
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16470
17517
|
* @param {*} [options] Override http request option.
|
|
16471
17518
|
* @throws {RequiredError}
|
|
@@ -16583,6 +17630,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16583
17630
|
* @throws {RequiredError}
|
|
16584
17631
|
*/
|
|
16585
17632
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserSettingsResponse>;
|
|
17633
|
+
/**
|
|
17634
|
+
*
|
|
17635
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17636
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
17637
|
+
* @param {*} [options] Override http request option.
|
|
17638
|
+
* @throws {RequiredError}
|
|
17639
|
+
*/
|
|
17640
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserTosResponse>;
|
|
16586
17641
|
/**
|
|
16587
17642
|
*
|
|
16588
17643
|
* @summary Returns the user\'s containers
|
|
@@ -16599,6 +17654,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16599
17654
|
* @throws {RequiredError}
|
|
16600
17655
|
*/
|
|
16601
17656
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17657
|
+
/**
|
|
17658
|
+
*
|
|
17659
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
17660
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17661
|
+
* @param {*} [options] Override http request option.
|
|
17662
|
+
* @throws {RequiredError}
|
|
17663
|
+
*/
|
|
17664
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16602
17665
|
/**
|
|
16603
17666
|
*
|
|
16604
17667
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17028,6 +18091,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
17028
18091
|
*/
|
|
17029
18092
|
readonly id: number;
|
|
17030
18093
|
}
|
|
18094
|
+
/**
|
|
18095
|
+
* Request parameters for getUserTos operation in UsersApi.
|
|
18096
|
+
* @export
|
|
18097
|
+
* @interface UsersApiGetUserTosRequest
|
|
18098
|
+
*/
|
|
18099
|
+
export interface UsersApiGetUserTosRequest {
|
|
18100
|
+
/**
|
|
18101
|
+
* The id of the user
|
|
18102
|
+
* @type {number}
|
|
18103
|
+
* @memberof UsersApiGetUserTos
|
|
18104
|
+
*/
|
|
18105
|
+
readonly id: number;
|
|
18106
|
+
}
|
|
17031
18107
|
/**
|
|
17032
18108
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
17033
18109
|
* @export
|
|
@@ -17090,6 +18166,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17090
18166
|
*/
|
|
17091
18167
|
readonly skip?: number;
|
|
17092
18168
|
}
|
|
18169
|
+
/**
|
|
18170
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
18171
|
+
* @export
|
|
18172
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
18173
|
+
*/
|
|
18174
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
18175
|
+
/**
|
|
18176
|
+
* The id of the beneficiary user.
|
|
18177
|
+
* @type {number}
|
|
18178
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18179
|
+
*/
|
|
18180
|
+
readonly id: number;
|
|
18181
|
+
/**
|
|
18182
|
+
* Filter by creator user id.
|
|
18183
|
+
* @type {number}
|
|
18184
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18185
|
+
*/
|
|
18186
|
+
readonly createdById?: number;
|
|
18187
|
+
/**
|
|
18188
|
+
* Comma-separated list of derived statuses.
|
|
18189
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
18190
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18191
|
+
*/
|
|
18192
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
18193
|
+
/**
|
|
18194
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
18195
|
+
* @type {string}
|
|
18196
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18197
|
+
*/
|
|
18198
|
+
readonly fromDate?: string;
|
|
18199
|
+
/**
|
|
18200
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
18201
|
+
* @type {string}
|
|
18202
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18203
|
+
*/
|
|
18204
|
+
readonly tillDate?: string;
|
|
18205
|
+
/**
|
|
18206
|
+
* How many rows the endpoint should return
|
|
18207
|
+
* @type {number}
|
|
18208
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18209
|
+
*/
|
|
18210
|
+
readonly take?: number;
|
|
18211
|
+
/**
|
|
18212
|
+
* How many rows to skip (for pagination)
|
|
18213
|
+
* @type {number}
|
|
18214
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
18215
|
+
*/
|
|
18216
|
+
readonly skip?: number;
|
|
18217
|
+
}
|
|
17093
18218
|
/**
|
|
17094
18219
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17095
18220
|
* @export
|
|
@@ -17605,7 +18730,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17605
18730
|
export declare class UsersApi extends BaseAPI {
|
|
17606
18731
|
/**
|
|
17607
18732
|
*
|
|
17608
|
-
* @summary Accept the Terms of Service
|
|
18733
|
+
* @summary Accept the current Terms of Service version
|
|
17609
18734
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17610
18735
|
* @param {*} [options] Override http request option.
|
|
17611
18736
|
* @throws {RequiredError}
|
|
@@ -17738,6 +18863,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17738
18863
|
* @memberof UsersApi
|
|
17739
18864
|
*/
|
|
17740
18865
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserSettingsResponse, any, {}>>;
|
|
18866
|
+
/**
|
|
18867
|
+
*
|
|
18868
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
18869
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
18870
|
+
* @param {*} [options] Override http request option.
|
|
18871
|
+
* @throws {RequiredError}
|
|
18872
|
+
* @memberof UsersApi
|
|
18873
|
+
*/
|
|
18874
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserTosResponse, any, {}>>;
|
|
17741
18875
|
/**
|
|
17742
18876
|
*
|
|
17743
18877
|
* @summary Returns the user\'s containers
|
|
@@ -17756,6 +18890,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17756
18890
|
* @memberof UsersApi
|
|
17757
18891
|
*/
|
|
17758
18892
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18893
|
+
/**
|
|
18894
|
+
*
|
|
18895
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
18896
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18897
|
+
* @param {*} [options] Override http request option.
|
|
18898
|
+
* @throws {RequiredError}
|
|
18899
|
+
* @memberof UsersApi
|
|
18900
|
+
*/
|
|
18901
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17759
18902
|
/**
|
|
17760
18903
|
*
|
|
17761
18904
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17951,6 +19094,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17951
19094
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17952
19095
|
};
|
|
17953
19096
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
19097
|
+
/**
|
|
19098
|
+
* @export
|
|
19099
|
+
*/
|
|
19100
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
19101
|
+
readonly Pending: "PENDING";
|
|
19102
|
+
readonly Paid: "PAID";
|
|
19103
|
+
readonly Expired: "EXPIRED";
|
|
19104
|
+
readonly Cancelled: "CANCELLED";
|
|
19105
|
+
};
|
|
19106
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17954
19107
|
/**
|
|
17955
19108
|
* @export
|
|
17956
19109
|
*/
|