@gewis/sudosos-client 0.0.0-develop.c12caf4 → 0.0.0-develop.c93ca19
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 +1321 -345
- package/dist/api.js +1180 -343
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface AcceptTosRequest {
|
|
|
25
25
|
* @memberof AcceptTosRequest
|
|
26
26
|
*/
|
|
27
27
|
'extensiveDataProcessing': boolean;
|
|
28
|
+
/**
|
|
29
|
+
* The TOS version being accepted.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AcceptTosRequest
|
|
32
|
+
*/
|
|
33
|
+
'version': string;
|
|
28
34
|
}
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
@@ -58,6 +64,25 @@ export interface AddRoleRequest {
|
|
|
58
64
|
*/
|
|
59
65
|
'roleId': number;
|
|
60
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @export
|
|
70
|
+
* @interface AuthenticationEanRequest
|
|
71
|
+
*/
|
|
72
|
+
export interface AuthenticationEanRequest {
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @type {string}
|
|
76
|
+
* @memberof AuthenticationEanRequest
|
|
77
|
+
*/
|
|
78
|
+
'eanCode': string;
|
|
79
|
+
/**
|
|
80
|
+
* POS identifier
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof AuthenticationEanRequest
|
|
83
|
+
*/
|
|
84
|
+
'posId': number;
|
|
85
|
+
}
|
|
61
86
|
/**
|
|
62
87
|
*
|
|
63
88
|
* @export
|
|
@@ -134,6 +159,50 @@ export interface AuthenticationMockRequest {
|
|
|
134
159
|
*/
|
|
135
160
|
'nonce': string;
|
|
136
161
|
}
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @export
|
|
165
|
+
* @interface AuthenticationNfcRequest
|
|
166
|
+
*/
|
|
167
|
+
export interface AuthenticationNfcRequest {
|
|
168
|
+
/**
|
|
169
|
+
*
|
|
170
|
+
* @type {string}
|
|
171
|
+
* @memberof AuthenticationNfcRequest
|
|
172
|
+
*/
|
|
173
|
+
'nfcCode': string;
|
|
174
|
+
/**
|
|
175
|
+
* POS identifier
|
|
176
|
+
* @type {number}
|
|
177
|
+
* @memberof AuthenticationNfcRequest
|
|
178
|
+
*/
|
|
179
|
+
'posId': number;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @export
|
|
184
|
+
* @interface AuthenticationPinRequest
|
|
185
|
+
*/
|
|
186
|
+
export interface AuthenticationPinRequest {
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @type {number}
|
|
190
|
+
* @memberof AuthenticationPinRequest
|
|
191
|
+
*/
|
|
192
|
+
'userId': number;
|
|
193
|
+
/**
|
|
194
|
+
*
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof AuthenticationPinRequest
|
|
197
|
+
*/
|
|
198
|
+
'pin': string;
|
|
199
|
+
/**
|
|
200
|
+
* POS identifier
|
|
201
|
+
* @type {number}
|
|
202
|
+
* @memberof AuthenticationPinRequest
|
|
203
|
+
*/
|
|
204
|
+
'posId': number;
|
|
205
|
+
}
|
|
137
206
|
/**
|
|
138
207
|
*
|
|
139
208
|
* @export
|
|
@@ -215,69 +284,6 @@ export interface AuthenticationResponse {
|
|
|
215
284
|
*/
|
|
216
285
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
217
286
|
}
|
|
218
|
-
/**
|
|
219
|
-
*
|
|
220
|
-
* @export
|
|
221
|
-
* @interface AuthenticationSecureEanRequest
|
|
222
|
-
*/
|
|
223
|
-
export interface AuthenticationSecureEanRequest {
|
|
224
|
-
/**
|
|
225
|
-
*
|
|
226
|
-
* @type {string}
|
|
227
|
-
* @memberof AuthenticationSecureEanRequest
|
|
228
|
-
*/
|
|
229
|
-
'eanCode': string;
|
|
230
|
-
/**
|
|
231
|
-
* POS identifier
|
|
232
|
-
* @type {number}
|
|
233
|
-
* @memberof AuthenticationSecureEanRequest
|
|
234
|
-
*/
|
|
235
|
-
'posId': number;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
*
|
|
239
|
-
* @export
|
|
240
|
-
* @interface AuthenticationSecureNfcRequest
|
|
241
|
-
*/
|
|
242
|
-
export interface AuthenticationSecureNfcRequest {
|
|
243
|
-
/**
|
|
244
|
-
*
|
|
245
|
-
* @type {string}
|
|
246
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
247
|
-
*/
|
|
248
|
-
'nfcCode': string;
|
|
249
|
-
/**
|
|
250
|
-
* POS identifier
|
|
251
|
-
* @type {number}
|
|
252
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
253
|
-
*/
|
|
254
|
-
'posId': number;
|
|
255
|
-
}
|
|
256
|
-
/**
|
|
257
|
-
*
|
|
258
|
-
* @export
|
|
259
|
-
* @interface AuthenticationSecurePinRequest
|
|
260
|
-
*/
|
|
261
|
-
export interface AuthenticationSecurePinRequest {
|
|
262
|
-
/**
|
|
263
|
-
*
|
|
264
|
-
* @type {number}
|
|
265
|
-
* @memberof AuthenticationSecurePinRequest
|
|
266
|
-
*/
|
|
267
|
-
'userId': number;
|
|
268
|
-
/**
|
|
269
|
-
*
|
|
270
|
-
* @type {string}
|
|
271
|
-
* @memberof AuthenticationSecurePinRequest
|
|
272
|
-
*/
|
|
273
|
-
'pin': string;
|
|
274
|
-
/**
|
|
275
|
-
* POS identifier (required for secure authentication)
|
|
276
|
-
* @type {number}
|
|
277
|
-
* @memberof AuthenticationSecurePinRequest
|
|
278
|
-
*/
|
|
279
|
-
'posId': number;
|
|
280
|
-
}
|
|
281
287
|
/**
|
|
282
288
|
*
|
|
283
289
|
* @export
|
|
@@ -901,6 +907,104 @@ export interface BaseInvoiceResponse {
|
|
|
901
907
|
*/
|
|
902
908
|
'totalInclVat': DineroObjectResponse;
|
|
903
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* PaymentRequest is UUID-keyed. To avoid overloading the `id` slot (which on other responses is the numeric DB id), the UUID is exposed under a semantically named field, mirroring how `QRAuthenticator` exposes its UUID as `sessionId`. The response therefore extends `BaseResponseWithoutId` (timestamps + version, no `id`) and declares a `uuid` of its own.
|
|
912
|
+
* @export
|
|
913
|
+
* @interface BasePaymentRequestResponse
|
|
914
|
+
*/
|
|
915
|
+
export interface BasePaymentRequestResponse {
|
|
916
|
+
/**
|
|
917
|
+
* UUID v4 identifier (also the public share-link id).
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof BasePaymentRequestResponse
|
|
920
|
+
*/
|
|
921
|
+
'uuid': string;
|
|
922
|
+
/**
|
|
923
|
+
* ISO-8601 creation timestamp.
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof BasePaymentRequestResponse
|
|
926
|
+
*/
|
|
927
|
+
'createdAt'?: string;
|
|
928
|
+
/**
|
|
929
|
+
* ISO-8601 last update timestamp.
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof BasePaymentRequestResponse
|
|
932
|
+
*/
|
|
933
|
+
'updatedAt'?: string;
|
|
934
|
+
/**
|
|
935
|
+
* Optimistic-locking version.
|
|
936
|
+
* @type {number}
|
|
937
|
+
* @memberof BasePaymentRequestResponse
|
|
938
|
+
*/
|
|
939
|
+
'version'?: number;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {BaseUserResponse}
|
|
943
|
+
* @memberof BasePaymentRequestResponse
|
|
944
|
+
*/
|
|
945
|
+
'for': BaseUserResponse;
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {BaseUserResponse}
|
|
949
|
+
* @memberof BasePaymentRequestResponse
|
|
950
|
+
*/
|
|
951
|
+
'createdBy': BaseUserResponse;
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {DineroObjectResponse}
|
|
955
|
+
* @memberof BasePaymentRequestResponse
|
|
956
|
+
*/
|
|
957
|
+
'amount': DineroObjectResponse;
|
|
958
|
+
/**
|
|
959
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof BasePaymentRequestResponse
|
|
962
|
+
*/
|
|
963
|
+
'expiresAt': string;
|
|
964
|
+
/**
|
|
965
|
+
* ISO-8601 timestamp the request was marked paid (null if not paid).
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof BasePaymentRequestResponse
|
|
968
|
+
*/
|
|
969
|
+
'paidAt'?: string;
|
|
970
|
+
/**
|
|
971
|
+
* ISO-8601 timestamp the request was cancelled (null if not cancelled).
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof BasePaymentRequestResponse
|
|
974
|
+
*/
|
|
975
|
+
'cancelledAt'?: string;
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {BaseUserResponse}
|
|
979
|
+
* @memberof BasePaymentRequestResponse
|
|
980
|
+
*/
|
|
981
|
+
'cancelledBy'?: BaseUserResponse;
|
|
982
|
+
/**
|
|
983
|
+
*
|
|
984
|
+
* @type {BaseUserResponse}
|
|
985
|
+
* @memberof BasePaymentRequestResponse
|
|
986
|
+
*/
|
|
987
|
+
'fulfilledBy'?: BaseUserResponse;
|
|
988
|
+
/**
|
|
989
|
+
* Optional human-readable description.
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof BasePaymentRequestResponse
|
|
992
|
+
*/
|
|
993
|
+
'description'?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Derived lifecycle status.
|
|
996
|
+
* @type {string}
|
|
997
|
+
* @memberof BasePaymentRequestResponse
|
|
998
|
+
*/
|
|
999
|
+
'status': BasePaymentRequestResponseStatusEnum;
|
|
1000
|
+
}
|
|
1001
|
+
export declare const BasePaymentRequestResponseStatusEnum: {
|
|
1002
|
+
readonly Pending: "PENDING";
|
|
1003
|
+
readonly Paid: "PAID";
|
|
1004
|
+
readonly Expired: "EXPIRED";
|
|
1005
|
+
readonly Cancelled: "CANCELLED";
|
|
1006
|
+
};
|
|
1007
|
+
export type BasePaymentRequestResponseStatusEnum = typeof BasePaymentRequestResponseStatusEnum[keyof typeof BasePaymentRequestResponseStatusEnum];
|
|
904
1008
|
/**
|
|
905
1009
|
*
|
|
906
1010
|
* @export
|
|
@@ -1141,6 +1245,31 @@ export interface BaseResponse {
|
|
|
1141
1245
|
*/
|
|
1142
1246
|
'version'?: number;
|
|
1143
1247
|
}
|
|
1248
|
+
/**
|
|
1249
|
+
* Standard timestamp/version fields every response shares, without an `id`. Responses that key on a UUID (or any non-integer identifier) extend this and add their own `id` field. Responses keyed on an integer id extend `BaseResponse` instead, which adds `id: number`. Parallel to `BaseEntityWithoutId` on the entity side.
|
|
1250
|
+
* @export
|
|
1251
|
+
* @interface BaseResponseWithoutId
|
|
1252
|
+
*/
|
|
1253
|
+
export interface BaseResponseWithoutId {
|
|
1254
|
+
/**
|
|
1255
|
+
* The creation Date of the entity.
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof BaseResponseWithoutId
|
|
1258
|
+
*/
|
|
1259
|
+
'createdAt'?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The last update Date of the entity.
|
|
1262
|
+
* @type {string}
|
|
1263
|
+
* @memberof BaseResponseWithoutId
|
|
1264
|
+
*/
|
|
1265
|
+
'updatedAt'?: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* The version of the entity.
|
|
1268
|
+
* @type {number}
|
|
1269
|
+
* @memberof BaseResponseWithoutId
|
|
1270
|
+
*/
|
|
1271
|
+
'version'?: number;
|
|
1272
|
+
}
|
|
1144
1273
|
/**
|
|
1145
1274
|
*
|
|
1146
1275
|
* @export
|
|
@@ -1779,6 +1908,37 @@ export interface CreateInvoiceRequest {
|
|
|
1779
1908
|
*/
|
|
1780
1909
|
'amount': DineroObjectRequest;
|
|
1781
1910
|
}
|
|
1911
|
+
/**
|
|
1912
|
+
*
|
|
1913
|
+
* @export
|
|
1914
|
+
* @interface CreatePaymentRequestRequest
|
|
1915
|
+
*/
|
|
1916
|
+
export interface CreatePaymentRequestRequest {
|
|
1917
|
+
/**
|
|
1918
|
+
* The ID of the user whose balance will be credited on payment.
|
|
1919
|
+
* @type {number}
|
|
1920
|
+
* @memberof CreatePaymentRequestRequest
|
|
1921
|
+
*/
|
|
1922
|
+
'forId': number;
|
|
1923
|
+
/**
|
|
1924
|
+
*
|
|
1925
|
+
* @type {DineroObjectRequest}
|
|
1926
|
+
* @memberof CreatePaymentRequestRequest
|
|
1927
|
+
*/
|
|
1928
|
+
'amount': DineroObjectRequest;
|
|
1929
|
+
/**
|
|
1930
|
+
* ISO-8601 timestamp after which the request stops accepting payments.
|
|
1931
|
+
* @type {string}
|
|
1932
|
+
* @memberof CreatePaymentRequestRequest
|
|
1933
|
+
*/
|
|
1934
|
+
'expiresAt': string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Optional human-readable description (e.g. invoice reference).
|
|
1937
|
+
* @type {string}
|
|
1938
|
+
* @memberof CreatePaymentRequestRequest
|
|
1939
|
+
*/
|
|
1940
|
+
'description'?: string;
|
|
1941
|
+
}
|
|
1782
1942
|
/**
|
|
1783
1943
|
*
|
|
1784
1944
|
* @export
|
|
@@ -3109,25 +3269,38 @@ export interface InvoiceUserResponse {
|
|
|
3109
3269
|
/**
|
|
3110
3270
|
*
|
|
3111
3271
|
* @export
|
|
3112
|
-
* @interface
|
|
3272
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3273
|
+
*/
|
|
3274
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3275
|
+
/**
|
|
3276
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3277
|
+
* @type {string}
|
|
3278
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3279
|
+
*/
|
|
3280
|
+
'reason': string;
|
|
3281
|
+
}
|
|
3282
|
+
/**
|
|
3283
|
+
*
|
|
3284
|
+
* @export
|
|
3285
|
+
* @interface MemberAuthenticationPinRequest
|
|
3113
3286
|
*/
|
|
3114
|
-
export interface
|
|
3287
|
+
export interface MemberAuthenticationPinRequest {
|
|
3115
3288
|
/**
|
|
3116
3289
|
*
|
|
3117
3290
|
* @type {number}
|
|
3118
|
-
* @memberof
|
|
3291
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3119
3292
|
*/
|
|
3120
3293
|
'memberId': number;
|
|
3121
3294
|
/**
|
|
3122
3295
|
*
|
|
3123
3296
|
* @type {string}
|
|
3124
|
-
* @memberof
|
|
3297
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3125
3298
|
*/
|
|
3126
3299
|
'pin': string;
|
|
3127
3300
|
/**
|
|
3128
3301
|
* POS identifier
|
|
3129
3302
|
* @type {number}
|
|
3130
|
-
* @memberof
|
|
3303
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3131
3304
|
*/
|
|
3132
3305
|
'posId': number;
|
|
3133
3306
|
}
|
|
@@ -3201,6 +3374,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3201
3374
|
*/
|
|
3202
3375
|
'records': Array<BaseEventResponse>;
|
|
3203
3376
|
}
|
|
3377
|
+
/**
|
|
3378
|
+
*
|
|
3379
|
+
* @export
|
|
3380
|
+
* @interface PaginatedBasePaymentRequestResponse
|
|
3381
|
+
*/
|
|
3382
|
+
export interface PaginatedBasePaymentRequestResponse {
|
|
3383
|
+
/**
|
|
3384
|
+
*
|
|
3385
|
+
* @type {PaginationResult}
|
|
3386
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3387
|
+
*/
|
|
3388
|
+
'_pagination': PaginationResult;
|
|
3389
|
+
/**
|
|
3390
|
+
* Returned payment requests
|
|
3391
|
+
* @type {Array<BasePaymentRequestResponse>}
|
|
3392
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3393
|
+
*/
|
|
3394
|
+
'records': Array<BasePaymentRequestResponse>;
|
|
3395
|
+
}
|
|
3204
3396
|
/**
|
|
3205
3397
|
*
|
|
3206
3398
|
* @export
|
|
@@ -3631,6 +3823,31 @@ export interface PatchUserTypeRequest {
|
|
|
3631
3823
|
*/
|
|
3632
3824
|
'userType': string;
|
|
3633
3825
|
}
|
|
3826
|
+
/**
|
|
3827
|
+
* Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
|
|
3828
|
+
* @export
|
|
3829
|
+
* @interface PaymentRequestStartResponse
|
|
3830
|
+
*/
|
|
3831
|
+
export interface PaymentRequestStartResponse {
|
|
3832
|
+
/**
|
|
3833
|
+
* The PaymentRequest id the intent is linked to.
|
|
3834
|
+
* @type {string}
|
|
3835
|
+
* @memberof PaymentRequestStartResponse
|
|
3836
|
+
*/
|
|
3837
|
+
'paymentRequestId': string;
|
|
3838
|
+
/**
|
|
3839
|
+
* Stripe payment intent id.
|
|
3840
|
+
* @type {string}
|
|
3841
|
+
* @memberof PaymentRequestStartResponse
|
|
3842
|
+
*/
|
|
3843
|
+
'stripeId': string;
|
|
3844
|
+
/**
|
|
3845
|
+
* Stripe client secret for the intent.
|
|
3846
|
+
* @type {string}
|
|
3847
|
+
* @memberof PaymentRequestStartResponse
|
|
3848
|
+
*/
|
|
3849
|
+
'clientSecret': string;
|
|
3850
|
+
}
|
|
3634
3851
|
/**
|
|
3635
3852
|
*
|
|
3636
3853
|
* @export
|
|
@@ -4156,27 +4373,77 @@ export interface ProductResponse {
|
|
|
4156
4373
|
'priceList': boolean;
|
|
4157
4374
|
}
|
|
4158
4375
|
/**
|
|
4159
|
-
*
|
|
4376
|
+
* Minimal response returned to unauthenticated callers of the public share link endpoint. It deliberately omits `createdBy`, `cancelledBy`, and other internal audit fields — anyone with the link can see it, so we leak as little user info as possible.
|
|
4160
4377
|
* @export
|
|
4161
|
-
* @interface
|
|
4378
|
+
* @interface PublicPaymentRequestResponse
|
|
4162
4379
|
*/
|
|
4163
|
-
export interface
|
|
4380
|
+
export interface PublicPaymentRequestResponse {
|
|
4164
4381
|
/**
|
|
4165
|
-
*
|
|
4382
|
+
* UUID v4 identifier.
|
|
4166
4383
|
* @type {string}
|
|
4167
|
-
* @memberof
|
|
4384
|
+
* @memberof PublicPaymentRequestResponse
|
|
4168
4385
|
*/
|
|
4169
|
-
'
|
|
4386
|
+
'uuid': string;
|
|
4170
4387
|
/**
|
|
4171
|
-
*
|
|
4388
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4172
4389
|
* @type {string}
|
|
4173
|
-
* @memberof
|
|
4390
|
+
* @memberof PublicPaymentRequestResponse
|
|
4174
4391
|
*/
|
|
4175
|
-
'
|
|
4392
|
+
'forDisplayName': string;
|
|
4176
4393
|
/**
|
|
4177
|
-
*
|
|
4178
|
-
* @type {
|
|
4179
|
-
* @memberof
|
|
4394
|
+
*
|
|
4395
|
+
* @type {DineroObjectResponse}
|
|
4396
|
+
* @memberof PublicPaymentRequestResponse
|
|
4397
|
+
*/
|
|
4398
|
+
'amount': DineroObjectResponse;
|
|
4399
|
+
/**
|
|
4400
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4401
|
+
* @type {string}
|
|
4402
|
+
* @memberof PublicPaymentRequestResponse
|
|
4403
|
+
*/
|
|
4404
|
+
'expiresAt': string;
|
|
4405
|
+
/**
|
|
4406
|
+
* Optional human-readable description.
|
|
4407
|
+
* @type {string}
|
|
4408
|
+
* @memberof PublicPaymentRequestResponse
|
|
4409
|
+
*/
|
|
4410
|
+
'description'?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* Derived lifecycle status.
|
|
4413
|
+
* @type {string}
|
|
4414
|
+
* @memberof PublicPaymentRequestResponse
|
|
4415
|
+
*/
|
|
4416
|
+
'status': PublicPaymentRequestResponseStatusEnum;
|
|
4417
|
+
}
|
|
4418
|
+
export declare const PublicPaymentRequestResponseStatusEnum: {
|
|
4419
|
+
readonly Pending: "PENDING";
|
|
4420
|
+
readonly Paid: "PAID";
|
|
4421
|
+
readonly Expired: "EXPIRED";
|
|
4422
|
+
readonly Cancelled: "CANCELLED";
|
|
4423
|
+
};
|
|
4424
|
+
export type PublicPaymentRequestResponseStatusEnum = typeof PublicPaymentRequestResponseStatusEnum[keyof typeof PublicPaymentRequestResponseStatusEnum];
|
|
4425
|
+
/**
|
|
4426
|
+
*
|
|
4427
|
+
* @export
|
|
4428
|
+
* @interface QRCodeResponse
|
|
4429
|
+
*/
|
|
4430
|
+
export interface QRCodeResponse {
|
|
4431
|
+
/**
|
|
4432
|
+
* The session ID
|
|
4433
|
+
* @type {string}
|
|
4434
|
+
* @memberof QRCodeResponse
|
|
4435
|
+
*/
|
|
4436
|
+
'sessionId': string;
|
|
4437
|
+
/**
|
|
4438
|
+
* The QR code URL
|
|
4439
|
+
* @type {string}
|
|
4440
|
+
* @memberof QRCodeResponse
|
|
4441
|
+
*/
|
|
4442
|
+
'qrCodeUrl': string;
|
|
4443
|
+
/**
|
|
4444
|
+
* The expiry date of the QR code
|
|
4445
|
+
* @type {string}
|
|
4446
|
+
* @memberof QRCodeResponse
|
|
4180
4447
|
*/
|
|
4181
4448
|
'expiresAt': string;
|
|
4182
4449
|
}
|
|
@@ -5036,6 +5303,12 @@ export interface TermsOfServiceResponse {
|
|
|
5036
5303
|
* @memberof TermsOfServiceResponse
|
|
5037
5304
|
*/
|
|
5038
5305
|
'versionNumber': string;
|
|
5306
|
+
/**
|
|
5307
|
+
* The date this version took effect.
|
|
5308
|
+
* @type {string}
|
|
5309
|
+
* @memberof TermsOfServiceResponse
|
|
5310
|
+
*/
|
|
5311
|
+
'date': string;
|
|
5039
5312
|
/**
|
|
5040
5313
|
* The terms of service content.
|
|
5041
5314
|
* @type {string}
|
|
@@ -5043,6 +5316,17 @@ export interface TermsOfServiceResponse {
|
|
|
5043
5316
|
*/
|
|
5044
5317
|
'content': string;
|
|
5045
5318
|
}
|
|
5319
|
+
/**
|
|
5320
|
+
* The terms of service status of a user
|
|
5321
|
+
* @export
|
|
5322
|
+
* @enum {string}
|
|
5323
|
+
*/
|
|
5324
|
+
export declare const TermsOfServiceStatus: {
|
|
5325
|
+
readonly Accepted: "ACCEPTED";
|
|
5326
|
+
readonly NotAccepted: "NOT_ACCEPTED";
|
|
5327
|
+
readonly NotRequired: "NOT_REQUIRED";
|
|
5328
|
+
};
|
|
5329
|
+
export type TermsOfServiceStatus = typeof TermsOfServiceStatus[keyof typeof TermsOfServiceStatus];
|
|
5046
5330
|
/**
|
|
5047
5331
|
*
|
|
5048
5332
|
* @export
|
|
@@ -6109,6 +6393,12 @@ export interface UpdateUserRequest {
|
|
|
6109
6393
|
* @memberof UpdateUserRequest
|
|
6110
6394
|
*/
|
|
6111
6395
|
'inactiveNotificationSend'?: boolean;
|
|
6396
|
+
/**
|
|
6397
|
+
* ISO date at which the account expires; pass null to clear
|
|
6398
|
+
* @type {string}
|
|
6399
|
+
* @memberof UpdateUserRequest
|
|
6400
|
+
*/
|
|
6401
|
+
'expiryDate'?: string | null;
|
|
6112
6402
|
}
|
|
6113
6403
|
/**
|
|
6114
6404
|
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
@@ -6284,11 +6574,11 @@ export interface UserResponse {
|
|
|
6284
6574
|
*/
|
|
6285
6575
|
'email'?: string;
|
|
6286
6576
|
/**
|
|
6287
|
-
* Whether this user
|
|
6288
|
-
* @type {
|
|
6577
|
+
* Whether this user is required to accept the TOS
|
|
6578
|
+
* @type {boolean}
|
|
6289
6579
|
* @memberof UserResponse
|
|
6290
6580
|
*/
|
|
6291
|
-
'
|
|
6581
|
+
'tosRequired'?: boolean;
|
|
6292
6582
|
/**
|
|
6293
6583
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6294
6584
|
* @type {boolean}
|
|
@@ -6325,6 +6615,12 @@ export interface UserResponse {
|
|
|
6325
6615
|
* @memberof UserResponse
|
|
6326
6616
|
*/
|
|
6327
6617
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6618
|
+
/**
|
|
6619
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6620
|
+
* @type {string}
|
|
6621
|
+
* @memberof UserResponse
|
|
6622
|
+
*/
|
|
6623
|
+
'expiryDate'?: string | null;
|
|
6328
6624
|
}
|
|
6329
6625
|
/**
|
|
6330
6626
|
*
|
|
@@ -6431,6 +6727,50 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6431
6727
|
*/
|
|
6432
6728
|
'nickname'?: string;
|
|
6433
6729
|
}
|
|
6730
|
+
/**
|
|
6731
|
+
*
|
|
6732
|
+
* @export
|
|
6733
|
+
* @interface UserTosAcceptanceResponse
|
|
6734
|
+
*/
|
|
6735
|
+
export interface UserTosAcceptanceResponse {
|
|
6736
|
+
/**
|
|
6737
|
+
* The accepted terms of service version number.
|
|
6738
|
+
* @type {string}
|
|
6739
|
+
* @memberof UserTosAcceptanceResponse
|
|
6740
|
+
*/
|
|
6741
|
+
'versionNumber': string;
|
|
6742
|
+
/**
|
|
6743
|
+
* The date at which this version was accepted.
|
|
6744
|
+
* @type {string}
|
|
6745
|
+
* @memberof UserTosAcceptanceResponse
|
|
6746
|
+
*/
|
|
6747
|
+
'acceptedAt': string;
|
|
6748
|
+
}
|
|
6749
|
+
/**
|
|
6750
|
+
*
|
|
6751
|
+
* @export
|
|
6752
|
+
* @interface UserTosResponse
|
|
6753
|
+
*/
|
|
6754
|
+
export interface UserTosResponse {
|
|
6755
|
+
/**
|
|
6756
|
+
*
|
|
6757
|
+
* @type {TermsOfServiceStatus}
|
|
6758
|
+
* @memberof UserTosResponse
|
|
6759
|
+
*/
|
|
6760
|
+
'status': TermsOfServiceStatus;
|
|
6761
|
+
/**
|
|
6762
|
+
* The current terms of service version number.
|
|
6763
|
+
* @type {string}
|
|
6764
|
+
* @memberof UserTosResponse
|
|
6765
|
+
*/
|
|
6766
|
+
'currentVersion': string;
|
|
6767
|
+
/**
|
|
6768
|
+
* All TOS versions the user has accepted.
|
|
6769
|
+
* @type {Array<UserTosAcceptanceResponse>}
|
|
6770
|
+
* @memberof UserTosResponse
|
|
6771
|
+
*/
|
|
6772
|
+
'acceptances': Array<UserTosAcceptanceResponse>;
|
|
6773
|
+
}
|
|
6434
6774
|
/**
|
|
6435
6775
|
* The type of a user
|
|
6436
6776
|
* @export
|
|
@@ -6996,6 +7336,14 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6996
7336
|
* @throws {RequiredError}
|
|
6997
7337
|
*/
|
|
6998
7338
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7339
|
+
/**
|
|
7340
|
+
*
|
|
7341
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7342
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7343
|
+
* @param {*} [options] Override http request option.
|
|
7344
|
+
* @throws {RequiredError}
|
|
7345
|
+
*/
|
|
7346
|
+
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6999
7347
|
/**
|
|
7000
7348
|
*
|
|
7001
7349
|
* @summary Generate a QR code for authentication
|
|
@@ -7067,67 +7415,59 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7067
7415
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7068
7416
|
/**
|
|
7069
7417
|
*
|
|
7070
|
-
* @summary
|
|
7071
|
-
* @param {
|
|
7072
|
-
* @param {*} [options] Override http request option.
|
|
7073
|
-
* @throws {RequiredError}
|
|
7074
|
-
*/
|
|
7075
|
-
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7076
|
-
/**
|
|
7077
|
-
*
|
|
7078
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7418
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7419
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7079
7420
|
* @param {*} [options] Override http request option.
|
|
7080
7421
|
* @throws {RequiredError}
|
|
7081
7422
|
*/
|
|
7082
|
-
|
|
7423
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7083
7424
|
/**
|
|
7084
7425
|
*
|
|
7085
|
-
* @summary
|
|
7086
|
-
* @param {
|
|
7426
|
+
* @summary Mock login and hand out token.
|
|
7427
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7087
7428
|
* @param {*} [options] Override http request option.
|
|
7088
7429
|
* @throws {RequiredError}
|
|
7089
7430
|
*/
|
|
7090
|
-
|
|
7431
|
+
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7091
7432
|
/**
|
|
7092
7433
|
*
|
|
7093
|
-
* @summary
|
|
7094
|
-
* @param {
|
|
7434
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7435
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7095
7436
|
* @param {*} [options] Override http request option.
|
|
7096
7437
|
* @throws {RequiredError}
|
|
7097
7438
|
*/
|
|
7098
|
-
|
|
7439
|
+
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7099
7440
|
/**
|
|
7100
7441
|
*
|
|
7101
|
-
* @summary
|
|
7102
|
-
* @param {
|
|
7442
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7443
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7103
7444
|
* @param {*} [options] Override http request option.
|
|
7104
7445
|
* @throws {RequiredError}
|
|
7105
7446
|
*/
|
|
7106
|
-
|
|
7447
|
+
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7107
7448
|
/**
|
|
7108
7449
|
*
|
|
7109
|
-
* @summary
|
|
7110
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7450
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7111
7451
|
* @param {*} [options] Override http request option.
|
|
7112
7452
|
* @throws {RequiredError}
|
|
7113
7453
|
*/
|
|
7114
|
-
|
|
7454
|
+
refreshToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7115
7455
|
/**
|
|
7116
7456
|
*
|
|
7117
|
-
* @summary
|
|
7118
|
-
* @param {
|
|
7457
|
+
* @summary Creates a reset token for the local authentication
|
|
7458
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7119
7459
|
* @param {*} [options] Override http request option.
|
|
7120
7460
|
* @throws {RequiredError}
|
|
7121
7461
|
*/
|
|
7122
|
-
|
|
7462
|
+
resetLocal: (resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7123
7463
|
/**
|
|
7124
7464
|
*
|
|
7125
|
-
* @summary
|
|
7126
|
-
* @param {
|
|
7465
|
+
* @summary Reset local authentication using the provided token
|
|
7466
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7127
7467
|
* @param {*} [options] Override http request option.
|
|
7128
7468
|
* @throws {RequiredError}
|
|
7129
7469
|
*/
|
|
7130
|
-
|
|
7470
|
+
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7131
7471
|
};
|
|
7132
7472
|
/**
|
|
7133
7473
|
* AuthenticateApi - functional programming interface
|
|
@@ -7158,6 +7498,14 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7158
7498
|
* @throws {RequiredError}
|
|
7159
7499
|
*/
|
|
7160
7500
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7501
|
+
/**
|
|
7502
|
+
*
|
|
7503
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7504
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7505
|
+
* @param {*} [options] Override http request option.
|
|
7506
|
+
* @throws {RequiredError}
|
|
7507
|
+
*/
|
|
7508
|
+
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7161
7509
|
/**
|
|
7162
7510
|
*
|
|
7163
7511
|
* @summary Generate a QR code for authentication
|
|
@@ -7229,67 +7577,59 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7229
7577
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7230
7578
|
/**
|
|
7231
7579
|
*
|
|
7232
|
-
* @summary
|
|
7233
|
-
* @param {
|
|
7234
|
-
* @param {*} [options] Override http request option.
|
|
7235
|
-
* @throws {RequiredError}
|
|
7236
|
-
*/
|
|
7237
|
-
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7238
|
-
/**
|
|
7239
|
-
*
|
|
7240
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7580
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7581
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7241
7582
|
* @param {*} [options] Override http request option.
|
|
7242
7583
|
* @throws {RequiredError}
|
|
7243
7584
|
*/
|
|
7244
|
-
|
|
7585
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7245
7586
|
/**
|
|
7246
7587
|
*
|
|
7247
|
-
* @summary
|
|
7248
|
-
* @param {
|
|
7588
|
+
* @summary Mock login and hand out token.
|
|
7589
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7249
7590
|
* @param {*} [options] Override http request option.
|
|
7250
7591
|
* @throws {RequiredError}
|
|
7251
7592
|
*/
|
|
7252
|
-
|
|
7593
|
+
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7253
7594
|
/**
|
|
7254
7595
|
*
|
|
7255
|
-
* @summary
|
|
7256
|
-
* @param {
|
|
7596
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7597
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7257
7598
|
* @param {*} [options] Override http request option.
|
|
7258
7599
|
* @throws {RequiredError}
|
|
7259
7600
|
*/
|
|
7260
|
-
|
|
7601
|
+
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7261
7602
|
/**
|
|
7262
7603
|
*
|
|
7263
|
-
* @summary
|
|
7264
|
-
* @param {
|
|
7604
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7605
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7265
7606
|
* @param {*} [options] Override http request option.
|
|
7266
7607
|
* @throws {RequiredError}
|
|
7267
7608
|
*/
|
|
7268
|
-
|
|
7609
|
+
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7269
7610
|
/**
|
|
7270
7611
|
*
|
|
7271
|
-
* @summary
|
|
7272
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7612
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7273
7613
|
* @param {*} [options] Override http request option.
|
|
7274
7614
|
* @throws {RequiredError}
|
|
7275
7615
|
*/
|
|
7276
|
-
|
|
7616
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7277
7617
|
/**
|
|
7278
7618
|
*
|
|
7279
|
-
* @summary
|
|
7280
|
-
* @param {
|
|
7619
|
+
* @summary Creates a reset token for the local authentication
|
|
7620
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7281
7621
|
* @param {*} [options] Override http request option.
|
|
7282
7622
|
* @throws {RequiredError}
|
|
7283
7623
|
*/
|
|
7284
|
-
|
|
7624
|
+
resetLocal(resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7285
7625
|
/**
|
|
7286
7626
|
*
|
|
7287
|
-
* @summary
|
|
7288
|
-
* @param {
|
|
7627
|
+
* @summary Reset local authentication using the provided token
|
|
7628
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7289
7629
|
* @param {*} [options] Override http request option.
|
|
7290
7630
|
* @throws {RequiredError}
|
|
7291
7631
|
*/
|
|
7292
|
-
|
|
7632
|
+
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7293
7633
|
};
|
|
7294
7634
|
/**
|
|
7295
7635
|
* AuthenticateApi - factory interface
|
|
@@ -7320,6 +7660,14 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7320
7660
|
* @throws {RequiredError}
|
|
7321
7661
|
*/
|
|
7322
7662
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7663
|
+
/**
|
|
7664
|
+
*
|
|
7665
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7666
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7667
|
+
* @param {*} [options] Override http request option.
|
|
7668
|
+
* @throws {RequiredError}
|
|
7669
|
+
*/
|
|
7670
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7323
7671
|
/**
|
|
7324
7672
|
*
|
|
7325
7673
|
* @summary Generate a QR code for authentication
|
|
@@ -7391,67 +7739,59 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7391
7739
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7392
7740
|
/**
|
|
7393
7741
|
*
|
|
7394
|
-
* @summary
|
|
7395
|
-
* @param {
|
|
7396
|
-
* @param {*} [options] Override http request option.
|
|
7397
|
-
* @throws {RequiredError}
|
|
7398
|
-
*/
|
|
7399
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7400
|
-
/**
|
|
7401
|
-
*
|
|
7402
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7742
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7743
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7403
7744
|
* @param {*} [options] Override http request option.
|
|
7404
7745
|
* @throws {RequiredError}
|
|
7405
7746
|
*/
|
|
7406
|
-
|
|
7747
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7407
7748
|
/**
|
|
7408
7749
|
*
|
|
7409
|
-
* @summary
|
|
7410
|
-
* @param {
|
|
7750
|
+
* @summary Mock login and hand out token.
|
|
7751
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7411
7752
|
* @param {*} [options] Override http request option.
|
|
7412
7753
|
* @throws {RequiredError}
|
|
7413
7754
|
*/
|
|
7414
|
-
|
|
7755
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7415
7756
|
/**
|
|
7416
7757
|
*
|
|
7417
|
-
* @summary
|
|
7418
|
-
* @param {
|
|
7758
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7759
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7419
7760
|
* @param {*} [options] Override http request option.
|
|
7420
7761
|
* @throws {RequiredError}
|
|
7421
7762
|
*/
|
|
7422
|
-
|
|
7763
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7423
7764
|
/**
|
|
7424
7765
|
*
|
|
7425
|
-
* @summary
|
|
7426
|
-
* @param {
|
|
7766
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7767
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7427
7768
|
* @param {*} [options] Override http request option.
|
|
7428
7769
|
* @throws {RequiredError}
|
|
7429
7770
|
*/
|
|
7430
|
-
|
|
7771
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7431
7772
|
/**
|
|
7432
7773
|
*
|
|
7433
|
-
* @summary
|
|
7434
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7774
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7435
7775
|
* @param {*} [options] Override http request option.
|
|
7436
7776
|
* @throws {RequiredError}
|
|
7437
7777
|
*/
|
|
7438
|
-
|
|
7778
|
+
refreshToken(options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7439
7779
|
/**
|
|
7440
7780
|
*
|
|
7441
|
-
* @summary
|
|
7442
|
-
* @param {
|
|
7781
|
+
* @summary Creates a reset token for the local authentication
|
|
7782
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7443
7783
|
* @param {*} [options] Override http request option.
|
|
7444
7784
|
* @throws {RequiredError}
|
|
7445
7785
|
*/
|
|
7446
|
-
|
|
7786
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7447
7787
|
/**
|
|
7448
7788
|
*
|
|
7449
|
-
* @summary
|
|
7450
|
-
* @param {
|
|
7789
|
+
* @summary Reset local authentication using the provided token
|
|
7790
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7451
7791
|
* @param {*} [options] Override http request option.
|
|
7452
7792
|
* @throws {RequiredError}
|
|
7453
7793
|
*/
|
|
7454
|
-
|
|
7794
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7455
7795
|
};
|
|
7456
7796
|
/**
|
|
7457
7797
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7492,6 +7832,19 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7492
7832
|
*/
|
|
7493
7833
|
readonly sessionId: string;
|
|
7494
7834
|
}
|
|
7835
|
+
/**
|
|
7836
|
+
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7837
|
+
* @export
|
|
7838
|
+
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7839
|
+
*/
|
|
7840
|
+
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7841
|
+
/**
|
|
7842
|
+
* The EAN login request with posId
|
|
7843
|
+
* @type {AuthenticationEanRequest}
|
|
7844
|
+
* @memberof AuthenticateApiEanAuthentication
|
|
7845
|
+
*/
|
|
7846
|
+
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7847
|
+
}
|
|
7495
7848
|
/**
|
|
7496
7849
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7497
7850
|
* @export
|
|
@@ -7570,6 +7923,19 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7570
7923
|
*/
|
|
7571
7924
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7572
7925
|
}
|
|
7926
|
+
/**
|
|
7927
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7928
|
+
* @export
|
|
7929
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7930
|
+
*/
|
|
7931
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7932
|
+
/**
|
|
7933
|
+
* The PIN login request with posId
|
|
7934
|
+
* @type {MemberAuthenticationPinRequest}
|
|
7935
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7936
|
+
*/
|
|
7937
|
+
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7938
|
+
}
|
|
7573
7939
|
/**
|
|
7574
7940
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7575
7941
|
* @export
|
|
@@ -7583,6 +7949,32 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7583
7949
|
*/
|
|
7584
7950
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7585
7951
|
}
|
|
7952
|
+
/**
|
|
7953
|
+
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
7954
|
+
* @export
|
|
7955
|
+
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
7956
|
+
*/
|
|
7957
|
+
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7958
|
+
/**
|
|
7959
|
+
* The NFC login request with posId
|
|
7960
|
+
* @type {AuthenticationNfcRequest}
|
|
7961
|
+
* @memberof AuthenticateApiNfcAuthentication
|
|
7962
|
+
*/
|
|
7963
|
+
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
7964
|
+
}
|
|
7965
|
+
/**
|
|
7966
|
+
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
7967
|
+
* @export
|
|
7968
|
+
* @interface AuthenticateApiPinAuthenticationRequest
|
|
7969
|
+
*/
|
|
7970
|
+
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7971
|
+
/**
|
|
7972
|
+
* The PIN login request with posId
|
|
7973
|
+
* @type {AuthenticationPinRequest}
|
|
7974
|
+
* @memberof AuthenticateApiPinAuthentication
|
|
7975
|
+
*/
|
|
7976
|
+
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
7977
|
+
}
|
|
7586
7978
|
/**
|
|
7587
7979
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7588
7980
|
* @export
|
|
@@ -7609,58 +8001,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7609
8001
|
*/
|
|
7610
8002
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7611
8003
|
}
|
|
7612
|
-
/**
|
|
7613
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7614
|
-
* @export
|
|
7615
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7616
|
-
*/
|
|
7617
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7618
|
-
/**
|
|
7619
|
-
* The EAN login request with posId
|
|
7620
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7621
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7622
|
-
*/
|
|
7623
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7624
|
-
}
|
|
7625
|
-
/**
|
|
7626
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7627
|
-
* @export
|
|
7628
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7629
|
-
*/
|
|
7630
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7631
|
-
/**
|
|
7632
|
-
* The PIN login request with posId
|
|
7633
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7634
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7635
|
-
*/
|
|
7636
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7637
|
-
}
|
|
7638
|
-
/**
|
|
7639
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7640
|
-
* @export
|
|
7641
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7642
|
-
*/
|
|
7643
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7644
|
-
/**
|
|
7645
|
-
* The NFC login request with posId
|
|
7646
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7647
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7648
|
-
*/
|
|
7649
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7650
|
-
}
|
|
7651
|
-
/**
|
|
7652
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7653
|
-
* @export
|
|
7654
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7655
|
-
*/
|
|
7656
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7657
|
-
/**
|
|
7658
|
-
* The PIN login request with posId
|
|
7659
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7660
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7661
|
-
*/
|
|
7662
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7663
|
-
}
|
|
7664
8004
|
/**
|
|
7665
8005
|
* AuthenticateApi - object-oriented interface
|
|
7666
8006
|
* @export
|
|
@@ -7695,6 +8035,15 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7695
8035
|
* @memberof AuthenticateApi
|
|
7696
8036
|
*/
|
|
7697
8037
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8038
|
+
/**
|
|
8039
|
+
*
|
|
8040
|
+
* @summary EAN authentication that requires POS user authentication
|
|
8041
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
8042
|
+
* @param {*} [options] Override http request option.
|
|
8043
|
+
* @throws {RequiredError}
|
|
8044
|
+
* @memberof AuthenticateApi
|
|
8045
|
+
*/
|
|
8046
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7698
8047
|
/**
|
|
7699
8048
|
*
|
|
7700
8049
|
* @summary Generate a QR code for authentication
|
|
@@ -7773,6 +8122,15 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7773
8122
|
* @memberof AuthenticateApi
|
|
7774
8123
|
*/
|
|
7775
8124
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8125
|
+
/**
|
|
8126
|
+
*
|
|
8127
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8128
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8129
|
+
* @param {*} [options] Override http request option.
|
|
8130
|
+
* @throws {RequiredError}
|
|
8131
|
+
* @memberof AuthenticateApi
|
|
8132
|
+
*/
|
|
8133
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7776
8134
|
/**
|
|
7777
8135
|
*
|
|
7778
8136
|
* @summary Mock login and hand out token.
|
|
@@ -7784,66 +8142,48 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7784
8142
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7785
8143
|
/**
|
|
7786
8144
|
*
|
|
7787
|
-
* @summary
|
|
8145
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8146
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7788
8147
|
* @param {*} [options] Override http request option.
|
|
7789
8148
|
* @throws {RequiredError}
|
|
7790
8149
|
* @memberof AuthenticateApi
|
|
7791
8150
|
*/
|
|
7792
|
-
|
|
8151
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7793
8152
|
/**
|
|
7794
8153
|
*
|
|
7795
|
-
* @summary
|
|
7796
|
-
* @param {
|
|
8154
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8155
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7797
8156
|
* @param {*} [options] Override http request option.
|
|
7798
8157
|
* @throws {RequiredError}
|
|
7799
8158
|
* @memberof AuthenticateApi
|
|
7800
8159
|
*/
|
|
7801
|
-
|
|
8160
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7802
8161
|
/**
|
|
7803
8162
|
*
|
|
7804
|
-
* @summary
|
|
7805
|
-
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7806
|
-
* @param {*} [options] Override http request option.
|
|
7807
|
-
* @throws {RequiredError}
|
|
7808
|
-
* @memberof AuthenticateApi
|
|
7809
|
-
*/
|
|
7810
|
-
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7811
|
-
/**
|
|
7812
|
-
*
|
|
7813
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7814
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7815
|
-
* @param {*} [options] Override http request option.
|
|
7816
|
-
* @throws {RequiredError}
|
|
7817
|
-
* @memberof AuthenticateApi
|
|
7818
|
-
*/
|
|
7819
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7820
|
-
/**
|
|
7821
|
-
*
|
|
7822
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7823
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8163
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7824
8164
|
* @param {*} [options] Override http request option.
|
|
7825
8165
|
* @throws {RequiredError}
|
|
7826
8166
|
* @memberof AuthenticateApi
|
|
7827
8167
|
*/
|
|
7828
|
-
|
|
8168
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7829
8169
|
/**
|
|
7830
8170
|
*
|
|
7831
|
-
* @summary
|
|
7832
|
-
* @param {
|
|
8171
|
+
* @summary Creates a reset token for the local authentication
|
|
8172
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7833
8173
|
* @param {*} [options] Override http request option.
|
|
7834
8174
|
* @throws {RequiredError}
|
|
7835
8175
|
* @memberof AuthenticateApi
|
|
7836
8176
|
*/
|
|
7837
|
-
|
|
8177
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7838
8178
|
/**
|
|
7839
8179
|
*
|
|
7840
|
-
* @summary
|
|
7841
|
-
* @param {
|
|
8180
|
+
* @summary Reset local authentication using the provided token
|
|
8181
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7842
8182
|
* @param {*} [options] Override http request option.
|
|
7843
8183
|
* @throws {RequiredError}
|
|
7844
8184
|
* @memberof AuthenticateApi
|
|
7845
8185
|
*/
|
|
7846
|
-
|
|
8186
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7847
8187
|
}
|
|
7848
8188
|
/**
|
|
7849
8189
|
* BalanceApi - axios parameter creator
|
|
@@ -11035,7 +11375,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11035
11375
|
* @param {*} [options] Override http request option.
|
|
11036
11376
|
* @throws {RequiredError}
|
|
11037
11377
|
*/
|
|
11038
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11378
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11039
11379
|
/**
|
|
11040
11380
|
*
|
|
11041
11381
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11132,7 +11472,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11132
11472
|
* @param {*} [options] Override http request option.
|
|
11133
11473
|
* @throws {RequiredError}
|
|
11134
11474
|
*/
|
|
11135
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11475
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11136
11476
|
/**
|
|
11137
11477
|
*
|
|
11138
11478
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11323,183 +11663,669 @@ export interface InvoicesApiGetInvoicePdfRequest {
|
|
|
11323
11663
|
* @type {boolean}
|
|
11324
11664
|
* @memberof InvoicesApiGetInvoicePdf
|
|
11325
11665
|
*/
|
|
11326
|
-
readonly force?: boolean;
|
|
11666
|
+
readonly force?: boolean;
|
|
11667
|
+
}
|
|
11668
|
+
/**
|
|
11669
|
+
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11670
|
+
* @export
|
|
11671
|
+
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11672
|
+
*/
|
|
11673
|
+
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11674
|
+
/**
|
|
11675
|
+
* The id of the requested invoice
|
|
11676
|
+
* @type {number}
|
|
11677
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11678
|
+
*/
|
|
11679
|
+
readonly id: number;
|
|
11680
|
+
/**
|
|
11681
|
+
* Boolean if invoice entries should be returned, defaults to true.
|
|
11682
|
+
* @type {boolean}
|
|
11683
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11684
|
+
*/
|
|
11685
|
+
readonly returnEntries?: boolean;
|
|
11686
|
+
}
|
|
11687
|
+
/**
|
|
11688
|
+
* Request parameters for getSingleInvoiceUser operation in InvoicesApi.
|
|
11689
|
+
* @export
|
|
11690
|
+
* @interface InvoicesApiGetSingleInvoiceUserRequest
|
|
11691
|
+
*/
|
|
11692
|
+
export interface InvoicesApiGetSingleInvoiceUserRequest {
|
|
11693
|
+
/**
|
|
11694
|
+
* The id of the invoice user to return.
|
|
11695
|
+
* @type {number}
|
|
11696
|
+
* @memberof InvoicesApiGetSingleInvoiceUser
|
|
11697
|
+
*/
|
|
11698
|
+
readonly id: number;
|
|
11699
|
+
}
|
|
11700
|
+
/**
|
|
11701
|
+
* Request parameters for putInvoiceUser operation in InvoicesApi.
|
|
11702
|
+
* @export
|
|
11703
|
+
* @interface InvoicesApiPutInvoiceUserRequest
|
|
11704
|
+
*/
|
|
11705
|
+
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11706
|
+
/**
|
|
11707
|
+
* The id of the user to update
|
|
11708
|
+
* @type {number}
|
|
11709
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11710
|
+
*/
|
|
11711
|
+
readonly id: number;
|
|
11712
|
+
/**
|
|
11713
|
+
* The invoice user which should be updated
|
|
11714
|
+
* @type {UpdateInvoiceUserRequest}
|
|
11715
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11716
|
+
*/
|
|
11717
|
+
readonly updateInvoiceUserRequest: UpdateInvoiceUserRequest;
|
|
11718
|
+
}
|
|
11719
|
+
/**
|
|
11720
|
+
* Request parameters for updateInvoice operation in InvoicesApi.
|
|
11721
|
+
* @export
|
|
11722
|
+
* @interface InvoicesApiUpdateInvoiceRequest
|
|
11723
|
+
*/
|
|
11724
|
+
export interface InvoicesApiUpdateInvoiceRequest {
|
|
11725
|
+
/**
|
|
11726
|
+
* The id of the invoice which should be updated
|
|
11727
|
+
* @type {number}
|
|
11728
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11729
|
+
*/
|
|
11730
|
+
readonly id: number;
|
|
11731
|
+
/**
|
|
11732
|
+
* The invoice update to process
|
|
11733
|
+
* @type {UpdateInvoiceRequest}
|
|
11734
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11735
|
+
*/
|
|
11736
|
+
readonly updateInvoiceRequest: UpdateInvoiceRequest;
|
|
11737
|
+
}
|
|
11738
|
+
/**
|
|
11739
|
+
* InvoicesApi - object-oriented interface
|
|
11740
|
+
* @export
|
|
11741
|
+
* @class InvoicesApi
|
|
11742
|
+
* @extends {BaseAPI}
|
|
11743
|
+
*/
|
|
11744
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
11745
|
+
/**
|
|
11746
|
+
*
|
|
11747
|
+
* @summary Adds an invoice to the system.
|
|
11748
|
+
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
11749
|
+
* @param {*} [options] Override http request option.
|
|
11750
|
+
* @throws {RequiredError}
|
|
11751
|
+
* @memberof InvoicesApi
|
|
11752
|
+
*/
|
|
11753
|
+
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11754
|
+
/**
|
|
11755
|
+
*
|
|
11756
|
+
* @summary Deletes an invoice.
|
|
11757
|
+
* @param {InvoicesApiDeleteInvoiceRequest} requestParameters Request parameters.
|
|
11758
|
+
* @param {*} [options] Override http request option.
|
|
11759
|
+
* @throws {RequiredError}
|
|
11760
|
+
* @memberof InvoicesApi
|
|
11761
|
+
*/
|
|
11762
|
+
deleteInvoice(requestParameters: InvoicesApiDeleteInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11763
|
+
/**
|
|
11764
|
+
*
|
|
11765
|
+
* @summary Delete invoice user defaults.
|
|
11766
|
+
* @param {InvoicesApiDeleteInvoiceUserRequest} requestParameters Request parameters.
|
|
11767
|
+
* @param {*} [options] Override http request option.
|
|
11768
|
+
* @throws {RequiredError}
|
|
11769
|
+
* @memberof InvoicesApi
|
|
11770
|
+
*/
|
|
11771
|
+
deleteInvoiceUser(requestParameters: InvoicesApiDeleteInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11772
|
+
/**
|
|
11773
|
+
*
|
|
11774
|
+
* @summary Returns all invoices in the system.
|
|
11775
|
+
* @param {InvoicesApiGetAllInvoicesRequest} requestParameters Request parameters.
|
|
11776
|
+
* @param {*} [options] Override http request option.
|
|
11777
|
+
* @throws {RequiredError}
|
|
11778
|
+
* @memberof InvoicesApi
|
|
11779
|
+
*/
|
|
11780
|
+
getAllInvoices(requestParameters?: InvoicesApiGetAllInvoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedInvoiceResponse, any, {}>>;
|
|
11781
|
+
/**
|
|
11782
|
+
*
|
|
11783
|
+
* @summary Get eligible transactions for invoice creation.
|
|
11784
|
+
* @param {InvoicesApiGetEligibleTransactionsRequest} requestParameters Request parameters.
|
|
11785
|
+
* @param {*} [options] Override http request option.
|
|
11786
|
+
* @throws {RequiredError}
|
|
11787
|
+
* @memberof InvoicesApi
|
|
11788
|
+
*/
|
|
11789
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11790
|
+
/**
|
|
11791
|
+
*
|
|
11792
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11793
|
+
* @param {*} [options] Override http request option.
|
|
11794
|
+
* @throws {RequiredError}
|
|
11795
|
+
* @memberof InvoicesApi
|
|
11796
|
+
*/
|
|
11797
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11798
|
+
/**
|
|
11799
|
+
*
|
|
11800
|
+
* @summary Get an invoice pdf.
|
|
11801
|
+
* @param {InvoicesApiGetInvoicePdfRequest} requestParameters Request parameters.
|
|
11802
|
+
* @param {*} [options] Override http request option.
|
|
11803
|
+
* @throws {RequiredError}
|
|
11804
|
+
* @memberof InvoicesApi
|
|
11805
|
+
*/
|
|
11806
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11807
|
+
/**
|
|
11808
|
+
*
|
|
11809
|
+
* @summary Returns a single invoice in the system.
|
|
11810
|
+
* @param {InvoicesApiGetSingleInvoiceRequest} requestParameters Request parameters.
|
|
11811
|
+
* @param {*} [options] Override http request option.
|
|
11812
|
+
* @throws {RequiredError}
|
|
11813
|
+
* @memberof InvoicesApi
|
|
11814
|
+
*/
|
|
11815
|
+
getSingleInvoice(requestParameters: InvoicesApiGetSingleInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11816
|
+
/**
|
|
11817
|
+
*
|
|
11818
|
+
* @summary Get invoice user defaults.
|
|
11819
|
+
* @param {InvoicesApiGetSingleInvoiceUserRequest} requestParameters Request parameters.
|
|
11820
|
+
* @param {*} [options] Override http request option.
|
|
11821
|
+
* @throws {RequiredError}
|
|
11822
|
+
* @memberof InvoicesApi
|
|
11823
|
+
*/
|
|
11824
|
+
getSingleInvoiceUser(requestParameters: InvoicesApiGetSingleInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11825
|
+
/**
|
|
11826
|
+
*
|
|
11827
|
+
* @summary Update or create invoice user defaults.
|
|
11828
|
+
* @param {InvoicesApiPutInvoiceUserRequest} requestParameters Request parameters.
|
|
11829
|
+
* @param {*} [options] Override http request option.
|
|
11830
|
+
* @throws {RequiredError}
|
|
11831
|
+
* @memberof InvoicesApi
|
|
11832
|
+
*/
|
|
11833
|
+
putInvoiceUser(requestParameters: InvoicesApiPutInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11834
|
+
/**
|
|
11835
|
+
*
|
|
11836
|
+
* @summary Adds an invoice to the system.
|
|
11837
|
+
* @param {InvoicesApiUpdateInvoiceRequest} requestParameters Request parameters.
|
|
11838
|
+
* @param {*} [options] Override http request option.
|
|
11839
|
+
* @throws {RequiredError}
|
|
11840
|
+
* @memberof InvoicesApi
|
|
11841
|
+
*/
|
|
11842
|
+
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11843
|
+
}
|
|
11844
|
+
/**
|
|
11845
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11846
|
+
* @export
|
|
11847
|
+
*/
|
|
11848
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11849
|
+
/**
|
|
11850
|
+
*
|
|
11851
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11852
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11853
|
+
* @param {*} [options] Override http request option.
|
|
11854
|
+
* @throws {RequiredError}
|
|
11855
|
+
*/
|
|
11856
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11857
|
+
/**
|
|
11858
|
+
*
|
|
11859
|
+
* @summary Create a new PaymentRequest.
|
|
11860
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11861
|
+
* @param {*} [options] Override http request option.
|
|
11862
|
+
* @throws {RequiredError}
|
|
11863
|
+
*/
|
|
11864
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11865
|
+
/**
|
|
11866
|
+
*
|
|
11867
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11868
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11869
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11870
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11871
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11872
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11873
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11874
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11875
|
+
* @param {*} [options] Override http request option.
|
|
11876
|
+
* @throws {RequiredError}
|
|
11877
|
+
*/
|
|
11878
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11879
|
+
/**
|
|
11880
|
+
*
|
|
11881
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11882
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11883
|
+
* @param {*} [options] Override http request option.
|
|
11884
|
+
* @throws {RequiredError}
|
|
11885
|
+
*/
|
|
11886
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11887
|
+
/**
|
|
11888
|
+
*
|
|
11889
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11890
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11891
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11892
|
+
* @param {*} [options] Override http request option.
|
|
11893
|
+
* @throws {RequiredError}
|
|
11894
|
+
*/
|
|
11895
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11896
|
+
/**
|
|
11897
|
+
*
|
|
11898
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11899
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11900
|
+
* @param {*} [options] Override http request option.
|
|
11901
|
+
* @throws {RequiredError}
|
|
11902
|
+
*/
|
|
11903
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11904
|
+
};
|
|
11905
|
+
/**
|
|
11906
|
+
* PaymentRequestsApi - functional programming interface
|
|
11907
|
+
* @export
|
|
11908
|
+
*/
|
|
11909
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11913
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11914
|
+
* @param {*} [options] Override http request option.
|
|
11915
|
+
* @throws {RequiredError}
|
|
11916
|
+
*/
|
|
11917
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11918
|
+
/**
|
|
11919
|
+
*
|
|
11920
|
+
* @summary Create a new PaymentRequest.
|
|
11921
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11922
|
+
* @param {*} [options] Override http request option.
|
|
11923
|
+
* @throws {RequiredError}
|
|
11924
|
+
*/
|
|
11925
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11926
|
+
/**
|
|
11927
|
+
*
|
|
11928
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11929
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11930
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11931
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11932
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11933
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11934
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11935
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11936
|
+
* @param {*} [options] Override http request option.
|
|
11937
|
+
* @throws {RequiredError}
|
|
11938
|
+
*/
|
|
11939
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11940
|
+
/**
|
|
11941
|
+
*
|
|
11942
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11943
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11944
|
+
* @param {*} [options] Override http request option.
|
|
11945
|
+
* @throws {RequiredError}
|
|
11946
|
+
*/
|
|
11947
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11948
|
+
/**
|
|
11949
|
+
*
|
|
11950
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11951
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11952
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11953
|
+
* @param {*} [options] Override http request option.
|
|
11954
|
+
* @throws {RequiredError}
|
|
11955
|
+
*/
|
|
11956
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11957
|
+
/**
|
|
11958
|
+
*
|
|
11959
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11960
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11961
|
+
* @param {*} [options] Override http request option.
|
|
11962
|
+
* @throws {RequiredError}
|
|
11963
|
+
*/
|
|
11964
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11965
|
+
};
|
|
11966
|
+
/**
|
|
11967
|
+
* PaymentRequestsApi - factory interface
|
|
11968
|
+
* @export
|
|
11969
|
+
*/
|
|
11970
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11971
|
+
/**
|
|
11972
|
+
*
|
|
11973
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11974
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11975
|
+
* @param {*} [options] Override http request option.
|
|
11976
|
+
* @throws {RequiredError}
|
|
11977
|
+
*/
|
|
11978
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11979
|
+
/**
|
|
11980
|
+
*
|
|
11981
|
+
* @summary Create a new PaymentRequest.
|
|
11982
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11983
|
+
* @param {*} [options] Override http request option.
|
|
11984
|
+
* @throws {RequiredError}
|
|
11985
|
+
*/
|
|
11986
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11987
|
+
/**
|
|
11988
|
+
*
|
|
11989
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11990
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11991
|
+
* @param {*} [options] Override http request option.
|
|
11992
|
+
* @throws {RequiredError}
|
|
11993
|
+
*/
|
|
11994
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11995
|
+
/**
|
|
11996
|
+
*
|
|
11997
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11998
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11999
|
+
* @param {*} [options] Override http request option.
|
|
12000
|
+
* @throws {RequiredError}
|
|
12001
|
+
*/
|
|
12002
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12003
|
+
/**
|
|
12004
|
+
*
|
|
12005
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12006
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
12007
|
+
* @param {*} [options] Override http request option.
|
|
12008
|
+
* @throws {RequiredError}
|
|
12009
|
+
*/
|
|
12010
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
12011
|
+
/**
|
|
12012
|
+
*
|
|
12013
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12014
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
12015
|
+
* @param {*} [options] Override http request option.
|
|
12016
|
+
* @throws {RequiredError}
|
|
12017
|
+
*/
|
|
12018
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12019
|
+
};
|
|
12020
|
+
/**
|
|
12021
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
12022
|
+
* @export
|
|
12023
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
12024
|
+
*/
|
|
12025
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
12026
|
+
/**
|
|
12027
|
+
* UUID v4 of the payment request.
|
|
12028
|
+
* @type {string}
|
|
12029
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
12030
|
+
*/
|
|
12031
|
+
readonly id: string;
|
|
12032
|
+
}
|
|
12033
|
+
/**
|
|
12034
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
12035
|
+
* @export
|
|
12036
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
12037
|
+
*/
|
|
12038
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
12039
|
+
/**
|
|
12040
|
+
* The request to create
|
|
12041
|
+
* @type {CreatePaymentRequestRequest}
|
|
12042
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
12043
|
+
*/
|
|
12044
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11327
12045
|
}
|
|
11328
12046
|
/**
|
|
11329
|
-
* Request parameters for
|
|
12047
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11330
12048
|
* @export
|
|
11331
|
-
* @interface
|
|
12049
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11332
12050
|
*/
|
|
11333
|
-
export interface
|
|
12051
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11334
12052
|
/**
|
|
11335
|
-
*
|
|
12053
|
+
* Filter by beneficiary user id.
|
|
11336
12054
|
* @type {number}
|
|
11337
|
-
* @memberof
|
|
12055
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11338
12056
|
*/
|
|
11339
|
-
readonly
|
|
12057
|
+
readonly forId?: number;
|
|
11340
12058
|
/**
|
|
11341
|
-
*
|
|
11342
|
-
* @type {
|
|
11343
|
-
* @memberof
|
|
12059
|
+
* Filter by creator user id.
|
|
12060
|
+
* @type {number}
|
|
12061
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11344
12062
|
*/
|
|
11345
|
-
readonly
|
|
12063
|
+
readonly createdById?: number;
|
|
12064
|
+
/**
|
|
12065
|
+
* Comma-separated list of derived statuses.
|
|
12066
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12067
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12068
|
+
*/
|
|
12069
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12070
|
+
/**
|
|
12071
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12072
|
+
* @type {string}
|
|
12073
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12074
|
+
*/
|
|
12075
|
+
readonly fromDate?: string;
|
|
12076
|
+
/**
|
|
12077
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12078
|
+
* @type {string}
|
|
12079
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12080
|
+
*/
|
|
12081
|
+
readonly tillDate?: string;
|
|
12082
|
+
/**
|
|
12083
|
+
* How many rows the endpoint should return
|
|
12084
|
+
* @type {number}
|
|
12085
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12086
|
+
*/
|
|
12087
|
+
readonly take?: number;
|
|
12088
|
+
/**
|
|
12089
|
+
* How many rows to skip (for pagination)
|
|
12090
|
+
* @type {number}
|
|
12091
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12092
|
+
*/
|
|
12093
|
+
readonly skip?: number;
|
|
11346
12094
|
}
|
|
11347
12095
|
/**
|
|
11348
|
-
* Request parameters for
|
|
12096
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11349
12097
|
* @export
|
|
11350
|
-
* @interface
|
|
12098
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11351
12099
|
*/
|
|
11352
|
-
export interface
|
|
12100
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11353
12101
|
/**
|
|
11354
|
-
*
|
|
11355
|
-
* @type {
|
|
11356
|
-
* @memberof
|
|
12102
|
+
* UUID v4 of the payment request.
|
|
12103
|
+
* @type {string}
|
|
12104
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11357
12105
|
*/
|
|
11358
|
-
readonly id:
|
|
12106
|
+
readonly id: string;
|
|
11359
12107
|
}
|
|
11360
12108
|
/**
|
|
11361
|
-
* Request parameters for
|
|
12109
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11362
12110
|
* @export
|
|
11363
|
-
* @interface
|
|
12111
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11364
12112
|
*/
|
|
11365
|
-
export interface
|
|
12113
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11366
12114
|
/**
|
|
11367
|
-
*
|
|
11368
|
-
* @type {
|
|
11369
|
-
* @memberof
|
|
12115
|
+
* UUID v4 of the payment request.
|
|
12116
|
+
* @type {string}
|
|
12117
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11370
12118
|
*/
|
|
11371
|
-
readonly id:
|
|
12119
|
+
readonly id: string;
|
|
11372
12120
|
/**
|
|
11373
|
-
* The
|
|
11374
|
-
* @type {
|
|
11375
|
-
* @memberof
|
|
12121
|
+
* The audit reason
|
|
12122
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12123
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11376
12124
|
*/
|
|
11377
|
-
readonly
|
|
12125
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11378
12126
|
}
|
|
11379
12127
|
/**
|
|
11380
|
-
* Request parameters for
|
|
12128
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11381
12129
|
* @export
|
|
11382
|
-
* @interface
|
|
12130
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11383
12131
|
*/
|
|
11384
|
-
export interface
|
|
11385
|
-
/**
|
|
11386
|
-
* The id of the invoice which should be updated
|
|
11387
|
-
* @type {number}
|
|
11388
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11389
|
-
*/
|
|
11390
|
-
readonly id: number;
|
|
12132
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11391
12133
|
/**
|
|
11392
|
-
*
|
|
11393
|
-
* @type {
|
|
11394
|
-
* @memberof
|
|
12134
|
+
* UUID v4 of the payment request.
|
|
12135
|
+
* @type {string}
|
|
12136
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11395
12137
|
*/
|
|
11396
|
-
readonly
|
|
12138
|
+
readonly id: string;
|
|
11397
12139
|
}
|
|
11398
12140
|
/**
|
|
11399
|
-
*
|
|
12141
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11400
12142
|
* @export
|
|
11401
|
-
* @class
|
|
12143
|
+
* @class PaymentRequestsApi
|
|
11402
12144
|
* @extends {BaseAPI}
|
|
11403
12145
|
*/
|
|
11404
|
-
export declare class
|
|
12146
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11405
12147
|
/**
|
|
11406
12148
|
*
|
|
11407
|
-
* @summary
|
|
11408
|
-
* @param {
|
|
12149
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12150
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11409
12151
|
* @param {*} [options] Override http request option.
|
|
11410
12152
|
* @throws {RequiredError}
|
|
11411
|
-
* @memberof
|
|
12153
|
+
* @memberof PaymentRequestsApi
|
|
11412
12154
|
*/
|
|
11413
|
-
|
|
12155
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11414
12156
|
/**
|
|
11415
12157
|
*
|
|
11416
|
-
* @summary
|
|
11417
|
-
* @param {
|
|
12158
|
+
* @summary Create a new PaymentRequest.
|
|
12159
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11418
12160
|
* @param {*} [options] Override http request option.
|
|
11419
12161
|
* @throws {RequiredError}
|
|
11420
|
-
* @memberof
|
|
12162
|
+
* @memberof PaymentRequestsApi
|
|
11421
12163
|
*/
|
|
11422
|
-
|
|
12164
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11423
12165
|
/**
|
|
11424
12166
|
*
|
|
11425
|
-
* @summary
|
|
11426
|
-
* @param {
|
|
12167
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12168
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11427
12169
|
* @param {*} [options] Override http request option.
|
|
11428
12170
|
* @throws {RequiredError}
|
|
11429
|
-
* @memberof
|
|
12171
|
+
* @memberof PaymentRequestsApi
|
|
11430
12172
|
*/
|
|
11431
|
-
|
|
12173
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11432
12174
|
/**
|
|
11433
12175
|
*
|
|
11434
|
-
* @summary
|
|
11435
|
-
* @param {
|
|
12176
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12177
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11436
12178
|
* @param {*} [options] Override http request option.
|
|
11437
12179
|
* @throws {RequiredError}
|
|
11438
|
-
* @memberof
|
|
12180
|
+
* @memberof PaymentRequestsApi
|
|
11439
12181
|
*/
|
|
11440
|
-
|
|
12182
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11441
12183
|
/**
|
|
11442
12184
|
*
|
|
11443
|
-
* @summary
|
|
11444
|
-
* @param {
|
|
12185
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12186
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11445
12187
|
* @param {*} [options] Override http request option.
|
|
11446
12188
|
* @throws {RequiredError}
|
|
11447
|
-
* @memberof
|
|
12189
|
+
* @memberof PaymentRequestsApi
|
|
11448
12190
|
*/
|
|
11449
|
-
|
|
12191
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11450
12192
|
/**
|
|
11451
12193
|
*
|
|
11452
|
-
* @summary
|
|
12194
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12195
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11453
12196
|
* @param {*} [options] Override http request option.
|
|
11454
12197
|
* @throws {RequiredError}
|
|
11455
|
-
* @memberof
|
|
12198
|
+
* @memberof PaymentRequestsApi
|
|
11456
12199
|
*/
|
|
11457
|
-
|
|
12200
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12201
|
+
}
|
|
12202
|
+
/**
|
|
12203
|
+
* @export
|
|
12204
|
+
*/
|
|
12205
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12206
|
+
readonly Pending: "PENDING";
|
|
12207
|
+
readonly Paid: "PAID";
|
|
12208
|
+
readonly Expired: "EXPIRED";
|
|
12209
|
+
readonly Cancelled: "CANCELLED";
|
|
12210
|
+
};
|
|
12211
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12212
|
+
/**
|
|
12213
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12214
|
+
* @export
|
|
12215
|
+
*/
|
|
12216
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11458
12217
|
/**
|
|
11459
12218
|
*
|
|
11460
|
-
* @summary
|
|
11461
|
-
* @param {
|
|
12219
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12220
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11462
12221
|
* @param {*} [options] Override http request option.
|
|
11463
12222
|
* @throws {RequiredError}
|
|
11464
|
-
* @memberof InvoicesApi
|
|
11465
12223
|
*/
|
|
11466
|
-
|
|
12224
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11467
12225
|
/**
|
|
11468
12226
|
*
|
|
11469
|
-
* @summary
|
|
11470
|
-
* @param {
|
|
12227
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12228
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11471
12229
|
* @param {*} [options] Override http request option.
|
|
11472
12230
|
* @throws {RequiredError}
|
|
11473
|
-
* @memberof InvoicesApi
|
|
11474
12231
|
*/
|
|
11475
|
-
|
|
12232
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12233
|
+
};
|
|
12234
|
+
/**
|
|
12235
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12236
|
+
* @export
|
|
12237
|
+
*/
|
|
12238
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
11476
12239
|
/**
|
|
11477
12240
|
*
|
|
11478
|
-
* @summary
|
|
11479
|
-
* @param {
|
|
12241
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12242
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11480
12243
|
* @param {*} [options] Override http request option.
|
|
11481
12244
|
* @throws {RequiredError}
|
|
11482
|
-
* @memberof InvoicesApi
|
|
11483
12245
|
*/
|
|
11484
|
-
|
|
12246
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11485
12247
|
/**
|
|
11486
12248
|
*
|
|
11487
|
-
* @summary
|
|
11488
|
-
* @param {
|
|
12249
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12250
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11489
12251
|
* @param {*} [options] Override http request option.
|
|
11490
12252
|
* @throws {RequiredError}
|
|
11491
|
-
* @memberof InvoicesApi
|
|
11492
12253
|
*/
|
|
11493
|
-
|
|
12254
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12255
|
+
};
|
|
12256
|
+
/**
|
|
12257
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12258
|
+
* @export
|
|
12259
|
+
*/
|
|
12260
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11494
12261
|
/**
|
|
11495
12262
|
*
|
|
11496
|
-
* @summary
|
|
11497
|
-
* @param {
|
|
12263
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12264
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
11498
12265
|
* @param {*} [options] Override http request option.
|
|
11499
12266
|
* @throws {RequiredError}
|
|
11500
|
-
* @memberof InvoicesApi
|
|
11501
12267
|
*/
|
|
11502
|
-
|
|
12268
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12269
|
+
/**
|
|
12270
|
+
*
|
|
12271
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12272
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12273
|
+
* @param {*} [options] Override http request option.
|
|
12274
|
+
* @throws {RequiredError}
|
|
12275
|
+
*/
|
|
12276
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12277
|
+
};
|
|
12278
|
+
/**
|
|
12279
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12280
|
+
* @export
|
|
12281
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12282
|
+
*/
|
|
12283
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12284
|
+
/**
|
|
12285
|
+
* UUID v4 of the payment request.
|
|
12286
|
+
* @type {string}
|
|
12287
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12288
|
+
*/
|
|
12289
|
+
readonly id: string;
|
|
12290
|
+
}
|
|
12291
|
+
/**
|
|
12292
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12293
|
+
* @export
|
|
12294
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12295
|
+
*/
|
|
12296
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12297
|
+
/**
|
|
12298
|
+
* UUID v4 of the payment request.
|
|
12299
|
+
* @type {string}
|
|
12300
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12301
|
+
*/
|
|
12302
|
+
readonly id: string;
|
|
12303
|
+
}
|
|
12304
|
+
/**
|
|
12305
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12306
|
+
* @export
|
|
12307
|
+
* @class PaymentRequestsPublicApi
|
|
12308
|
+
* @extends {BaseAPI}
|
|
12309
|
+
*/
|
|
12310
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12311
|
+
/**
|
|
12312
|
+
*
|
|
12313
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12314
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12315
|
+
* @param {*} [options] Override http request option.
|
|
12316
|
+
* @throws {RequiredError}
|
|
12317
|
+
* @memberof PaymentRequestsPublicApi
|
|
12318
|
+
*/
|
|
12319
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12320
|
+
/**
|
|
12321
|
+
*
|
|
12322
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12323
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12324
|
+
* @param {*} [options] Override http request option.
|
|
12325
|
+
* @throws {RequiredError}
|
|
12326
|
+
* @memberof PaymentRequestsPublicApi
|
|
12327
|
+
*/
|
|
12328
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
11503
12329
|
}
|
|
11504
12330
|
/**
|
|
11505
12331
|
* PayoutRequestsApi - axios parameter creator
|
|
@@ -15512,7 +16338,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15512
16338
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15513
16339
|
/**
|
|
15514
16340
|
*
|
|
15515
|
-
* @summary Accept the Terms of Service
|
|
16341
|
+
* @summary Accept the current Terms of Service version
|
|
15516
16342
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15517
16343
|
* @param {*} [options] Override http request option.
|
|
15518
16344
|
* @throws {RequiredError}
|
|
@@ -15642,6 +16468,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15642
16468
|
* @throws {RequiredError}
|
|
15643
16469
|
*/
|
|
15644
16470
|
getUserSettings: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16471
|
+
/**
|
|
16472
|
+
*
|
|
16473
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
16474
|
+
* @param {number} id The id of the user
|
|
16475
|
+
* @param {*} [options] Override http request option.
|
|
16476
|
+
* @throws {RequiredError}
|
|
16477
|
+
*/
|
|
16478
|
+
getUserTos: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15645
16479
|
/**
|
|
15646
16480
|
*
|
|
15647
16481
|
* @summary Returns the user\'s containers
|
|
@@ -15664,6 +16498,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15664
16498
|
* @throws {RequiredError}
|
|
15665
16499
|
*/
|
|
15666
16500
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16501
|
+
/**
|
|
16502
|
+
*
|
|
16503
|
+
* @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.
|
|
16504
|
+
* @param {number} id The id of the beneficiary user.
|
|
16505
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16506
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16507
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16508
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16509
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16510
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16511
|
+
* @param {*} [options] Override http request option.
|
|
16512
|
+
* @throws {RequiredError}
|
|
16513
|
+
*/
|
|
16514
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15667
16515
|
/**
|
|
15668
16516
|
*
|
|
15669
16517
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -15874,7 +16722,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15874
16722
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
15875
16723
|
/**
|
|
15876
16724
|
*
|
|
15877
|
-
* @summary Accept the Terms of Service
|
|
16725
|
+
* @summary Accept the current Terms of Service version
|
|
15878
16726
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15879
16727
|
* @param {*} [options] Override http request option.
|
|
15880
16728
|
* @throws {RequiredError}
|
|
@@ -16004,6 +16852,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16004
16852
|
* @throws {RequiredError}
|
|
16005
16853
|
*/
|
|
16006
16854
|
getUserSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserSettingsResponse>>;
|
|
16855
|
+
/**
|
|
16856
|
+
*
|
|
16857
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
16858
|
+
* @param {number} id The id of the user
|
|
16859
|
+
* @param {*} [options] Override http request option.
|
|
16860
|
+
* @throws {RequiredError}
|
|
16861
|
+
*/
|
|
16862
|
+
getUserTos(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserTosResponse>>;
|
|
16007
16863
|
/**
|
|
16008
16864
|
*
|
|
16009
16865
|
* @summary Returns the user\'s containers
|
|
@@ -16026,6 +16882,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16026
16882
|
* @throws {RequiredError}
|
|
16027
16883
|
*/
|
|
16028
16884
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
16885
|
+
/**
|
|
16886
|
+
*
|
|
16887
|
+
* @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.
|
|
16888
|
+
* @param {number} id The id of the beneficiary user.
|
|
16889
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16890
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16891
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16892
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16893
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16894
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16895
|
+
* @param {*} [options] Override http request option.
|
|
16896
|
+
* @throws {RequiredError}
|
|
16897
|
+
*/
|
|
16898
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16029
16899
|
/**
|
|
16030
16900
|
*
|
|
16031
16901
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16236,7 +17106,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16236
17106
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16237
17107
|
/**
|
|
16238
17108
|
*
|
|
16239
|
-
* @summary Accept the Terms of Service
|
|
17109
|
+
* @summary Accept the current Terms of Service version
|
|
16240
17110
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16241
17111
|
* @param {*} [options] Override http request option.
|
|
16242
17112
|
* @throws {RequiredError}
|
|
@@ -16354,6 +17224,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16354
17224
|
* @throws {RequiredError}
|
|
16355
17225
|
*/
|
|
16356
17226
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserSettingsResponse>;
|
|
17227
|
+
/**
|
|
17228
|
+
*
|
|
17229
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
17230
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
17231
|
+
* @param {*} [options] Override http request option.
|
|
17232
|
+
* @throws {RequiredError}
|
|
17233
|
+
*/
|
|
17234
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserTosResponse>;
|
|
16357
17235
|
/**
|
|
16358
17236
|
*
|
|
16359
17237
|
* @summary Returns the user\'s containers
|
|
@@ -16370,6 +17248,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16370
17248
|
* @throws {RequiredError}
|
|
16371
17249
|
*/
|
|
16372
17250
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17251
|
+
/**
|
|
17252
|
+
*
|
|
17253
|
+
* @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.
|
|
17254
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17255
|
+
* @param {*} [options] Override http request option.
|
|
17256
|
+
* @throws {RequiredError}
|
|
17257
|
+
*/
|
|
17258
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16373
17259
|
/**
|
|
16374
17260
|
*
|
|
16375
17261
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16799,6 +17685,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
16799
17685
|
*/
|
|
16800
17686
|
readonly id: number;
|
|
16801
17687
|
}
|
|
17688
|
+
/**
|
|
17689
|
+
* Request parameters for getUserTos operation in UsersApi.
|
|
17690
|
+
* @export
|
|
17691
|
+
* @interface UsersApiGetUserTosRequest
|
|
17692
|
+
*/
|
|
17693
|
+
export interface UsersApiGetUserTosRequest {
|
|
17694
|
+
/**
|
|
17695
|
+
* The id of the user
|
|
17696
|
+
* @type {number}
|
|
17697
|
+
* @memberof UsersApiGetUserTos
|
|
17698
|
+
*/
|
|
17699
|
+
readonly id: number;
|
|
17700
|
+
}
|
|
16802
17701
|
/**
|
|
16803
17702
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
16804
17703
|
* @export
|
|
@@ -16861,6 +17760,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16861
17760
|
*/
|
|
16862
17761
|
readonly skip?: number;
|
|
16863
17762
|
}
|
|
17763
|
+
/**
|
|
17764
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
17765
|
+
* @export
|
|
17766
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
17767
|
+
*/
|
|
17768
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
17769
|
+
/**
|
|
17770
|
+
* The id of the beneficiary user.
|
|
17771
|
+
* @type {number}
|
|
17772
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17773
|
+
*/
|
|
17774
|
+
readonly id: number;
|
|
17775
|
+
/**
|
|
17776
|
+
* Filter by creator user id.
|
|
17777
|
+
* @type {number}
|
|
17778
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17779
|
+
*/
|
|
17780
|
+
readonly createdById?: number;
|
|
17781
|
+
/**
|
|
17782
|
+
* Comma-separated list of derived statuses.
|
|
17783
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
17784
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17785
|
+
*/
|
|
17786
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
17787
|
+
/**
|
|
17788
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
17789
|
+
* @type {string}
|
|
17790
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17791
|
+
*/
|
|
17792
|
+
readonly fromDate?: string;
|
|
17793
|
+
/**
|
|
17794
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
17795
|
+
* @type {string}
|
|
17796
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17797
|
+
*/
|
|
17798
|
+
readonly tillDate?: string;
|
|
17799
|
+
/**
|
|
17800
|
+
* How many rows the endpoint should return
|
|
17801
|
+
* @type {number}
|
|
17802
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17803
|
+
*/
|
|
17804
|
+
readonly take?: number;
|
|
17805
|
+
/**
|
|
17806
|
+
* How many rows to skip (for pagination)
|
|
17807
|
+
* @type {number}
|
|
17808
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17809
|
+
*/
|
|
17810
|
+
readonly skip?: number;
|
|
17811
|
+
}
|
|
16864
17812
|
/**
|
|
16865
17813
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16866
17814
|
* @export
|
|
@@ -17376,7 +18324,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17376
18324
|
export declare class UsersApi extends BaseAPI {
|
|
17377
18325
|
/**
|
|
17378
18326
|
*
|
|
17379
|
-
* @summary Accept the Terms of Service
|
|
18327
|
+
* @summary Accept the current Terms of Service version
|
|
17380
18328
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17381
18329
|
* @param {*} [options] Override http request option.
|
|
17382
18330
|
* @throws {RequiredError}
|
|
@@ -17509,6 +18457,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17509
18457
|
* @memberof UsersApi
|
|
17510
18458
|
*/
|
|
17511
18459
|
getUserSettings(requestParameters: UsersApiGetUserSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserSettingsResponse, any, {}>>;
|
|
18460
|
+
/**
|
|
18461
|
+
*
|
|
18462
|
+
* @summary Get a user\'s terms of service status and acceptance history
|
|
18463
|
+
* @param {UsersApiGetUserTosRequest} requestParameters Request parameters.
|
|
18464
|
+
* @param {*} [options] Override http request option.
|
|
18465
|
+
* @throws {RequiredError}
|
|
18466
|
+
* @memberof UsersApi
|
|
18467
|
+
*/
|
|
18468
|
+
getUserTos(requestParameters: UsersApiGetUserTosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserTosResponse, any, {}>>;
|
|
17512
18469
|
/**
|
|
17513
18470
|
*
|
|
17514
18471
|
* @summary Returns the user\'s containers
|
|
@@ -17527,6 +18484,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17527
18484
|
* @memberof UsersApi
|
|
17528
18485
|
*/
|
|
17529
18486
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18487
|
+
/**
|
|
18488
|
+
*
|
|
18489
|
+
* @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.
|
|
18490
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18491
|
+
* @param {*} [options] Override http request option.
|
|
18492
|
+
* @throws {RequiredError}
|
|
18493
|
+
* @memberof UsersApi
|
|
18494
|
+
*/
|
|
18495
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17530
18496
|
/**
|
|
17531
18497
|
*
|
|
17532
18498
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17722,6 +18688,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17722
18688
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17723
18689
|
};
|
|
17724
18690
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
18691
|
+
/**
|
|
18692
|
+
* @export
|
|
18693
|
+
*/
|
|
18694
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
18695
|
+
readonly Pending: "PENDING";
|
|
18696
|
+
readonly Paid: "PAID";
|
|
18697
|
+
readonly Expired: "EXPIRED";
|
|
18698
|
+
readonly Cancelled: "CANCELLED";
|
|
18699
|
+
};
|
|
18700
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17725
18701
|
/**
|
|
17726
18702
|
* @export
|
|
17727
18703
|
*/
|