@gewis/sudosos-client 0.0.0-develop.e05135a → 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/README.md +110 -0
- package/dist/api.d.ts +1230 -494
- package/dist/api.js +1063 -474
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/package.json +4 -4
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
|
*/
|
|
@@ -1683,11 +1761,11 @@ export interface CreateContainerRequest {
|
|
|
1683
1761
|
*/
|
|
1684
1762
|
'public': boolean;
|
|
1685
1763
|
/**
|
|
1686
|
-
* Id of the
|
|
1764
|
+
* Id of the organ that will own the container
|
|
1687
1765
|
* @type {number}
|
|
1688
1766
|
* @memberof CreateContainerRequest
|
|
1689
1767
|
*/
|
|
1690
|
-
'ownerId'
|
|
1768
|
+
'ownerId': number;
|
|
1691
1769
|
}
|
|
1692
1770
|
/**
|
|
1693
1771
|
*
|
|
@@ -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
|
*/
|
|
@@ -1880,7 +1989,7 @@ export interface CreatePointOfSaleRequest {
|
|
|
1880
1989
|
*/
|
|
1881
1990
|
'containers': Array<number>;
|
|
1882
1991
|
/**
|
|
1883
|
-
* ID of the user who will own the POS
|
|
1992
|
+
* ID of the user who will own the POS.
|
|
1884
1993
|
* @type {number}
|
|
1885
1994
|
* @memberof CreatePointOfSaleRequest
|
|
1886
1995
|
*/
|
|
@@ -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
|
*/
|
|
@@ -2566,10 +2675,15 @@ export interface FineResponse {
|
|
|
2566
2675
|
/**
|
|
2567
2676
|
*
|
|
2568
2677
|
* @export
|
|
2569
|
-
* @
|
|
2678
|
+
* @enum {string}
|
|
2570
2679
|
*/
|
|
2571
|
-
export
|
|
2572
|
-
|
|
2680
|
+
export declare const GetAllInvoicesCurrentStateParameterInner: {
|
|
2681
|
+
readonly Created: "CREATED";
|
|
2682
|
+
readonly Sent: "SENT";
|
|
2683
|
+
readonly Paid: "PAID";
|
|
2684
|
+
readonly Deleted: "DELETED";
|
|
2685
|
+
};
|
|
2686
|
+
export type GetAllInvoicesCurrentStateParameterInner = typeof GetAllInvoicesCurrentStateParameterInner[keyof typeof GetAllInvoicesCurrentStateParameterInner];
|
|
2573
2687
|
/**
|
|
2574
2688
|
* @type GetAllPayoutRequestsRequestedByIdParameter
|
|
2575
2689
|
* @export
|
|
@@ -2724,6 +2838,37 @@ export interface InactiveAdministrativeCostResponse {
|
|
|
2724
2838
|
*/
|
|
2725
2839
|
'transfer': TransferResponse;
|
|
2726
2840
|
}
|
|
2841
|
+
/**
|
|
2842
|
+
*
|
|
2843
|
+
* @export
|
|
2844
|
+
* @interface InvoiceDriftResponse
|
|
2845
|
+
*/
|
|
2846
|
+
export interface InvoiceDriftResponse {
|
|
2847
|
+
/**
|
|
2848
|
+
*
|
|
2849
|
+
* @type {BaseInvoiceResponse}
|
|
2850
|
+
* @memberof InvoiceDriftResponse
|
|
2851
|
+
*/
|
|
2852
|
+
'invoice': BaseInvoiceResponse;
|
|
2853
|
+
/**
|
|
2854
|
+
*
|
|
2855
|
+
* @type {DineroObjectResponse}
|
|
2856
|
+
* @memberof InvoiceDriftResponse
|
|
2857
|
+
*/
|
|
2858
|
+
'actualAmount': DineroObjectResponse;
|
|
2859
|
+
/**
|
|
2860
|
+
*
|
|
2861
|
+
* @type {DineroObjectResponse}
|
|
2862
|
+
* @memberof InvoiceDriftResponse
|
|
2863
|
+
*/
|
|
2864
|
+
'expectedAmount': DineroObjectResponse;
|
|
2865
|
+
/**
|
|
2866
|
+
*
|
|
2867
|
+
* @type {DineroObjectResponse}
|
|
2868
|
+
* @memberof InvoiceDriftResponse
|
|
2869
|
+
*/
|
|
2870
|
+
'deltaAmount': DineroObjectResponse;
|
|
2871
|
+
}
|
|
2727
2872
|
/**
|
|
2728
2873
|
*
|
|
2729
2874
|
* @export
|
|
@@ -3118,44 +3263,38 @@ export interface InvoiceUserResponse {
|
|
|
3118
3263
|
/**
|
|
3119
3264
|
*
|
|
3120
3265
|
* @export
|
|
3121
|
-
* @interface
|
|
3266
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3122
3267
|
*/
|
|
3123
|
-
export interface
|
|
3124
|
-
/**
|
|
3125
|
-
*
|
|
3126
|
-
* @type {number}
|
|
3127
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3128
|
-
*/
|
|
3129
|
-
'memberId': number;
|
|
3268
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3130
3269
|
/**
|
|
3131
|
-
*
|
|
3270
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3132
3271
|
* @type {string}
|
|
3133
|
-
* @memberof
|
|
3272
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3134
3273
|
*/
|
|
3135
|
-
'
|
|
3274
|
+
'reason': string;
|
|
3136
3275
|
}
|
|
3137
3276
|
/**
|
|
3138
3277
|
*
|
|
3139
3278
|
* @export
|
|
3140
|
-
* @interface
|
|
3279
|
+
* @interface MemberAuthenticationPinRequest
|
|
3141
3280
|
*/
|
|
3142
|
-
export interface
|
|
3281
|
+
export interface MemberAuthenticationPinRequest {
|
|
3143
3282
|
/**
|
|
3144
3283
|
*
|
|
3145
3284
|
* @type {number}
|
|
3146
|
-
* @memberof
|
|
3285
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3147
3286
|
*/
|
|
3148
3287
|
'memberId': number;
|
|
3149
3288
|
/**
|
|
3150
3289
|
*
|
|
3151
3290
|
* @type {string}
|
|
3152
|
-
* @memberof
|
|
3291
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3153
3292
|
*/
|
|
3154
3293
|
'pin': string;
|
|
3155
3294
|
/**
|
|
3156
3295
|
* POS identifier
|
|
3157
3296
|
* @type {number}
|
|
3158
|
-
* @memberof
|
|
3297
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3159
3298
|
*/
|
|
3160
3299
|
'posId': number;
|
|
3161
3300
|
}
|
|
@@ -3183,13 +3322,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3183
3322
|
* @type {PaginationResult}
|
|
3184
3323
|
* @memberof PaginatedBalanceResponse
|
|
3185
3324
|
*/
|
|
3186
|
-
'_pagination'
|
|
3325
|
+
'_pagination': PaginationResult;
|
|
3187
3326
|
/**
|
|
3188
3327
|
* Returned balance responses
|
|
3189
3328
|
* @type {Array<BalanceResponse>}
|
|
3190
3329
|
* @memberof PaginatedBalanceResponse
|
|
3191
3330
|
*/
|
|
3192
|
-
'records'
|
|
3331
|
+
'records': Array<BalanceResponse>;
|
|
3193
3332
|
}
|
|
3194
3333
|
/**
|
|
3195
3334
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3202,13 +3341,13 @@ export interface PaginatedBannerResponse {
|
|
|
3202
3341
|
* @type {PaginationResult}
|
|
3203
3342
|
* @memberof PaginatedBannerResponse
|
|
3204
3343
|
*/
|
|
3205
|
-
'_pagination'
|
|
3344
|
+
'_pagination': PaginationResult;
|
|
3206
3345
|
/**
|
|
3207
3346
|
* Returned banners
|
|
3208
3347
|
* @type {Array<BannerResponse>}
|
|
3209
3348
|
* @memberof PaginatedBannerResponse
|
|
3210
3349
|
*/
|
|
3211
|
-
'records'
|
|
3350
|
+
'records': Array<BannerResponse>;
|
|
3212
3351
|
}
|
|
3213
3352
|
/**
|
|
3214
3353
|
*
|
|
@@ -3229,6 +3368,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3229
3368
|
*/
|
|
3230
3369
|
'records': Array<BaseEventResponse>;
|
|
3231
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
|
+
}
|
|
3232
3390
|
/**
|
|
3233
3391
|
*
|
|
3234
3392
|
* @export
|
|
@@ -3268,7 +3426,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3268
3426
|
'records': Array<BaseTransactionResponse>;
|
|
3269
3427
|
}
|
|
3270
3428
|
/**
|
|
3271
|
-
*
|
|
3429
|
+
* Paginated API Response for the `container` entity.
|
|
3272
3430
|
* @export
|
|
3273
3431
|
* @interface PaginatedContainerResponse
|
|
3274
3432
|
*/
|
|
@@ -3287,7 +3445,7 @@ export interface PaginatedContainerResponse {
|
|
|
3287
3445
|
'records': Array<ContainerResponse>;
|
|
3288
3446
|
}
|
|
3289
3447
|
/**
|
|
3290
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3291
3449
|
* @export
|
|
3292
3450
|
* @interface PaginatedContainerWithProductResponse
|
|
3293
3451
|
*/
|
|
@@ -3373,13 +3531,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3373
3531
|
* @type {PaginationResult}
|
|
3374
3532
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3375
3533
|
*/
|
|
3376
|
-
'_pagination'
|
|
3534
|
+
'_pagination': PaginationResult;
|
|
3377
3535
|
/**
|
|
3378
3536
|
* Returned InactiveAdministrativeCost
|
|
3379
3537
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3380
3538
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3381
3539
|
*/
|
|
3382
|
-
'records'
|
|
3540
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3383
3541
|
}
|
|
3384
3542
|
/**
|
|
3385
3543
|
*
|
|
@@ -3401,7 +3559,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3401
3559
|
'records': Array<InvoiceResponseTypes>;
|
|
3402
3560
|
}
|
|
3403
3561
|
/**
|
|
3404
|
-
*
|
|
3562
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3405
3563
|
* @export
|
|
3406
3564
|
* @interface PaginatedPointOfSaleResponse
|
|
3407
3565
|
*/
|
|
@@ -3420,7 +3578,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3420
3578
|
'records': Array<PointOfSaleResponse>;
|
|
3421
3579
|
}
|
|
3422
3580
|
/**
|
|
3423
|
-
*
|
|
3581
|
+
* Paginated API Response for the `product category` entity.
|
|
3424
3582
|
* @export
|
|
3425
3583
|
* @interface PaginatedProductCategoryResponse
|
|
3426
3584
|
*/
|
|
@@ -3439,7 +3597,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3439
3597
|
'records': Array<ProductCategoryResponse>;
|
|
3440
3598
|
}
|
|
3441
3599
|
/**
|
|
3442
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product` entity.
|
|
3443
3601
|
* @export
|
|
3444
3602
|
* @interface PaginatedProductResponse
|
|
3445
3603
|
*/
|
|
@@ -3534,7 +3692,7 @@ export interface PaginatedUserResponse {
|
|
|
3534
3692
|
'records': Array<UserResponse>;
|
|
3535
3693
|
}
|
|
3536
3694
|
/**
|
|
3537
|
-
*
|
|
3695
|
+
* Paginated API Response for the `vat group` entity.
|
|
3538
3696
|
* @export
|
|
3539
3697
|
* @interface PaginatedVatGroupResponse
|
|
3540
3698
|
*/
|
|
@@ -3659,6 +3817,31 @@ export interface PatchUserTypeRequest {
|
|
|
3659
3817
|
*/
|
|
3660
3818
|
'userType': string;
|
|
3661
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
|
+
}
|
|
3662
3845
|
/**
|
|
3663
3846
|
*
|
|
3664
3847
|
* @export
|
|
@@ -3866,7 +4049,7 @@ export interface PermissionResponse {
|
|
|
3866
4049
|
'actions': Array<ActionResponse>;
|
|
3867
4050
|
}
|
|
3868
4051
|
/**
|
|
3869
|
-
*
|
|
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).
|
|
3870
4053
|
* @export
|
|
3871
4054
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3872
4055
|
*/
|
|
@@ -4019,7 +4202,7 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4019
4202
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4020
4203
|
}
|
|
4021
4204
|
/**
|
|
4022
|
-
*
|
|
4205
|
+
* API Request for creating or updating a `product category` entity.
|
|
4023
4206
|
* @export
|
|
4024
4207
|
* @interface ProductCategoryRequest
|
|
4025
4208
|
*/
|
|
@@ -4183,6 +4366,56 @@ export interface ProductResponse {
|
|
|
4183
4366
|
*/
|
|
4184
4367
|
'priceList': boolean;
|
|
4185
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];
|
|
4186
4419
|
/**
|
|
4187
4420
|
*
|
|
4188
4421
|
* @export
|
|
@@ -5084,23 +5317,23 @@ export interface TotalBalanceResponse {
|
|
|
5084
5317
|
*/
|
|
5085
5318
|
'date': string;
|
|
5086
5319
|
/**
|
|
5087
|
-
*
|
|
5088
|
-
* @type {
|
|
5320
|
+
*
|
|
5321
|
+
* @type {DineroObjectResponse}
|
|
5089
5322
|
* @memberof TotalBalanceResponse
|
|
5090
5323
|
*/
|
|
5091
|
-
'totalPositive':
|
|
5324
|
+
'totalPositive': DineroObjectResponse;
|
|
5092
5325
|
/**
|
|
5093
|
-
*
|
|
5094
|
-
* @type {
|
|
5326
|
+
*
|
|
5327
|
+
* @type {DineroObjectResponse}
|
|
5095
5328
|
* @memberof TotalBalanceResponse
|
|
5096
5329
|
*/
|
|
5097
|
-
'totalNegative':
|
|
5330
|
+
'totalNegative': DineroObjectResponse;
|
|
5098
5331
|
/**
|
|
5099
|
-
*
|
|
5100
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5332
|
+
* The total balances for the different user types
|
|
5333
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5101
5334
|
* @memberof TotalBalanceResponse
|
|
5102
5335
|
*/
|
|
5103
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5336
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5104
5337
|
}
|
|
5105
5338
|
/**
|
|
5106
5339
|
*
|
|
@@ -5671,9 +5904,21 @@ export interface TransferSummaryResponse {
|
|
|
5671
5904
|
* @memberof TransferSummaryResponse
|
|
5672
5905
|
*/
|
|
5673
5906
|
'inactiveAdministrativeCosts': TransferAggregateResponse;
|
|
5907
|
+
/**
|
|
5908
|
+
*
|
|
5909
|
+
* @type {TransferAggregateResponse}
|
|
5910
|
+
* @memberof TransferSummaryResponse
|
|
5911
|
+
*/
|
|
5912
|
+
'manualCreations': TransferAggregateResponse;
|
|
5913
|
+
/**
|
|
5914
|
+
*
|
|
5915
|
+
* @type {TransferAggregateResponse}
|
|
5916
|
+
* @memberof TransferSummaryResponse
|
|
5917
|
+
*/
|
|
5918
|
+
'manualDeletions': TransferAggregateResponse;
|
|
5674
5919
|
}
|
|
5675
5920
|
/**
|
|
5676
|
-
*
|
|
5921
|
+
* API Request for updating a `container` entity.
|
|
5677
5922
|
* @export
|
|
5678
5923
|
* @interface UpdateContainerRequest
|
|
5679
5924
|
*/
|
|
@@ -5923,7 +6168,7 @@ export interface UpdatePinRequest {
|
|
|
5923
6168
|
'pin': string;
|
|
5924
6169
|
}
|
|
5925
6170
|
/**
|
|
5926
|
-
*
|
|
6171
|
+
* API Request for updating a `point of sale` entity.
|
|
5927
6172
|
* @export
|
|
5928
6173
|
* @interface UpdatePointOfSaleRequest
|
|
5929
6174
|
*/
|
|
@@ -5960,7 +6205,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
5960
6205
|
'cashierRoleIds'?: Array<number>;
|
|
5961
6206
|
}
|
|
5962
6207
|
/**
|
|
5963
|
-
*
|
|
6208
|
+
* API Request for updating a `product` entity.
|
|
5964
6209
|
* @export
|
|
5965
6210
|
* @interface UpdateProductRequest
|
|
5966
6211
|
*/
|
|
@@ -6125,9 +6370,15 @@ export interface UpdateUserRequest {
|
|
|
6125
6370
|
* @memberof UpdateUserRequest
|
|
6126
6371
|
*/
|
|
6127
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;
|
|
6128
6379
|
}
|
|
6129
6380
|
/**
|
|
6130
|
-
*
|
|
6381
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6131
6382
|
* @export
|
|
6132
6383
|
* @interface UpdateVatGroupRequest
|
|
6133
6384
|
*/
|
|
@@ -6341,6 +6592,12 @@ export interface UserResponse {
|
|
|
6341
6592
|
* @memberof UserResponse
|
|
6342
6593
|
*/
|
|
6343
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;
|
|
6344
6601
|
}
|
|
6345
6602
|
/**
|
|
6346
6603
|
*
|
|
@@ -6447,6 +6704,22 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6447
6704
|
*/
|
|
6448
6705
|
'nickname'?: string;
|
|
6449
6706
|
}
|
|
6707
|
+
/**
|
|
6708
|
+
* The type of a user
|
|
6709
|
+
* @export
|
|
6710
|
+
* @enum {string}
|
|
6711
|
+
*/
|
|
6712
|
+
export declare const UserType: {
|
|
6713
|
+
readonly Member: "MEMBER";
|
|
6714
|
+
readonly Organ: "ORGAN";
|
|
6715
|
+
readonly Voucher: "VOUCHER";
|
|
6716
|
+
readonly LocalUser: "LOCAL_USER";
|
|
6717
|
+
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6718
|
+
readonly Invoice: "INVOICE";
|
|
6719
|
+
readonly PointOfSale: "POINT_OF_SALE";
|
|
6720
|
+
readonly Integration: "INTEGRATION";
|
|
6721
|
+
};
|
|
6722
|
+
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6450
6723
|
/**
|
|
6451
6724
|
*
|
|
6452
6725
|
* @export
|
|
@@ -6473,7 +6746,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6473
6746
|
'totalNegative': DineroObjectResponse;
|
|
6474
6747
|
}
|
|
6475
6748
|
/**
|
|
6476
|
-
*
|
|
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.
|
|
6477
6750
|
* @export
|
|
6478
6751
|
* @interface UserWithIndex
|
|
6479
6752
|
*/
|
|
@@ -6488,6 +6761,25 @@ export interface UserWithIndex {
|
|
|
6488
6761
|
/**
|
|
6489
6762
|
*
|
|
6490
6763
|
* @export
|
|
6764
|
+
* @interface ValidationResponse
|
|
6765
|
+
*/
|
|
6766
|
+
export interface ValidationResponse {
|
|
6767
|
+
/**
|
|
6768
|
+
* Whether the request passed validation.
|
|
6769
|
+
* @type {boolean}
|
|
6770
|
+
* @memberof ValidationResponse
|
|
6771
|
+
*/
|
|
6772
|
+
'valid': boolean;
|
|
6773
|
+
/**
|
|
6774
|
+
* List of validation error messages.
|
|
6775
|
+
* @type {Array<string>}
|
|
6776
|
+
* @memberof ValidationResponse
|
|
6777
|
+
*/
|
|
6778
|
+
'errors': Array<string>;
|
|
6779
|
+
}
|
|
6780
|
+
/**
|
|
6781
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6782
|
+
* @export
|
|
6491
6783
|
* @interface VatDeclarationResponse
|
|
6492
6784
|
*/
|
|
6493
6785
|
export interface VatDeclarationResponse {
|
|
@@ -6511,7 +6803,7 @@ export interface VatDeclarationResponse {
|
|
|
6511
6803
|
'rows': Array<VatDeclarationRow>;
|
|
6512
6804
|
}
|
|
6513
6805
|
/**
|
|
6514
|
-
*
|
|
6806
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6515
6807
|
* @export
|
|
6516
6808
|
* @interface VatDeclarationRow
|
|
6517
6809
|
*/
|
|
@@ -6979,10 +7271,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6979
7271
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6980
7272
|
/**
|
|
6981
7273
|
*
|
|
6982
|
-
* @summary EAN
|
|
6983
|
-
* @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
|
|
6984
7276
|
* @param {*} [options] Override http request option.
|
|
6985
|
-
* @deprecated
|
|
6986
7277
|
* @throws {RequiredError}
|
|
6987
7278
|
*/
|
|
6988
7279
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7057,13 +7348,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7057
7348
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7058
7349
|
/**
|
|
7059
7350
|
*
|
|
7060
|
-
* @summary PIN
|
|
7061
|
-
* @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
|
|
7062
7353
|
* @param {*} [options] Override http request option.
|
|
7063
|
-
* @deprecated
|
|
7064
7354
|
* @throws {RequiredError}
|
|
7065
7355
|
*/
|
|
7066
|
-
|
|
7356
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7067
7357
|
/**
|
|
7068
7358
|
*
|
|
7069
7359
|
* @summary Mock login and hand out token.
|
|
@@ -7074,19 +7364,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7074
7364
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7075
7365
|
/**
|
|
7076
7366
|
*
|
|
7077
|
-
* @summary NFC
|
|
7078
|
-
* @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
|
|
7079
7369
|
* @param {*} [options] Override http request option.
|
|
7080
|
-
* @deprecated
|
|
7081
7370
|
* @throws {RequiredError}
|
|
7082
7371
|
*/
|
|
7083
7372
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7084
7373
|
/**
|
|
7085
7374
|
*
|
|
7086
|
-
* @summary PIN
|
|
7087
|
-
* @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
|
|
7088
7377
|
* @param {*} [options] Override http request option.
|
|
7089
|
-
* @deprecated
|
|
7090
7378
|
* @throws {RequiredError}
|
|
7091
7379
|
*/
|
|
7092
7380
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7113,38 +7401,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7113
7401
|
* @throws {RequiredError}
|
|
7114
7402
|
*/
|
|
7115
7403
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7116
|
-
/**
|
|
7117
|
-
*
|
|
7118
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7119
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7120
|
-
* @param {*} [options] Override http request option.
|
|
7121
|
-
* @throws {RequiredError}
|
|
7122
|
-
*/
|
|
7123
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7124
|
-
/**
|
|
7125
|
-
*
|
|
7126
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7127
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7128
|
-
* @param {*} [options] Override http request option.
|
|
7129
|
-
* @throws {RequiredError}
|
|
7130
|
-
*/
|
|
7131
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7132
|
-
/**
|
|
7133
|
-
*
|
|
7134
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7135
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7136
|
-
* @param {*} [options] Override http request option.
|
|
7137
|
-
* @throws {RequiredError}
|
|
7138
|
-
*/
|
|
7139
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7140
|
-
/**
|
|
7141
|
-
*
|
|
7142
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7143
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7144
|
-
* @param {*} [options] Override http request option.
|
|
7145
|
-
* @throws {RequiredError}
|
|
7146
|
-
*/
|
|
7147
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7148
7404
|
};
|
|
7149
7405
|
/**
|
|
7150
7406
|
* AuthenticateApi - functional programming interface
|
|
@@ -7177,10 +7433,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7177
7433
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7178
7434
|
/**
|
|
7179
7435
|
*
|
|
7180
|
-
* @summary EAN
|
|
7181
|
-
* @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
|
|
7182
7438
|
* @param {*} [options] Override http request option.
|
|
7183
|
-
* @deprecated
|
|
7184
7439
|
* @throws {RequiredError}
|
|
7185
7440
|
*/
|
|
7186
7441
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7255,13 +7510,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7255
7510
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7256
7511
|
/**
|
|
7257
7512
|
*
|
|
7258
|
-
* @summary PIN
|
|
7259
|
-
* @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
|
|
7260
7515
|
* @param {*} [options] Override http request option.
|
|
7261
|
-
* @deprecated
|
|
7262
7516
|
* @throws {RequiredError}
|
|
7263
7517
|
*/
|
|
7264
|
-
|
|
7518
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7265
7519
|
/**
|
|
7266
7520
|
*
|
|
7267
7521
|
* @summary Mock login and hand out token.
|
|
@@ -7272,19 +7526,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7272
7526
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7273
7527
|
/**
|
|
7274
7528
|
*
|
|
7275
|
-
* @summary NFC
|
|
7276
|
-
* @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
|
|
7277
7531
|
* @param {*} [options] Override http request option.
|
|
7278
|
-
* @deprecated
|
|
7279
7532
|
* @throws {RequiredError}
|
|
7280
7533
|
*/
|
|
7281
7534
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7282
7535
|
/**
|
|
7283
7536
|
*
|
|
7284
|
-
* @summary PIN
|
|
7285
|
-
* @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
|
|
7286
7539
|
* @param {*} [options] Override http request option.
|
|
7287
|
-
* @deprecated
|
|
7288
7540
|
* @throws {RequiredError}
|
|
7289
7541
|
*/
|
|
7290
7542
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7311,38 +7563,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7311
7563
|
* @throws {RequiredError}
|
|
7312
7564
|
*/
|
|
7313
7565
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7314
|
-
/**
|
|
7315
|
-
*
|
|
7316
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7317
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7318
|
-
* @param {*} [options] Override http request option.
|
|
7319
|
-
* @throws {RequiredError}
|
|
7320
|
-
*/
|
|
7321
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7322
|
-
/**
|
|
7323
|
-
*
|
|
7324
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7325
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7326
|
-
* @param {*} [options] Override http request option.
|
|
7327
|
-
* @throws {RequiredError}
|
|
7328
|
-
*/
|
|
7329
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7330
|
-
/**
|
|
7331
|
-
*
|
|
7332
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7333
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7334
|
-
* @param {*} [options] Override http request option.
|
|
7335
|
-
* @throws {RequiredError}
|
|
7336
|
-
*/
|
|
7337
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7338
|
-
/**
|
|
7339
|
-
*
|
|
7340
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7341
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7342
|
-
* @param {*} [options] Override http request option.
|
|
7343
|
-
* @throws {RequiredError}
|
|
7344
|
-
*/
|
|
7345
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7346
7566
|
};
|
|
7347
7567
|
/**
|
|
7348
7568
|
* AuthenticateApi - factory interface
|
|
@@ -7375,10 +7595,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7375
7595
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7376
7596
|
/**
|
|
7377
7597
|
*
|
|
7378
|
-
* @summary EAN
|
|
7598
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7379
7599
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7380
7600
|
* @param {*} [options] Override http request option.
|
|
7381
|
-
* @deprecated
|
|
7382
7601
|
* @throws {RequiredError}
|
|
7383
7602
|
*/
|
|
7384
7603
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7453,13 +7672,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7453
7672
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7454
7673
|
/**
|
|
7455
7674
|
*
|
|
7456
|
-
* @summary PIN
|
|
7457
|
-
* @param {
|
|
7675
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7676
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7458
7677
|
* @param {*} [options] Override http request option.
|
|
7459
|
-
* @deprecated
|
|
7460
7678
|
* @throws {RequiredError}
|
|
7461
7679
|
*/
|
|
7462
|
-
|
|
7680
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7463
7681
|
/**
|
|
7464
7682
|
*
|
|
7465
7683
|
* @summary Mock login and hand out token.
|
|
@@ -7470,19 +7688,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7470
7688
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7471
7689
|
/**
|
|
7472
7690
|
*
|
|
7473
|
-
* @summary NFC
|
|
7691
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7474
7692
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7475
7693
|
* @param {*} [options] Override http request option.
|
|
7476
|
-
* @deprecated
|
|
7477
7694
|
* @throws {RequiredError}
|
|
7478
7695
|
*/
|
|
7479
7696
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7480
7697
|
/**
|
|
7481
7698
|
*
|
|
7482
|
-
* @summary PIN
|
|
7699
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7483
7700
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7484
7701
|
* @param {*} [options] Override http request option.
|
|
7485
|
-
* @deprecated
|
|
7486
7702
|
* @throws {RequiredError}
|
|
7487
7703
|
*/
|
|
7488
7704
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7509,38 +7725,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7509
7725
|
* @throws {RequiredError}
|
|
7510
7726
|
*/
|
|
7511
7727
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7512
|
-
/**
|
|
7513
|
-
*
|
|
7514
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7515
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7516
|
-
* @param {*} [options] Override http request option.
|
|
7517
|
-
* @throws {RequiredError}
|
|
7518
|
-
*/
|
|
7519
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7520
|
-
/**
|
|
7521
|
-
*
|
|
7522
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7523
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7524
|
-
* @param {*} [options] Override http request option.
|
|
7525
|
-
* @throws {RequiredError}
|
|
7526
|
-
*/
|
|
7527
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7528
|
-
/**
|
|
7529
|
-
*
|
|
7530
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7531
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7532
|
-
* @param {*} [options] Override http request option.
|
|
7533
|
-
* @throws {RequiredError}
|
|
7534
|
-
*/
|
|
7535
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7536
|
-
/**
|
|
7537
|
-
*
|
|
7538
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7539
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7540
|
-
* @param {*} [options] Override http request option.
|
|
7541
|
-
* @throws {RequiredError}
|
|
7542
|
-
*/
|
|
7543
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7544
7728
|
};
|
|
7545
7729
|
/**
|
|
7546
7730
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7588,7 +7772,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7588
7772
|
*/
|
|
7589
7773
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7590
7774
|
/**
|
|
7591
|
-
* The EAN login
|
|
7775
|
+
* The EAN login request with posId
|
|
7592
7776
|
* @type {AuthenticationEanRequest}
|
|
7593
7777
|
* @memberof AuthenticateApiEanAuthentication
|
|
7594
7778
|
*/
|
|
@@ -7673,15 +7857,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7673
7857
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7674
7858
|
}
|
|
7675
7859
|
/**
|
|
7676
|
-
* Request parameters for
|
|
7860
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7677
7861
|
* @export
|
|
7678
|
-
* @interface
|
|
7862
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7679
7863
|
*/
|
|
7680
|
-
export interface
|
|
7864
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7681
7865
|
/**
|
|
7682
|
-
* The PIN login
|
|
7866
|
+
* The PIN login request with posId
|
|
7683
7867
|
* @type {MemberAuthenticationPinRequest}
|
|
7684
|
-
* @memberof
|
|
7868
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7685
7869
|
*/
|
|
7686
7870
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7687
7871
|
}
|
|
@@ -7705,7 +7889,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7705
7889
|
*/
|
|
7706
7890
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7707
7891
|
/**
|
|
7708
|
-
* The NFC login
|
|
7892
|
+
* The NFC login request with posId
|
|
7709
7893
|
* @type {AuthenticationNfcRequest}
|
|
7710
7894
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7711
7895
|
*/
|
|
@@ -7718,7 +7902,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7718
7902
|
*/
|
|
7719
7903
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7720
7904
|
/**
|
|
7721
|
-
* The PIN login
|
|
7905
|
+
* The PIN login request with posId
|
|
7722
7906
|
* @type {AuthenticationPinRequest}
|
|
7723
7907
|
* @memberof AuthenticateApiPinAuthentication
|
|
7724
7908
|
*/
|
|
@@ -7750,58 +7934,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7750
7934
|
*/
|
|
7751
7935
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7752
7936
|
}
|
|
7753
|
-
/**
|
|
7754
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7755
|
-
* @export
|
|
7756
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7757
|
-
*/
|
|
7758
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7759
|
-
/**
|
|
7760
|
-
* The EAN login request with posId
|
|
7761
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7762
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7763
|
-
*/
|
|
7764
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7765
|
-
}
|
|
7766
|
-
/**
|
|
7767
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7768
|
-
* @export
|
|
7769
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7770
|
-
*/
|
|
7771
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7772
|
-
/**
|
|
7773
|
-
* The PIN login request with posId
|
|
7774
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7775
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7776
|
-
*/
|
|
7777
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7778
|
-
}
|
|
7779
|
-
/**
|
|
7780
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7781
|
-
* @export
|
|
7782
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7783
|
-
*/
|
|
7784
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7785
|
-
/**
|
|
7786
|
-
* The NFC login request with posId
|
|
7787
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7788
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7789
|
-
*/
|
|
7790
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7791
|
-
}
|
|
7792
|
-
/**
|
|
7793
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7794
|
-
* @export
|
|
7795
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7796
|
-
*/
|
|
7797
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7798
|
-
/**
|
|
7799
|
-
* The PIN login request with posId
|
|
7800
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7801
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7802
|
-
*/
|
|
7803
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7804
|
-
}
|
|
7805
7937
|
/**
|
|
7806
7938
|
* AuthenticateApi - object-oriented interface
|
|
7807
7939
|
* @export
|
|
@@ -7838,10 +7970,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7838
7970
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7839
7971
|
/**
|
|
7840
7972
|
*
|
|
7841
|
-
* @summary EAN
|
|
7973
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7842
7974
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7843
7975
|
* @param {*} [options] Override http request option.
|
|
7844
|
-
* @deprecated
|
|
7845
7976
|
* @throws {RequiredError}
|
|
7846
7977
|
* @memberof AuthenticateApi
|
|
7847
7978
|
*/
|
|
@@ -7926,14 +8057,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7926
8057
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7927
8058
|
/**
|
|
7928
8059
|
*
|
|
7929
|
-
* @summary PIN
|
|
7930
|
-
* @param {
|
|
8060
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8061
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7931
8062
|
* @param {*} [options] Override http request option.
|
|
7932
|
-
* @deprecated
|
|
7933
8063
|
* @throws {RequiredError}
|
|
7934
8064
|
* @memberof AuthenticateApi
|
|
7935
8065
|
*/
|
|
7936
|
-
|
|
8066
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7937
8067
|
/**
|
|
7938
8068
|
*
|
|
7939
8069
|
* @summary Mock login and hand out token.
|
|
@@ -7945,20 +8075,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7945
8075
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7946
8076
|
/**
|
|
7947
8077
|
*
|
|
7948
|
-
* @summary NFC
|
|
8078
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7949
8079
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7950
8080
|
* @param {*} [options] Override http request option.
|
|
7951
|
-
* @deprecated
|
|
7952
8081
|
* @throws {RequiredError}
|
|
7953
8082
|
* @memberof AuthenticateApi
|
|
7954
8083
|
*/
|
|
7955
8084
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7956
8085
|
/**
|
|
7957
8086
|
*
|
|
7958
|
-
* @summary PIN
|
|
8087
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7959
8088
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7960
8089
|
* @param {*} [options] Override http request option.
|
|
7961
|
-
* @deprecated
|
|
7962
8090
|
* @throws {RequiredError}
|
|
7963
8091
|
* @memberof AuthenticateApi
|
|
7964
8092
|
*/
|
|
@@ -7989,42 +8117,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7989
8117
|
* @memberof AuthenticateApi
|
|
7990
8118
|
*/
|
|
7991
8119
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7992
|
-
/**
|
|
7993
|
-
*
|
|
7994
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7995
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7996
|
-
* @param {*} [options] Override http request option.
|
|
7997
|
-
* @throws {RequiredError}
|
|
7998
|
-
* @memberof AuthenticateApi
|
|
7999
|
-
*/
|
|
8000
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8001
|
-
/**
|
|
8002
|
-
*
|
|
8003
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
8004
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8005
|
-
* @param {*} [options] Override http request option.
|
|
8006
|
-
* @throws {RequiredError}
|
|
8007
|
-
* @memberof AuthenticateApi
|
|
8008
|
-
*/
|
|
8009
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8010
|
-
/**
|
|
8011
|
-
*
|
|
8012
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
8013
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8014
|
-
* @param {*} [options] Override http request option.
|
|
8015
|
-
* @throws {RequiredError}
|
|
8016
|
-
* @memberof AuthenticateApi
|
|
8017
|
-
*/
|
|
8018
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8019
|
-
/**
|
|
8020
|
-
*
|
|
8021
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
8022
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
8023
|
-
* @param {*} [options] Override http request option.
|
|
8024
|
-
* @throws {RequiredError}
|
|
8025
|
-
* @memberof AuthenticateApi
|
|
8026
|
-
*/
|
|
8027
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8028
8120
|
}
|
|
8029
8121
|
/**
|
|
8030
8122
|
* BalanceApi - axios parameter creator
|
|
@@ -8049,7 +8141,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8049
8141
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8050
8142
|
* @param {number} [minFine] Minimum fine
|
|
8051
8143
|
* @param {number} [maxFine] Maximum fine
|
|
8052
|
-
* @param {
|
|
8144
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8053
8145
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8054
8146
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8055
8147
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8059,7 +8151,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8059
8151
|
* @param {*} [options] Override http request option.
|
|
8060
8152
|
* @throws {RequiredError}
|
|
8061
8153
|
*/
|
|
8062
|
-
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8154
|
+
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8063
8155
|
/**
|
|
8064
8156
|
*
|
|
8065
8157
|
* @summary Retrieves the requested balance
|
|
@@ -8099,7 +8191,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8099
8191
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8100
8192
|
* @param {number} [minFine] Minimum fine
|
|
8101
8193
|
* @param {number} [maxFine] Maximum fine
|
|
8102
|
-
* @param {
|
|
8194
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8103
8195
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8104
8196
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8105
8197
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8109,7 +8201,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8109
8201
|
* @param {*} [options] Override http request option.
|
|
8110
8202
|
* @throws {RequiredError}
|
|
8111
8203
|
*/
|
|
8112
|
-
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8204
|
+
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?: Array<UserType>, orderBy?: string, orderDirection?: GetAllBalanceOrderDirectionEnum, allowDeleted?: boolean, inactive?: boolean, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBalanceResponse>>;
|
|
8113
8205
|
/**
|
|
8114
8206
|
*
|
|
8115
8207
|
* @summary Retrieves the requested balance
|
|
@@ -8226,10 +8318,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8226
8318
|
readonly maxFine?: number;
|
|
8227
8319
|
/**
|
|
8228
8320
|
* Filter based on user type.
|
|
8229
|
-
* @type {Array<
|
|
8321
|
+
* @type {Array<UserType>}
|
|
8230
8322
|
* @memberof BalanceApiGetAllBalance
|
|
8231
8323
|
*/
|
|
8232
|
-
readonly userTypes?:
|
|
8324
|
+
readonly userTypes?: Array<UserType>;
|
|
8233
8325
|
/**
|
|
8234
8326
|
* Column to order balance by - eg: id,amount
|
|
8235
8327
|
* @type {string}
|
|
@@ -8323,11 +8415,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8323
8415
|
*/
|
|
8324
8416
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8325
8417
|
}
|
|
8326
|
-
/**
|
|
8327
|
-
* @export
|
|
8328
|
-
*/
|
|
8329
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8330
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8331
8418
|
/**
|
|
8332
8419
|
* @export
|
|
8333
8420
|
*/
|
|
@@ -10748,7 +10835,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10748
10835
|
* @param {*} [options] Override http request option.
|
|
10749
10836
|
* @throws {RequiredError}
|
|
10750
10837
|
*/
|
|
10751
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10838
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10752
10839
|
/**
|
|
10753
10840
|
*
|
|
10754
10841
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10826,7 +10913,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10826
10913
|
* @param {*} [options] Override http request option.
|
|
10827
10914
|
* @throws {RequiredError}
|
|
10828
10915
|
*/
|
|
10829
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10916
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10830
10917
|
/**
|
|
10831
10918
|
*
|
|
10832
10919
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11049,7 +11136,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11049
11136
|
* @throws {RequiredError}
|
|
11050
11137
|
* @memberof InactiveAdministrativeCostsApi
|
|
11051
11138
|
*/
|
|
11052
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11139
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11053
11140
|
/**
|
|
11054
11141
|
*
|
|
11055
11142
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11094,16 +11181,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11094
11181
|
* @summary Returns all invoices in the system.
|
|
11095
11182
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11096
11183
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11097
|
-
* @param {
|
|
11184
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11098
11185
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11099
11186
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11100
11187
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
11188
|
+
* @param {string} [description] Filter invoices by description (partial match)
|
|
11101
11189
|
* @param {number} [take] How many entries the endpoint should return
|
|
11102
11190
|
* @param {number} [skip] How many entries should be skipped (for pagination)
|
|
11103
11191
|
* @param {*} [options] Override http request option.
|
|
11104
11192
|
* @throws {RequiredError}
|
|
11105
11193
|
*/
|
|
11106
|
-
getAllInvoices: (toId?: number, invoiceId?: number, currentState?:
|
|
11194
|
+
getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11107
11195
|
/**
|
|
11108
11196
|
*
|
|
11109
11197
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11114,6 +11202,13 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11114
11202
|
* @throws {RequiredError}
|
|
11115
11203
|
*/
|
|
11116
11204
|
getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11205
|
+
/**
|
|
11206
|
+
*
|
|
11207
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11208
|
+
* @param {*} [options] Override http request option.
|
|
11209
|
+
* @throws {RequiredError}
|
|
11210
|
+
*/
|
|
11211
|
+
getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11117
11212
|
/**
|
|
11118
11213
|
*
|
|
11119
11214
|
* @summary Get an invoice pdf.
|
|
@@ -11193,16 +11288,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11193
11288
|
* @summary Returns all invoices in the system.
|
|
11194
11289
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11195
11290
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11196
|
-
* @param {
|
|
11291
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11197
11292
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11198
11293
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11199
11294
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
11295
|
+
* @param {string} [description] Filter invoices by description (partial match)
|
|
11200
11296
|
* @param {number} [take] How many entries the endpoint should return
|
|
11201
11297
|
* @param {number} [skip] How many entries should be skipped (for pagination)
|
|
11202
11298
|
* @param {*} [options] Override http request option.
|
|
11203
11299
|
* @throws {RequiredError}
|
|
11204
11300
|
*/
|
|
11205
|
-
getAllInvoices(toId?: number, invoiceId?: number, currentState?:
|
|
11301
|
+
getAllInvoices(toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedInvoiceResponse>>;
|
|
11206
11302
|
/**
|
|
11207
11303
|
*
|
|
11208
11304
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11212,7 +11308,14 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11212
11308
|
* @param {*} [options] Override http request option.
|
|
11213
11309
|
* @throws {RequiredError}
|
|
11214
11310
|
*/
|
|
11215
|
-
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>>>;
|
|
11312
|
+
/**
|
|
11313
|
+
*
|
|
11314
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11315
|
+
* @param {*} [options] Override http request option.
|
|
11316
|
+
* @throws {RequiredError}
|
|
11317
|
+
*/
|
|
11318
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
|
|
11216
11319
|
/**
|
|
11217
11320
|
*
|
|
11218
11321
|
* @summary Get an invoice pdf.
|
|
@@ -11221,7 +11324,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11221
11324
|
* @param {*} [options] Override http request option.
|
|
11222
11325
|
* @throws {RequiredError}
|
|
11223
11326
|
*/
|
|
11224
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11327
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11225
11328
|
/**
|
|
11226
11329
|
*
|
|
11227
11330
|
* @summary Returns a single invoice in the system.
|
|
@@ -11302,7 +11405,14 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11302
11405
|
* @param {*} [options] Override http request option.
|
|
11303
11406
|
* @throws {RequiredError}
|
|
11304
11407
|
*/
|
|
11305
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11408
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11409
|
+
/**
|
|
11410
|
+
*
|
|
11411
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11412
|
+
* @param {*} [options] Override http request option.
|
|
11413
|
+
* @throws {RequiredError}
|
|
11414
|
+
*/
|
|
11415
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
|
|
11306
11416
|
/**
|
|
11307
11417
|
*
|
|
11308
11418
|
* @summary Get an invoice pdf.
|
|
@@ -11310,7 +11420,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11310
11420
|
* @param {*} [options] Override http request option.
|
|
11311
11421
|
* @throws {RequiredError}
|
|
11312
11422
|
*/
|
|
11313
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11423
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11314
11424
|
/**
|
|
11315
11425
|
*
|
|
11316
11426
|
* @summary Returns a single invoice in the system.
|
|
@@ -11403,10 +11513,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11403
11513
|
readonly invoiceId?: number;
|
|
11404
11514
|
/**
|
|
11405
11515
|
* Filter based on Invoice State.
|
|
11406
|
-
* @type {Array<
|
|
11516
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11407
11517
|
* @memberof InvoicesApiGetAllInvoices
|
|
11408
11518
|
*/
|
|
11409
|
-
readonly currentState?:
|
|
11519
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11410
11520
|
/**
|
|
11411
11521
|
* Boolean if invoice entries should be returned
|
|
11412
11522
|
* @type {boolean}
|
|
@@ -11425,6 +11535,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11425
11535
|
* @memberof InvoicesApiGetAllInvoices
|
|
11426
11536
|
*/
|
|
11427
11537
|
readonly tillDate?: string;
|
|
11538
|
+
/**
|
|
11539
|
+
* Filter invoices by description (partial match)
|
|
11540
|
+
* @type {string}
|
|
11541
|
+
* @memberof InvoicesApiGetAllInvoices
|
|
11542
|
+
*/
|
|
11543
|
+
readonly description?: string;
|
|
11428
11544
|
/**
|
|
11429
11545
|
* How many entries the endpoint should return
|
|
11430
11546
|
* @type {number}
|
|
@@ -11457,204 +11573,693 @@ export interface InvoicesApiGetEligibleTransactionsRequest {
|
|
|
11457
11573
|
*/
|
|
11458
11574
|
readonly fromDate: string;
|
|
11459
11575
|
/**
|
|
11460
|
-
* End date for selected transactions (exclusive)
|
|
11461
|
-
* @type {string}
|
|
11462
|
-
* @memberof InvoicesApiGetEligibleTransactions
|
|
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
|
+
};
|
|
11953
|
+
/**
|
|
11954
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11955
|
+
* @export
|
|
11956
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11957
|
+
*/
|
|
11958
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11959
|
+
/**
|
|
11960
|
+
* UUID v4 of the payment request.
|
|
11961
|
+
* @type {string}
|
|
11962
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11963
|
+
*/
|
|
11964
|
+
readonly id: string;
|
|
11965
|
+
}
|
|
11966
|
+
/**
|
|
11967
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11968
|
+
* @export
|
|
11969
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11970
|
+
*/
|
|
11971
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11972
|
+
/**
|
|
11973
|
+
* The request to create
|
|
11974
|
+
* @type {CreatePaymentRequestRequest}
|
|
11975
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11463
11976
|
*/
|
|
11464
|
-
readonly
|
|
11977
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11465
11978
|
}
|
|
11466
11979
|
/**
|
|
11467
|
-
* Request parameters for
|
|
11980
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11468
11981
|
* @export
|
|
11469
|
-
* @interface
|
|
11982
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11470
11983
|
*/
|
|
11471
|
-
export interface
|
|
11984
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11472
11985
|
/**
|
|
11473
|
-
*
|
|
11986
|
+
* Filter by beneficiary user id.
|
|
11474
11987
|
* @type {number}
|
|
11475
|
-
* @memberof
|
|
11988
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11476
11989
|
*/
|
|
11477
|
-
readonly
|
|
11990
|
+
readonly forId?: number;
|
|
11478
11991
|
/**
|
|
11479
|
-
*
|
|
11480
|
-
* @type {
|
|
11481
|
-
* @memberof
|
|
11992
|
+
* Filter by creator user id.
|
|
11993
|
+
* @type {number}
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11482
11995
|
*/
|
|
11483
|
-
readonly
|
|
11484
|
-
}
|
|
11485
|
-
/**
|
|
11486
|
-
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11487
|
-
* @export
|
|
11488
|
-
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11489
|
-
*/
|
|
11490
|
-
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11996
|
+
readonly createdById?: number;
|
|
11491
11997
|
/**
|
|
11492
|
-
*
|
|
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
|
|
11493
12017
|
* @type {number}
|
|
11494
|
-
* @memberof
|
|
12018
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11495
12019
|
*/
|
|
11496
|
-
readonly
|
|
12020
|
+
readonly take?: number;
|
|
11497
12021
|
/**
|
|
11498
|
-
*
|
|
11499
|
-
* @type {
|
|
11500
|
-
* @memberof
|
|
12022
|
+
* How many rows to skip (for pagination)
|
|
12023
|
+
* @type {number}
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11501
12025
|
*/
|
|
11502
|
-
readonly
|
|
12026
|
+
readonly skip?: number;
|
|
11503
12027
|
}
|
|
11504
12028
|
/**
|
|
11505
|
-
* Request parameters for
|
|
12029
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11506
12030
|
* @export
|
|
11507
|
-
* @interface
|
|
12031
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11508
12032
|
*/
|
|
11509
|
-
export interface
|
|
12033
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11510
12034
|
/**
|
|
11511
|
-
*
|
|
11512
|
-
* @type {
|
|
11513
|
-
* @memberof
|
|
12035
|
+
* UUID v4 of the payment request.
|
|
12036
|
+
* @type {string}
|
|
12037
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11514
12038
|
*/
|
|
11515
|
-
readonly id:
|
|
12039
|
+
readonly id: string;
|
|
11516
12040
|
}
|
|
11517
12041
|
/**
|
|
11518
|
-
* Request parameters for
|
|
12042
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11519
12043
|
* @export
|
|
11520
|
-
* @interface
|
|
12044
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11521
12045
|
*/
|
|
11522
|
-
export interface
|
|
12046
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11523
12047
|
/**
|
|
11524
|
-
*
|
|
11525
|
-
* @type {
|
|
11526
|
-
* @memberof
|
|
12048
|
+
* UUID v4 of the payment request.
|
|
12049
|
+
* @type {string}
|
|
12050
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11527
12051
|
*/
|
|
11528
|
-
readonly id:
|
|
12052
|
+
readonly id: string;
|
|
11529
12053
|
/**
|
|
11530
|
-
* The
|
|
11531
|
-
* @type {
|
|
11532
|
-
* @memberof
|
|
12054
|
+
* The audit reason
|
|
12055
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11533
12057
|
*/
|
|
11534
|
-
readonly
|
|
12058
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11535
12059
|
}
|
|
11536
12060
|
/**
|
|
11537
|
-
* Request parameters for
|
|
12061
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11538
12062
|
* @export
|
|
11539
|
-
* @interface
|
|
12063
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11540
12064
|
*/
|
|
11541
|
-
export interface
|
|
11542
|
-
/**
|
|
11543
|
-
* The id of the invoice which should be updated
|
|
11544
|
-
* @type {number}
|
|
11545
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11546
|
-
*/
|
|
11547
|
-
readonly id: number;
|
|
12065
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11548
12066
|
/**
|
|
11549
|
-
*
|
|
11550
|
-
* @type {
|
|
11551
|
-
* @memberof
|
|
12067
|
+
* UUID v4 of the payment request.
|
|
12068
|
+
* @type {string}
|
|
12069
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11552
12070
|
*/
|
|
11553
|
-
readonly
|
|
12071
|
+
readonly id: string;
|
|
11554
12072
|
}
|
|
11555
12073
|
/**
|
|
11556
|
-
*
|
|
12074
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11557
12075
|
* @export
|
|
11558
|
-
* @class
|
|
12076
|
+
* @class PaymentRequestsApi
|
|
11559
12077
|
* @extends {BaseAPI}
|
|
11560
12078
|
*/
|
|
11561
|
-
export declare class
|
|
12079
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11562
12080
|
/**
|
|
11563
12081
|
*
|
|
11564
|
-
* @summary
|
|
11565
|
-
* @param {
|
|
12082
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12083
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11566
12084
|
* @param {*} [options] Override http request option.
|
|
11567
12085
|
* @throws {RequiredError}
|
|
11568
|
-
* @memberof
|
|
12086
|
+
* @memberof PaymentRequestsApi
|
|
11569
12087
|
*/
|
|
11570
|
-
|
|
12088
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11571
12089
|
/**
|
|
11572
12090
|
*
|
|
11573
|
-
* @summary
|
|
11574
|
-
* @param {
|
|
12091
|
+
* @summary Create a new PaymentRequest.
|
|
12092
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11575
12093
|
* @param {*} [options] Override http request option.
|
|
11576
12094
|
* @throws {RequiredError}
|
|
11577
|
-
* @memberof
|
|
12095
|
+
* @memberof PaymentRequestsApi
|
|
11578
12096
|
*/
|
|
11579
|
-
|
|
12097
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11580
12098
|
/**
|
|
11581
12099
|
*
|
|
11582
|
-
* @summary
|
|
11583
|
-
* @param {
|
|
12100
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12101
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11584
12102
|
* @param {*} [options] Override http request option.
|
|
11585
12103
|
* @throws {RequiredError}
|
|
11586
|
-
* @memberof
|
|
12104
|
+
* @memberof PaymentRequestsApi
|
|
11587
12105
|
*/
|
|
11588
|
-
|
|
12106
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11589
12107
|
/**
|
|
11590
12108
|
*
|
|
11591
|
-
* @summary
|
|
11592
|
-
* @param {
|
|
12109
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12110
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11593
12111
|
* @param {*} [options] Override http request option.
|
|
11594
12112
|
* @throws {RequiredError}
|
|
11595
|
-
* @memberof
|
|
12113
|
+
* @memberof PaymentRequestsApi
|
|
11596
12114
|
*/
|
|
11597
|
-
|
|
12115
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11598
12116
|
/**
|
|
11599
12117
|
*
|
|
11600
|
-
* @summary
|
|
11601
|
-
* @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.
|
|
11602
12120
|
* @param {*} [options] Override http request option.
|
|
11603
12121
|
* @throws {RequiredError}
|
|
11604
|
-
* @memberof
|
|
12122
|
+
* @memberof PaymentRequestsApi
|
|
11605
12123
|
*/
|
|
11606
|
-
|
|
12124
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11607
12125
|
/**
|
|
11608
12126
|
*
|
|
11609
|
-
* @summary
|
|
11610
|
-
* @param {
|
|
12127
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12128
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11611
12129
|
* @param {*} [options] Override http request option.
|
|
11612
12130
|
* @throws {RequiredError}
|
|
11613
|
-
* @memberof
|
|
12131
|
+
* @memberof PaymentRequestsApi
|
|
11614
12132
|
*/
|
|
11615
|
-
|
|
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) => {
|
|
11616
12150
|
/**
|
|
11617
12151
|
*
|
|
11618
|
-
* @summary Returns a
|
|
11619
|
-
* @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.
|
|
11620
12154
|
* @param {*} [options] Override http request option.
|
|
11621
12155
|
* @throws {RequiredError}
|
|
11622
|
-
* @memberof InvoicesApi
|
|
11623
12156
|
*/
|
|
11624
|
-
|
|
12157
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11625
12158
|
/**
|
|
11626
12159
|
*
|
|
11627
|
-
* @summary
|
|
11628
|
-
* @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.
|
|
11629
12162
|
* @param {*} [options] Override http request option.
|
|
11630
12163
|
* @throws {RequiredError}
|
|
11631
|
-
* @memberof InvoicesApi
|
|
11632
12164
|
*/
|
|
11633
|
-
|
|
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) => {
|
|
11634
12172
|
/**
|
|
11635
12173
|
*
|
|
11636
|
-
* @summary
|
|
11637
|
-
* @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.
|
|
11638
12176
|
* @param {*} [options] Override http request option.
|
|
11639
12177
|
* @throws {RequiredError}
|
|
11640
|
-
* @memberof InvoicesApi
|
|
11641
12178
|
*/
|
|
11642
|
-
|
|
12179
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11643
12180
|
/**
|
|
11644
12181
|
*
|
|
11645
|
-
* @summary
|
|
11646
|
-
* @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.
|
|
11647
12184
|
* @param {*} [options] Override http request option.
|
|
11648
12185
|
* @throws {RequiredError}
|
|
11649
|
-
* @memberof InvoicesApi
|
|
11650
12186
|
*/
|
|
11651
|
-
|
|
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) => {
|
|
12194
|
+
/**
|
|
12195
|
+
*
|
|
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.
|
|
12198
|
+
* @param {*} [options] Override http request option.
|
|
12199
|
+
* @throws {RequiredError}
|
|
12200
|
+
*/
|
|
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;
|
|
11652
12236
|
}
|
|
11653
12237
|
/**
|
|
12238
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
11654
12239
|
* @export
|
|
12240
|
+
* @class PaymentRequestsPublicApi
|
|
12241
|
+
* @extends {BaseAPI}
|
|
11655
12242
|
*/
|
|
11656
|
-
export declare
|
|
11657
|
-
|
|
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, {}>>;
|
|
12262
|
+
}
|
|
11658
12263
|
/**
|
|
11659
12264
|
* PayoutRequestsApi - axios parameter creator
|
|
11660
12265
|
* @export
|
|
@@ -14209,11 +14814,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
14209
14814
|
/**
|
|
14210
14815
|
* Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
|
|
14211
14816
|
* @summary Get dry-run sync results for users
|
|
14212
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14817
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14213
14818
|
* @param {*} [options] Override http request option.
|
|
14214
14819
|
* @throws {RequiredError}
|
|
14215
14820
|
*/
|
|
14216
|
-
getUserSyncResults: (service?: GetUserSyncResultsServiceEnum
|
|
14821
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14217
14822
|
};
|
|
14218
14823
|
/**
|
|
14219
14824
|
* SyncApi - functional programming interface
|
|
@@ -14223,11 +14828,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
|
14223
14828
|
/**
|
|
14224
14829
|
* Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
|
|
14225
14830
|
* @summary Get dry-run sync results for users
|
|
14226
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14831
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14227
14832
|
* @param {*} [options] Override http request option.
|
|
14228
14833
|
* @throws {RequiredError}
|
|
14229
14834
|
*/
|
|
14230
|
-
getUserSyncResults(service?: GetUserSyncResultsServiceEnum
|
|
14835
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14231
14836
|
};
|
|
14232
14837
|
/**
|
|
14233
14838
|
* SyncApi - factory interface
|
|
@@ -14251,10 +14856,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14251
14856
|
export interface SyncApiGetUserSyncResultsRequest {
|
|
14252
14857
|
/**
|
|
14253
14858
|
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14254
|
-
* @type {Array<
|
|
14859
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
14255
14860
|
* @memberof SyncApiGetUserSyncResults
|
|
14256
14861
|
*/
|
|
14257
|
-
readonly service?: GetUserSyncResultsServiceEnum
|
|
14862
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
14258
14863
|
}
|
|
14259
14864
|
/**
|
|
14260
14865
|
* SyncApi - object-oriented interface
|
|
@@ -14276,7 +14881,10 @@ export declare class SyncApi extends BaseAPI {
|
|
|
14276
14881
|
/**
|
|
14277
14882
|
* @export
|
|
14278
14883
|
*/
|
|
14279
|
-
export declare const GetUserSyncResultsServiceEnum: {
|
|
14884
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
14885
|
+
readonly Ldap: "LDAP";
|
|
14886
|
+
readonly Gewisdb: "GEWISDB";
|
|
14887
|
+
};
|
|
14280
14888
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14281
14889
|
/**
|
|
14282
14890
|
* TermsOfServiceApi - axios parameter creator
|
|
@@ -15026,12 +15634,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15026
15634
|
* @summary Returns all existing transfers
|
|
15027
15635
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15028
15636
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15637
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15638
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15639
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15029
15640
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15030
15641
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15031
15642
|
* @param {*} [options] Override http request option.
|
|
15032
15643
|
* @throws {RequiredError}
|
|
15033
15644
|
*/
|
|
15034
|
-
getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15645
|
+
getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15035
15646
|
/**
|
|
15036
15647
|
*
|
|
15037
15648
|
* @summary Returns the requested transfer
|
|
@@ -15098,12 +15709,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15098
15709
|
* @summary Returns all existing transfers
|
|
15099
15710
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15100
15711
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15712
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15713
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15714
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15101
15715
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15102
15716
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15103
15717
|
* @param {*} [options] Override http request option.
|
|
15104
15718
|
* @throws {RequiredError}
|
|
15105
15719
|
*/
|
|
15106
|
-
getAllTransfers(fromDate?: string, tillDate?: 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>>;
|
|
15107
15721
|
/**
|
|
15108
15722
|
*
|
|
15109
15723
|
* @summary Returns the requested transfer
|
|
@@ -15172,7 +15786,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15172
15786
|
* @param {*} [options] Override http request option.
|
|
15173
15787
|
* @throws {RequiredError}
|
|
15174
15788
|
*/
|
|
15175
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15789
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15176
15790
|
/**
|
|
15177
15791
|
*
|
|
15178
15792
|
* @summary Returns the requested transfer
|
|
@@ -15250,6 +15864,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15250
15864
|
* @memberof TransfersApiGetAllTransfers
|
|
15251
15865
|
*/
|
|
15252
15866
|
readonly tillDate?: string;
|
|
15867
|
+
/**
|
|
15868
|
+
* Filter transfers from this user ID
|
|
15869
|
+
* @type {number}
|
|
15870
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15871
|
+
*/
|
|
15872
|
+
readonly fromId?: number;
|
|
15873
|
+
/**
|
|
15874
|
+
* Filter transfers to this user ID
|
|
15875
|
+
* @type {number}
|
|
15876
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15877
|
+
*/
|
|
15878
|
+
readonly toId?: number;
|
|
15879
|
+
/**
|
|
15880
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15881
|
+
* @type {string}
|
|
15882
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15883
|
+
*/
|
|
15884
|
+
readonly category?: string;
|
|
15253
15885
|
/**
|
|
15254
15886
|
* How many transfers the endpoint should return
|
|
15255
15887
|
* @type {number}
|
|
@@ -15390,7 +16022,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15390
16022
|
* @throws {RequiredError}
|
|
15391
16023
|
* @memberof TransfersApi
|
|
15392
16024
|
*/
|
|
15393
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16025
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15394
16026
|
/**
|
|
15395
16027
|
*
|
|
15396
16028
|
* @summary Returns the requested transfer
|
|
@@ -15791,6 +16423,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15791
16423
|
* @throws {RequiredError}
|
|
15792
16424
|
*/
|
|
15793
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>;
|
|
15794
16440
|
/**
|
|
15795
16441
|
*
|
|
15796
16442
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16153,6 +16799,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16153
16799
|
* @throws {RequiredError}
|
|
16154
16800
|
*/
|
|
16155
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>>;
|
|
16156
16816
|
/**
|
|
16157
16817
|
*
|
|
16158
16818
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16497,6 +17157,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16497
17157
|
* @throws {RequiredError}
|
|
16498
17158
|
*/
|
|
16499
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>;
|
|
16500
17168
|
/**
|
|
16501
17169
|
*
|
|
16502
17170
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16988,6 +17656,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16988
17656
|
*/
|
|
16989
17657
|
readonly skip?: number;
|
|
16990
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
|
+
}
|
|
16991
17708
|
/**
|
|
16992
17709
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16993
17710
|
* @export
|
|
@@ -17654,6 +18371,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17654
18371
|
* @memberof UsersApi
|
|
17655
18372
|
*/
|
|
17656
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, {}>>;
|
|
17657
18383
|
/**
|
|
17658
18384
|
*
|
|
17659
18385
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17849,6 +18575,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17849
18575
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17850
18576
|
};
|
|
17851
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];
|
|
17852
18588
|
/**
|
|
17853
18589
|
* @export
|
|
17854
18590
|
*/
|