@gewis/sudosos-client 0.0.0-develop.e4aa3f3 → 0.0.0-develop.e6519ec
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 +1058 -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
|
|
@@ -5721,7 +5918,7 @@ export interface TransferSummaryResponse {
|
|
|
5721
5918
|
'manualDeletions': TransferAggregateResponse;
|
|
5722
5919
|
}
|
|
5723
5920
|
/**
|
|
5724
|
-
*
|
|
5921
|
+
* API Request for updating a `container` entity.
|
|
5725
5922
|
* @export
|
|
5726
5923
|
* @interface UpdateContainerRequest
|
|
5727
5924
|
*/
|
|
@@ -5971,7 +6168,7 @@ export interface UpdatePinRequest {
|
|
|
5971
6168
|
'pin': string;
|
|
5972
6169
|
}
|
|
5973
6170
|
/**
|
|
5974
|
-
*
|
|
6171
|
+
* API Request for updating a `point of sale` entity.
|
|
5975
6172
|
* @export
|
|
5976
6173
|
* @interface UpdatePointOfSaleRequest
|
|
5977
6174
|
*/
|
|
@@ -6008,7 +6205,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6008
6205
|
'cashierRoleIds'?: Array<number>;
|
|
6009
6206
|
}
|
|
6010
6207
|
/**
|
|
6011
|
-
*
|
|
6208
|
+
* API Request for updating a `product` entity.
|
|
6012
6209
|
* @export
|
|
6013
6210
|
* @interface UpdateProductRequest
|
|
6014
6211
|
*/
|
|
@@ -6173,9 +6370,15 @@ export interface UpdateUserRequest {
|
|
|
6173
6370
|
* @memberof UpdateUserRequest
|
|
6174
6371
|
*/
|
|
6175
6372
|
'inactiveNotificationSend'?: boolean;
|
|
6373
|
+
/**
|
|
6374
|
+
* ISO date at which the account expires; pass null to clear
|
|
6375
|
+
* @type {string}
|
|
6376
|
+
* @memberof UpdateUserRequest
|
|
6377
|
+
*/
|
|
6378
|
+
'expiryDate'?: string | null;
|
|
6176
6379
|
}
|
|
6177
6380
|
/**
|
|
6178
|
-
*
|
|
6381
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6179
6382
|
* @export
|
|
6180
6383
|
* @interface UpdateVatGroupRequest
|
|
6181
6384
|
*/
|
|
@@ -6389,6 +6592,12 @@ export interface UserResponse {
|
|
|
6389
6592
|
* @memberof UserResponse
|
|
6390
6593
|
*/
|
|
6391
6594
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6595
|
+
/**
|
|
6596
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6597
|
+
* @type {string}
|
|
6598
|
+
* @memberof UserResponse
|
|
6599
|
+
*/
|
|
6600
|
+
'expiryDate'?: string | null;
|
|
6392
6601
|
}
|
|
6393
6602
|
/**
|
|
6394
6603
|
*
|
|
@@ -6537,7 +6746,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6537
6746
|
'totalNegative': DineroObjectResponse;
|
|
6538
6747
|
}
|
|
6539
6748
|
/**
|
|
6540
|
-
*
|
|
6749
|
+
* 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
6750
|
* @export
|
|
6542
6751
|
* @interface UserWithIndex
|
|
6543
6752
|
*/
|
|
@@ -6569,7 +6778,7 @@ export interface ValidationResponse {
|
|
|
6569
6778
|
'errors': Array<string>;
|
|
6570
6779
|
}
|
|
6571
6780
|
/**
|
|
6572
|
-
*
|
|
6781
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6573
6782
|
* @export
|
|
6574
6783
|
* @interface VatDeclarationResponse
|
|
6575
6784
|
*/
|
|
@@ -6594,7 +6803,7 @@ export interface VatDeclarationResponse {
|
|
|
6594
6803
|
'rows': Array<VatDeclarationRow>;
|
|
6595
6804
|
}
|
|
6596
6805
|
/**
|
|
6597
|
-
*
|
|
6806
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6598
6807
|
* @export
|
|
6599
6808
|
* @interface VatDeclarationRow
|
|
6600
6809
|
*/
|
|
@@ -7062,10 +7271,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7062
7271
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7063
7272
|
/**
|
|
7064
7273
|
*
|
|
7065
|
-
* @summary EAN
|
|
7066
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7274
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7275
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7067
7276
|
* @param {*} [options] Override http request option.
|
|
7068
|
-
* @deprecated
|
|
7069
7277
|
* @throws {RequiredError}
|
|
7070
7278
|
*/
|
|
7071
7279
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7140,13 +7348,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7140
7348
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7141
7349
|
/**
|
|
7142
7350
|
*
|
|
7143
|
-
* @summary PIN
|
|
7144
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7351
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7352
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7145
7353
|
* @param {*} [options] Override http request option.
|
|
7146
|
-
* @deprecated
|
|
7147
7354
|
* @throws {RequiredError}
|
|
7148
7355
|
*/
|
|
7149
|
-
|
|
7356
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7150
7357
|
/**
|
|
7151
7358
|
*
|
|
7152
7359
|
* @summary Mock login and hand out token.
|
|
@@ -7157,19 +7364,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7157
7364
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7158
7365
|
/**
|
|
7159
7366
|
*
|
|
7160
|
-
* @summary NFC
|
|
7161
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7367
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7368
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7162
7369
|
* @param {*} [options] Override http request option.
|
|
7163
|
-
* @deprecated
|
|
7164
7370
|
* @throws {RequiredError}
|
|
7165
7371
|
*/
|
|
7166
7372
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
7373
|
/**
|
|
7168
7374
|
*
|
|
7169
|
-
* @summary PIN
|
|
7170
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7375
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7376
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7171
7377
|
* @param {*} [options] Override http request option.
|
|
7172
|
-
* @deprecated
|
|
7173
7378
|
* @throws {RequiredError}
|
|
7174
7379
|
*/
|
|
7175
7380
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7196,38 +7401,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7196
7401
|
* @throws {RequiredError}
|
|
7197
7402
|
*/
|
|
7198
7403
|
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
7404
|
};
|
|
7232
7405
|
/**
|
|
7233
7406
|
* AuthenticateApi - functional programming interface
|
|
@@ -7260,10 +7433,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7260
7433
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7261
7434
|
/**
|
|
7262
7435
|
*
|
|
7263
|
-
* @summary EAN
|
|
7264
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7436
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7437
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7265
7438
|
* @param {*} [options] Override http request option.
|
|
7266
|
-
* @deprecated
|
|
7267
7439
|
* @throws {RequiredError}
|
|
7268
7440
|
*/
|
|
7269
7441
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7338,13 +7510,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7338
7510
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7339
7511
|
/**
|
|
7340
7512
|
*
|
|
7341
|
-
* @summary PIN
|
|
7342
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7513
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7514
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7343
7515
|
* @param {*} [options] Override http request option.
|
|
7344
|
-
* @deprecated
|
|
7345
7516
|
* @throws {RequiredError}
|
|
7346
7517
|
*/
|
|
7347
|
-
|
|
7518
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7348
7519
|
/**
|
|
7349
7520
|
*
|
|
7350
7521
|
* @summary Mock login and hand out token.
|
|
@@ -7355,19 +7526,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7355
7526
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7356
7527
|
/**
|
|
7357
7528
|
*
|
|
7358
|
-
* @summary NFC
|
|
7359
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7529
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7530
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7360
7531
|
* @param {*} [options] Override http request option.
|
|
7361
|
-
* @deprecated
|
|
7362
7532
|
* @throws {RequiredError}
|
|
7363
7533
|
*/
|
|
7364
7534
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7365
7535
|
/**
|
|
7366
7536
|
*
|
|
7367
|
-
* @summary PIN
|
|
7368
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7537
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7538
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7369
7539
|
* @param {*} [options] Override http request option.
|
|
7370
|
-
* @deprecated
|
|
7371
7540
|
* @throws {RequiredError}
|
|
7372
7541
|
*/
|
|
7373
7542
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7394,38 +7563,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7394
7563
|
* @throws {RequiredError}
|
|
7395
7564
|
*/
|
|
7396
7565
|
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
7566
|
};
|
|
7430
7567
|
/**
|
|
7431
7568
|
* AuthenticateApi - factory interface
|
|
@@ -7458,10 +7595,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7458
7595
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
7596
|
/**
|
|
7460
7597
|
*
|
|
7461
|
-
* @summary EAN
|
|
7598
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7462
7599
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7463
7600
|
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @deprecated
|
|
7465
7601
|
* @throws {RequiredError}
|
|
7466
7602
|
*/
|
|
7467
7603
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7536,13 +7672,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7536
7672
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7537
7673
|
/**
|
|
7538
7674
|
*
|
|
7539
|
-
* @summary PIN
|
|
7540
|
-
* @param {
|
|
7675
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7676
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7541
7677
|
* @param {*} [options] Override http request option.
|
|
7542
|
-
* @deprecated
|
|
7543
7678
|
* @throws {RequiredError}
|
|
7544
7679
|
*/
|
|
7545
|
-
|
|
7680
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7546
7681
|
/**
|
|
7547
7682
|
*
|
|
7548
7683
|
* @summary Mock login and hand out token.
|
|
@@ -7553,19 +7688,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7553
7688
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7554
7689
|
/**
|
|
7555
7690
|
*
|
|
7556
|
-
* @summary NFC
|
|
7691
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7557
7692
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7558
7693
|
* @param {*} [options] Override http request option.
|
|
7559
|
-
* @deprecated
|
|
7560
7694
|
* @throws {RequiredError}
|
|
7561
7695
|
*/
|
|
7562
7696
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7563
7697
|
/**
|
|
7564
7698
|
*
|
|
7565
|
-
* @summary PIN
|
|
7699
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7566
7700
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7567
7701
|
* @param {*} [options] Override http request option.
|
|
7568
|
-
* @deprecated
|
|
7569
7702
|
* @throws {RequiredError}
|
|
7570
7703
|
*/
|
|
7571
7704
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7592,38 +7725,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7592
7725
|
* @throws {RequiredError}
|
|
7593
7726
|
*/
|
|
7594
7727
|
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
7728
|
};
|
|
7628
7729
|
/**
|
|
7629
7730
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7671,7 +7772,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7671
7772
|
*/
|
|
7672
7773
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7673
7774
|
/**
|
|
7674
|
-
* The EAN login
|
|
7775
|
+
* The EAN login request with posId
|
|
7675
7776
|
* @type {AuthenticationEanRequest}
|
|
7676
7777
|
* @memberof AuthenticateApiEanAuthentication
|
|
7677
7778
|
*/
|
|
@@ -7756,15 +7857,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7756
7857
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7757
7858
|
}
|
|
7758
7859
|
/**
|
|
7759
|
-
* Request parameters for
|
|
7860
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7760
7861
|
* @export
|
|
7761
|
-
* @interface
|
|
7862
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7762
7863
|
*/
|
|
7763
|
-
export interface
|
|
7864
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7764
7865
|
/**
|
|
7765
|
-
* The PIN login
|
|
7866
|
+
* The PIN login request with posId
|
|
7766
7867
|
* @type {MemberAuthenticationPinRequest}
|
|
7767
|
-
* @memberof
|
|
7868
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7768
7869
|
*/
|
|
7769
7870
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7770
7871
|
}
|
|
@@ -7788,7 +7889,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7788
7889
|
*/
|
|
7789
7890
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7790
7891
|
/**
|
|
7791
|
-
* The NFC login
|
|
7892
|
+
* The NFC login request with posId
|
|
7792
7893
|
* @type {AuthenticationNfcRequest}
|
|
7793
7894
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7794
7895
|
*/
|
|
@@ -7801,7 +7902,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7801
7902
|
*/
|
|
7802
7903
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7803
7904
|
/**
|
|
7804
|
-
* The PIN login
|
|
7905
|
+
* The PIN login request with posId
|
|
7805
7906
|
* @type {AuthenticationPinRequest}
|
|
7806
7907
|
* @memberof AuthenticateApiPinAuthentication
|
|
7807
7908
|
*/
|
|
@@ -7833,58 +7934,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7833
7934
|
*/
|
|
7834
7935
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7835
7936
|
}
|
|
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
7937
|
/**
|
|
7889
7938
|
* AuthenticateApi - object-oriented interface
|
|
7890
7939
|
* @export
|
|
@@ -7921,10 +7970,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7921
7970
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7922
7971
|
/**
|
|
7923
7972
|
*
|
|
7924
|
-
* @summary EAN
|
|
7973
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7925
7974
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7926
7975
|
* @param {*} [options] Override http request option.
|
|
7927
|
-
* @deprecated
|
|
7928
7976
|
* @throws {RequiredError}
|
|
7929
7977
|
* @memberof AuthenticateApi
|
|
7930
7978
|
*/
|
|
@@ -8009,14 +8057,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8009
8057
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8010
8058
|
/**
|
|
8011
8059
|
*
|
|
8012
|
-
* @summary PIN
|
|
8013
|
-
* @param {
|
|
8060
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8061
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8014
8062
|
* @param {*} [options] Override http request option.
|
|
8015
|
-
* @deprecated
|
|
8016
8063
|
* @throws {RequiredError}
|
|
8017
8064
|
* @memberof AuthenticateApi
|
|
8018
8065
|
*/
|
|
8019
|
-
|
|
8066
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8020
8067
|
/**
|
|
8021
8068
|
*
|
|
8022
8069
|
* @summary Mock login and hand out token.
|
|
@@ -8028,20 +8075,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8028
8075
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8029
8076
|
/**
|
|
8030
8077
|
*
|
|
8031
|
-
* @summary NFC
|
|
8078
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8032
8079
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8033
8080
|
* @param {*} [options] Override http request option.
|
|
8034
|
-
* @deprecated
|
|
8035
8081
|
* @throws {RequiredError}
|
|
8036
8082
|
* @memberof AuthenticateApi
|
|
8037
8083
|
*/
|
|
8038
8084
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8039
8085
|
/**
|
|
8040
8086
|
*
|
|
8041
|
-
* @summary PIN
|
|
8087
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8042
8088
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8043
8089
|
* @param {*} [options] Override http request option.
|
|
8044
|
-
* @deprecated
|
|
8045
8090
|
* @throws {RequiredError}
|
|
8046
8091
|
* @memberof AuthenticateApi
|
|
8047
8092
|
*/
|
|
@@ -8072,42 +8117,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8072
8117
|
* @memberof AuthenticateApi
|
|
8073
8118
|
*/
|
|
8074
8119
|
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
8120
|
}
|
|
8112
8121
|
/**
|
|
8113
8122
|
* BalanceApi - axios parameter creator
|
|
@@ -11299,7 +11308,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11299
11308
|
* @param {*} [options] Override http request option.
|
|
11300
11309
|
* @throws {RequiredError}
|
|
11301
11310
|
*/
|
|
11302
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11311
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11303
11312
|
/**
|
|
11304
11313
|
*
|
|
11305
11314
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11396,7 +11405,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11396
11405
|
* @param {*} [options] Override http request option.
|
|
11397
11406
|
* @throws {RequiredError}
|
|
11398
11407
|
*/
|
|
11399
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11408
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11400
11409
|
/**
|
|
11401
11410
|
*
|
|
11402
11411
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11543,227 +11552,713 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11543
11552
|
* @type {number}
|
|
11544
11553
|
* @memberof InvoicesApiGetAllInvoices
|
|
11545
11554
|
*/
|
|
11546
|
-
readonly skip?: number;
|
|
11547
|
-
}
|
|
11555
|
+
readonly skip?: number;
|
|
11556
|
+
}
|
|
11557
|
+
/**
|
|
11558
|
+
* Request parameters for getEligibleTransactions operation in InvoicesApi.
|
|
11559
|
+
* @export
|
|
11560
|
+
* @interface InvoicesApiGetEligibleTransactionsRequest
|
|
11561
|
+
*/
|
|
11562
|
+
export interface InvoicesApiGetEligibleTransactionsRequest {
|
|
11563
|
+
/**
|
|
11564
|
+
* Filter on Id of the debtor
|
|
11565
|
+
* @type {number}
|
|
11566
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11567
|
+
*/
|
|
11568
|
+
readonly forId: number;
|
|
11569
|
+
/**
|
|
11570
|
+
* Start date for selected transactions (inclusive)
|
|
11571
|
+
* @type {string}
|
|
11572
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11573
|
+
*/
|
|
11574
|
+
readonly fromDate: string;
|
|
11575
|
+
/**
|
|
11576
|
+
* End date for selected transactions (exclusive)
|
|
11577
|
+
* @type {string}
|
|
11578
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11579
|
+
*/
|
|
11580
|
+
readonly tillDate?: string;
|
|
11581
|
+
}
|
|
11582
|
+
/**
|
|
11583
|
+
* Request parameters for getInvoicePdf operation in InvoicesApi.
|
|
11584
|
+
* @export
|
|
11585
|
+
* @interface InvoicesApiGetInvoicePdfRequest
|
|
11586
|
+
*/
|
|
11587
|
+
export interface InvoicesApiGetInvoicePdfRequest {
|
|
11588
|
+
/**
|
|
11589
|
+
* The id of the invoice to return
|
|
11590
|
+
* @type {number}
|
|
11591
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11592
|
+
*/
|
|
11593
|
+
readonly id: number;
|
|
11594
|
+
/**
|
|
11595
|
+
* Force creation of pdf
|
|
11596
|
+
* @type {boolean}
|
|
11597
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11598
|
+
*/
|
|
11599
|
+
readonly force?: boolean;
|
|
11600
|
+
}
|
|
11601
|
+
/**
|
|
11602
|
+
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11603
|
+
* @export
|
|
11604
|
+
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11605
|
+
*/
|
|
11606
|
+
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11607
|
+
/**
|
|
11608
|
+
* The id of the requested invoice
|
|
11609
|
+
* @type {number}
|
|
11610
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11611
|
+
*/
|
|
11612
|
+
readonly id: number;
|
|
11613
|
+
/**
|
|
11614
|
+
* Boolean if invoice entries should be returned, defaults to true.
|
|
11615
|
+
* @type {boolean}
|
|
11616
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11617
|
+
*/
|
|
11618
|
+
readonly returnEntries?: boolean;
|
|
11619
|
+
}
|
|
11620
|
+
/**
|
|
11621
|
+
* Request parameters for getSingleInvoiceUser operation in InvoicesApi.
|
|
11622
|
+
* @export
|
|
11623
|
+
* @interface InvoicesApiGetSingleInvoiceUserRequest
|
|
11624
|
+
*/
|
|
11625
|
+
export interface InvoicesApiGetSingleInvoiceUserRequest {
|
|
11626
|
+
/**
|
|
11627
|
+
* The id of the invoice user to return.
|
|
11628
|
+
* @type {number}
|
|
11629
|
+
* @memberof InvoicesApiGetSingleInvoiceUser
|
|
11630
|
+
*/
|
|
11631
|
+
readonly id: number;
|
|
11632
|
+
}
|
|
11633
|
+
/**
|
|
11634
|
+
* Request parameters for putInvoiceUser operation in InvoicesApi.
|
|
11635
|
+
* @export
|
|
11636
|
+
* @interface InvoicesApiPutInvoiceUserRequest
|
|
11637
|
+
*/
|
|
11638
|
+
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11639
|
+
/**
|
|
11640
|
+
* The id of the user to update
|
|
11641
|
+
* @type {number}
|
|
11642
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11643
|
+
*/
|
|
11644
|
+
readonly id: number;
|
|
11645
|
+
/**
|
|
11646
|
+
* The invoice user which should be updated
|
|
11647
|
+
* @type {UpdateInvoiceUserRequest}
|
|
11648
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11649
|
+
*/
|
|
11650
|
+
readonly updateInvoiceUserRequest: UpdateInvoiceUserRequest;
|
|
11651
|
+
}
|
|
11652
|
+
/**
|
|
11653
|
+
* Request parameters for updateInvoice operation in InvoicesApi.
|
|
11654
|
+
* @export
|
|
11655
|
+
* @interface InvoicesApiUpdateInvoiceRequest
|
|
11656
|
+
*/
|
|
11657
|
+
export interface InvoicesApiUpdateInvoiceRequest {
|
|
11658
|
+
/**
|
|
11659
|
+
* The id of the invoice which should be updated
|
|
11660
|
+
* @type {number}
|
|
11661
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11662
|
+
*/
|
|
11663
|
+
readonly id: number;
|
|
11664
|
+
/**
|
|
11665
|
+
* The invoice update to process
|
|
11666
|
+
* @type {UpdateInvoiceRequest}
|
|
11667
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11668
|
+
*/
|
|
11669
|
+
readonly updateInvoiceRequest: UpdateInvoiceRequest;
|
|
11670
|
+
}
|
|
11671
|
+
/**
|
|
11672
|
+
* InvoicesApi - object-oriented interface
|
|
11673
|
+
* @export
|
|
11674
|
+
* @class InvoicesApi
|
|
11675
|
+
* @extends {BaseAPI}
|
|
11676
|
+
*/
|
|
11677
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
11678
|
+
/**
|
|
11679
|
+
*
|
|
11680
|
+
* @summary Adds an invoice to the system.
|
|
11681
|
+
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
11682
|
+
* @param {*} [options] Override http request option.
|
|
11683
|
+
* @throws {RequiredError}
|
|
11684
|
+
* @memberof InvoicesApi
|
|
11685
|
+
*/
|
|
11686
|
+
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11687
|
+
/**
|
|
11688
|
+
*
|
|
11689
|
+
* @summary Deletes an invoice.
|
|
11690
|
+
* @param {InvoicesApiDeleteInvoiceRequest} requestParameters Request parameters.
|
|
11691
|
+
* @param {*} [options] Override http request option.
|
|
11692
|
+
* @throws {RequiredError}
|
|
11693
|
+
* @memberof InvoicesApi
|
|
11694
|
+
*/
|
|
11695
|
+
deleteInvoice(requestParameters: InvoicesApiDeleteInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11696
|
+
/**
|
|
11697
|
+
*
|
|
11698
|
+
* @summary Delete invoice user defaults.
|
|
11699
|
+
* @param {InvoicesApiDeleteInvoiceUserRequest} requestParameters Request parameters.
|
|
11700
|
+
* @param {*} [options] Override http request option.
|
|
11701
|
+
* @throws {RequiredError}
|
|
11702
|
+
* @memberof InvoicesApi
|
|
11703
|
+
*/
|
|
11704
|
+
deleteInvoiceUser(requestParameters: InvoicesApiDeleteInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11705
|
+
/**
|
|
11706
|
+
*
|
|
11707
|
+
* @summary Returns all invoices in the system.
|
|
11708
|
+
* @param {InvoicesApiGetAllInvoicesRequest} requestParameters Request parameters.
|
|
11709
|
+
* @param {*} [options] Override http request option.
|
|
11710
|
+
* @throws {RequiredError}
|
|
11711
|
+
* @memberof InvoicesApi
|
|
11712
|
+
*/
|
|
11713
|
+
getAllInvoices(requestParameters?: InvoicesApiGetAllInvoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedInvoiceResponse, any, {}>>;
|
|
11714
|
+
/**
|
|
11715
|
+
*
|
|
11716
|
+
* @summary Get eligible transactions for invoice creation.
|
|
11717
|
+
* @param {InvoicesApiGetEligibleTransactionsRequest} requestParameters Request parameters.
|
|
11718
|
+
* @param {*} [options] Override http request option.
|
|
11719
|
+
* @throws {RequiredError}
|
|
11720
|
+
* @memberof InvoicesApi
|
|
11721
|
+
*/
|
|
11722
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11723
|
+
/**
|
|
11724
|
+
*
|
|
11725
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11726
|
+
* @param {*} [options] Override http request option.
|
|
11727
|
+
* @throws {RequiredError}
|
|
11728
|
+
* @memberof InvoicesApi
|
|
11729
|
+
*/
|
|
11730
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11731
|
+
/**
|
|
11732
|
+
*
|
|
11733
|
+
* @summary Get an invoice pdf.
|
|
11734
|
+
* @param {InvoicesApiGetInvoicePdfRequest} requestParameters Request parameters.
|
|
11735
|
+
* @param {*} [options] Override http request option.
|
|
11736
|
+
* @throws {RequiredError}
|
|
11737
|
+
* @memberof InvoicesApi
|
|
11738
|
+
*/
|
|
11739
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11740
|
+
/**
|
|
11741
|
+
*
|
|
11742
|
+
* @summary Returns a single invoice in the system.
|
|
11743
|
+
* @param {InvoicesApiGetSingleInvoiceRequest} requestParameters Request parameters.
|
|
11744
|
+
* @param {*} [options] Override http request option.
|
|
11745
|
+
* @throws {RequiredError}
|
|
11746
|
+
* @memberof InvoicesApi
|
|
11747
|
+
*/
|
|
11748
|
+
getSingleInvoice(requestParameters: InvoicesApiGetSingleInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11749
|
+
/**
|
|
11750
|
+
*
|
|
11751
|
+
* @summary Get invoice user defaults.
|
|
11752
|
+
* @param {InvoicesApiGetSingleInvoiceUserRequest} requestParameters Request parameters.
|
|
11753
|
+
* @param {*} [options] Override http request option.
|
|
11754
|
+
* @throws {RequiredError}
|
|
11755
|
+
* @memberof InvoicesApi
|
|
11756
|
+
*/
|
|
11757
|
+
getSingleInvoiceUser(requestParameters: InvoicesApiGetSingleInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11758
|
+
/**
|
|
11759
|
+
*
|
|
11760
|
+
* @summary Update or create invoice user defaults.
|
|
11761
|
+
* @param {InvoicesApiPutInvoiceUserRequest} requestParameters Request parameters.
|
|
11762
|
+
* @param {*} [options] Override http request option.
|
|
11763
|
+
* @throws {RequiredError}
|
|
11764
|
+
* @memberof InvoicesApi
|
|
11765
|
+
*/
|
|
11766
|
+
putInvoiceUser(requestParameters: InvoicesApiPutInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11767
|
+
/**
|
|
11768
|
+
*
|
|
11769
|
+
* @summary Adds an invoice to the system.
|
|
11770
|
+
* @param {InvoicesApiUpdateInvoiceRequest} requestParameters Request parameters.
|
|
11771
|
+
* @param {*} [options] Override http request option.
|
|
11772
|
+
* @throws {RequiredError}
|
|
11773
|
+
* @memberof InvoicesApi
|
|
11774
|
+
*/
|
|
11775
|
+
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11776
|
+
}
|
|
11777
|
+
/**
|
|
11778
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11779
|
+
* @export
|
|
11780
|
+
*/
|
|
11781
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11782
|
+
/**
|
|
11783
|
+
*
|
|
11784
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11785
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11786
|
+
* @param {*} [options] Override http request option.
|
|
11787
|
+
* @throws {RequiredError}
|
|
11788
|
+
*/
|
|
11789
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11790
|
+
/**
|
|
11791
|
+
*
|
|
11792
|
+
* @summary Create a new PaymentRequest.
|
|
11793
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11794
|
+
* @param {*} [options] Override http request option.
|
|
11795
|
+
* @throws {RequiredError}
|
|
11796
|
+
*/
|
|
11797
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11798
|
+
/**
|
|
11799
|
+
*
|
|
11800
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11801
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11802
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11803
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11804
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11805
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11806
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11807
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11808
|
+
* @param {*} [options] Override http request option.
|
|
11809
|
+
* @throws {RequiredError}
|
|
11810
|
+
*/
|
|
11811
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11812
|
+
/**
|
|
11813
|
+
*
|
|
11814
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11815
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11816
|
+
* @param {*} [options] Override http request option.
|
|
11817
|
+
* @throws {RequiredError}
|
|
11818
|
+
*/
|
|
11819
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11820
|
+
/**
|
|
11821
|
+
*
|
|
11822
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11823
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11824
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11825
|
+
* @param {*} [options] Override http request option.
|
|
11826
|
+
* @throws {RequiredError}
|
|
11827
|
+
*/
|
|
11828
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11829
|
+
/**
|
|
11830
|
+
*
|
|
11831
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11832
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11833
|
+
* @param {*} [options] Override http request option.
|
|
11834
|
+
* @throws {RequiredError}
|
|
11835
|
+
*/
|
|
11836
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11837
|
+
};
|
|
11838
|
+
/**
|
|
11839
|
+
* PaymentRequestsApi - functional programming interface
|
|
11840
|
+
* @export
|
|
11841
|
+
*/
|
|
11842
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11843
|
+
/**
|
|
11844
|
+
*
|
|
11845
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11846
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11847
|
+
* @param {*} [options] Override http request option.
|
|
11848
|
+
* @throws {RequiredError}
|
|
11849
|
+
*/
|
|
11850
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11851
|
+
/**
|
|
11852
|
+
*
|
|
11853
|
+
* @summary Create a new PaymentRequest.
|
|
11854
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11855
|
+
* @param {*} [options] Override http request option.
|
|
11856
|
+
* @throws {RequiredError}
|
|
11857
|
+
*/
|
|
11858
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11859
|
+
/**
|
|
11860
|
+
*
|
|
11861
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11862
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11863
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11864
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11865
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11866
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11867
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11868
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11869
|
+
* @param {*} [options] Override http request option.
|
|
11870
|
+
* @throws {RequiredError}
|
|
11871
|
+
*/
|
|
11872
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11873
|
+
/**
|
|
11874
|
+
*
|
|
11875
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11876
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11877
|
+
* @param {*} [options] Override http request option.
|
|
11878
|
+
* @throws {RequiredError}
|
|
11879
|
+
*/
|
|
11880
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11881
|
+
/**
|
|
11882
|
+
*
|
|
11883
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11884
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11885
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11886
|
+
* @param {*} [options] Override http request option.
|
|
11887
|
+
* @throws {RequiredError}
|
|
11888
|
+
*/
|
|
11889
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11890
|
+
/**
|
|
11891
|
+
*
|
|
11892
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11893
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11894
|
+
* @param {*} [options] Override http request option.
|
|
11895
|
+
* @throws {RequiredError}
|
|
11896
|
+
*/
|
|
11897
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11898
|
+
};
|
|
11899
|
+
/**
|
|
11900
|
+
* PaymentRequestsApi - factory interface
|
|
11901
|
+
* @export
|
|
11902
|
+
*/
|
|
11903
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11907
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11908
|
+
* @param {*} [options] Override http request option.
|
|
11909
|
+
* @throws {RequiredError}
|
|
11910
|
+
*/
|
|
11911
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11912
|
+
/**
|
|
11913
|
+
*
|
|
11914
|
+
* @summary Create a new PaymentRequest.
|
|
11915
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11916
|
+
* @param {*} [options] Override http request option.
|
|
11917
|
+
* @throws {RequiredError}
|
|
11918
|
+
*/
|
|
11919
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11920
|
+
/**
|
|
11921
|
+
*
|
|
11922
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11923
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11924
|
+
* @param {*} [options] Override http request option.
|
|
11925
|
+
* @throws {RequiredError}
|
|
11926
|
+
*/
|
|
11927
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11928
|
+
/**
|
|
11929
|
+
*
|
|
11930
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11931
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11932
|
+
* @param {*} [options] Override http request option.
|
|
11933
|
+
* @throws {RequiredError}
|
|
11934
|
+
*/
|
|
11935
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11936
|
+
/**
|
|
11937
|
+
*
|
|
11938
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11939
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11940
|
+
* @param {*} [options] Override http request option.
|
|
11941
|
+
* @throws {RequiredError}
|
|
11942
|
+
*/
|
|
11943
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11944
|
+
/**
|
|
11945
|
+
*
|
|
11946
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11947
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11948
|
+
* @param {*} [options] Override http request option.
|
|
11949
|
+
* @throws {RequiredError}
|
|
11950
|
+
*/
|
|
11951
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11952
|
+
};
|
|
11548
11953
|
/**
|
|
11549
|
-
* Request parameters for
|
|
11954
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11550
11955
|
* @export
|
|
11551
|
-
* @interface
|
|
11956
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11552
11957
|
*/
|
|
11553
|
-
export interface
|
|
11958
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11554
11959
|
/**
|
|
11555
|
-
*
|
|
11556
|
-
* @type {number}
|
|
11557
|
-
* @memberof InvoicesApiGetEligibleTransactions
|
|
11558
|
-
*/
|
|
11559
|
-
readonly forId: number;
|
|
11560
|
-
/**
|
|
11561
|
-
* Start date for selected transactions (inclusive)
|
|
11960
|
+
* UUID v4 of the payment request.
|
|
11562
11961
|
* @type {string}
|
|
11563
|
-
* @memberof
|
|
11962
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11564
11963
|
*/
|
|
11565
|
-
readonly
|
|
11964
|
+
readonly id: string;
|
|
11965
|
+
}
|
|
11966
|
+
/**
|
|
11967
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11968
|
+
* @export
|
|
11969
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11970
|
+
*/
|
|
11971
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11566
11972
|
/**
|
|
11567
|
-
*
|
|
11568
|
-
* @type {
|
|
11569
|
-
* @memberof
|
|
11973
|
+
* The request to create
|
|
11974
|
+
* @type {CreatePaymentRequestRequest}
|
|
11975
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11570
11976
|
*/
|
|
11571
|
-
readonly
|
|
11977
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11572
11978
|
}
|
|
11573
11979
|
/**
|
|
11574
|
-
* Request parameters for
|
|
11980
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11575
11981
|
* @export
|
|
11576
|
-
* @interface
|
|
11982
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11577
11983
|
*/
|
|
11578
|
-
export interface
|
|
11984
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11579
11985
|
/**
|
|
11580
|
-
*
|
|
11986
|
+
* Filter by beneficiary user id.
|
|
11581
11987
|
* @type {number}
|
|
11582
|
-
* @memberof
|
|
11988
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11583
11989
|
*/
|
|
11584
|
-
readonly
|
|
11990
|
+
readonly forId?: number;
|
|
11585
11991
|
/**
|
|
11586
|
-
*
|
|
11587
|
-
* @type {
|
|
11588
|
-
* @memberof
|
|
11992
|
+
* Filter by creator user id.
|
|
11993
|
+
* @type {number}
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11589
11995
|
*/
|
|
11590
|
-
readonly
|
|
11591
|
-
}
|
|
11592
|
-
/**
|
|
11593
|
-
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11594
|
-
* @export
|
|
11595
|
-
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11596
|
-
*/
|
|
11597
|
-
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11996
|
+
readonly createdById?: number;
|
|
11598
11997
|
/**
|
|
11599
|
-
*
|
|
11998
|
+
* Comma-separated list of derived statuses.
|
|
11999
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12001
|
+
*/
|
|
12002
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12003
|
+
/**
|
|
12004
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12005
|
+
* @type {string}
|
|
12006
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12007
|
+
*/
|
|
12008
|
+
readonly fromDate?: string;
|
|
12009
|
+
/**
|
|
12010
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12011
|
+
* @type {string}
|
|
12012
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12013
|
+
*/
|
|
12014
|
+
readonly tillDate?: string;
|
|
12015
|
+
/**
|
|
12016
|
+
* How many rows the endpoint should return
|
|
11600
12017
|
* @type {number}
|
|
11601
|
-
* @memberof
|
|
12018
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11602
12019
|
*/
|
|
11603
|
-
readonly
|
|
12020
|
+
readonly take?: number;
|
|
11604
12021
|
/**
|
|
11605
|
-
*
|
|
11606
|
-
* @type {
|
|
11607
|
-
* @memberof
|
|
12022
|
+
* How many rows to skip (for pagination)
|
|
12023
|
+
* @type {number}
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11608
12025
|
*/
|
|
11609
|
-
readonly
|
|
12026
|
+
readonly skip?: number;
|
|
11610
12027
|
}
|
|
11611
12028
|
/**
|
|
11612
|
-
* Request parameters for
|
|
12029
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11613
12030
|
* @export
|
|
11614
|
-
* @interface
|
|
12031
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11615
12032
|
*/
|
|
11616
|
-
export interface
|
|
12033
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11617
12034
|
/**
|
|
11618
|
-
*
|
|
11619
|
-
* @type {
|
|
11620
|
-
* @memberof
|
|
12035
|
+
* UUID v4 of the payment request.
|
|
12036
|
+
* @type {string}
|
|
12037
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11621
12038
|
*/
|
|
11622
|
-
readonly id:
|
|
12039
|
+
readonly id: string;
|
|
11623
12040
|
}
|
|
11624
12041
|
/**
|
|
11625
|
-
* Request parameters for
|
|
12042
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11626
12043
|
* @export
|
|
11627
|
-
* @interface
|
|
12044
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11628
12045
|
*/
|
|
11629
|
-
export interface
|
|
12046
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11630
12047
|
/**
|
|
11631
|
-
*
|
|
11632
|
-
* @type {
|
|
11633
|
-
* @memberof
|
|
12048
|
+
* UUID v4 of the payment request.
|
|
12049
|
+
* @type {string}
|
|
12050
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11634
12051
|
*/
|
|
11635
|
-
readonly id:
|
|
12052
|
+
readonly id: string;
|
|
11636
12053
|
/**
|
|
11637
|
-
* The
|
|
11638
|
-
* @type {
|
|
11639
|
-
* @memberof
|
|
12054
|
+
* The audit reason
|
|
12055
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11640
12057
|
*/
|
|
11641
|
-
readonly
|
|
12058
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11642
12059
|
}
|
|
11643
12060
|
/**
|
|
11644
|
-
* Request parameters for
|
|
12061
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11645
12062
|
* @export
|
|
11646
|
-
* @interface
|
|
12063
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11647
12064
|
*/
|
|
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;
|
|
12065
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11655
12066
|
/**
|
|
11656
|
-
*
|
|
11657
|
-
* @type {
|
|
11658
|
-
* @memberof
|
|
12067
|
+
* UUID v4 of the payment request.
|
|
12068
|
+
* @type {string}
|
|
12069
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11659
12070
|
*/
|
|
11660
|
-
readonly
|
|
12071
|
+
readonly id: string;
|
|
11661
12072
|
}
|
|
11662
12073
|
/**
|
|
11663
|
-
*
|
|
12074
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11664
12075
|
* @export
|
|
11665
|
-
* @class
|
|
12076
|
+
* @class PaymentRequestsApi
|
|
11666
12077
|
* @extends {BaseAPI}
|
|
11667
12078
|
*/
|
|
11668
|
-
export declare class
|
|
12079
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11669
12080
|
/**
|
|
11670
12081
|
*
|
|
11671
|
-
* @summary
|
|
11672
|
-
* @param {
|
|
12082
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12083
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11673
12084
|
* @param {*} [options] Override http request option.
|
|
11674
12085
|
* @throws {RequiredError}
|
|
11675
|
-
* @memberof
|
|
12086
|
+
* @memberof PaymentRequestsApi
|
|
11676
12087
|
*/
|
|
11677
|
-
|
|
12088
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11678
12089
|
/**
|
|
11679
12090
|
*
|
|
11680
|
-
* @summary
|
|
11681
|
-
* @param {
|
|
12091
|
+
* @summary Create a new PaymentRequest.
|
|
12092
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11682
12093
|
* @param {*} [options] Override http request option.
|
|
11683
12094
|
* @throws {RequiredError}
|
|
11684
|
-
* @memberof
|
|
12095
|
+
* @memberof PaymentRequestsApi
|
|
11685
12096
|
*/
|
|
11686
|
-
|
|
12097
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11687
12098
|
/**
|
|
11688
12099
|
*
|
|
11689
|
-
* @summary
|
|
11690
|
-
* @param {
|
|
12100
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12101
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11691
12102
|
* @param {*} [options] Override http request option.
|
|
11692
12103
|
* @throws {RequiredError}
|
|
11693
|
-
* @memberof
|
|
12104
|
+
* @memberof PaymentRequestsApi
|
|
11694
12105
|
*/
|
|
11695
|
-
|
|
12106
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11696
12107
|
/**
|
|
11697
12108
|
*
|
|
11698
|
-
* @summary
|
|
11699
|
-
* @param {
|
|
12109
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12110
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11700
12111
|
* @param {*} [options] Override http request option.
|
|
11701
12112
|
* @throws {RequiredError}
|
|
11702
|
-
* @memberof
|
|
12113
|
+
* @memberof PaymentRequestsApi
|
|
11703
12114
|
*/
|
|
11704
|
-
|
|
12115
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11705
12116
|
/**
|
|
11706
12117
|
*
|
|
11707
|
-
* @summary
|
|
11708
|
-
* @param {
|
|
12118
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12119
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11709
12120
|
* @param {*} [options] Override http request option.
|
|
11710
12121
|
* @throws {RequiredError}
|
|
11711
|
-
* @memberof
|
|
12122
|
+
* @memberof PaymentRequestsApi
|
|
11712
12123
|
*/
|
|
11713
|
-
|
|
12124
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11714
12125
|
/**
|
|
11715
12126
|
*
|
|
11716
|
-
* @summary
|
|
12127
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12128
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11717
12129
|
* @param {*} [options] Override http request option.
|
|
11718
12130
|
* @throws {RequiredError}
|
|
11719
|
-
* @memberof
|
|
12131
|
+
* @memberof PaymentRequestsApi
|
|
11720
12132
|
*/
|
|
11721
|
-
|
|
12133
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12134
|
+
}
|
|
12135
|
+
/**
|
|
12136
|
+
* @export
|
|
12137
|
+
*/
|
|
12138
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12139
|
+
readonly Pending: "PENDING";
|
|
12140
|
+
readonly Paid: "PAID";
|
|
12141
|
+
readonly Expired: "EXPIRED";
|
|
12142
|
+
readonly Cancelled: "CANCELLED";
|
|
12143
|
+
};
|
|
12144
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12145
|
+
/**
|
|
12146
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12147
|
+
* @export
|
|
12148
|
+
*/
|
|
12149
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11722
12150
|
/**
|
|
11723
12151
|
*
|
|
11724
|
-
* @summary
|
|
11725
|
-
* @param {
|
|
12152
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12153
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11726
12154
|
* @param {*} [options] Override http request option.
|
|
11727
12155
|
* @throws {RequiredError}
|
|
11728
|
-
* @memberof InvoicesApi
|
|
11729
12156
|
*/
|
|
11730
|
-
|
|
12157
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11731
12158
|
/**
|
|
11732
12159
|
*
|
|
11733
|
-
* @summary
|
|
11734
|
-
* @param {
|
|
12160
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12161
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11735
12162
|
* @param {*} [options] Override http request option.
|
|
11736
12163
|
* @throws {RequiredError}
|
|
11737
|
-
* @memberof InvoicesApi
|
|
11738
12164
|
*/
|
|
11739
|
-
|
|
12165
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12166
|
+
};
|
|
12167
|
+
/**
|
|
12168
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12169
|
+
* @export
|
|
12170
|
+
*/
|
|
12171
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
11740
12172
|
/**
|
|
11741
12173
|
*
|
|
11742
|
-
* @summary
|
|
11743
|
-
* @param {
|
|
12174
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12175
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11744
12176
|
* @param {*} [options] Override http request option.
|
|
11745
12177
|
* @throws {RequiredError}
|
|
11746
|
-
* @memberof InvoicesApi
|
|
11747
12178
|
*/
|
|
11748
|
-
|
|
12179
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11749
12180
|
/**
|
|
11750
12181
|
*
|
|
11751
|
-
* @summary
|
|
11752
|
-
* @param {
|
|
12182
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12183
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11753
12184
|
* @param {*} [options] Override http request option.
|
|
11754
12185
|
* @throws {RequiredError}
|
|
11755
|
-
* @memberof InvoicesApi
|
|
11756
12186
|
*/
|
|
11757
|
-
|
|
12187
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12188
|
+
};
|
|
12189
|
+
/**
|
|
12190
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12191
|
+
* @export
|
|
12192
|
+
*/
|
|
12193
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11758
12194
|
/**
|
|
11759
12195
|
*
|
|
11760
|
-
* @summary
|
|
11761
|
-
* @param {
|
|
12196
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12197
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
11762
12198
|
* @param {*} [options] Override http request option.
|
|
11763
12199
|
* @throws {RequiredError}
|
|
11764
|
-
* @memberof InvoicesApi
|
|
11765
12200
|
*/
|
|
11766
|
-
|
|
12201
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12202
|
+
/**
|
|
12203
|
+
*
|
|
12204
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12205
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12206
|
+
* @param {*} [options] Override http request option.
|
|
12207
|
+
* @throws {RequiredError}
|
|
12208
|
+
*/
|
|
12209
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12210
|
+
};
|
|
12211
|
+
/**
|
|
12212
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12213
|
+
* @export
|
|
12214
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12215
|
+
*/
|
|
12216
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12217
|
+
/**
|
|
12218
|
+
* UUID v4 of the payment request.
|
|
12219
|
+
* @type {string}
|
|
12220
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12221
|
+
*/
|
|
12222
|
+
readonly id: string;
|
|
12223
|
+
}
|
|
12224
|
+
/**
|
|
12225
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12226
|
+
* @export
|
|
12227
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12228
|
+
*/
|
|
12229
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12230
|
+
/**
|
|
12231
|
+
* UUID v4 of the payment request.
|
|
12232
|
+
* @type {string}
|
|
12233
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12234
|
+
*/
|
|
12235
|
+
readonly id: string;
|
|
12236
|
+
}
|
|
12237
|
+
/**
|
|
12238
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12239
|
+
* @export
|
|
12240
|
+
* @class PaymentRequestsPublicApi
|
|
12241
|
+
* @extends {BaseAPI}
|
|
12242
|
+
*/
|
|
12243
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12244
|
+
/**
|
|
12245
|
+
*
|
|
12246
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12247
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12248
|
+
* @param {*} [options] Override http request option.
|
|
12249
|
+
* @throws {RequiredError}
|
|
12250
|
+
* @memberof PaymentRequestsPublicApi
|
|
12251
|
+
*/
|
|
12252
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12253
|
+
/**
|
|
12254
|
+
*
|
|
12255
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12256
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12257
|
+
* @param {*} [options] Override http request option.
|
|
12258
|
+
* @throws {RequiredError}
|
|
12259
|
+
* @memberof PaymentRequestsPublicApi
|
|
12260
|
+
*/
|
|
12261
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
11767
12262
|
}
|
|
11768
12263
|
/**
|
|
11769
12264
|
* PayoutRequestsApi - axios parameter creator
|
|
@@ -15222,7 +15717,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15222
15717
|
* @param {*} [options] Override http request option.
|
|
15223
15718
|
* @throws {RequiredError}
|
|
15224
15719
|
*/
|
|
15225
|
-
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
15720
|
+
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
15721
|
/**
|
|
15227
15722
|
*
|
|
15228
15723
|
* @summary Returns the requested transfer
|
|
@@ -15291,7 +15786,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15291
15786
|
* @param {*} [options] Override http request option.
|
|
15292
15787
|
* @throws {RequiredError}
|
|
15293
15788
|
*/
|
|
15294
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15789
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15295
15790
|
/**
|
|
15296
15791
|
*
|
|
15297
15792
|
* @summary Returns the requested transfer
|
|
@@ -15527,7 +16022,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15527
16022
|
* @throws {RequiredError}
|
|
15528
16023
|
* @memberof TransfersApi
|
|
15529
16024
|
*/
|
|
15530
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16025
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15531
16026
|
/**
|
|
15532
16027
|
*
|
|
15533
16028
|
* @summary Returns the requested transfer
|
|
@@ -15928,6 +16423,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15928
16423
|
* @throws {RequiredError}
|
|
15929
16424
|
*/
|
|
15930
16425
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16426
|
+
/**
|
|
16427
|
+
*
|
|
16428
|
+
* @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.
|
|
16429
|
+
* @param {number} id The id of the beneficiary user.
|
|
16430
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16431
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16432
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16433
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16434
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16435
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16436
|
+
* @param {*} [options] Override http request option.
|
|
16437
|
+
* @throws {RequiredError}
|
|
16438
|
+
*/
|
|
16439
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15931
16440
|
/**
|
|
15932
16441
|
*
|
|
15933
16442
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16290,6 +16799,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16290
16799
|
* @throws {RequiredError}
|
|
16291
16800
|
*/
|
|
16292
16801
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
16802
|
+
/**
|
|
16803
|
+
*
|
|
16804
|
+
* @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.
|
|
16805
|
+
* @param {number} id The id of the beneficiary user.
|
|
16806
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16807
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16808
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16809
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16810
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16811
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16812
|
+
* @param {*} [options] Override http request option.
|
|
16813
|
+
* @throws {RequiredError}
|
|
16814
|
+
*/
|
|
16815
|
+
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
16816
|
/**
|
|
16294
16817
|
*
|
|
16295
16818
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16634,6 +17157,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16634
17157
|
* @throws {RequiredError}
|
|
16635
17158
|
*/
|
|
16636
17159
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17160
|
+
/**
|
|
17161
|
+
*
|
|
17162
|
+
* @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.
|
|
17163
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17164
|
+
* @param {*} [options] Override http request option.
|
|
17165
|
+
* @throws {RequiredError}
|
|
17166
|
+
*/
|
|
17167
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16637
17168
|
/**
|
|
16638
17169
|
*
|
|
16639
17170
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17125,6 +17656,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17125
17656
|
*/
|
|
17126
17657
|
readonly skip?: number;
|
|
17127
17658
|
}
|
|
17659
|
+
/**
|
|
17660
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
17661
|
+
* @export
|
|
17662
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
17663
|
+
*/
|
|
17664
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
17665
|
+
/**
|
|
17666
|
+
* The id of the beneficiary user.
|
|
17667
|
+
* @type {number}
|
|
17668
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17669
|
+
*/
|
|
17670
|
+
readonly id: number;
|
|
17671
|
+
/**
|
|
17672
|
+
* Filter by creator user id.
|
|
17673
|
+
* @type {number}
|
|
17674
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17675
|
+
*/
|
|
17676
|
+
readonly createdById?: number;
|
|
17677
|
+
/**
|
|
17678
|
+
* Comma-separated list of derived statuses.
|
|
17679
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
17680
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17681
|
+
*/
|
|
17682
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
17683
|
+
/**
|
|
17684
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
17685
|
+
* @type {string}
|
|
17686
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17687
|
+
*/
|
|
17688
|
+
readonly fromDate?: string;
|
|
17689
|
+
/**
|
|
17690
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
17691
|
+
* @type {string}
|
|
17692
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17693
|
+
*/
|
|
17694
|
+
readonly tillDate?: string;
|
|
17695
|
+
/**
|
|
17696
|
+
* How many rows the endpoint should return
|
|
17697
|
+
* @type {number}
|
|
17698
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17699
|
+
*/
|
|
17700
|
+
readonly take?: number;
|
|
17701
|
+
/**
|
|
17702
|
+
* How many rows to skip (for pagination)
|
|
17703
|
+
* @type {number}
|
|
17704
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17705
|
+
*/
|
|
17706
|
+
readonly skip?: number;
|
|
17707
|
+
}
|
|
17128
17708
|
/**
|
|
17129
17709
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17130
17710
|
* @export
|
|
@@ -17791,6 +18371,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17791
18371
|
* @memberof UsersApi
|
|
17792
18372
|
*/
|
|
17793
18373
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18374
|
+
/**
|
|
18375
|
+
*
|
|
18376
|
+
* @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.
|
|
18377
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18378
|
+
* @param {*} [options] Override http request option.
|
|
18379
|
+
* @throws {RequiredError}
|
|
18380
|
+
* @memberof UsersApi
|
|
18381
|
+
*/
|
|
18382
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17794
18383
|
/**
|
|
17795
18384
|
*
|
|
17796
18385
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17986,6 +18575,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17986
18575
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17987
18576
|
};
|
|
17988
18577
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
18578
|
+
/**
|
|
18579
|
+
* @export
|
|
18580
|
+
*/
|
|
18581
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
18582
|
+
readonly Pending: "PENDING";
|
|
18583
|
+
readonly Paid: "PAID";
|
|
18584
|
+
readonly Expired: "EXPIRED";
|
|
18585
|
+
readonly Cancelled: "CANCELLED";
|
|
18586
|
+
};
|
|
18587
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17989
18588
|
/**
|
|
17990
18589
|
* @export
|
|
17991
18590
|
*/
|