@gewis/sudosos-client 0.0.0-develop.1132eaf → 0.0.0-develop.121f5df
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 +1208 -472
- package/dist/api.js +1030 -450
- package/dist/base.js +1 -1
- package/package.json +4 -4
package/dist/api.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface AcceptTosRequest {
|
|
|
25
25
|
* @memberof AcceptTosRequest
|
|
26
26
|
*/
|
|
27
27
|
'extensiveDataProcessing': boolean;
|
|
28
|
+
/**
|
|
29
|
+
* The TOS version being accepted.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AcceptTosRequest
|
|
32
|
+
*/
|
|
33
|
+
'version': string;
|
|
28
34
|
}
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
@@ -70,6 +76,12 @@ export interface AuthenticationEanRequest {
|
|
|
70
76
|
* @memberof AuthenticationEanRequest
|
|
71
77
|
*/
|
|
72
78
|
'eanCode': string;
|
|
79
|
+
/**
|
|
80
|
+
* POS identifier
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof AuthenticationEanRequest
|
|
83
|
+
*/
|
|
84
|
+
'posId': number;
|
|
73
85
|
}
|
|
74
86
|
/**
|
|
75
87
|
*
|
|
@@ -159,6 +171,12 @@ export interface AuthenticationNfcRequest {
|
|
|
159
171
|
* @memberof AuthenticationNfcRequest
|
|
160
172
|
*/
|
|
161
173
|
'nfcCode': string;
|
|
174
|
+
/**
|
|
175
|
+
* POS identifier
|
|
176
|
+
* @type {number}
|
|
177
|
+
* @memberof AuthenticationNfcRequest
|
|
178
|
+
*/
|
|
179
|
+
'posId': number;
|
|
162
180
|
}
|
|
163
181
|
/**
|
|
164
182
|
*
|
|
@@ -178,6 +196,12 @@ export interface AuthenticationPinRequest {
|
|
|
178
196
|
* @memberof AuthenticationPinRequest
|
|
179
197
|
*/
|
|
180
198
|
'pin': string;
|
|
199
|
+
/**
|
|
200
|
+
* POS identifier
|
|
201
|
+
* @type {number}
|
|
202
|
+
* @memberof AuthenticationPinRequest
|
|
203
|
+
*/
|
|
204
|
+
'posId': number;
|
|
181
205
|
}
|
|
182
206
|
/**
|
|
183
207
|
*
|
|
@@ -260,69 +284,6 @@ export interface AuthenticationResponse {
|
|
|
260
284
|
*/
|
|
261
285
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
262
286
|
}
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @export
|
|
266
|
-
* @interface AuthenticationSecureEanRequest
|
|
267
|
-
*/
|
|
268
|
-
export interface AuthenticationSecureEanRequest {
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {string}
|
|
272
|
-
* @memberof AuthenticationSecureEanRequest
|
|
273
|
-
*/
|
|
274
|
-
'eanCode': string;
|
|
275
|
-
/**
|
|
276
|
-
* POS identifier
|
|
277
|
-
* @type {number}
|
|
278
|
-
* @memberof AuthenticationSecureEanRequest
|
|
279
|
-
*/
|
|
280
|
-
'posId': number;
|
|
281
|
-
}
|
|
282
|
-
/**
|
|
283
|
-
*
|
|
284
|
-
* @export
|
|
285
|
-
* @interface AuthenticationSecureNfcRequest
|
|
286
|
-
*/
|
|
287
|
-
export interface AuthenticationSecureNfcRequest {
|
|
288
|
-
/**
|
|
289
|
-
*
|
|
290
|
-
* @type {string}
|
|
291
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
292
|
-
*/
|
|
293
|
-
'nfcCode': string;
|
|
294
|
-
/**
|
|
295
|
-
* POS identifier
|
|
296
|
-
* @type {number}
|
|
297
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
298
|
-
*/
|
|
299
|
-
'posId': number;
|
|
300
|
-
}
|
|
301
|
-
/**
|
|
302
|
-
*
|
|
303
|
-
* @export
|
|
304
|
-
* @interface AuthenticationSecurePinRequest
|
|
305
|
-
*/
|
|
306
|
-
export interface AuthenticationSecurePinRequest {
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @type {number}
|
|
310
|
-
* @memberof AuthenticationSecurePinRequest
|
|
311
|
-
*/
|
|
312
|
-
'userId': number;
|
|
313
|
-
/**
|
|
314
|
-
*
|
|
315
|
-
* @type {string}
|
|
316
|
-
* @memberof AuthenticationSecurePinRequest
|
|
317
|
-
*/
|
|
318
|
-
'pin': string;
|
|
319
|
-
/**
|
|
320
|
-
* POS identifier (required for secure authentication)
|
|
321
|
-
* @type {number}
|
|
322
|
-
* @memberof AuthenticationSecurePinRequest
|
|
323
|
-
*/
|
|
324
|
-
'posId': number;
|
|
325
|
-
}
|
|
326
287
|
/**
|
|
327
288
|
*
|
|
328
289
|
* @export
|
|
@@ -946,6 +907,104 @@ export interface BaseInvoiceResponse {
|
|
|
946
907
|
*/
|
|
947
908
|
'totalInclVat': DineroObjectResponse;
|
|
948
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* PaymentRequest is UUID-keyed. To avoid overloading the `id` slot (which on other responses is the numeric DB id), the UUID is exposed under a semantically named field, mirroring how `QRAuthenticator` exposes its UUID as `sessionId`. The response therefore extends `BaseResponseWithoutId` (timestamps + version, no `id`) and declares a `uuid` of its own.
|
|
912
|
+
* @export
|
|
913
|
+
* @interface BasePaymentRequestResponse
|
|
914
|
+
*/
|
|
915
|
+
export interface BasePaymentRequestResponse {
|
|
916
|
+
/**
|
|
917
|
+
* UUID v4 identifier (also the public share-link id).
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof BasePaymentRequestResponse
|
|
920
|
+
*/
|
|
921
|
+
'uuid': string;
|
|
922
|
+
/**
|
|
923
|
+
* ISO-8601 creation timestamp.
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof BasePaymentRequestResponse
|
|
926
|
+
*/
|
|
927
|
+
'createdAt'?: string;
|
|
928
|
+
/**
|
|
929
|
+
* ISO-8601 last update timestamp.
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof BasePaymentRequestResponse
|
|
932
|
+
*/
|
|
933
|
+
'updatedAt'?: string;
|
|
934
|
+
/**
|
|
935
|
+
* Optimistic-locking version.
|
|
936
|
+
* @type {number}
|
|
937
|
+
* @memberof BasePaymentRequestResponse
|
|
938
|
+
*/
|
|
939
|
+
'version'?: number;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {BaseUserResponse}
|
|
943
|
+
* @memberof BasePaymentRequestResponse
|
|
944
|
+
*/
|
|
945
|
+
'for': BaseUserResponse;
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {BaseUserResponse}
|
|
949
|
+
* @memberof BasePaymentRequestResponse
|
|
950
|
+
*/
|
|
951
|
+
'createdBy': BaseUserResponse;
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {DineroObjectResponse}
|
|
955
|
+
* @memberof BasePaymentRequestResponse
|
|
956
|
+
*/
|
|
957
|
+
'amount': DineroObjectResponse;
|
|
958
|
+
/**
|
|
959
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof BasePaymentRequestResponse
|
|
962
|
+
*/
|
|
963
|
+
'expiresAt': string;
|
|
964
|
+
/**
|
|
965
|
+
* ISO-8601 timestamp the request was marked paid (null if not paid).
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof BasePaymentRequestResponse
|
|
968
|
+
*/
|
|
969
|
+
'paidAt'?: string;
|
|
970
|
+
/**
|
|
971
|
+
* ISO-8601 timestamp the request was cancelled (null if not cancelled).
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof BasePaymentRequestResponse
|
|
974
|
+
*/
|
|
975
|
+
'cancelledAt'?: string;
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {BaseUserResponse}
|
|
979
|
+
* @memberof BasePaymentRequestResponse
|
|
980
|
+
*/
|
|
981
|
+
'cancelledBy'?: BaseUserResponse;
|
|
982
|
+
/**
|
|
983
|
+
*
|
|
984
|
+
* @type {BaseUserResponse}
|
|
985
|
+
* @memberof BasePaymentRequestResponse
|
|
986
|
+
*/
|
|
987
|
+
'fulfilledBy'?: BaseUserResponse;
|
|
988
|
+
/**
|
|
989
|
+
* Optional human-readable description.
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof BasePaymentRequestResponse
|
|
992
|
+
*/
|
|
993
|
+
'description'?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Derived lifecycle status.
|
|
996
|
+
* @type {string}
|
|
997
|
+
* @memberof BasePaymentRequestResponse
|
|
998
|
+
*/
|
|
999
|
+
'status': BasePaymentRequestResponseStatusEnum;
|
|
1000
|
+
}
|
|
1001
|
+
export declare const BasePaymentRequestResponseStatusEnum: {
|
|
1002
|
+
readonly Pending: "PENDING";
|
|
1003
|
+
readonly Paid: "PAID";
|
|
1004
|
+
readonly Expired: "EXPIRED";
|
|
1005
|
+
readonly Cancelled: "CANCELLED";
|
|
1006
|
+
};
|
|
1007
|
+
export type BasePaymentRequestResponseStatusEnum = typeof BasePaymentRequestResponseStatusEnum[keyof typeof BasePaymentRequestResponseStatusEnum];
|
|
949
1008
|
/**
|
|
950
1009
|
*
|
|
951
1010
|
* @export
|
|
@@ -1186,6 +1245,31 @@ export interface BaseResponse {
|
|
|
1186
1245
|
*/
|
|
1187
1246
|
'version'?: number;
|
|
1188
1247
|
}
|
|
1248
|
+
/**
|
|
1249
|
+
* Standard timestamp/version fields every response shares, without an `id`. Responses that key on a UUID (or any non-integer identifier) extend this and add their own `id` field. Responses keyed on an integer id extend `BaseResponse` instead, which adds `id: number`. Parallel to `BaseEntityWithoutId` on the entity side.
|
|
1250
|
+
* @export
|
|
1251
|
+
* @interface BaseResponseWithoutId
|
|
1252
|
+
*/
|
|
1253
|
+
export interface BaseResponseWithoutId {
|
|
1254
|
+
/**
|
|
1255
|
+
* The creation Date of the entity.
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof BaseResponseWithoutId
|
|
1258
|
+
*/
|
|
1259
|
+
'createdAt'?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The last update Date of the entity.
|
|
1262
|
+
* @type {string}
|
|
1263
|
+
* @memberof BaseResponseWithoutId
|
|
1264
|
+
*/
|
|
1265
|
+
'updatedAt'?: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* The version of the entity.
|
|
1268
|
+
* @type {number}
|
|
1269
|
+
* @memberof BaseResponseWithoutId
|
|
1270
|
+
*/
|
|
1271
|
+
'version'?: number;
|
|
1272
|
+
}
|
|
1189
1273
|
/**
|
|
1190
1274
|
*
|
|
1191
1275
|
* @export
|
|
@@ -1659,7 +1743,7 @@ export interface ContainerWithProductsResponse {
|
|
|
1659
1743
|
'products': Array<ProductResponse>;
|
|
1660
1744
|
}
|
|
1661
1745
|
/**
|
|
1662
|
-
*
|
|
1746
|
+
* API Request for creating a `container` entity.
|
|
1663
1747
|
* @export
|
|
1664
1748
|
* @interface CreateContainerRequest
|
|
1665
1749
|
*/
|
|
@@ -1824,6 +1908,37 @@ export interface CreateInvoiceRequest {
|
|
|
1824
1908
|
*/
|
|
1825
1909
|
'amount': DineroObjectRequest;
|
|
1826
1910
|
}
|
|
1911
|
+
/**
|
|
1912
|
+
*
|
|
1913
|
+
* @export
|
|
1914
|
+
* @interface CreatePaymentRequestRequest
|
|
1915
|
+
*/
|
|
1916
|
+
export interface CreatePaymentRequestRequest {
|
|
1917
|
+
/**
|
|
1918
|
+
* The ID of the user whose balance will be credited on payment.
|
|
1919
|
+
* @type {number}
|
|
1920
|
+
* @memberof CreatePaymentRequestRequest
|
|
1921
|
+
*/
|
|
1922
|
+
'forId': number;
|
|
1923
|
+
/**
|
|
1924
|
+
*
|
|
1925
|
+
* @type {DineroObjectRequest}
|
|
1926
|
+
* @memberof CreatePaymentRequestRequest
|
|
1927
|
+
*/
|
|
1928
|
+
'amount': DineroObjectRequest;
|
|
1929
|
+
/**
|
|
1930
|
+
* ISO-8601 timestamp after which the request stops accepting payments.
|
|
1931
|
+
* @type {string}
|
|
1932
|
+
* @memberof CreatePaymentRequestRequest
|
|
1933
|
+
*/
|
|
1934
|
+
'expiresAt': string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Optional human-readable description (e.g. invoice reference).
|
|
1937
|
+
* @type {string}
|
|
1938
|
+
* @memberof CreatePaymentRequestRequest
|
|
1939
|
+
*/
|
|
1940
|
+
'description'?: string;
|
|
1941
|
+
}
|
|
1827
1942
|
/**
|
|
1828
1943
|
*
|
|
1829
1944
|
* @export
|
|
@@ -1856,7 +1971,7 @@ export interface CreatePermissionParams {
|
|
|
1856
1971
|
'attributes': Array<string>;
|
|
1857
1972
|
}
|
|
1858
1973
|
/**
|
|
1859
|
-
*
|
|
1974
|
+
* API Request for creating a `point of sale` entity.
|
|
1860
1975
|
* @export
|
|
1861
1976
|
* @interface CreatePointOfSaleRequest
|
|
1862
1977
|
*/
|
|
@@ -1880,7 +1995,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1880
1995
|
*/
|
|
1881
1996
|
'containers': Array<number>;
|
|
1882
1997
|
/**
|
|
1883
|
-
* ID of the user who will own the POS
|
|
1998
|
+
* ID of the user who will own the POS.
|
|
1884
1999
|
* @type {number}
|
|
1885
2000
|
* @memberof CreatePointOfSaleRequest
|
|
1886
2001
|
*/
|
|
@@ -1893,7 +2008,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1893
2008
|
'cashierRoleIds'?: Array<number>;
|
|
1894
2009
|
}
|
|
1895
2010
|
/**
|
|
1896
|
-
*
|
|
2011
|
+
* API Request for creating a `product` entity.
|
|
1897
2012
|
* @export
|
|
1898
2013
|
* @interface CreateProductRequest
|
|
1899
2014
|
*/
|
|
@@ -3154,44 +3269,38 @@ export interface InvoiceUserResponse {
|
|
|
3154
3269
|
/**
|
|
3155
3270
|
*
|
|
3156
3271
|
* @export
|
|
3157
|
-
* @interface
|
|
3272
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3158
3273
|
*/
|
|
3159
|
-
export interface
|
|
3160
|
-
/**
|
|
3161
|
-
*
|
|
3162
|
-
* @type {number}
|
|
3163
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3164
|
-
*/
|
|
3165
|
-
'memberId': number;
|
|
3274
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3166
3275
|
/**
|
|
3167
|
-
*
|
|
3276
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3168
3277
|
* @type {string}
|
|
3169
|
-
* @memberof
|
|
3278
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3170
3279
|
*/
|
|
3171
|
-
'
|
|
3280
|
+
'reason': string;
|
|
3172
3281
|
}
|
|
3173
3282
|
/**
|
|
3174
3283
|
*
|
|
3175
3284
|
* @export
|
|
3176
|
-
* @interface
|
|
3285
|
+
* @interface MemberAuthenticationPinRequest
|
|
3177
3286
|
*/
|
|
3178
|
-
export interface
|
|
3287
|
+
export interface MemberAuthenticationPinRequest {
|
|
3179
3288
|
/**
|
|
3180
3289
|
*
|
|
3181
3290
|
* @type {number}
|
|
3182
|
-
* @memberof
|
|
3291
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3183
3292
|
*/
|
|
3184
3293
|
'memberId': number;
|
|
3185
3294
|
/**
|
|
3186
3295
|
*
|
|
3187
3296
|
* @type {string}
|
|
3188
|
-
* @memberof
|
|
3297
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3189
3298
|
*/
|
|
3190
3299
|
'pin': string;
|
|
3191
3300
|
/**
|
|
3192
3301
|
* POS identifier
|
|
3193
3302
|
* @type {number}
|
|
3194
|
-
* @memberof
|
|
3303
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3195
3304
|
*/
|
|
3196
3305
|
'posId': number;
|
|
3197
3306
|
}
|
|
@@ -3219,13 +3328,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3219
3328
|
* @type {PaginationResult}
|
|
3220
3329
|
* @memberof PaginatedBalanceResponse
|
|
3221
3330
|
*/
|
|
3222
|
-
'_pagination'
|
|
3331
|
+
'_pagination': PaginationResult;
|
|
3223
3332
|
/**
|
|
3224
3333
|
* Returned balance responses
|
|
3225
3334
|
* @type {Array<BalanceResponse>}
|
|
3226
3335
|
* @memberof PaginatedBalanceResponse
|
|
3227
3336
|
*/
|
|
3228
|
-
'records'
|
|
3337
|
+
'records': Array<BalanceResponse>;
|
|
3229
3338
|
}
|
|
3230
3339
|
/**
|
|
3231
3340
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3238,13 +3347,13 @@ export interface PaginatedBannerResponse {
|
|
|
3238
3347
|
* @type {PaginationResult}
|
|
3239
3348
|
* @memberof PaginatedBannerResponse
|
|
3240
3349
|
*/
|
|
3241
|
-
'_pagination'
|
|
3350
|
+
'_pagination': PaginationResult;
|
|
3242
3351
|
/**
|
|
3243
3352
|
* Returned banners
|
|
3244
3353
|
* @type {Array<BannerResponse>}
|
|
3245
3354
|
* @memberof PaginatedBannerResponse
|
|
3246
3355
|
*/
|
|
3247
|
-
'records'
|
|
3356
|
+
'records': Array<BannerResponse>;
|
|
3248
3357
|
}
|
|
3249
3358
|
/**
|
|
3250
3359
|
*
|
|
@@ -3265,6 +3374,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3265
3374
|
*/
|
|
3266
3375
|
'records': Array<BaseEventResponse>;
|
|
3267
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
|
+
}
|
|
3268
3396
|
/**
|
|
3269
3397
|
*
|
|
3270
3398
|
* @export
|
|
@@ -3304,7 +3432,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3304
3432
|
'records': Array<BaseTransactionResponse>;
|
|
3305
3433
|
}
|
|
3306
3434
|
/**
|
|
3307
|
-
*
|
|
3435
|
+
* Paginated API Response for the `container` entity.
|
|
3308
3436
|
* @export
|
|
3309
3437
|
* @interface PaginatedContainerResponse
|
|
3310
3438
|
*/
|
|
@@ -3323,7 +3451,7 @@ export interface PaginatedContainerResponse {
|
|
|
3323
3451
|
'records': Array<ContainerResponse>;
|
|
3324
3452
|
}
|
|
3325
3453
|
/**
|
|
3326
|
-
*
|
|
3454
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3327
3455
|
* @export
|
|
3328
3456
|
* @interface PaginatedContainerWithProductResponse
|
|
3329
3457
|
*/
|
|
@@ -3409,13 +3537,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3409
3537
|
* @type {PaginationResult}
|
|
3410
3538
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3411
3539
|
*/
|
|
3412
|
-
'_pagination'
|
|
3540
|
+
'_pagination': PaginationResult;
|
|
3413
3541
|
/**
|
|
3414
3542
|
* Returned InactiveAdministrativeCost
|
|
3415
3543
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3416
3544
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3417
3545
|
*/
|
|
3418
|
-
'records'
|
|
3546
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3419
3547
|
}
|
|
3420
3548
|
/**
|
|
3421
3549
|
*
|
|
@@ -3437,7 +3565,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3437
3565
|
'records': Array<InvoiceResponseTypes>;
|
|
3438
3566
|
}
|
|
3439
3567
|
/**
|
|
3440
|
-
*
|
|
3568
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3441
3569
|
* @export
|
|
3442
3570
|
* @interface PaginatedPointOfSaleResponse
|
|
3443
3571
|
*/
|
|
@@ -3456,7 +3584,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3456
3584
|
'records': Array<PointOfSaleResponse>;
|
|
3457
3585
|
}
|
|
3458
3586
|
/**
|
|
3459
|
-
*
|
|
3587
|
+
* Paginated API Response for the `product category` entity.
|
|
3460
3588
|
* @export
|
|
3461
3589
|
* @interface PaginatedProductCategoryResponse
|
|
3462
3590
|
*/
|
|
@@ -3475,7 +3603,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3475
3603
|
'records': Array<ProductCategoryResponse>;
|
|
3476
3604
|
}
|
|
3477
3605
|
/**
|
|
3478
|
-
*
|
|
3606
|
+
* Paginated API Response for the `product` entity.
|
|
3479
3607
|
* @export
|
|
3480
3608
|
* @interface PaginatedProductResponse
|
|
3481
3609
|
*/
|
|
@@ -3570,7 +3698,7 @@ export interface PaginatedUserResponse {
|
|
|
3570
3698
|
'records': Array<UserResponse>;
|
|
3571
3699
|
}
|
|
3572
3700
|
/**
|
|
3573
|
-
*
|
|
3701
|
+
* Paginated API Response for the `vat group` entity.
|
|
3574
3702
|
* @export
|
|
3575
3703
|
* @interface PaginatedVatGroupResponse
|
|
3576
3704
|
*/
|
|
@@ -3695,6 +3823,31 @@ export interface PatchUserTypeRequest {
|
|
|
3695
3823
|
*/
|
|
3696
3824
|
'userType': string;
|
|
3697
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
|
+
}
|
|
3698
3851
|
/**
|
|
3699
3852
|
*
|
|
3700
3853
|
* @export
|
|
@@ -3902,7 +4055,7 @@ export interface PermissionResponse {
|
|
|
3902
4055
|
'actions': Array<ActionResponse>;
|
|
3903
4056
|
}
|
|
3904
4057
|
/**
|
|
3905
|
-
*
|
|
4058
|
+
* API Response describing who is associated with a `point of sale`: its owner, the owner\'s organ members, and the cashier users (users holding at least one of the POS\'s cashier roles).
|
|
3906
4059
|
* @export
|
|
3907
4060
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3908
4061
|
*/
|
|
@@ -4055,7 +4208,7 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4055
4208
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4056
4209
|
}
|
|
4057
4210
|
/**
|
|
4058
|
-
*
|
|
4211
|
+
* API Request for creating or updating a `product category` entity.
|
|
4059
4212
|
* @export
|
|
4060
4213
|
* @interface ProductCategoryRequest
|
|
4061
4214
|
*/
|
|
@@ -4220,38 +4373,88 @@ export interface ProductResponse {
|
|
|
4220
4373
|
'priceList': boolean;
|
|
4221
4374
|
}
|
|
4222
4375
|
/**
|
|
4223
|
-
*
|
|
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.
|
|
4224
4377
|
* @export
|
|
4225
|
-
* @interface
|
|
4378
|
+
* @interface PublicPaymentRequestResponse
|
|
4226
4379
|
*/
|
|
4227
|
-
export interface
|
|
4380
|
+
export interface PublicPaymentRequestResponse {
|
|
4228
4381
|
/**
|
|
4229
|
-
*
|
|
4382
|
+
* UUID v4 identifier.
|
|
4230
4383
|
* @type {string}
|
|
4231
|
-
* @memberof
|
|
4384
|
+
* @memberof PublicPaymentRequestResponse
|
|
4232
4385
|
*/
|
|
4233
|
-
'
|
|
4386
|
+
'uuid': string;
|
|
4234
4387
|
/**
|
|
4235
|
-
*
|
|
4388
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4236
4389
|
* @type {string}
|
|
4237
|
-
* @memberof
|
|
4390
|
+
* @memberof PublicPaymentRequestResponse
|
|
4238
4391
|
*/
|
|
4239
|
-
'
|
|
4392
|
+
'forDisplayName': string;
|
|
4240
4393
|
/**
|
|
4241
|
-
*
|
|
4394
|
+
*
|
|
4395
|
+
* @type {DineroObjectResponse}
|
|
4396
|
+
* @memberof PublicPaymentRequestResponse
|
|
4397
|
+
*/
|
|
4398
|
+
'amount': DineroObjectResponse;
|
|
4399
|
+
/**
|
|
4400
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4242
4401
|
* @type {string}
|
|
4243
|
-
* @memberof
|
|
4402
|
+
* @memberof PublicPaymentRequestResponse
|
|
4244
4403
|
*/
|
|
4245
4404
|
'expiresAt': string;
|
|
4246
|
-
}
|
|
4247
|
-
/**
|
|
4248
|
-
*
|
|
4249
|
-
* @export
|
|
4250
|
-
* @interface QRStatusResponse
|
|
4251
|
-
*/
|
|
4252
|
-
export interface QRStatusResponse {
|
|
4253
4405
|
/**
|
|
4254
|
-
*
|
|
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
|
|
4447
|
+
*/
|
|
4448
|
+
'expiresAt': string;
|
|
4449
|
+
}
|
|
4450
|
+
/**
|
|
4451
|
+
*
|
|
4452
|
+
* @export
|
|
4453
|
+
* @interface QRStatusResponse
|
|
4454
|
+
*/
|
|
4455
|
+
export interface QRStatusResponse {
|
|
4456
|
+
/**
|
|
4457
|
+
* The status of the QR code
|
|
4255
4458
|
* @type {string}
|
|
4256
4459
|
* @memberof QRStatusResponse
|
|
4257
4460
|
*/
|
|
@@ -5100,6 +5303,12 @@ export interface TermsOfServiceResponse {
|
|
|
5100
5303
|
* @memberof TermsOfServiceResponse
|
|
5101
5304
|
*/
|
|
5102
5305
|
'versionNumber': string;
|
|
5306
|
+
/**
|
|
5307
|
+
* The date this version took effect.
|
|
5308
|
+
* @type {string}
|
|
5309
|
+
* @memberof TermsOfServiceResponse
|
|
5310
|
+
*/
|
|
5311
|
+
'date': string;
|
|
5103
5312
|
/**
|
|
5104
5313
|
* The terms of service content.
|
|
5105
5314
|
* @type {string}
|
|
@@ -5107,6 +5316,17 @@ export interface TermsOfServiceResponse {
|
|
|
5107
5316
|
*/
|
|
5108
5317
|
'content': string;
|
|
5109
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];
|
|
5110
5330
|
/**
|
|
5111
5331
|
*
|
|
5112
5332
|
* @export
|
|
@@ -5120,23 +5340,23 @@ export interface TotalBalanceResponse {
|
|
|
5120
5340
|
*/
|
|
5121
5341
|
'date': string;
|
|
5122
5342
|
/**
|
|
5123
|
-
*
|
|
5124
|
-
* @type {
|
|
5343
|
+
*
|
|
5344
|
+
* @type {DineroObjectResponse}
|
|
5125
5345
|
* @memberof TotalBalanceResponse
|
|
5126
5346
|
*/
|
|
5127
|
-
'totalPositive':
|
|
5347
|
+
'totalPositive': DineroObjectResponse;
|
|
5128
5348
|
/**
|
|
5129
|
-
*
|
|
5130
|
-
* @type {
|
|
5349
|
+
*
|
|
5350
|
+
* @type {DineroObjectResponse}
|
|
5131
5351
|
* @memberof TotalBalanceResponse
|
|
5132
5352
|
*/
|
|
5133
|
-
'totalNegative':
|
|
5353
|
+
'totalNegative': DineroObjectResponse;
|
|
5134
5354
|
/**
|
|
5135
|
-
*
|
|
5136
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5355
|
+
* The total balances for the different user types
|
|
5356
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5137
5357
|
* @memberof TotalBalanceResponse
|
|
5138
5358
|
*/
|
|
5139
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5359
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5140
5360
|
}
|
|
5141
5361
|
/**
|
|
5142
5362
|
*
|
|
@@ -5721,7 +5941,7 @@ export interface TransferSummaryResponse {
|
|
|
5721
5941
|
'manualDeletions': TransferAggregateResponse;
|
|
5722
5942
|
}
|
|
5723
5943
|
/**
|
|
5724
|
-
*
|
|
5944
|
+
* API Request for updating a `container` entity.
|
|
5725
5945
|
* @export
|
|
5726
5946
|
* @interface UpdateContainerRequest
|
|
5727
5947
|
*/
|
|
@@ -5971,7 +6191,7 @@ export interface UpdatePinRequest {
|
|
|
5971
6191
|
'pin': string;
|
|
5972
6192
|
}
|
|
5973
6193
|
/**
|
|
5974
|
-
*
|
|
6194
|
+
* API Request for updating a `point of sale` entity.
|
|
5975
6195
|
* @export
|
|
5976
6196
|
* @interface UpdatePointOfSaleRequest
|
|
5977
6197
|
*/
|
|
@@ -6008,7 +6228,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6008
6228
|
'cashierRoleIds'?: Array<number>;
|
|
6009
6229
|
}
|
|
6010
6230
|
/**
|
|
6011
|
-
*
|
|
6231
|
+
* API Request for updating a `product` entity.
|
|
6012
6232
|
* @export
|
|
6013
6233
|
* @interface UpdateProductRequest
|
|
6014
6234
|
*/
|
|
@@ -6173,9 +6393,15 @@ export interface UpdateUserRequest {
|
|
|
6173
6393
|
* @memberof UpdateUserRequest
|
|
6174
6394
|
*/
|
|
6175
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;
|
|
6176
6402
|
}
|
|
6177
6403
|
/**
|
|
6178
|
-
*
|
|
6404
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6179
6405
|
* @export
|
|
6180
6406
|
* @interface UpdateVatGroupRequest
|
|
6181
6407
|
*/
|
|
@@ -6348,11 +6574,11 @@ export interface UserResponse {
|
|
|
6348
6574
|
*/
|
|
6349
6575
|
'email'?: string;
|
|
6350
6576
|
/**
|
|
6351
|
-
* Whether this user
|
|
6352
|
-
* @type {
|
|
6577
|
+
* Whether this user is required to accept the TOS
|
|
6578
|
+
* @type {boolean}
|
|
6353
6579
|
* @memberof UserResponse
|
|
6354
6580
|
*/
|
|
6355
|
-
'
|
|
6581
|
+
'tosRequired'?: boolean;
|
|
6356
6582
|
/**
|
|
6357
6583
|
* Whether data about this user can be used (non-anonymously) for more data science!
|
|
6358
6584
|
* @type {boolean}
|
|
@@ -6389,6 +6615,12 @@ export interface UserResponse {
|
|
|
6389
6615
|
* @memberof UserResponse
|
|
6390
6616
|
*/
|
|
6391
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;
|
|
6392
6624
|
}
|
|
6393
6625
|
/**
|
|
6394
6626
|
*
|
|
@@ -6495,6 +6727,50 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6495
6727
|
*/
|
|
6496
6728
|
'nickname'?: string;
|
|
6497
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
|
+
}
|
|
6498
6774
|
/**
|
|
6499
6775
|
* The type of a user
|
|
6500
6776
|
* @export
|
|
@@ -6537,7 +6813,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6537
6813
|
'totalNegative': DineroObjectResponse;
|
|
6538
6814
|
}
|
|
6539
6815
|
/**
|
|
6540
|
-
*
|
|
6816
|
+
* A `BaseUserResponse` augmented with a stable position index, used to keep ordered user lists (e.g. POS owner members) rendering in a consistent order across requests.
|
|
6541
6817
|
* @export
|
|
6542
6818
|
* @interface UserWithIndex
|
|
6543
6819
|
*/
|
|
@@ -6569,7 +6845,7 @@ export interface ValidationResponse {
|
|
|
6569
6845
|
'errors': Array<string>;
|
|
6570
6846
|
}
|
|
6571
6847
|
/**
|
|
6572
|
-
*
|
|
6848
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6573
6849
|
* @export
|
|
6574
6850
|
* @interface VatDeclarationResponse
|
|
6575
6851
|
*/
|
|
@@ -6594,7 +6870,7 @@ export interface VatDeclarationResponse {
|
|
|
6594
6870
|
'rows': Array<VatDeclarationRow>;
|
|
6595
6871
|
}
|
|
6596
6872
|
/**
|
|
6597
|
-
*
|
|
6873
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6598
6874
|
* @export
|
|
6599
6875
|
* @interface VatDeclarationRow
|
|
6600
6876
|
*/
|
|
@@ -7062,10 +7338,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7062
7338
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7063
7339
|
/**
|
|
7064
7340
|
*
|
|
7065
|
-
* @summary EAN
|
|
7066
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7341
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7342
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7067
7343
|
* @param {*} [options] Override http request option.
|
|
7068
|
-
* @deprecated
|
|
7069
7344
|
* @throws {RequiredError}
|
|
7070
7345
|
*/
|
|
7071
7346
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7140,13 +7415,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7140
7415
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7141
7416
|
/**
|
|
7142
7417
|
*
|
|
7143
|
-
* @summary PIN
|
|
7144
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7418
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7419
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7145
7420
|
* @param {*} [options] Override http request option.
|
|
7146
|
-
* @deprecated
|
|
7147
7421
|
* @throws {RequiredError}
|
|
7148
7422
|
*/
|
|
7149
|
-
|
|
7423
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7150
7424
|
/**
|
|
7151
7425
|
*
|
|
7152
7426
|
* @summary Mock login and hand out token.
|
|
@@ -7157,19 +7431,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7157
7431
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7158
7432
|
/**
|
|
7159
7433
|
*
|
|
7160
|
-
* @summary NFC
|
|
7161
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7434
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7435
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7162
7436
|
* @param {*} [options] Override http request option.
|
|
7163
|
-
* @deprecated
|
|
7164
7437
|
* @throws {RequiredError}
|
|
7165
7438
|
*/
|
|
7166
7439
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
7440
|
/**
|
|
7168
7441
|
*
|
|
7169
|
-
* @summary PIN
|
|
7170
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7442
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7443
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7171
7444
|
* @param {*} [options] Override http request option.
|
|
7172
|
-
* @deprecated
|
|
7173
7445
|
* @throws {RequiredError}
|
|
7174
7446
|
*/
|
|
7175
7447
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7196,38 +7468,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7196
7468
|
* @throws {RequiredError}
|
|
7197
7469
|
*/
|
|
7198
7470
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7199
|
-
/**
|
|
7200
|
-
*
|
|
7201
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7202
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7203
|
-
* @param {*} [options] Override http request option.
|
|
7204
|
-
* @throws {RequiredError}
|
|
7205
|
-
*/
|
|
7206
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7207
|
-
/**
|
|
7208
|
-
*
|
|
7209
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7210
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7211
|
-
* @param {*} [options] Override http request option.
|
|
7212
|
-
* @throws {RequiredError}
|
|
7213
|
-
*/
|
|
7214
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7215
|
-
/**
|
|
7216
|
-
*
|
|
7217
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7218
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7219
|
-
* @param {*} [options] Override http request option.
|
|
7220
|
-
* @throws {RequiredError}
|
|
7221
|
-
*/
|
|
7222
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7223
|
-
/**
|
|
7224
|
-
*
|
|
7225
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7226
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7227
|
-
* @param {*} [options] Override http request option.
|
|
7228
|
-
* @throws {RequiredError}
|
|
7229
|
-
*/
|
|
7230
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7231
7471
|
};
|
|
7232
7472
|
/**
|
|
7233
7473
|
* AuthenticateApi - functional programming interface
|
|
@@ -7260,10 +7500,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7260
7500
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7261
7501
|
/**
|
|
7262
7502
|
*
|
|
7263
|
-
* @summary EAN
|
|
7264
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7503
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7504
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7265
7505
|
* @param {*} [options] Override http request option.
|
|
7266
|
-
* @deprecated
|
|
7267
7506
|
* @throws {RequiredError}
|
|
7268
7507
|
*/
|
|
7269
7508
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7338,13 +7577,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7338
7577
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7339
7578
|
/**
|
|
7340
7579
|
*
|
|
7341
|
-
* @summary PIN
|
|
7342
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7580
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7581
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7343
7582
|
* @param {*} [options] Override http request option.
|
|
7344
|
-
* @deprecated
|
|
7345
7583
|
* @throws {RequiredError}
|
|
7346
7584
|
*/
|
|
7347
|
-
|
|
7585
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7348
7586
|
/**
|
|
7349
7587
|
*
|
|
7350
7588
|
* @summary Mock login and hand out token.
|
|
@@ -7355,19 +7593,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7355
7593
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7356
7594
|
/**
|
|
7357
7595
|
*
|
|
7358
|
-
* @summary NFC
|
|
7359
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7596
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7597
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7360
7598
|
* @param {*} [options] Override http request option.
|
|
7361
|
-
* @deprecated
|
|
7362
7599
|
* @throws {RequiredError}
|
|
7363
7600
|
*/
|
|
7364
7601
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7365
7602
|
/**
|
|
7366
7603
|
*
|
|
7367
|
-
* @summary PIN
|
|
7368
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7604
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7605
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7369
7606
|
* @param {*} [options] Override http request option.
|
|
7370
|
-
* @deprecated
|
|
7371
7607
|
* @throws {RequiredError}
|
|
7372
7608
|
*/
|
|
7373
7609
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7394,38 +7630,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7394
7630
|
* @throws {RequiredError}
|
|
7395
7631
|
*/
|
|
7396
7632
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7397
|
-
/**
|
|
7398
|
-
*
|
|
7399
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7400
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7401
|
-
* @param {*} [options] Override http request option.
|
|
7402
|
-
* @throws {RequiredError}
|
|
7403
|
-
*/
|
|
7404
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7405
|
-
/**
|
|
7406
|
-
*
|
|
7407
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7408
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7409
|
-
* @param {*} [options] Override http request option.
|
|
7410
|
-
* @throws {RequiredError}
|
|
7411
|
-
*/
|
|
7412
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7413
|
-
/**
|
|
7414
|
-
*
|
|
7415
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7416
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7417
|
-
* @param {*} [options] Override http request option.
|
|
7418
|
-
* @throws {RequiredError}
|
|
7419
|
-
*/
|
|
7420
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7421
|
-
/**
|
|
7422
|
-
*
|
|
7423
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7424
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7425
|
-
* @param {*} [options] Override http request option.
|
|
7426
|
-
* @throws {RequiredError}
|
|
7427
|
-
*/
|
|
7428
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7429
7633
|
};
|
|
7430
7634
|
/**
|
|
7431
7635
|
* AuthenticateApi - factory interface
|
|
@@ -7458,10 +7662,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7458
7662
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
7663
|
/**
|
|
7460
7664
|
*
|
|
7461
|
-
* @summary EAN
|
|
7665
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7462
7666
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7463
7667
|
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @deprecated
|
|
7465
7668
|
* @throws {RequiredError}
|
|
7466
7669
|
*/
|
|
7467
7670
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7536,13 +7739,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7536
7739
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7537
7740
|
/**
|
|
7538
7741
|
*
|
|
7539
|
-
* @summary PIN
|
|
7540
|
-
* @param {
|
|
7742
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7743
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7541
7744
|
* @param {*} [options] Override http request option.
|
|
7542
|
-
* @deprecated
|
|
7543
7745
|
* @throws {RequiredError}
|
|
7544
7746
|
*/
|
|
7545
|
-
|
|
7747
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7546
7748
|
/**
|
|
7547
7749
|
*
|
|
7548
7750
|
* @summary Mock login and hand out token.
|
|
@@ -7553,19 +7755,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7553
7755
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7554
7756
|
/**
|
|
7555
7757
|
*
|
|
7556
|
-
* @summary NFC
|
|
7758
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7557
7759
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7558
7760
|
* @param {*} [options] Override http request option.
|
|
7559
|
-
* @deprecated
|
|
7560
7761
|
* @throws {RequiredError}
|
|
7561
7762
|
*/
|
|
7562
7763
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7563
7764
|
/**
|
|
7564
7765
|
*
|
|
7565
|
-
* @summary PIN
|
|
7766
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7566
7767
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7567
7768
|
* @param {*} [options] Override http request option.
|
|
7568
|
-
* @deprecated
|
|
7569
7769
|
* @throws {RequiredError}
|
|
7570
7770
|
*/
|
|
7571
7771
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7592,38 +7792,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7592
7792
|
* @throws {RequiredError}
|
|
7593
7793
|
*/
|
|
7594
7794
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7595
|
-
/**
|
|
7596
|
-
*
|
|
7597
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7598
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7599
|
-
* @param {*} [options] Override http request option.
|
|
7600
|
-
* @throws {RequiredError}
|
|
7601
|
-
*/
|
|
7602
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7603
|
-
/**
|
|
7604
|
-
*
|
|
7605
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7606
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7607
|
-
* @param {*} [options] Override http request option.
|
|
7608
|
-
* @throws {RequiredError}
|
|
7609
|
-
*/
|
|
7610
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7611
|
-
/**
|
|
7612
|
-
*
|
|
7613
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7614
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7615
|
-
* @param {*} [options] Override http request option.
|
|
7616
|
-
* @throws {RequiredError}
|
|
7617
|
-
*/
|
|
7618
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7619
|
-
/**
|
|
7620
|
-
*
|
|
7621
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7622
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7623
|
-
* @param {*} [options] Override http request option.
|
|
7624
|
-
* @throws {RequiredError}
|
|
7625
|
-
*/
|
|
7626
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7627
7795
|
};
|
|
7628
7796
|
/**
|
|
7629
7797
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7671,7 +7839,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7671
7839
|
*/
|
|
7672
7840
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7673
7841
|
/**
|
|
7674
|
-
* The EAN login
|
|
7842
|
+
* The EAN login request with posId
|
|
7675
7843
|
* @type {AuthenticationEanRequest}
|
|
7676
7844
|
* @memberof AuthenticateApiEanAuthentication
|
|
7677
7845
|
*/
|
|
@@ -7756,15 +7924,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7756
7924
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7757
7925
|
}
|
|
7758
7926
|
/**
|
|
7759
|
-
* Request parameters for
|
|
7927
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7760
7928
|
* @export
|
|
7761
|
-
* @interface
|
|
7929
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7762
7930
|
*/
|
|
7763
|
-
export interface
|
|
7931
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7764
7932
|
/**
|
|
7765
|
-
* The PIN login
|
|
7933
|
+
* The PIN login request with posId
|
|
7766
7934
|
* @type {MemberAuthenticationPinRequest}
|
|
7767
|
-
* @memberof
|
|
7935
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7768
7936
|
*/
|
|
7769
7937
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7770
7938
|
}
|
|
@@ -7788,7 +7956,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7788
7956
|
*/
|
|
7789
7957
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7790
7958
|
/**
|
|
7791
|
-
* The NFC login
|
|
7959
|
+
* The NFC login request with posId
|
|
7792
7960
|
* @type {AuthenticationNfcRequest}
|
|
7793
7961
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7794
7962
|
*/
|
|
@@ -7801,7 +7969,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7801
7969
|
*/
|
|
7802
7970
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7803
7971
|
/**
|
|
7804
|
-
* The PIN login
|
|
7972
|
+
* The PIN login request with posId
|
|
7805
7973
|
* @type {AuthenticationPinRequest}
|
|
7806
7974
|
* @memberof AuthenticateApiPinAuthentication
|
|
7807
7975
|
*/
|
|
@@ -7833,58 +8001,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7833
8001
|
*/
|
|
7834
8002
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7835
8003
|
}
|
|
7836
|
-
/**
|
|
7837
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7838
|
-
* @export
|
|
7839
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7840
|
-
*/
|
|
7841
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7842
|
-
/**
|
|
7843
|
-
* The EAN login request with posId
|
|
7844
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7845
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7846
|
-
*/
|
|
7847
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7848
|
-
}
|
|
7849
|
-
/**
|
|
7850
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7851
|
-
* @export
|
|
7852
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7853
|
-
*/
|
|
7854
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7855
|
-
/**
|
|
7856
|
-
* The PIN login request with posId
|
|
7857
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7858
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7859
|
-
*/
|
|
7860
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7861
|
-
}
|
|
7862
|
-
/**
|
|
7863
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7864
|
-
* @export
|
|
7865
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7866
|
-
*/
|
|
7867
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7868
|
-
/**
|
|
7869
|
-
* The NFC login request with posId
|
|
7870
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7871
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7872
|
-
*/
|
|
7873
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7874
|
-
}
|
|
7875
|
-
/**
|
|
7876
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7877
|
-
* @export
|
|
7878
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7879
|
-
*/
|
|
7880
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7881
|
-
/**
|
|
7882
|
-
* The PIN login request with posId
|
|
7883
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7884
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7885
|
-
*/
|
|
7886
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7887
|
-
}
|
|
7888
8004
|
/**
|
|
7889
8005
|
* AuthenticateApi - object-oriented interface
|
|
7890
8006
|
* @export
|
|
@@ -7921,10 +8037,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7921
8037
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7922
8038
|
/**
|
|
7923
8039
|
*
|
|
7924
|
-
* @summary EAN
|
|
8040
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7925
8041
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7926
8042
|
* @param {*} [options] Override http request option.
|
|
7927
|
-
* @deprecated
|
|
7928
8043
|
* @throws {RequiredError}
|
|
7929
8044
|
* @memberof AuthenticateApi
|
|
7930
8045
|
*/
|
|
@@ -8009,14 +8124,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8009
8124
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8010
8125
|
/**
|
|
8011
8126
|
*
|
|
8012
|
-
* @summary PIN
|
|
8013
|
-
* @param {
|
|
8127
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8128
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8014
8129
|
* @param {*} [options] Override http request option.
|
|
8015
|
-
* @deprecated
|
|
8016
8130
|
* @throws {RequiredError}
|
|
8017
8131
|
* @memberof AuthenticateApi
|
|
8018
8132
|
*/
|
|
8019
|
-
|
|
8133
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8020
8134
|
/**
|
|
8021
8135
|
*
|
|
8022
8136
|
* @summary Mock login and hand out token.
|
|
@@ -8028,20 +8142,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8028
8142
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8029
8143
|
/**
|
|
8030
8144
|
*
|
|
8031
|
-
* @summary NFC
|
|
8145
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8032
8146
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8033
8147
|
* @param {*} [options] Override http request option.
|
|
8034
|
-
* @deprecated
|
|
8035
8148
|
* @throws {RequiredError}
|
|
8036
8149
|
* @memberof AuthenticateApi
|
|
8037
8150
|
*/
|
|
8038
8151
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8039
8152
|
/**
|
|
8040
8153
|
*
|
|
8041
|
-
* @summary PIN
|
|
8154
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8042
8155
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8043
8156
|
* @param {*} [options] Override http request option.
|
|
8044
|
-
* @deprecated
|
|
8045
8157
|
* @throws {RequiredError}
|
|
8046
8158
|
* @memberof AuthenticateApi
|
|
8047
8159
|
*/
|
|
@@ -8072,42 +8184,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8072
8184
|
* @memberof AuthenticateApi
|
|
8073
8185
|
*/
|
|
8074
8186
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8075
|
-
/**
|
|
8076
|
-
*
|
|
8077
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
8078
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
8079
|
-
* @param {*} [options] Override http request option.
|
|
8080
|
-
* @throws {RequiredError}
|
|
8081
|
-
* @memberof AuthenticateApi
|
|
8082
|
-
*/
|
|
8083
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8084
|
-
/**
|
|
8085
|
-
*
|
|
8086
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
8087
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8088
|
-
* @param {*} [options] Override http request option.
|
|
8089
|
-
* @throws {RequiredError}
|
|
8090
|
-
* @memberof AuthenticateApi
|
|
8091
|
-
*/
|
|
8092
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8093
|
-
/**
|
|
8094
|
-
*
|
|
8095
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
8096
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8097
|
-
* @param {*} [options] Override http request option.
|
|
8098
|
-
* @throws {RequiredError}
|
|
8099
|
-
* @memberof AuthenticateApi
|
|
8100
|
-
*/
|
|
8101
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8102
|
-
/**
|
|
8103
|
-
*
|
|
8104
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
8105
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
8106
|
-
* @param {*} [options] Override http request option.
|
|
8107
|
-
* @throws {RequiredError}
|
|
8108
|
-
* @memberof AuthenticateApi
|
|
8109
|
-
*/
|
|
8110
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8111
8187
|
}
|
|
8112
8188
|
/**
|
|
8113
8189
|
* BalanceApi - axios parameter creator
|
|
@@ -10826,7 +10902,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10826
10902
|
* @param {*} [options] Override http request option.
|
|
10827
10903
|
* @throws {RequiredError}
|
|
10828
10904
|
*/
|
|
10829
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10905
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10830
10906
|
/**
|
|
10831
10907
|
*
|
|
10832
10908
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10904,7 +10980,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10904
10980
|
* @param {*} [options] Override http request option.
|
|
10905
10981
|
* @throws {RequiredError}
|
|
10906
10982
|
*/
|
|
10907
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10983
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10908
10984
|
/**
|
|
10909
10985
|
*
|
|
10910
10986
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11127,7 +11203,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11127
11203
|
* @throws {RequiredError}
|
|
11128
11204
|
* @memberof InactiveAdministrativeCostsApi
|
|
11129
11205
|
*/
|
|
11130
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11206
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11131
11207
|
/**
|
|
11132
11208
|
*
|
|
11133
11209
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11299,7 +11375,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11299
11375
|
* @param {*} [options] Override http request option.
|
|
11300
11376
|
* @throws {RequiredError}
|
|
11301
11377
|
*/
|
|
11302
|
-
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>>>;
|
|
11303
11379
|
/**
|
|
11304
11380
|
*
|
|
11305
11381
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11315,7 +11391,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11315
11391
|
* @param {*} [options] Override http request option.
|
|
11316
11392
|
* @throws {RequiredError}
|
|
11317
11393
|
*/
|
|
11318
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11394
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11319
11395
|
/**
|
|
11320
11396
|
*
|
|
11321
11397
|
* @summary Returns a single invoice in the system.
|
|
@@ -11396,7 +11472,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11396
11472
|
* @param {*} [options] Override http request option.
|
|
11397
11473
|
* @throws {RequiredError}
|
|
11398
11474
|
*/
|
|
11399
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11475
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11400
11476
|
/**
|
|
11401
11477
|
*
|
|
11402
11478
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11411,7 +11487,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11411
11487
|
* @param {*} [options] Override http request option.
|
|
11412
11488
|
* @throws {RequiredError}
|
|
11413
11489
|
*/
|
|
11414
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11490
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11415
11491
|
/**
|
|
11416
11492
|
*
|
|
11417
11493
|
* @summary Returns a single invoice in the system.
|
|
@@ -11596,174 +11672,660 @@ export interface InvoicesApiGetInvoicePdfRequest {
|
|
|
11596
11672
|
*/
|
|
11597
11673
|
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11598
11674
|
/**
|
|
11599
|
-
* The id of the requested invoice
|
|
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;
|
|
12045
|
+
}
|
|
12046
|
+
/**
|
|
12047
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
12048
|
+
* @export
|
|
12049
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
12050
|
+
*/
|
|
12051
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
12052
|
+
/**
|
|
12053
|
+
* Filter by beneficiary user id.
|
|
12054
|
+
* @type {number}
|
|
12055
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12056
|
+
*/
|
|
12057
|
+
readonly forId?: number;
|
|
12058
|
+
/**
|
|
12059
|
+
* Filter by creator user id.
|
|
12060
|
+
* @type {number}
|
|
12061
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12062
|
+
*/
|
|
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
|
|
11600
12084
|
* @type {number}
|
|
11601
|
-
* @memberof
|
|
12085
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11602
12086
|
*/
|
|
11603
|
-
readonly
|
|
12087
|
+
readonly take?: number;
|
|
11604
12088
|
/**
|
|
11605
|
-
*
|
|
11606
|
-
* @type {
|
|
11607
|
-
* @memberof
|
|
12089
|
+
* How many rows to skip (for pagination)
|
|
12090
|
+
* @type {number}
|
|
12091
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11608
12092
|
*/
|
|
11609
|
-
readonly
|
|
12093
|
+
readonly skip?: number;
|
|
11610
12094
|
}
|
|
11611
12095
|
/**
|
|
11612
|
-
* Request parameters for
|
|
12096
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11613
12097
|
* @export
|
|
11614
|
-
* @interface
|
|
12098
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11615
12099
|
*/
|
|
11616
|
-
export interface
|
|
12100
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11617
12101
|
/**
|
|
11618
|
-
*
|
|
11619
|
-
* @type {
|
|
11620
|
-
* @memberof
|
|
12102
|
+
* UUID v4 of the payment request.
|
|
12103
|
+
* @type {string}
|
|
12104
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11621
12105
|
*/
|
|
11622
|
-
readonly id:
|
|
12106
|
+
readonly id: string;
|
|
11623
12107
|
}
|
|
11624
12108
|
/**
|
|
11625
|
-
* Request parameters for
|
|
12109
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11626
12110
|
* @export
|
|
11627
|
-
* @interface
|
|
12111
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11628
12112
|
*/
|
|
11629
|
-
export interface
|
|
12113
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11630
12114
|
/**
|
|
11631
|
-
*
|
|
11632
|
-
* @type {
|
|
11633
|
-
* @memberof
|
|
12115
|
+
* UUID v4 of the payment request.
|
|
12116
|
+
* @type {string}
|
|
12117
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11634
12118
|
*/
|
|
11635
|
-
readonly id:
|
|
12119
|
+
readonly id: string;
|
|
11636
12120
|
/**
|
|
11637
|
-
* The
|
|
11638
|
-
* @type {
|
|
11639
|
-
* @memberof
|
|
12121
|
+
* The audit reason
|
|
12122
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12123
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11640
12124
|
*/
|
|
11641
|
-
readonly
|
|
12125
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11642
12126
|
}
|
|
11643
12127
|
/**
|
|
11644
|
-
* Request parameters for
|
|
12128
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11645
12129
|
* @export
|
|
11646
|
-
* @interface
|
|
12130
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11647
12131
|
*/
|
|
11648
|
-
export interface
|
|
11649
|
-
/**
|
|
11650
|
-
* The id of the invoice which should be updated
|
|
11651
|
-
* @type {number}
|
|
11652
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11653
|
-
*/
|
|
11654
|
-
readonly id: number;
|
|
12132
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11655
12133
|
/**
|
|
11656
|
-
*
|
|
11657
|
-
* @type {
|
|
11658
|
-
* @memberof
|
|
12134
|
+
* UUID v4 of the payment request.
|
|
12135
|
+
* @type {string}
|
|
12136
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11659
12137
|
*/
|
|
11660
|
-
readonly
|
|
12138
|
+
readonly id: string;
|
|
11661
12139
|
}
|
|
11662
12140
|
/**
|
|
11663
|
-
*
|
|
12141
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11664
12142
|
* @export
|
|
11665
|
-
* @class
|
|
12143
|
+
* @class PaymentRequestsApi
|
|
11666
12144
|
* @extends {BaseAPI}
|
|
11667
12145
|
*/
|
|
11668
|
-
export declare class
|
|
12146
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11669
12147
|
/**
|
|
11670
12148
|
*
|
|
11671
|
-
* @summary
|
|
11672
|
-
* @param {
|
|
12149
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12150
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11673
12151
|
* @param {*} [options] Override http request option.
|
|
11674
12152
|
* @throws {RequiredError}
|
|
11675
|
-
* @memberof
|
|
12153
|
+
* @memberof PaymentRequestsApi
|
|
11676
12154
|
*/
|
|
11677
|
-
|
|
12155
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11678
12156
|
/**
|
|
11679
12157
|
*
|
|
11680
|
-
* @summary
|
|
11681
|
-
* @param {
|
|
12158
|
+
* @summary Create a new PaymentRequest.
|
|
12159
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11682
12160
|
* @param {*} [options] Override http request option.
|
|
11683
12161
|
* @throws {RequiredError}
|
|
11684
|
-
* @memberof
|
|
12162
|
+
* @memberof PaymentRequestsApi
|
|
11685
12163
|
*/
|
|
11686
|
-
|
|
12164
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11687
12165
|
/**
|
|
11688
12166
|
*
|
|
11689
|
-
* @summary
|
|
11690
|
-
* @param {
|
|
12167
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12168
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11691
12169
|
* @param {*} [options] Override http request option.
|
|
11692
12170
|
* @throws {RequiredError}
|
|
11693
|
-
* @memberof
|
|
12171
|
+
* @memberof PaymentRequestsApi
|
|
11694
12172
|
*/
|
|
11695
|
-
|
|
12173
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11696
12174
|
/**
|
|
11697
12175
|
*
|
|
11698
|
-
* @summary
|
|
11699
|
-
* @param {
|
|
12176
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12177
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11700
12178
|
* @param {*} [options] Override http request option.
|
|
11701
12179
|
* @throws {RequiredError}
|
|
11702
|
-
* @memberof
|
|
12180
|
+
* @memberof PaymentRequestsApi
|
|
11703
12181
|
*/
|
|
11704
|
-
|
|
12182
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11705
12183
|
/**
|
|
11706
12184
|
*
|
|
11707
|
-
* @summary
|
|
11708
|
-
* @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.
|
|
11709
12187
|
* @param {*} [options] Override http request option.
|
|
11710
12188
|
* @throws {RequiredError}
|
|
11711
|
-
* @memberof
|
|
12189
|
+
* @memberof PaymentRequestsApi
|
|
11712
12190
|
*/
|
|
11713
|
-
|
|
12191
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11714
12192
|
/**
|
|
11715
12193
|
*
|
|
11716
|
-
* @summary
|
|
12194
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12195
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11717
12196
|
* @param {*} [options] Override http request option.
|
|
11718
12197
|
* @throws {RequiredError}
|
|
11719
|
-
* @memberof
|
|
12198
|
+
* @memberof PaymentRequestsApi
|
|
11720
12199
|
*/
|
|
11721
|
-
|
|
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) => {
|
|
11722
12217
|
/**
|
|
11723
12218
|
*
|
|
11724
|
-
* @summary
|
|
11725
|
-
* @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.
|
|
11726
12221
|
* @param {*} [options] Override http request option.
|
|
11727
12222
|
* @throws {RequiredError}
|
|
11728
|
-
* @memberof InvoicesApi
|
|
11729
12223
|
*/
|
|
11730
|
-
|
|
12224
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11731
12225
|
/**
|
|
11732
12226
|
*
|
|
11733
|
-
* @summary
|
|
11734
|
-
* @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.
|
|
11735
12229
|
* @param {*} [options] Override http request option.
|
|
11736
12230
|
* @throws {RequiredError}
|
|
11737
|
-
* @memberof InvoicesApi
|
|
11738
12231
|
*/
|
|
11739
|
-
|
|
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) => {
|
|
11740
12239
|
/**
|
|
11741
12240
|
*
|
|
11742
|
-
* @summary
|
|
11743
|
-
* @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.
|
|
11744
12243
|
* @param {*} [options] Override http request option.
|
|
11745
12244
|
* @throws {RequiredError}
|
|
11746
|
-
* @memberof InvoicesApi
|
|
11747
12245
|
*/
|
|
11748
|
-
|
|
12246
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11749
12247
|
/**
|
|
11750
12248
|
*
|
|
11751
|
-
* @summary
|
|
11752
|
-
* @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.
|
|
11753
12251
|
* @param {*} [options] Override http request option.
|
|
11754
12252
|
* @throws {RequiredError}
|
|
11755
|
-
* @memberof InvoicesApi
|
|
11756
12253
|
*/
|
|
11757
|
-
|
|
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) => {
|
|
11758
12261
|
/**
|
|
11759
12262
|
*
|
|
11760
|
-
* @summary
|
|
11761
|
-
* @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.
|
|
11762
12265
|
* @param {*} [options] Override http request option.
|
|
11763
12266
|
* @throws {RequiredError}
|
|
11764
|
-
* @memberof InvoicesApi
|
|
11765
12267
|
*/
|
|
11766
|
-
|
|
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, {}>>;
|
|
11767
12329
|
}
|
|
11768
12330
|
/**
|
|
11769
12331
|
* PayoutRequestsApi - axios parameter creator
|
|
@@ -15139,12 +15701,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15139
15701
|
* @summary Returns all existing transfers
|
|
15140
15702
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15141
15703
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15704
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15705
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15706
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15142
15707
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15143
15708
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15144
15709
|
* @param {*} [options] Override http request option.
|
|
15145
15710
|
* @throws {RequiredError}
|
|
15146
15711
|
*/
|
|
15147
|
-
getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15712
|
+
getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15148
15713
|
/**
|
|
15149
15714
|
*
|
|
15150
15715
|
* @summary Returns the requested transfer
|
|
@@ -15211,12 +15776,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15211
15776
|
* @summary Returns all existing transfers
|
|
15212
15777
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15213
15778
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15779
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15780
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15781
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15214
15782
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15215
15783
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15216
15784
|
* @param {*} [options] Override http request option.
|
|
15217
15785
|
* @throws {RequiredError}
|
|
15218
15786
|
*/
|
|
15219
|
-
getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
15787
|
+
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTransferResponse>>;
|
|
15220
15788
|
/**
|
|
15221
15789
|
*
|
|
15222
15790
|
* @summary Returns the requested transfer
|
|
@@ -15285,7 +15853,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15285
15853
|
* @param {*} [options] Override http request option.
|
|
15286
15854
|
* @throws {RequiredError}
|
|
15287
15855
|
*/
|
|
15288
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15856
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15289
15857
|
/**
|
|
15290
15858
|
*
|
|
15291
15859
|
* @summary Returns the requested transfer
|
|
@@ -15363,6 +15931,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15363
15931
|
* @memberof TransfersApiGetAllTransfers
|
|
15364
15932
|
*/
|
|
15365
15933
|
readonly tillDate?: string;
|
|
15934
|
+
/**
|
|
15935
|
+
* Filter transfers from this user ID
|
|
15936
|
+
* @type {number}
|
|
15937
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15938
|
+
*/
|
|
15939
|
+
readonly fromId?: number;
|
|
15940
|
+
/**
|
|
15941
|
+
* Filter transfers to this user ID
|
|
15942
|
+
* @type {number}
|
|
15943
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15944
|
+
*/
|
|
15945
|
+
readonly toId?: number;
|
|
15946
|
+
/**
|
|
15947
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15948
|
+
* @type {string}
|
|
15949
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15950
|
+
*/
|
|
15951
|
+
readonly category?: string;
|
|
15366
15952
|
/**
|
|
15367
15953
|
* How many transfers the endpoint should return
|
|
15368
15954
|
* @type {number}
|
|
@@ -15503,7 +16089,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15503
16089
|
* @throws {RequiredError}
|
|
15504
16090
|
* @memberof TransfersApi
|
|
15505
16091
|
*/
|
|
15506
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16092
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15507
16093
|
/**
|
|
15508
16094
|
*
|
|
15509
16095
|
* @summary Returns the requested transfer
|
|
@@ -15752,7 +16338,7 @@ export declare class UserNotificationPreferencesApi extends BaseAPI {
|
|
|
15752
16338
|
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15753
16339
|
/**
|
|
15754
16340
|
*
|
|
15755
|
-
* @summary Accept the Terms of Service
|
|
16341
|
+
* @summary Accept the current Terms of Service version
|
|
15756
16342
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
15757
16343
|
* @param {*} [options] Override http request option.
|
|
15758
16344
|
* @throws {RequiredError}
|
|
@@ -15882,6 +16468,14 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15882
16468
|
* @throws {RequiredError}
|
|
15883
16469
|
*/
|
|
15884
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>;
|
|
15885
16479
|
/**
|
|
15886
16480
|
*
|
|
15887
16481
|
* @summary Returns the user\'s containers
|
|
@@ -15904,6 +16498,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15904
16498
|
* @throws {RequiredError}
|
|
15905
16499
|
*/
|
|
15906
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>;
|
|
15907
16515
|
/**
|
|
15908
16516
|
*
|
|
15909
16517
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16114,7 +16722,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16114
16722
|
export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
16115
16723
|
/**
|
|
16116
16724
|
*
|
|
16117
|
-
* @summary Accept the Terms of Service
|
|
16725
|
+
* @summary Accept the current Terms of Service version
|
|
16118
16726
|
* @param {AcceptTosRequest} acceptTosRequest \"Tosrequest body\"
|
|
16119
16727
|
* @param {*} [options] Override http request option.
|
|
16120
16728
|
* @throws {RequiredError}
|
|
@@ -16244,6 +16852,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16244
16852
|
* @throws {RequiredError}
|
|
16245
16853
|
*/
|
|
16246
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>>;
|
|
16247
16863
|
/**
|
|
16248
16864
|
*
|
|
16249
16865
|
* @summary Returns the user\'s containers
|
|
@@ -16266,6 +16882,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16266
16882
|
* @throws {RequiredError}
|
|
16267
16883
|
*/
|
|
16268
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>>;
|
|
16269
16899
|
/**
|
|
16270
16900
|
*
|
|
16271
16901
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16476,7 +17106,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16476
17106
|
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16477
17107
|
/**
|
|
16478
17108
|
*
|
|
16479
|
-
* @summary Accept the Terms of Service
|
|
17109
|
+
* @summary Accept the current Terms of Service version
|
|
16480
17110
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
16481
17111
|
* @param {*} [options] Override http request option.
|
|
16482
17112
|
* @throws {RequiredError}
|
|
@@ -16594,6 +17224,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16594
17224
|
* @throws {RequiredError}
|
|
16595
17225
|
*/
|
|
16596
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>;
|
|
16597
17235
|
/**
|
|
16598
17236
|
*
|
|
16599
17237
|
* @summary Returns the user\'s containers
|
|
@@ -16610,6 +17248,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16610
17248
|
* @throws {RequiredError}
|
|
16611
17249
|
*/
|
|
16612
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>;
|
|
16613
17259
|
/**
|
|
16614
17260
|
*
|
|
16615
17261
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17039,6 +17685,19 @@ export interface UsersApiGetUserSettingsRequest {
|
|
|
17039
17685
|
*/
|
|
17040
17686
|
readonly id: number;
|
|
17041
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
|
+
}
|
|
17042
17701
|
/**
|
|
17043
17702
|
* Request parameters for getUsersContainers operation in UsersApi.
|
|
17044
17703
|
* @export
|
|
@@ -17101,6 +17760,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17101
17760
|
*/
|
|
17102
17761
|
readonly skip?: number;
|
|
17103
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
|
+
}
|
|
17104
17812
|
/**
|
|
17105
17813
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17106
17814
|
* @export
|
|
@@ -17616,7 +18324,7 @@ export interface UsersApiWaiveUserFinesRequest {
|
|
|
17616
18324
|
export declare class UsersApi extends BaseAPI {
|
|
17617
18325
|
/**
|
|
17618
18326
|
*
|
|
17619
|
-
* @summary Accept the Terms of Service
|
|
18327
|
+
* @summary Accept the current Terms of Service version
|
|
17620
18328
|
* @param {UsersApiAcceptTosRequest} requestParameters Request parameters.
|
|
17621
18329
|
* @param {*} [options] Override http request option.
|
|
17622
18330
|
* @throws {RequiredError}
|
|
@@ -17749,6 +18457,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17749
18457
|
* @memberof UsersApi
|
|
17750
18458
|
*/
|
|
17751
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, {}>>;
|
|
17752
18469
|
/**
|
|
17753
18470
|
*
|
|
17754
18471
|
* @summary Returns the user\'s containers
|
|
@@ -17767,6 +18484,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17767
18484
|
* @memberof UsersApi
|
|
17768
18485
|
*/
|
|
17769
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, {}>>;
|
|
17770
18496
|
/**
|
|
17771
18497
|
*
|
|
17772
18498
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17962,6 +18688,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17962
18688
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17963
18689
|
};
|
|
17964
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];
|
|
17965
18701
|
/**
|
|
17966
18702
|
* @export
|
|
17967
18703
|
*/
|