@gewis/sudosos-client 0.0.0-develop.e4aa3f3 → 0.0.0-develop.e880544
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 +1064 -459
- package/dist/api.js +886 -397
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -70,6 +70,12 @@ export interface AuthenticationEanRequest {
|
|
|
70
70
|
* @memberof AuthenticationEanRequest
|
|
71
71
|
*/
|
|
72
72
|
'eanCode': string;
|
|
73
|
+
/**
|
|
74
|
+
* POS identifier
|
|
75
|
+
* @type {number}
|
|
76
|
+
* @memberof AuthenticationEanRequest
|
|
77
|
+
*/
|
|
78
|
+
'posId': number;
|
|
73
79
|
}
|
|
74
80
|
/**
|
|
75
81
|
*
|
|
@@ -159,6 +165,12 @@ export interface AuthenticationNfcRequest {
|
|
|
159
165
|
* @memberof AuthenticationNfcRequest
|
|
160
166
|
*/
|
|
161
167
|
'nfcCode': string;
|
|
168
|
+
/**
|
|
169
|
+
* POS identifier
|
|
170
|
+
* @type {number}
|
|
171
|
+
* @memberof AuthenticationNfcRequest
|
|
172
|
+
*/
|
|
173
|
+
'posId': number;
|
|
162
174
|
}
|
|
163
175
|
/**
|
|
164
176
|
*
|
|
@@ -178,6 +190,12 @@ export interface AuthenticationPinRequest {
|
|
|
178
190
|
* @memberof AuthenticationPinRequest
|
|
179
191
|
*/
|
|
180
192
|
'pin': string;
|
|
193
|
+
/**
|
|
194
|
+
* POS identifier
|
|
195
|
+
* @type {number}
|
|
196
|
+
* @memberof AuthenticationPinRequest
|
|
197
|
+
*/
|
|
198
|
+
'posId': number;
|
|
181
199
|
}
|
|
182
200
|
/**
|
|
183
201
|
*
|
|
@@ -260,69 +278,6 @@ export interface AuthenticationResponse {
|
|
|
260
278
|
*/
|
|
261
279
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
262
280
|
}
|
|
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
281
|
/**
|
|
327
282
|
*
|
|
328
283
|
* @export
|
|
@@ -946,6 +901,104 @@ export interface BaseInvoiceResponse {
|
|
|
946
901
|
*/
|
|
947
902
|
'totalInclVat': DineroObjectResponse;
|
|
948
903
|
}
|
|
904
|
+
/**
|
|
905
|
+
* 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.
|
|
906
|
+
* @export
|
|
907
|
+
* @interface BasePaymentRequestResponse
|
|
908
|
+
*/
|
|
909
|
+
export interface BasePaymentRequestResponse {
|
|
910
|
+
/**
|
|
911
|
+
* UUID v4 identifier (also the public share-link id).
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof BasePaymentRequestResponse
|
|
914
|
+
*/
|
|
915
|
+
'uuid': string;
|
|
916
|
+
/**
|
|
917
|
+
* ISO-8601 creation timestamp.
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof BasePaymentRequestResponse
|
|
920
|
+
*/
|
|
921
|
+
'createdAt'?: string;
|
|
922
|
+
/**
|
|
923
|
+
* ISO-8601 last update timestamp.
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof BasePaymentRequestResponse
|
|
926
|
+
*/
|
|
927
|
+
'updatedAt'?: string;
|
|
928
|
+
/**
|
|
929
|
+
* Optimistic-locking version.
|
|
930
|
+
* @type {number}
|
|
931
|
+
* @memberof BasePaymentRequestResponse
|
|
932
|
+
*/
|
|
933
|
+
'version'?: number;
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @type {BaseUserResponse}
|
|
937
|
+
* @memberof BasePaymentRequestResponse
|
|
938
|
+
*/
|
|
939
|
+
'for': BaseUserResponse;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {BaseUserResponse}
|
|
943
|
+
* @memberof BasePaymentRequestResponse
|
|
944
|
+
*/
|
|
945
|
+
'createdBy': BaseUserResponse;
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {DineroObjectResponse}
|
|
949
|
+
* @memberof BasePaymentRequestResponse
|
|
950
|
+
*/
|
|
951
|
+
'amount': DineroObjectResponse;
|
|
952
|
+
/**
|
|
953
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
954
|
+
* @type {string}
|
|
955
|
+
* @memberof BasePaymentRequestResponse
|
|
956
|
+
*/
|
|
957
|
+
'expiresAt': string;
|
|
958
|
+
/**
|
|
959
|
+
* ISO-8601 timestamp the request was marked paid (null if not paid).
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof BasePaymentRequestResponse
|
|
962
|
+
*/
|
|
963
|
+
'paidAt'?: string;
|
|
964
|
+
/**
|
|
965
|
+
* ISO-8601 timestamp the request was cancelled (null if not cancelled).
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof BasePaymentRequestResponse
|
|
968
|
+
*/
|
|
969
|
+
'cancelledAt'?: string;
|
|
970
|
+
/**
|
|
971
|
+
*
|
|
972
|
+
* @type {BaseUserResponse}
|
|
973
|
+
* @memberof BasePaymentRequestResponse
|
|
974
|
+
*/
|
|
975
|
+
'cancelledBy'?: BaseUserResponse;
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {BaseUserResponse}
|
|
979
|
+
* @memberof BasePaymentRequestResponse
|
|
980
|
+
*/
|
|
981
|
+
'fulfilledBy'?: BaseUserResponse;
|
|
982
|
+
/**
|
|
983
|
+
* Optional human-readable description.
|
|
984
|
+
* @type {string}
|
|
985
|
+
* @memberof BasePaymentRequestResponse
|
|
986
|
+
*/
|
|
987
|
+
'description'?: string;
|
|
988
|
+
/**
|
|
989
|
+
* Derived lifecycle status.
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof BasePaymentRequestResponse
|
|
992
|
+
*/
|
|
993
|
+
'status': BasePaymentRequestResponseStatusEnum;
|
|
994
|
+
}
|
|
995
|
+
export declare const BasePaymentRequestResponseStatusEnum: {
|
|
996
|
+
readonly Pending: "PENDING";
|
|
997
|
+
readonly Paid: "PAID";
|
|
998
|
+
readonly Expired: "EXPIRED";
|
|
999
|
+
readonly Cancelled: "CANCELLED";
|
|
1000
|
+
};
|
|
1001
|
+
export type BasePaymentRequestResponseStatusEnum = typeof BasePaymentRequestResponseStatusEnum[keyof typeof BasePaymentRequestResponseStatusEnum];
|
|
949
1002
|
/**
|
|
950
1003
|
*
|
|
951
1004
|
* @export
|
|
@@ -1186,6 +1239,31 @@ export interface BaseResponse {
|
|
|
1186
1239
|
*/
|
|
1187
1240
|
'version'?: number;
|
|
1188
1241
|
}
|
|
1242
|
+
/**
|
|
1243
|
+
* 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.
|
|
1244
|
+
* @export
|
|
1245
|
+
* @interface BaseResponseWithoutId
|
|
1246
|
+
*/
|
|
1247
|
+
export interface BaseResponseWithoutId {
|
|
1248
|
+
/**
|
|
1249
|
+
* The creation Date of the entity.
|
|
1250
|
+
* @type {string}
|
|
1251
|
+
* @memberof BaseResponseWithoutId
|
|
1252
|
+
*/
|
|
1253
|
+
'createdAt'?: string;
|
|
1254
|
+
/**
|
|
1255
|
+
* The last update Date of the entity.
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof BaseResponseWithoutId
|
|
1258
|
+
*/
|
|
1259
|
+
'updatedAt'?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The version of the entity.
|
|
1262
|
+
* @type {number}
|
|
1263
|
+
* @memberof BaseResponseWithoutId
|
|
1264
|
+
*/
|
|
1265
|
+
'version'?: number;
|
|
1266
|
+
}
|
|
1189
1267
|
/**
|
|
1190
1268
|
*
|
|
1191
1269
|
* @export
|
|
@@ -1659,7 +1737,7 @@ export interface ContainerWithProductsResponse {
|
|
|
1659
1737
|
'products': Array<ProductResponse>;
|
|
1660
1738
|
}
|
|
1661
1739
|
/**
|
|
1662
|
-
*
|
|
1740
|
+
* API Request for creating a `container` entity.
|
|
1663
1741
|
* @export
|
|
1664
1742
|
* @interface CreateContainerRequest
|
|
1665
1743
|
*/
|
|
@@ -1824,6 +1902,37 @@ export interface CreateInvoiceRequest {
|
|
|
1824
1902
|
*/
|
|
1825
1903
|
'amount': DineroObjectRequest;
|
|
1826
1904
|
}
|
|
1905
|
+
/**
|
|
1906
|
+
*
|
|
1907
|
+
* @export
|
|
1908
|
+
* @interface CreatePaymentRequestRequest
|
|
1909
|
+
*/
|
|
1910
|
+
export interface CreatePaymentRequestRequest {
|
|
1911
|
+
/**
|
|
1912
|
+
* The ID of the user whose balance will be credited on payment.
|
|
1913
|
+
* @type {number}
|
|
1914
|
+
* @memberof CreatePaymentRequestRequest
|
|
1915
|
+
*/
|
|
1916
|
+
'forId': number;
|
|
1917
|
+
/**
|
|
1918
|
+
*
|
|
1919
|
+
* @type {DineroObjectRequest}
|
|
1920
|
+
* @memberof CreatePaymentRequestRequest
|
|
1921
|
+
*/
|
|
1922
|
+
'amount': DineroObjectRequest;
|
|
1923
|
+
/**
|
|
1924
|
+
* ISO-8601 timestamp after which the request stops accepting payments.
|
|
1925
|
+
* @type {string}
|
|
1926
|
+
* @memberof CreatePaymentRequestRequest
|
|
1927
|
+
*/
|
|
1928
|
+
'expiresAt': string;
|
|
1929
|
+
/**
|
|
1930
|
+
* Optional human-readable description (e.g. invoice reference).
|
|
1931
|
+
* @type {string}
|
|
1932
|
+
* @memberof CreatePaymentRequestRequest
|
|
1933
|
+
*/
|
|
1934
|
+
'description'?: string;
|
|
1935
|
+
}
|
|
1827
1936
|
/**
|
|
1828
1937
|
*
|
|
1829
1938
|
* @export
|
|
@@ -1856,7 +1965,7 @@ export interface CreatePermissionParams {
|
|
|
1856
1965
|
'attributes': Array<string>;
|
|
1857
1966
|
}
|
|
1858
1967
|
/**
|
|
1859
|
-
*
|
|
1968
|
+
* API Request for creating a `point of sale` entity.
|
|
1860
1969
|
* @export
|
|
1861
1970
|
* @interface CreatePointOfSaleRequest
|
|
1862
1971
|
*/
|
|
@@ -1893,7 +2002,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1893
2002
|
'cashierRoleIds'?: Array<number>;
|
|
1894
2003
|
}
|
|
1895
2004
|
/**
|
|
1896
|
-
*
|
|
2005
|
+
* API Request for creating a `product` entity.
|
|
1897
2006
|
* @export
|
|
1898
2007
|
* @interface CreateProductRequest
|
|
1899
2008
|
*/
|
|
@@ -3154,44 +3263,38 @@ export interface InvoiceUserResponse {
|
|
|
3154
3263
|
/**
|
|
3155
3264
|
*
|
|
3156
3265
|
* @export
|
|
3157
|
-
* @interface
|
|
3266
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3158
3267
|
*/
|
|
3159
|
-
export interface
|
|
3268
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3160
3269
|
/**
|
|
3161
|
-
*
|
|
3162
|
-
* @type {number}
|
|
3163
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3164
|
-
*/
|
|
3165
|
-
'memberId': number;
|
|
3166
|
-
/**
|
|
3167
|
-
*
|
|
3270
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3168
3271
|
* @type {string}
|
|
3169
|
-
* @memberof
|
|
3272
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3170
3273
|
*/
|
|
3171
|
-
'
|
|
3274
|
+
'reason': string;
|
|
3172
3275
|
}
|
|
3173
3276
|
/**
|
|
3174
3277
|
*
|
|
3175
3278
|
* @export
|
|
3176
|
-
* @interface
|
|
3279
|
+
* @interface MemberAuthenticationPinRequest
|
|
3177
3280
|
*/
|
|
3178
|
-
export interface
|
|
3281
|
+
export interface MemberAuthenticationPinRequest {
|
|
3179
3282
|
/**
|
|
3180
3283
|
*
|
|
3181
3284
|
* @type {number}
|
|
3182
|
-
* @memberof
|
|
3285
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3183
3286
|
*/
|
|
3184
3287
|
'memberId': number;
|
|
3185
3288
|
/**
|
|
3186
3289
|
*
|
|
3187
3290
|
* @type {string}
|
|
3188
|
-
* @memberof
|
|
3291
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3189
3292
|
*/
|
|
3190
3293
|
'pin': string;
|
|
3191
3294
|
/**
|
|
3192
3295
|
* POS identifier
|
|
3193
3296
|
* @type {number}
|
|
3194
|
-
* @memberof
|
|
3297
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3195
3298
|
*/
|
|
3196
3299
|
'posId': number;
|
|
3197
3300
|
}
|
|
@@ -3265,6 +3368,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3265
3368
|
*/
|
|
3266
3369
|
'records': Array<BaseEventResponse>;
|
|
3267
3370
|
}
|
|
3371
|
+
/**
|
|
3372
|
+
*
|
|
3373
|
+
* @export
|
|
3374
|
+
* @interface PaginatedBasePaymentRequestResponse
|
|
3375
|
+
*/
|
|
3376
|
+
export interface PaginatedBasePaymentRequestResponse {
|
|
3377
|
+
/**
|
|
3378
|
+
*
|
|
3379
|
+
* @type {PaginationResult}
|
|
3380
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3381
|
+
*/
|
|
3382
|
+
'_pagination': PaginationResult;
|
|
3383
|
+
/**
|
|
3384
|
+
* Returned payment requests
|
|
3385
|
+
* @type {Array<BasePaymentRequestResponse>}
|
|
3386
|
+
* @memberof PaginatedBasePaymentRequestResponse
|
|
3387
|
+
*/
|
|
3388
|
+
'records': Array<BasePaymentRequestResponse>;
|
|
3389
|
+
}
|
|
3268
3390
|
/**
|
|
3269
3391
|
*
|
|
3270
3392
|
* @export
|
|
@@ -3304,7 +3426,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3304
3426
|
'records': Array<BaseTransactionResponse>;
|
|
3305
3427
|
}
|
|
3306
3428
|
/**
|
|
3307
|
-
*
|
|
3429
|
+
* Paginated API Response for the `container` entity.
|
|
3308
3430
|
* @export
|
|
3309
3431
|
* @interface PaginatedContainerResponse
|
|
3310
3432
|
*/
|
|
@@ -3323,7 +3445,7 @@ export interface PaginatedContainerResponse {
|
|
|
3323
3445
|
'records': Array<ContainerResponse>;
|
|
3324
3446
|
}
|
|
3325
3447
|
/**
|
|
3326
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3327
3449
|
* @export
|
|
3328
3450
|
* @interface PaginatedContainerWithProductResponse
|
|
3329
3451
|
*/
|
|
@@ -3437,7 +3559,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3437
3559
|
'records': Array<InvoiceResponseTypes>;
|
|
3438
3560
|
}
|
|
3439
3561
|
/**
|
|
3440
|
-
*
|
|
3562
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3441
3563
|
* @export
|
|
3442
3564
|
* @interface PaginatedPointOfSaleResponse
|
|
3443
3565
|
*/
|
|
@@ -3456,7 +3578,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3456
3578
|
'records': Array<PointOfSaleResponse>;
|
|
3457
3579
|
}
|
|
3458
3580
|
/**
|
|
3459
|
-
*
|
|
3581
|
+
* Paginated API Response for the `product category` entity.
|
|
3460
3582
|
* @export
|
|
3461
3583
|
* @interface PaginatedProductCategoryResponse
|
|
3462
3584
|
*/
|
|
@@ -3475,7 +3597,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3475
3597
|
'records': Array<ProductCategoryResponse>;
|
|
3476
3598
|
}
|
|
3477
3599
|
/**
|
|
3478
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product` entity.
|
|
3479
3601
|
* @export
|
|
3480
3602
|
* @interface PaginatedProductResponse
|
|
3481
3603
|
*/
|
|
@@ -3570,7 +3692,7 @@ export interface PaginatedUserResponse {
|
|
|
3570
3692
|
'records': Array<UserResponse>;
|
|
3571
3693
|
}
|
|
3572
3694
|
/**
|
|
3573
|
-
*
|
|
3695
|
+
* Paginated API Response for the `vat group` entity.
|
|
3574
3696
|
* @export
|
|
3575
3697
|
* @interface PaginatedVatGroupResponse
|
|
3576
3698
|
*/
|
|
@@ -3695,6 +3817,31 @@ export interface PatchUserTypeRequest {
|
|
|
3695
3817
|
*/
|
|
3696
3818
|
'userType': string;
|
|
3697
3819
|
}
|
|
3820
|
+
/**
|
|
3821
|
+
* Response returned from the \"start payment\" endpoint. Contains just enough to let the browser redirect into the Stripe Payment Element.
|
|
3822
|
+
* @export
|
|
3823
|
+
* @interface PaymentRequestStartResponse
|
|
3824
|
+
*/
|
|
3825
|
+
export interface PaymentRequestStartResponse {
|
|
3826
|
+
/**
|
|
3827
|
+
* The PaymentRequest id the intent is linked to.
|
|
3828
|
+
* @type {string}
|
|
3829
|
+
* @memberof PaymentRequestStartResponse
|
|
3830
|
+
*/
|
|
3831
|
+
'paymentRequestId': string;
|
|
3832
|
+
/**
|
|
3833
|
+
* Stripe payment intent id.
|
|
3834
|
+
* @type {string}
|
|
3835
|
+
* @memberof PaymentRequestStartResponse
|
|
3836
|
+
*/
|
|
3837
|
+
'stripeId': string;
|
|
3838
|
+
/**
|
|
3839
|
+
* Stripe client secret for the intent.
|
|
3840
|
+
* @type {string}
|
|
3841
|
+
* @memberof PaymentRequestStartResponse
|
|
3842
|
+
*/
|
|
3843
|
+
'clientSecret': string;
|
|
3844
|
+
}
|
|
3698
3845
|
/**
|
|
3699
3846
|
*
|
|
3700
3847
|
* @export
|
|
@@ -3902,7 +4049,7 @@ export interface PermissionResponse {
|
|
|
3902
4049
|
'actions': Array<ActionResponse>;
|
|
3903
4050
|
}
|
|
3904
4051
|
/**
|
|
3905
|
-
*
|
|
4052
|
+
* 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
4053
|
* @export
|
|
3907
4054
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3908
4055
|
*/
|
|
@@ -4055,7 +4202,7 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4055
4202
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4056
4203
|
}
|
|
4057
4204
|
/**
|
|
4058
|
-
*
|
|
4205
|
+
* API Request for creating or updating a `product category` entity.
|
|
4059
4206
|
* @export
|
|
4060
4207
|
* @interface ProductCategoryRequest
|
|
4061
4208
|
*/
|
|
@@ -4219,6 +4366,56 @@ export interface ProductResponse {
|
|
|
4219
4366
|
*/
|
|
4220
4367
|
'priceList': boolean;
|
|
4221
4368
|
}
|
|
4369
|
+
/**
|
|
4370
|
+
* 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.
|
|
4371
|
+
* @export
|
|
4372
|
+
* @interface PublicPaymentRequestResponse
|
|
4373
|
+
*/
|
|
4374
|
+
export interface PublicPaymentRequestResponse {
|
|
4375
|
+
/**
|
|
4376
|
+
* UUID v4 identifier.
|
|
4377
|
+
* @type {string}
|
|
4378
|
+
* @memberof PublicPaymentRequestResponse
|
|
4379
|
+
*/
|
|
4380
|
+
'uuid': string;
|
|
4381
|
+
/**
|
|
4382
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4383
|
+
* @type {string}
|
|
4384
|
+
* @memberof PublicPaymentRequestResponse
|
|
4385
|
+
*/
|
|
4386
|
+
'forDisplayName': string;
|
|
4387
|
+
/**
|
|
4388
|
+
*
|
|
4389
|
+
* @type {DineroObjectResponse}
|
|
4390
|
+
* @memberof PublicPaymentRequestResponse
|
|
4391
|
+
*/
|
|
4392
|
+
'amount': DineroObjectResponse;
|
|
4393
|
+
/**
|
|
4394
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4395
|
+
* @type {string}
|
|
4396
|
+
* @memberof PublicPaymentRequestResponse
|
|
4397
|
+
*/
|
|
4398
|
+
'expiresAt': string;
|
|
4399
|
+
/**
|
|
4400
|
+
* Optional human-readable description.
|
|
4401
|
+
* @type {string}
|
|
4402
|
+
* @memberof PublicPaymentRequestResponse
|
|
4403
|
+
*/
|
|
4404
|
+
'description'?: string;
|
|
4405
|
+
/**
|
|
4406
|
+
* Derived lifecycle status.
|
|
4407
|
+
* @type {string}
|
|
4408
|
+
* @memberof PublicPaymentRequestResponse
|
|
4409
|
+
*/
|
|
4410
|
+
'status': PublicPaymentRequestResponseStatusEnum;
|
|
4411
|
+
}
|
|
4412
|
+
export declare const PublicPaymentRequestResponseStatusEnum: {
|
|
4413
|
+
readonly Pending: "PENDING";
|
|
4414
|
+
readonly Paid: "PAID";
|
|
4415
|
+
readonly Expired: "EXPIRED";
|
|
4416
|
+
readonly Cancelled: "CANCELLED";
|
|
4417
|
+
};
|
|
4418
|
+
export type PublicPaymentRequestResponseStatusEnum = typeof PublicPaymentRequestResponseStatusEnum[keyof typeof PublicPaymentRequestResponseStatusEnum];
|
|
4222
4419
|
/**
|
|
4223
4420
|
*
|
|
4224
4421
|
* @export
|
|
@@ -5100,6 +5297,12 @@ export interface TermsOfServiceResponse {
|
|
|
5100
5297
|
* @memberof TermsOfServiceResponse
|
|
5101
5298
|
*/
|
|
5102
5299
|
'versionNumber': string;
|
|
5300
|
+
/**
|
|
5301
|
+
* The date this version took effect.
|
|
5302
|
+
* @type {string}
|
|
5303
|
+
* @memberof TermsOfServiceResponse
|
|
5304
|
+
*/
|
|
5305
|
+
'date': string;
|
|
5103
5306
|
/**
|
|
5104
5307
|
* The terms of service content.
|
|
5105
5308
|
* @type {string}
|
|
@@ -5721,7 +5924,7 @@ export interface TransferSummaryResponse {
|
|
|
5721
5924
|
'manualDeletions': TransferAggregateResponse;
|
|
5722
5925
|
}
|
|
5723
5926
|
/**
|
|
5724
|
-
*
|
|
5927
|
+
* API Request for updating a `container` entity.
|
|
5725
5928
|
* @export
|
|
5726
5929
|
* @interface UpdateContainerRequest
|
|
5727
5930
|
*/
|
|
@@ -5971,7 +6174,7 @@ export interface UpdatePinRequest {
|
|
|
5971
6174
|
'pin': string;
|
|
5972
6175
|
}
|
|
5973
6176
|
/**
|
|
5974
|
-
*
|
|
6177
|
+
* API Request for updating a `point of sale` entity.
|
|
5975
6178
|
* @export
|
|
5976
6179
|
* @interface UpdatePointOfSaleRequest
|
|
5977
6180
|
*/
|
|
@@ -6008,7 +6211,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6008
6211
|
'cashierRoleIds'?: Array<number>;
|
|
6009
6212
|
}
|
|
6010
6213
|
/**
|
|
6011
|
-
*
|
|
6214
|
+
* API Request for updating a `product` entity.
|
|
6012
6215
|
* @export
|
|
6013
6216
|
* @interface UpdateProductRequest
|
|
6014
6217
|
*/
|
|
@@ -6173,9 +6376,15 @@ export interface UpdateUserRequest {
|
|
|
6173
6376
|
* @memberof UpdateUserRequest
|
|
6174
6377
|
*/
|
|
6175
6378
|
'inactiveNotificationSend'?: boolean;
|
|
6379
|
+
/**
|
|
6380
|
+
* ISO date at which the account expires; pass null to clear
|
|
6381
|
+
* @type {string}
|
|
6382
|
+
* @memberof UpdateUserRequest
|
|
6383
|
+
*/
|
|
6384
|
+
'expiryDate'?: string | null;
|
|
6176
6385
|
}
|
|
6177
6386
|
/**
|
|
6178
|
-
*
|
|
6387
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6179
6388
|
* @export
|
|
6180
6389
|
* @interface UpdateVatGroupRequest
|
|
6181
6390
|
*/
|
|
@@ -6389,6 +6598,12 @@ export interface UserResponse {
|
|
|
6389
6598
|
* @memberof UserResponse
|
|
6390
6599
|
*/
|
|
6391
6600
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6601
|
+
/**
|
|
6602
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6603
|
+
* @type {string}
|
|
6604
|
+
* @memberof UserResponse
|
|
6605
|
+
*/
|
|
6606
|
+
'expiryDate'?: string | null;
|
|
6392
6607
|
}
|
|
6393
6608
|
/**
|
|
6394
6609
|
*
|
|
@@ -6537,7 +6752,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6537
6752
|
'totalNegative': DineroObjectResponse;
|
|
6538
6753
|
}
|
|
6539
6754
|
/**
|
|
6540
|
-
*
|
|
6755
|
+
* 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
6756
|
* @export
|
|
6542
6757
|
* @interface UserWithIndex
|
|
6543
6758
|
*/
|
|
@@ -6569,7 +6784,7 @@ export interface ValidationResponse {
|
|
|
6569
6784
|
'errors': Array<string>;
|
|
6570
6785
|
}
|
|
6571
6786
|
/**
|
|
6572
|
-
*
|
|
6787
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6573
6788
|
* @export
|
|
6574
6789
|
* @interface VatDeclarationResponse
|
|
6575
6790
|
*/
|
|
@@ -6594,7 +6809,7 @@ export interface VatDeclarationResponse {
|
|
|
6594
6809
|
'rows': Array<VatDeclarationRow>;
|
|
6595
6810
|
}
|
|
6596
6811
|
/**
|
|
6597
|
-
*
|
|
6812
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6598
6813
|
* @export
|
|
6599
6814
|
* @interface VatDeclarationRow
|
|
6600
6815
|
*/
|
|
@@ -7062,10 +7277,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7062
7277
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7063
7278
|
/**
|
|
7064
7279
|
*
|
|
7065
|
-
* @summary EAN
|
|
7066
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7280
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7281
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7067
7282
|
* @param {*} [options] Override http request option.
|
|
7068
|
-
* @deprecated
|
|
7069
7283
|
* @throws {RequiredError}
|
|
7070
7284
|
*/
|
|
7071
7285
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7140,13 +7354,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7140
7354
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7141
7355
|
/**
|
|
7142
7356
|
*
|
|
7143
|
-
* @summary PIN
|
|
7144
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7357
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7358
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7145
7359
|
* @param {*} [options] Override http request option.
|
|
7146
|
-
* @deprecated
|
|
7147
7360
|
* @throws {RequiredError}
|
|
7148
7361
|
*/
|
|
7149
|
-
|
|
7362
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7150
7363
|
/**
|
|
7151
7364
|
*
|
|
7152
7365
|
* @summary Mock login and hand out token.
|
|
@@ -7157,19 +7370,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7157
7370
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7158
7371
|
/**
|
|
7159
7372
|
*
|
|
7160
|
-
* @summary NFC
|
|
7161
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7373
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7374
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7162
7375
|
* @param {*} [options] Override http request option.
|
|
7163
|
-
* @deprecated
|
|
7164
7376
|
* @throws {RequiredError}
|
|
7165
7377
|
*/
|
|
7166
7378
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
7379
|
/**
|
|
7168
7380
|
*
|
|
7169
|
-
* @summary PIN
|
|
7170
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7381
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7382
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7171
7383
|
* @param {*} [options] Override http request option.
|
|
7172
|
-
* @deprecated
|
|
7173
7384
|
* @throws {RequiredError}
|
|
7174
7385
|
*/
|
|
7175
7386
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7196,38 +7407,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7196
7407
|
* @throws {RequiredError}
|
|
7197
7408
|
*/
|
|
7198
7409
|
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
7410
|
};
|
|
7232
7411
|
/**
|
|
7233
7412
|
* AuthenticateApi - functional programming interface
|
|
@@ -7260,10 +7439,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7260
7439
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7261
7440
|
/**
|
|
7262
7441
|
*
|
|
7263
|
-
* @summary EAN
|
|
7264
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7442
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7443
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7265
7444
|
* @param {*} [options] Override http request option.
|
|
7266
|
-
* @deprecated
|
|
7267
7445
|
* @throws {RequiredError}
|
|
7268
7446
|
*/
|
|
7269
7447
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7338,13 +7516,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7338
7516
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7339
7517
|
/**
|
|
7340
7518
|
*
|
|
7341
|
-
* @summary PIN
|
|
7342
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7519
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7520
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7343
7521
|
* @param {*} [options] Override http request option.
|
|
7344
|
-
* @deprecated
|
|
7345
7522
|
* @throws {RequiredError}
|
|
7346
7523
|
*/
|
|
7347
|
-
|
|
7524
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7348
7525
|
/**
|
|
7349
7526
|
*
|
|
7350
7527
|
* @summary Mock login and hand out token.
|
|
@@ -7355,19 +7532,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7355
7532
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7356
7533
|
/**
|
|
7357
7534
|
*
|
|
7358
|
-
* @summary NFC
|
|
7359
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7535
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7536
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7360
7537
|
* @param {*} [options] Override http request option.
|
|
7361
|
-
* @deprecated
|
|
7362
7538
|
* @throws {RequiredError}
|
|
7363
7539
|
*/
|
|
7364
7540
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7365
7541
|
/**
|
|
7366
7542
|
*
|
|
7367
|
-
* @summary PIN
|
|
7368
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7543
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7544
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7369
7545
|
* @param {*} [options] Override http request option.
|
|
7370
|
-
* @deprecated
|
|
7371
7546
|
* @throws {RequiredError}
|
|
7372
7547
|
*/
|
|
7373
7548
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7394,38 +7569,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7394
7569
|
* @throws {RequiredError}
|
|
7395
7570
|
*/
|
|
7396
7571
|
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
7572
|
};
|
|
7430
7573
|
/**
|
|
7431
7574
|
* AuthenticateApi - factory interface
|
|
@@ -7458,10 +7601,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7458
7601
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
7602
|
/**
|
|
7460
7603
|
*
|
|
7461
|
-
* @summary EAN
|
|
7604
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7462
7605
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7463
7606
|
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @deprecated
|
|
7465
7607
|
* @throws {RequiredError}
|
|
7466
7608
|
*/
|
|
7467
7609
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7536,13 +7678,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7536
7678
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7537
7679
|
/**
|
|
7538
7680
|
*
|
|
7539
|
-
* @summary PIN
|
|
7540
|
-
* @param {
|
|
7681
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7682
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7541
7683
|
* @param {*} [options] Override http request option.
|
|
7542
|
-
* @deprecated
|
|
7543
7684
|
* @throws {RequiredError}
|
|
7544
7685
|
*/
|
|
7545
|
-
|
|
7686
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7546
7687
|
/**
|
|
7547
7688
|
*
|
|
7548
7689
|
* @summary Mock login and hand out token.
|
|
@@ -7553,19 +7694,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7553
7694
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7554
7695
|
/**
|
|
7555
7696
|
*
|
|
7556
|
-
* @summary NFC
|
|
7697
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7557
7698
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7558
7699
|
* @param {*} [options] Override http request option.
|
|
7559
|
-
* @deprecated
|
|
7560
7700
|
* @throws {RequiredError}
|
|
7561
7701
|
*/
|
|
7562
7702
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7563
7703
|
/**
|
|
7564
7704
|
*
|
|
7565
|
-
* @summary PIN
|
|
7705
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7566
7706
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7567
7707
|
* @param {*} [options] Override http request option.
|
|
7568
|
-
* @deprecated
|
|
7569
7708
|
* @throws {RequiredError}
|
|
7570
7709
|
*/
|
|
7571
7710
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7592,38 +7731,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7592
7731
|
* @throws {RequiredError}
|
|
7593
7732
|
*/
|
|
7594
7733
|
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
7734
|
};
|
|
7628
7735
|
/**
|
|
7629
7736
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7671,7 +7778,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7671
7778
|
*/
|
|
7672
7779
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7673
7780
|
/**
|
|
7674
|
-
* The EAN login
|
|
7781
|
+
* The EAN login request with posId
|
|
7675
7782
|
* @type {AuthenticationEanRequest}
|
|
7676
7783
|
* @memberof AuthenticateApiEanAuthentication
|
|
7677
7784
|
*/
|
|
@@ -7756,15 +7863,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7756
7863
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7757
7864
|
}
|
|
7758
7865
|
/**
|
|
7759
|
-
* Request parameters for
|
|
7866
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7760
7867
|
* @export
|
|
7761
|
-
* @interface
|
|
7868
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7762
7869
|
*/
|
|
7763
|
-
export interface
|
|
7870
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7764
7871
|
/**
|
|
7765
|
-
* The PIN login
|
|
7872
|
+
* The PIN login request with posId
|
|
7766
7873
|
* @type {MemberAuthenticationPinRequest}
|
|
7767
|
-
* @memberof
|
|
7874
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7768
7875
|
*/
|
|
7769
7876
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7770
7877
|
}
|
|
@@ -7788,7 +7895,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7788
7895
|
*/
|
|
7789
7896
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7790
7897
|
/**
|
|
7791
|
-
* The NFC login
|
|
7898
|
+
* The NFC login request with posId
|
|
7792
7899
|
* @type {AuthenticationNfcRequest}
|
|
7793
7900
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7794
7901
|
*/
|
|
@@ -7801,7 +7908,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7801
7908
|
*/
|
|
7802
7909
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7803
7910
|
/**
|
|
7804
|
-
* The PIN login
|
|
7911
|
+
* The PIN login request with posId
|
|
7805
7912
|
* @type {AuthenticationPinRequest}
|
|
7806
7913
|
* @memberof AuthenticateApiPinAuthentication
|
|
7807
7914
|
*/
|
|
@@ -7833,58 +7940,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7833
7940
|
*/
|
|
7834
7941
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7835
7942
|
}
|
|
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
7943
|
/**
|
|
7889
7944
|
* AuthenticateApi - object-oriented interface
|
|
7890
7945
|
* @export
|
|
@@ -7921,10 +7976,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7921
7976
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7922
7977
|
/**
|
|
7923
7978
|
*
|
|
7924
|
-
* @summary EAN
|
|
7979
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7925
7980
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7926
7981
|
* @param {*} [options] Override http request option.
|
|
7927
|
-
* @deprecated
|
|
7928
7982
|
* @throws {RequiredError}
|
|
7929
7983
|
* @memberof AuthenticateApi
|
|
7930
7984
|
*/
|
|
@@ -8009,14 +8063,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8009
8063
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8010
8064
|
/**
|
|
8011
8065
|
*
|
|
8012
|
-
* @summary PIN
|
|
8013
|
-
* @param {
|
|
8066
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8067
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8014
8068
|
* @param {*} [options] Override http request option.
|
|
8015
|
-
* @deprecated
|
|
8016
8069
|
* @throws {RequiredError}
|
|
8017
8070
|
* @memberof AuthenticateApi
|
|
8018
8071
|
*/
|
|
8019
|
-
|
|
8072
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8020
8073
|
/**
|
|
8021
8074
|
*
|
|
8022
8075
|
* @summary Mock login and hand out token.
|
|
@@ -8028,20 +8081,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8028
8081
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8029
8082
|
/**
|
|
8030
8083
|
*
|
|
8031
|
-
* @summary NFC
|
|
8084
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8032
8085
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8033
8086
|
* @param {*} [options] Override http request option.
|
|
8034
|
-
* @deprecated
|
|
8035
8087
|
* @throws {RequiredError}
|
|
8036
8088
|
* @memberof AuthenticateApi
|
|
8037
8089
|
*/
|
|
8038
8090
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8039
8091
|
/**
|
|
8040
8092
|
*
|
|
8041
|
-
* @summary PIN
|
|
8093
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8042
8094
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8043
8095
|
* @param {*} [options] Override http request option.
|
|
8044
|
-
* @deprecated
|
|
8045
8096
|
* @throws {RequiredError}
|
|
8046
8097
|
* @memberof AuthenticateApi
|
|
8047
8098
|
*/
|
|
@@ -8072,42 +8123,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8072
8123
|
* @memberof AuthenticateApi
|
|
8073
8124
|
*/
|
|
8074
8125
|
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
8126
|
}
|
|
8112
8127
|
/**
|
|
8113
8128
|
* BalanceApi - axios parameter creator
|
|
@@ -11299,7 +11314,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11299
11314
|
* @param {*} [options] Override http request option.
|
|
11300
11315
|
* @throws {RequiredError}
|
|
11301
11316
|
*/
|
|
11302
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11317
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11303
11318
|
/**
|
|
11304
11319
|
*
|
|
11305
11320
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11396,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11396
11411
|
* @param {*} [options] Override http request option.
|
|
11397
11412
|
* @throws {RequiredError}
|
|
11398
11413
|
*/
|
|
11399
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11414
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11400
11415
|
/**
|
|
11401
11416
|
*
|
|
11402
11417
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11543,227 +11558,713 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11543
11558
|
* @type {number}
|
|
11544
11559
|
* @memberof InvoicesApiGetAllInvoices
|
|
11545
11560
|
*/
|
|
11546
|
-
readonly skip?: number;
|
|
11547
|
-
}
|
|
11561
|
+
readonly skip?: number;
|
|
11562
|
+
}
|
|
11563
|
+
/**
|
|
11564
|
+
* Request parameters for getEligibleTransactions operation in InvoicesApi.
|
|
11565
|
+
* @export
|
|
11566
|
+
* @interface InvoicesApiGetEligibleTransactionsRequest
|
|
11567
|
+
*/
|
|
11568
|
+
export interface InvoicesApiGetEligibleTransactionsRequest {
|
|
11569
|
+
/**
|
|
11570
|
+
* Filter on Id of the debtor
|
|
11571
|
+
* @type {number}
|
|
11572
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11573
|
+
*/
|
|
11574
|
+
readonly forId: number;
|
|
11575
|
+
/**
|
|
11576
|
+
* Start date for selected transactions (inclusive)
|
|
11577
|
+
* @type {string}
|
|
11578
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11579
|
+
*/
|
|
11580
|
+
readonly fromDate: string;
|
|
11581
|
+
/**
|
|
11582
|
+
* End date for selected transactions (exclusive)
|
|
11583
|
+
* @type {string}
|
|
11584
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11585
|
+
*/
|
|
11586
|
+
readonly tillDate?: string;
|
|
11587
|
+
}
|
|
11588
|
+
/**
|
|
11589
|
+
* Request parameters for getInvoicePdf operation in InvoicesApi.
|
|
11590
|
+
* @export
|
|
11591
|
+
* @interface InvoicesApiGetInvoicePdfRequest
|
|
11592
|
+
*/
|
|
11593
|
+
export interface InvoicesApiGetInvoicePdfRequest {
|
|
11594
|
+
/**
|
|
11595
|
+
* The id of the invoice to return
|
|
11596
|
+
* @type {number}
|
|
11597
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11598
|
+
*/
|
|
11599
|
+
readonly id: number;
|
|
11600
|
+
/**
|
|
11601
|
+
* Force creation of pdf
|
|
11602
|
+
* @type {boolean}
|
|
11603
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11604
|
+
*/
|
|
11605
|
+
readonly force?: boolean;
|
|
11606
|
+
}
|
|
11607
|
+
/**
|
|
11608
|
+
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11609
|
+
* @export
|
|
11610
|
+
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11611
|
+
*/
|
|
11612
|
+
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11613
|
+
/**
|
|
11614
|
+
* The id of the requested invoice
|
|
11615
|
+
* @type {number}
|
|
11616
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11617
|
+
*/
|
|
11618
|
+
readonly id: number;
|
|
11619
|
+
/**
|
|
11620
|
+
* Boolean if invoice entries should be returned, defaults to true.
|
|
11621
|
+
* @type {boolean}
|
|
11622
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11623
|
+
*/
|
|
11624
|
+
readonly returnEntries?: boolean;
|
|
11625
|
+
}
|
|
11626
|
+
/**
|
|
11627
|
+
* Request parameters for getSingleInvoiceUser operation in InvoicesApi.
|
|
11628
|
+
* @export
|
|
11629
|
+
* @interface InvoicesApiGetSingleInvoiceUserRequest
|
|
11630
|
+
*/
|
|
11631
|
+
export interface InvoicesApiGetSingleInvoiceUserRequest {
|
|
11632
|
+
/**
|
|
11633
|
+
* The id of the invoice user to return.
|
|
11634
|
+
* @type {number}
|
|
11635
|
+
* @memberof InvoicesApiGetSingleInvoiceUser
|
|
11636
|
+
*/
|
|
11637
|
+
readonly id: number;
|
|
11638
|
+
}
|
|
11639
|
+
/**
|
|
11640
|
+
* Request parameters for putInvoiceUser operation in InvoicesApi.
|
|
11641
|
+
* @export
|
|
11642
|
+
* @interface InvoicesApiPutInvoiceUserRequest
|
|
11643
|
+
*/
|
|
11644
|
+
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11645
|
+
/**
|
|
11646
|
+
* The id of the user to update
|
|
11647
|
+
* @type {number}
|
|
11648
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11649
|
+
*/
|
|
11650
|
+
readonly id: number;
|
|
11651
|
+
/**
|
|
11652
|
+
* The invoice user which should be updated
|
|
11653
|
+
* @type {UpdateInvoiceUserRequest}
|
|
11654
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11655
|
+
*/
|
|
11656
|
+
readonly updateInvoiceUserRequest: UpdateInvoiceUserRequest;
|
|
11657
|
+
}
|
|
11658
|
+
/**
|
|
11659
|
+
* Request parameters for updateInvoice operation in InvoicesApi.
|
|
11660
|
+
* @export
|
|
11661
|
+
* @interface InvoicesApiUpdateInvoiceRequest
|
|
11662
|
+
*/
|
|
11663
|
+
export interface InvoicesApiUpdateInvoiceRequest {
|
|
11664
|
+
/**
|
|
11665
|
+
* The id of the invoice which should be updated
|
|
11666
|
+
* @type {number}
|
|
11667
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11668
|
+
*/
|
|
11669
|
+
readonly id: number;
|
|
11670
|
+
/**
|
|
11671
|
+
* The invoice update to process
|
|
11672
|
+
* @type {UpdateInvoiceRequest}
|
|
11673
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11674
|
+
*/
|
|
11675
|
+
readonly updateInvoiceRequest: UpdateInvoiceRequest;
|
|
11676
|
+
}
|
|
11677
|
+
/**
|
|
11678
|
+
* InvoicesApi - object-oriented interface
|
|
11679
|
+
* @export
|
|
11680
|
+
* @class InvoicesApi
|
|
11681
|
+
* @extends {BaseAPI}
|
|
11682
|
+
*/
|
|
11683
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
11684
|
+
/**
|
|
11685
|
+
*
|
|
11686
|
+
* @summary Adds an invoice to the system.
|
|
11687
|
+
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
11688
|
+
* @param {*} [options] Override http request option.
|
|
11689
|
+
* @throws {RequiredError}
|
|
11690
|
+
* @memberof InvoicesApi
|
|
11691
|
+
*/
|
|
11692
|
+
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11693
|
+
/**
|
|
11694
|
+
*
|
|
11695
|
+
* @summary Deletes an invoice.
|
|
11696
|
+
* @param {InvoicesApiDeleteInvoiceRequest} requestParameters Request parameters.
|
|
11697
|
+
* @param {*} [options] Override http request option.
|
|
11698
|
+
* @throws {RequiredError}
|
|
11699
|
+
* @memberof InvoicesApi
|
|
11700
|
+
*/
|
|
11701
|
+
deleteInvoice(requestParameters: InvoicesApiDeleteInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11702
|
+
/**
|
|
11703
|
+
*
|
|
11704
|
+
* @summary Delete invoice user defaults.
|
|
11705
|
+
* @param {InvoicesApiDeleteInvoiceUserRequest} requestParameters Request parameters.
|
|
11706
|
+
* @param {*} [options] Override http request option.
|
|
11707
|
+
* @throws {RequiredError}
|
|
11708
|
+
* @memberof InvoicesApi
|
|
11709
|
+
*/
|
|
11710
|
+
deleteInvoiceUser(requestParameters: InvoicesApiDeleteInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11711
|
+
/**
|
|
11712
|
+
*
|
|
11713
|
+
* @summary Returns all invoices in the system.
|
|
11714
|
+
* @param {InvoicesApiGetAllInvoicesRequest} requestParameters Request parameters.
|
|
11715
|
+
* @param {*} [options] Override http request option.
|
|
11716
|
+
* @throws {RequiredError}
|
|
11717
|
+
* @memberof InvoicesApi
|
|
11718
|
+
*/
|
|
11719
|
+
getAllInvoices(requestParameters?: InvoicesApiGetAllInvoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedInvoiceResponse, any, {}>>;
|
|
11720
|
+
/**
|
|
11721
|
+
*
|
|
11722
|
+
* @summary Get eligible transactions for invoice creation.
|
|
11723
|
+
* @param {InvoicesApiGetEligibleTransactionsRequest} requestParameters Request parameters.
|
|
11724
|
+
* @param {*} [options] Override http request option.
|
|
11725
|
+
* @throws {RequiredError}
|
|
11726
|
+
* @memberof InvoicesApi
|
|
11727
|
+
*/
|
|
11728
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11729
|
+
/**
|
|
11730
|
+
*
|
|
11731
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11732
|
+
* @param {*} [options] Override http request option.
|
|
11733
|
+
* @throws {RequiredError}
|
|
11734
|
+
* @memberof InvoicesApi
|
|
11735
|
+
*/
|
|
11736
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11737
|
+
/**
|
|
11738
|
+
*
|
|
11739
|
+
* @summary Get an invoice pdf.
|
|
11740
|
+
* @param {InvoicesApiGetInvoicePdfRequest} requestParameters Request parameters.
|
|
11741
|
+
* @param {*} [options] Override http request option.
|
|
11742
|
+
* @throws {RequiredError}
|
|
11743
|
+
* @memberof InvoicesApi
|
|
11744
|
+
*/
|
|
11745
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11746
|
+
/**
|
|
11747
|
+
*
|
|
11748
|
+
* @summary Returns a single invoice in the system.
|
|
11749
|
+
* @param {InvoicesApiGetSingleInvoiceRequest} requestParameters Request parameters.
|
|
11750
|
+
* @param {*} [options] Override http request option.
|
|
11751
|
+
* @throws {RequiredError}
|
|
11752
|
+
* @memberof InvoicesApi
|
|
11753
|
+
*/
|
|
11754
|
+
getSingleInvoice(requestParameters: InvoicesApiGetSingleInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11755
|
+
/**
|
|
11756
|
+
*
|
|
11757
|
+
* @summary Get invoice user defaults.
|
|
11758
|
+
* @param {InvoicesApiGetSingleInvoiceUserRequest} requestParameters Request parameters.
|
|
11759
|
+
* @param {*} [options] Override http request option.
|
|
11760
|
+
* @throws {RequiredError}
|
|
11761
|
+
* @memberof InvoicesApi
|
|
11762
|
+
*/
|
|
11763
|
+
getSingleInvoiceUser(requestParameters: InvoicesApiGetSingleInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11764
|
+
/**
|
|
11765
|
+
*
|
|
11766
|
+
* @summary Update or create invoice user defaults.
|
|
11767
|
+
* @param {InvoicesApiPutInvoiceUserRequest} requestParameters Request parameters.
|
|
11768
|
+
* @param {*} [options] Override http request option.
|
|
11769
|
+
* @throws {RequiredError}
|
|
11770
|
+
* @memberof InvoicesApi
|
|
11771
|
+
*/
|
|
11772
|
+
putInvoiceUser(requestParameters: InvoicesApiPutInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11773
|
+
/**
|
|
11774
|
+
*
|
|
11775
|
+
* @summary Adds an invoice to the system.
|
|
11776
|
+
* @param {InvoicesApiUpdateInvoiceRequest} requestParameters Request parameters.
|
|
11777
|
+
* @param {*} [options] Override http request option.
|
|
11778
|
+
* @throws {RequiredError}
|
|
11779
|
+
* @memberof InvoicesApi
|
|
11780
|
+
*/
|
|
11781
|
+
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11785
|
+
* @export
|
|
11786
|
+
*/
|
|
11787
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11788
|
+
/**
|
|
11789
|
+
*
|
|
11790
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11791
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11792
|
+
* @param {*} [options] Override http request option.
|
|
11793
|
+
* @throws {RequiredError}
|
|
11794
|
+
*/
|
|
11795
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11796
|
+
/**
|
|
11797
|
+
*
|
|
11798
|
+
* @summary Create a new PaymentRequest.
|
|
11799
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11800
|
+
* @param {*} [options] Override http request option.
|
|
11801
|
+
* @throws {RequiredError}
|
|
11802
|
+
*/
|
|
11803
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11804
|
+
/**
|
|
11805
|
+
*
|
|
11806
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11807
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11808
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11809
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11810
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11811
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11812
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11813
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11814
|
+
* @param {*} [options] Override http request option.
|
|
11815
|
+
* @throws {RequiredError}
|
|
11816
|
+
*/
|
|
11817
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11818
|
+
/**
|
|
11819
|
+
*
|
|
11820
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11821
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11822
|
+
* @param {*} [options] Override http request option.
|
|
11823
|
+
* @throws {RequiredError}
|
|
11824
|
+
*/
|
|
11825
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11826
|
+
/**
|
|
11827
|
+
*
|
|
11828
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11829
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11830
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11831
|
+
* @param {*} [options] Override http request option.
|
|
11832
|
+
* @throws {RequiredError}
|
|
11833
|
+
*/
|
|
11834
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11835
|
+
/**
|
|
11836
|
+
*
|
|
11837
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11838
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11839
|
+
* @param {*} [options] Override http request option.
|
|
11840
|
+
* @throws {RequiredError}
|
|
11841
|
+
*/
|
|
11842
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11843
|
+
};
|
|
11844
|
+
/**
|
|
11845
|
+
* PaymentRequestsApi - functional programming interface
|
|
11846
|
+
* @export
|
|
11847
|
+
*/
|
|
11848
|
+
export declare const PaymentRequestsApiFp: (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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11904
|
+
};
|
|
11905
|
+
/**
|
|
11906
|
+
* PaymentRequestsApi - factory interface
|
|
11907
|
+
* @export
|
|
11908
|
+
*/
|
|
11909
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11913
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11914
|
+
* @param {*} [options] Override http request option.
|
|
11915
|
+
* @throws {RequiredError}
|
|
11916
|
+
*/
|
|
11917
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11918
|
+
/**
|
|
11919
|
+
*
|
|
11920
|
+
* @summary Create a new PaymentRequest.
|
|
11921
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11922
|
+
* @param {*} [options] Override http request option.
|
|
11923
|
+
* @throws {RequiredError}
|
|
11924
|
+
*/
|
|
11925
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11926
|
+
/**
|
|
11927
|
+
*
|
|
11928
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11929
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11930
|
+
* @param {*} [options] Override http request option.
|
|
11931
|
+
* @throws {RequiredError}
|
|
11932
|
+
*/
|
|
11933
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11934
|
+
/**
|
|
11935
|
+
*
|
|
11936
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11937
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11938
|
+
* @param {*} [options] Override http request option.
|
|
11939
|
+
* @throws {RequiredError}
|
|
11940
|
+
*/
|
|
11941
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11942
|
+
/**
|
|
11943
|
+
*
|
|
11944
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11945
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11946
|
+
* @param {*} [options] Override http request option.
|
|
11947
|
+
* @throws {RequiredError}
|
|
11948
|
+
*/
|
|
11949
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11950
|
+
/**
|
|
11951
|
+
*
|
|
11952
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11953
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11954
|
+
* @param {*} [options] Override http request option.
|
|
11955
|
+
* @throws {RequiredError}
|
|
11956
|
+
*/
|
|
11957
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11958
|
+
};
|
|
11548
11959
|
/**
|
|
11549
|
-
* Request parameters for
|
|
11960
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11550
11961
|
* @export
|
|
11551
|
-
* @interface
|
|
11962
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11552
11963
|
*/
|
|
11553
|
-
export interface
|
|
11964
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11554
11965
|
/**
|
|
11555
|
-
*
|
|
11556
|
-
* @type {number}
|
|
11557
|
-
* @memberof InvoicesApiGetEligibleTransactions
|
|
11558
|
-
*/
|
|
11559
|
-
readonly forId: number;
|
|
11560
|
-
/**
|
|
11561
|
-
* Start date for selected transactions (inclusive)
|
|
11966
|
+
* UUID v4 of the payment request.
|
|
11562
11967
|
* @type {string}
|
|
11563
|
-
* @memberof
|
|
11968
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11564
11969
|
*/
|
|
11565
|
-
readonly
|
|
11970
|
+
readonly id: string;
|
|
11971
|
+
}
|
|
11972
|
+
/**
|
|
11973
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11974
|
+
* @export
|
|
11975
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11976
|
+
*/
|
|
11977
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11566
11978
|
/**
|
|
11567
|
-
*
|
|
11568
|
-
* @type {
|
|
11569
|
-
* @memberof
|
|
11979
|
+
* The request to create
|
|
11980
|
+
* @type {CreatePaymentRequestRequest}
|
|
11981
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11570
11982
|
*/
|
|
11571
|
-
readonly
|
|
11983
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11572
11984
|
}
|
|
11573
11985
|
/**
|
|
11574
|
-
* Request parameters for
|
|
11986
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11575
11987
|
* @export
|
|
11576
|
-
* @interface
|
|
11988
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11577
11989
|
*/
|
|
11578
|
-
export interface
|
|
11990
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11579
11991
|
/**
|
|
11580
|
-
*
|
|
11992
|
+
* Filter by beneficiary user id.
|
|
11581
11993
|
* @type {number}
|
|
11582
|
-
* @memberof
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11583
11995
|
*/
|
|
11584
|
-
readonly
|
|
11996
|
+
readonly forId?: number;
|
|
11585
11997
|
/**
|
|
11586
|
-
*
|
|
11587
|
-
* @type {
|
|
11588
|
-
* @memberof
|
|
11998
|
+
* Filter by creator user id.
|
|
11999
|
+
* @type {number}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11589
12001
|
*/
|
|
11590
|
-
readonly
|
|
11591
|
-
}
|
|
11592
|
-
/**
|
|
11593
|
-
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11594
|
-
* @export
|
|
11595
|
-
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11596
|
-
*/
|
|
11597
|
-
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
12002
|
+
readonly createdById?: number;
|
|
11598
12003
|
/**
|
|
11599
|
-
*
|
|
12004
|
+
* Comma-separated list of derived statuses.
|
|
12005
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12006
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12007
|
+
*/
|
|
12008
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12009
|
+
/**
|
|
12010
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12011
|
+
* @type {string}
|
|
12012
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12013
|
+
*/
|
|
12014
|
+
readonly fromDate?: string;
|
|
12015
|
+
/**
|
|
12016
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12017
|
+
* @type {string}
|
|
12018
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12019
|
+
*/
|
|
12020
|
+
readonly tillDate?: string;
|
|
12021
|
+
/**
|
|
12022
|
+
* How many rows the endpoint should return
|
|
11600
12023
|
* @type {number}
|
|
11601
|
-
* @memberof
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11602
12025
|
*/
|
|
11603
|
-
readonly
|
|
12026
|
+
readonly take?: number;
|
|
11604
12027
|
/**
|
|
11605
|
-
*
|
|
11606
|
-
* @type {
|
|
11607
|
-
* @memberof
|
|
12028
|
+
* How many rows to skip (for pagination)
|
|
12029
|
+
* @type {number}
|
|
12030
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11608
12031
|
*/
|
|
11609
|
-
readonly
|
|
12032
|
+
readonly skip?: number;
|
|
11610
12033
|
}
|
|
11611
12034
|
/**
|
|
11612
|
-
* Request parameters for
|
|
12035
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11613
12036
|
* @export
|
|
11614
|
-
* @interface
|
|
12037
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11615
12038
|
*/
|
|
11616
|
-
export interface
|
|
12039
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11617
12040
|
/**
|
|
11618
|
-
*
|
|
11619
|
-
* @type {
|
|
11620
|
-
* @memberof
|
|
12041
|
+
* UUID v4 of the payment request.
|
|
12042
|
+
* @type {string}
|
|
12043
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11621
12044
|
*/
|
|
11622
|
-
readonly id:
|
|
12045
|
+
readonly id: string;
|
|
11623
12046
|
}
|
|
11624
12047
|
/**
|
|
11625
|
-
* Request parameters for
|
|
12048
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11626
12049
|
* @export
|
|
11627
|
-
* @interface
|
|
12050
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11628
12051
|
*/
|
|
11629
|
-
export interface
|
|
12052
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11630
12053
|
/**
|
|
11631
|
-
*
|
|
11632
|
-
* @type {
|
|
11633
|
-
* @memberof
|
|
12054
|
+
* UUID v4 of the payment request.
|
|
12055
|
+
* @type {string}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11634
12057
|
*/
|
|
11635
|
-
readonly id:
|
|
12058
|
+
readonly id: string;
|
|
11636
12059
|
/**
|
|
11637
|
-
* The
|
|
11638
|
-
* @type {
|
|
11639
|
-
* @memberof
|
|
12060
|
+
* The audit reason
|
|
12061
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12062
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11640
12063
|
*/
|
|
11641
|
-
readonly
|
|
12064
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11642
12065
|
}
|
|
11643
12066
|
/**
|
|
11644
|
-
* Request parameters for
|
|
12067
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11645
12068
|
* @export
|
|
11646
|
-
* @interface
|
|
12069
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11647
12070
|
*/
|
|
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;
|
|
12071
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11655
12072
|
/**
|
|
11656
|
-
*
|
|
11657
|
-
* @type {
|
|
11658
|
-
* @memberof
|
|
12073
|
+
* UUID v4 of the payment request.
|
|
12074
|
+
* @type {string}
|
|
12075
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11659
12076
|
*/
|
|
11660
|
-
readonly
|
|
12077
|
+
readonly id: string;
|
|
11661
12078
|
}
|
|
11662
12079
|
/**
|
|
11663
|
-
*
|
|
12080
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11664
12081
|
* @export
|
|
11665
|
-
* @class
|
|
12082
|
+
* @class PaymentRequestsApi
|
|
11666
12083
|
* @extends {BaseAPI}
|
|
11667
12084
|
*/
|
|
11668
|
-
export declare class
|
|
12085
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11669
12086
|
/**
|
|
11670
12087
|
*
|
|
11671
|
-
* @summary
|
|
11672
|
-
* @param {
|
|
12088
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12089
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11673
12090
|
* @param {*} [options] Override http request option.
|
|
11674
12091
|
* @throws {RequiredError}
|
|
11675
|
-
* @memberof
|
|
12092
|
+
* @memberof PaymentRequestsApi
|
|
11676
12093
|
*/
|
|
11677
|
-
|
|
12094
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11678
12095
|
/**
|
|
11679
12096
|
*
|
|
11680
|
-
* @summary
|
|
11681
|
-
* @param {
|
|
12097
|
+
* @summary Create a new PaymentRequest.
|
|
12098
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11682
12099
|
* @param {*} [options] Override http request option.
|
|
11683
12100
|
* @throws {RequiredError}
|
|
11684
|
-
* @memberof
|
|
12101
|
+
* @memberof PaymentRequestsApi
|
|
11685
12102
|
*/
|
|
11686
|
-
|
|
12103
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11687
12104
|
/**
|
|
11688
12105
|
*
|
|
11689
|
-
* @summary
|
|
11690
|
-
* @param {
|
|
12106
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12107
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11691
12108
|
* @param {*} [options] Override http request option.
|
|
11692
12109
|
* @throws {RequiredError}
|
|
11693
|
-
* @memberof
|
|
12110
|
+
* @memberof PaymentRequestsApi
|
|
11694
12111
|
*/
|
|
11695
|
-
|
|
12112
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11696
12113
|
/**
|
|
11697
12114
|
*
|
|
11698
|
-
* @summary
|
|
11699
|
-
* @param {
|
|
12115
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12116
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11700
12117
|
* @param {*} [options] Override http request option.
|
|
11701
12118
|
* @throws {RequiredError}
|
|
11702
|
-
* @memberof
|
|
12119
|
+
* @memberof PaymentRequestsApi
|
|
11703
12120
|
*/
|
|
11704
|
-
|
|
12121
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11705
12122
|
/**
|
|
11706
12123
|
*
|
|
11707
|
-
* @summary
|
|
11708
|
-
* @param {
|
|
12124
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12125
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11709
12126
|
* @param {*} [options] Override http request option.
|
|
11710
12127
|
* @throws {RequiredError}
|
|
11711
|
-
* @memberof
|
|
12128
|
+
* @memberof PaymentRequestsApi
|
|
11712
12129
|
*/
|
|
11713
|
-
|
|
12130
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11714
12131
|
/**
|
|
11715
12132
|
*
|
|
11716
|
-
* @summary
|
|
12133
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12134
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11717
12135
|
* @param {*} [options] Override http request option.
|
|
11718
12136
|
* @throws {RequiredError}
|
|
11719
|
-
* @memberof
|
|
12137
|
+
* @memberof PaymentRequestsApi
|
|
11720
12138
|
*/
|
|
11721
|
-
|
|
12139
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12140
|
+
}
|
|
12141
|
+
/**
|
|
12142
|
+
* @export
|
|
12143
|
+
*/
|
|
12144
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12145
|
+
readonly Pending: "PENDING";
|
|
12146
|
+
readonly Paid: "PAID";
|
|
12147
|
+
readonly Expired: "EXPIRED";
|
|
12148
|
+
readonly Cancelled: "CANCELLED";
|
|
12149
|
+
};
|
|
12150
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12151
|
+
/**
|
|
12152
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12153
|
+
* @export
|
|
12154
|
+
*/
|
|
12155
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11722
12156
|
/**
|
|
11723
12157
|
*
|
|
11724
|
-
* @summary
|
|
11725
|
-
* @param {
|
|
12158
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12159
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11726
12160
|
* @param {*} [options] Override http request option.
|
|
11727
12161
|
* @throws {RequiredError}
|
|
11728
|
-
* @memberof InvoicesApi
|
|
11729
12162
|
*/
|
|
11730
|
-
|
|
12163
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11731
12164
|
/**
|
|
11732
12165
|
*
|
|
11733
|
-
* @summary
|
|
11734
|
-
* @param {
|
|
12166
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12167
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11735
12168
|
* @param {*} [options] Override http request option.
|
|
11736
12169
|
* @throws {RequiredError}
|
|
11737
|
-
* @memberof InvoicesApi
|
|
11738
12170
|
*/
|
|
11739
|
-
|
|
12171
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12172
|
+
};
|
|
12173
|
+
/**
|
|
12174
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12175
|
+
* @export
|
|
12176
|
+
*/
|
|
12177
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
11740
12178
|
/**
|
|
11741
12179
|
*
|
|
11742
|
-
* @summary
|
|
11743
|
-
* @param {
|
|
12180
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12181
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11744
12182
|
* @param {*} [options] Override http request option.
|
|
11745
12183
|
* @throws {RequiredError}
|
|
11746
|
-
* @memberof InvoicesApi
|
|
11747
12184
|
*/
|
|
11748
|
-
|
|
12185
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11749
12186
|
/**
|
|
11750
12187
|
*
|
|
11751
|
-
* @summary
|
|
11752
|
-
* @param {
|
|
12188
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12189
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11753
12190
|
* @param {*} [options] Override http request option.
|
|
11754
12191
|
* @throws {RequiredError}
|
|
11755
|
-
* @memberof InvoicesApi
|
|
11756
12192
|
*/
|
|
11757
|
-
|
|
12193
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12194
|
+
};
|
|
12195
|
+
/**
|
|
12196
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12197
|
+
* @export
|
|
12198
|
+
*/
|
|
12199
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11758
12200
|
/**
|
|
11759
12201
|
*
|
|
11760
|
-
* @summary
|
|
11761
|
-
* @param {
|
|
12202
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12203
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
11762
12204
|
* @param {*} [options] Override http request option.
|
|
11763
12205
|
* @throws {RequiredError}
|
|
11764
|
-
* @memberof InvoicesApi
|
|
11765
12206
|
*/
|
|
11766
|
-
|
|
12207
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12208
|
+
/**
|
|
12209
|
+
*
|
|
12210
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12211
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12212
|
+
* @param {*} [options] Override http request option.
|
|
12213
|
+
* @throws {RequiredError}
|
|
12214
|
+
*/
|
|
12215
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12216
|
+
};
|
|
12217
|
+
/**
|
|
12218
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12219
|
+
* @export
|
|
12220
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12221
|
+
*/
|
|
12222
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12223
|
+
/**
|
|
12224
|
+
* UUID v4 of the payment request.
|
|
12225
|
+
* @type {string}
|
|
12226
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12227
|
+
*/
|
|
12228
|
+
readonly id: string;
|
|
12229
|
+
}
|
|
12230
|
+
/**
|
|
12231
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12232
|
+
* @export
|
|
12233
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12234
|
+
*/
|
|
12235
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12236
|
+
/**
|
|
12237
|
+
* UUID v4 of the payment request.
|
|
12238
|
+
* @type {string}
|
|
12239
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12240
|
+
*/
|
|
12241
|
+
readonly id: string;
|
|
12242
|
+
}
|
|
12243
|
+
/**
|
|
12244
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12245
|
+
* @export
|
|
12246
|
+
* @class PaymentRequestsPublicApi
|
|
12247
|
+
* @extends {BaseAPI}
|
|
12248
|
+
*/
|
|
12249
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12250
|
+
/**
|
|
12251
|
+
*
|
|
12252
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12253
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12254
|
+
* @param {*} [options] Override http request option.
|
|
12255
|
+
* @throws {RequiredError}
|
|
12256
|
+
* @memberof PaymentRequestsPublicApi
|
|
12257
|
+
*/
|
|
12258
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12259
|
+
/**
|
|
12260
|
+
*
|
|
12261
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12262
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12263
|
+
* @param {*} [options] Override http request option.
|
|
12264
|
+
* @throws {RequiredError}
|
|
12265
|
+
* @memberof PaymentRequestsPublicApi
|
|
12266
|
+
*/
|
|
12267
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
11767
12268
|
}
|
|
11768
12269
|
/**
|
|
11769
12270
|
* PayoutRequestsApi - axios parameter creator
|
|
@@ -15222,7 +15723,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15222
15723
|
* @param {*} [options] Override http request option.
|
|
15223
15724
|
* @throws {RequiredError}
|
|
15224
15725
|
*/
|
|
15225
|
-
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
15726
|
+
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTransferResponse>>;
|
|
15226
15727
|
/**
|
|
15227
15728
|
*
|
|
15228
15729
|
* @summary Returns the requested transfer
|
|
@@ -15291,7 +15792,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15291
15792
|
* @param {*} [options] Override http request option.
|
|
15292
15793
|
* @throws {RequiredError}
|
|
15293
15794
|
*/
|
|
15294
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15795
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15295
15796
|
/**
|
|
15296
15797
|
*
|
|
15297
15798
|
* @summary Returns the requested transfer
|
|
@@ -15527,7 +16028,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15527
16028
|
* @throws {RequiredError}
|
|
15528
16029
|
* @memberof TransfersApi
|
|
15529
16030
|
*/
|
|
15530
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16031
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15531
16032
|
/**
|
|
15532
16033
|
*
|
|
15533
16034
|
* @summary Returns the requested transfer
|
|
@@ -15928,6 +16429,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15928
16429
|
* @throws {RequiredError}
|
|
15929
16430
|
*/
|
|
15930
16431
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16432
|
+
/**
|
|
16433
|
+
*
|
|
16434
|
+
* @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.
|
|
16435
|
+
* @param {number} id The id of the beneficiary user.
|
|
16436
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16437
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16438
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16439
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16440
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16441
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16442
|
+
* @param {*} [options] Override http request option.
|
|
16443
|
+
* @throws {RequiredError}
|
|
16444
|
+
*/
|
|
16445
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15931
16446
|
/**
|
|
15932
16447
|
*
|
|
15933
16448
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16290,6 +16805,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16290
16805
|
* @throws {RequiredError}
|
|
16291
16806
|
*/
|
|
16292
16807
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
16808
|
+
/**
|
|
16809
|
+
*
|
|
16810
|
+
* @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.
|
|
16811
|
+
* @param {number} id The id of the beneficiary user.
|
|
16812
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16813
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16814
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16815
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16816
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16817
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16818
|
+
* @param {*} [options] Override http request option.
|
|
16819
|
+
* @throws {RequiredError}
|
|
16820
|
+
*/
|
|
16821
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16293
16822
|
/**
|
|
16294
16823
|
*
|
|
16295
16824
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16634,6 +17163,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16634
17163
|
* @throws {RequiredError}
|
|
16635
17164
|
*/
|
|
16636
17165
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17166
|
+
/**
|
|
17167
|
+
*
|
|
17168
|
+
* @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.
|
|
17169
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17170
|
+
* @param {*} [options] Override http request option.
|
|
17171
|
+
* @throws {RequiredError}
|
|
17172
|
+
*/
|
|
17173
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16637
17174
|
/**
|
|
16638
17175
|
*
|
|
16639
17176
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17125,6 +17662,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17125
17662
|
*/
|
|
17126
17663
|
readonly skip?: number;
|
|
17127
17664
|
}
|
|
17665
|
+
/**
|
|
17666
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
17667
|
+
* @export
|
|
17668
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
17669
|
+
*/
|
|
17670
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
17671
|
+
/**
|
|
17672
|
+
* The id of the beneficiary user.
|
|
17673
|
+
* @type {number}
|
|
17674
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17675
|
+
*/
|
|
17676
|
+
readonly id: number;
|
|
17677
|
+
/**
|
|
17678
|
+
* Filter by creator user id.
|
|
17679
|
+
* @type {number}
|
|
17680
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17681
|
+
*/
|
|
17682
|
+
readonly createdById?: number;
|
|
17683
|
+
/**
|
|
17684
|
+
* Comma-separated list of derived statuses.
|
|
17685
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
17686
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17687
|
+
*/
|
|
17688
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
17689
|
+
/**
|
|
17690
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
17691
|
+
* @type {string}
|
|
17692
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17693
|
+
*/
|
|
17694
|
+
readonly fromDate?: string;
|
|
17695
|
+
/**
|
|
17696
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
17697
|
+
* @type {string}
|
|
17698
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17699
|
+
*/
|
|
17700
|
+
readonly tillDate?: string;
|
|
17701
|
+
/**
|
|
17702
|
+
* How many rows the endpoint should return
|
|
17703
|
+
* @type {number}
|
|
17704
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17705
|
+
*/
|
|
17706
|
+
readonly take?: number;
|
|
17707
|
+
/**
|
|
17708
|
+
* How many rows to skip (for pagination)
|
|
17709
|
+
* @type {number}
|
|
17710
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17711
|
+
*/
|
|
17712
|
+
readonly skip?: number;
|
|
17713
|
+
}
|
|
17128
17714
|
/**
|
|
17129
17715
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17130
17716
|
* @export
|
|
@@ -17791,6 +18377,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17791
18377
|
* @memberof UsersApi
|
|
17792
18378
|
*/
|
|
17793
18379
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18380
|
+
/**
|
|
18381
|
+
*
|
|
18382
|
+
* @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.
|
|
18383
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18384
|
+
* @param {*} [options] Override http request option.
|
|
18385
|
+
* @throws {RequiredError}
|
|
18386
|
+
* @memberof UsersApi
|
|
18387
|
+
*/
|
|
18388
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17794
18389
|
/**
|
|
17795
18390
|
*
|
|
17796
18391
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17986,6 +18581,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17986
18581
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17987
18582
|
};
|
|
17988
18583
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
18584
|
+
/**
|
|
18585
|
+
* @export
|
|
18586
|
+
*/
|
|
18587
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
18588
|
+
readonly Pending: "PENDING";
|
|
18589
|
+
readonly Paid: "PAID";
|
|
18590
|
+
readonly Expired: "EXPIRED";
|
|
18591
|
+
readonly Cancelled: "CANCELLED";
|
|
18592
|
+
};
|
|
18593
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17989
18594
|
/**
|
|
17990
18595
|
* @export
|
|
17991
18596
|
*/
|