@gewis/sudosos-client 0.0.0-develop.d4ebe23 → 0.0.0-develop.d63760f
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 +1341 -462
- package/dist/api.js +1123 -453
- package/dist/base.js +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
|
|
@@ -5064,6 +5297,12 @@ export interface TermsOfServiceResponse {
|
|
|
5064
5297
|
* @memberof TermsOfServiceResponse
|
|
5065
5298
|
*/
|
|
5066
5299
|
'versionNumber': string;
|
|
5300
|
+
/**
|
|
5301
|
+
* The date this version took effect.
|
|
5302
|
+
* @type {string}
|
|
5303
|
+
* @memberof TermsOfServiceResponse
|
|
5304
|
+
*/
|
|
5305
|
+
'date': string;
|
|
5067
5306
|
/**
|
|
5068
5307
|
* The terms of service content.
|
|
5069
5308
|
* @type {string}
|
|
@@ -5084,23 +5323,23 @@ export interface TotalBalanceResponse {
|
|
|
5084
5323
|
*/
|
|
5085
5324
|
'date': string;
|
|
5086
5325
|
/**
|
|
5087
|
-
*
|
|
5088
|
-
* @type {
|
|
5326
|
+
*
|
|
5327
|
+
* @type {DineroObjectResponse}
|
|
5089
5328
|
* @memberof TotalBalanceResponse
|
|
5090
5329
|
*/
|
|
5091
|
-
'totalPositive':
|
|
5330
|
+
'totalPositive': DineroObjectResponse;
|
|
5092
5331
|
/**
|
|
5093
|
-
*
|
|
5094
|
-
* @type {
|
|
5332
|
+
*
|
|
5333
|
+
* @type {DineroObjectResponse}
|
|
5095
5334
|
* @memberof TotalBalanceResponse
|
|
5096
5335
|
*/
|
|
5097
|
-
'totalNegative':
|
|
5336
|
+
'totalNegative': DineroObjectResponse;
|
|
5098
5337
|
/**
|
|
5099
|
-
*
|
|
5100
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5338
|
+
* The total balances for the different user types
|
|
5339
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5101
5340
|
* @memberof TotalBalanceResponse
|
|
5102
5341
|
*/
|
|
5103
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5342
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5104
5343
|
}
|
|
5105
5344
|
/**
|
|
5106
5345
|
*
|
|
@@ -5608,6 +5847,85 @@ export interface TransferResponse {
|
|
|
5608
5847
|
/**
|
|
5609
5848
|
*
|
|
5610
5849
|
* @export
|
|
5850
|
+
* @interface TransferSummaryResponse
|
|
5851
|
+
*/
|
|
5852
|
+
export interface TransferSummaryResponse {
|
|
5853
|
+
/**
|
|
5854
|
+
*
|
|
5855
|
+
* @type {TransferAggregateResponse}
|
|
5856
|
+
* @memberof TransferSummaryResponse
|
|
5857
|
+
*/
|
|
5858
|
+
'total': TransferAggregateResponse;
|
|
5859
|
+
/**
|
|
5860
|
+
*
|
|
5861
|
+
* @type {TransferAggregateResponse}
|
|
5862
|
+
* @memberof TransferSummaryResponse
|
|
5863
|
+
*/
|
|
5864
|
+
'deposits': TransferAggregateResponse;
|
|
5865
|
+
/**
|
|
5866
|
+
*
|
|
5867
|
+
* @type {TransferAggregateResponse}
|
|
5868
|
+
* @memberof TransferSummaryResponse
|
|
5869
|
+
*/
|
|
5870
|
+
'payoutRequests': TransferAggregateResponse;
|
|
5871
|
+
/**
|
|
5872
|
+
*
|
|
5873
|
+
* @type {TransferAggregateResponse}
|
|
5874
|
+
* @memberof TransferSummaryResponse
|
|
5875
|
+
*/
|
|
5876
|
+
'sellerPayouts': TransferAggregateResponse;
|
|
5877
|
+
/**
|
|
5878
|
+
*
|
|
5879
|
+
* @type {TransferAggregateResponse}
|
|
5880
|
+
* @memberof TransferSummaryResponse
|
|
5881
|
+
*/
|
|
5882
|
+
'invoices': TransferAggregateResponse;
|
|
5883
|
+
/**
|
|
5884
|
+
*
|
|
5885
|
+
* @type {TransferAggregateResponse}
|
|
5886
|
+
* @memberof TransferSummaryResponse
|
|
5887
|
+
*/
|
|
5888
|
+
'creditInvoices': TransferAggregateResponse;
|
|
5889
|
+
/**
|
|
5890
|
+
*
|
|
5891
|
+
* @type {TransferAggregateResponse}
|
|
5892
|
+
* @memberof TransferSummaryResponse
|
|
5893
|
+
*/
|
|
5894
|
+
'fines': TransferAggregateResponse;
|
|
5895
|
+
/**
|
|
5896
|
+
*
|
|
5897
|
+
* @type {TransferAggregateResponse}
|
|
5898
|
+
* @memberof TransferSummaryResponse
|
|
5899
|
+
*/
|
|
5900
|
+
'waivedFines': TransferAggregateResponse;
|
|
5901
|
+
/**
|
|
5902
|
+
*
|
|
5903
|
+
* @type {TransferAggregateResponse}
|
|
5904
|
+
* @memberof TransferSummaryResponse
|
|
5905
|
+
*/
|
|
5906
|
+
'writeOffs': TransferAggregateResponse;
|
|
5907
|
+
/**
|
|
5908
|
+
*
|
|
5909
|
+
* @type {TransferAggregateResponse}
|
|
5910
|
+
* @memberof TransferSummaryResponse
|
|
5911
|
+
*/
|
|
5912
|
+
'inactiveAdministrativeCosts': TransferAggregateResponse;
|
|
5913
|
+
/**
|
|
5914
|
+
*
|
|
5915
|
+
* @type {TransferAggregateResponse}
|
|
5916
|
+
* @memberof TransferSummaryResponse
|
|
5917
|
+
*/
|
|
5918
|
+
'manualCreations': TransferAggregateResponse;
|
|
5919
|
+
/**
|
|
5920
|
+
*
|
|
5921
|
+
* @type {TransferAggregateResponse}
|
|
5922
|
+
* @memberof TransferSummaryResponse
|
|
5923
|
+
*/
|
|
5924
|
+
'manualDeletions': TransferAggregateResponse;
|
|
5925
|
+
}
|
|
5926
|
+
/**
|
|
5927
|
+
* API Request for updating a `container` entity.
|
|
5928
|
+
* @export
|
|
5611
5929
|
* @interface UpdateContainerRequest
|
|
5612
5930
|
*/
|
|
5613
5931
|
export interface UpdateContainerRequest {
|
|
@@ -5856,7 +6174,7 @@ export interface UpdatePinRequest {
|
|
|
5856
6174
|
'pin': string;
|
|
5857
6175
|
}
|
|
5858
6176
|
/**
|
|
5859
|
-
*
|
|
6177
|
+
* API Request for updating a `point of sale` entity.
|
|
5860
6178
|
* @export
|
|
5861
6179
|
* @interface UpdatePointOfSaleRequest
|
|
5862
6180
|
*/
|
|
@@ -5893,7 +6211,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
5893
6211
|
'cashierRoleIds'?: Array<number>;
|
|
5894
6212
|
}
|
|
5895
6213
|
/**
|
|
5896
|
-
*
|
|
6214
|
+
* API Request for updating a `product` entity.
|
|
5897
6215
|
* @export
|
|
5898
6216
|
* @interface UpdateProductRequest
|
|
5899
6217
|
*/
|
|
@@ -6058,9 +6376,15 @@ export interface UpdateUserRequest {
|
|
|
6058
6376
|
* @memberof UpdateUserRequest
|
|
6059
6377
|
*/
|
|
6060
6378
|
'inactiveNotificationSend'?: boolean;
|
|
6379
|
+
/**
|
|
6380
|
+
* ISO date at which the account expires; pass null to clear
|
|
6381
|
+
* @type {string}
|
|
6382
|
+
* @memberof UpdateUserRequest
|
|
6383
|
+
*/
|
|
6384
|
+
'expiryDate'?: string | null;
|
|
6061
6385
|
}
|
|
6062
6386
|
/**
|
|
6063
|
-
*
|
|
6387
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6064
6388
|
* @export
|
|
6065
6389
|
* @interface UpdateVatGroupRequest
|
|
6066
6390
|
*/
|
|
@@ -6274,6 +6598,12 @@ export interface UserResponse {
|
|
|
6274
6598
|
* @memberof UserResponse
|
|
6275
6599
|
*/
|
|
6276
6600
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6601
|
+
/**
|
|
6602
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6603
|
+
* @type {string}
|
|
6604
|
+
* @memberof UserResponse
|
|
6605
|
+
*/
|
|
6606
|
+
'expiryDate'?: string | null;
|
|
6277
6607
|
}
|
|
6278
6608
|
/**
|
|
6279
6609
|
*
|
|
@@ -6380,6 +6710,22 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6380
6710
|
*/
|
|
6381
6711
|
'nickname'?: string;
|
|
6382
6712
|
}
|
|
6713
|
+
/**
|
|
6714
|
+
* The type of a user
|
|
6715
|
+
* @export
|
|
6716
|
+
* @enum {string}
|
|
6717
|
+
*/
|
|
6718
|
+
export declare const UserType: {
|
|
6719
|
+
readonly Member: "MEMBER";
|
|
6720
|
+
readonly Organ: "ORGAN";
|
|
6721
|
+
readonly Voucher: "VOUCHER";
|
|
6722
|
+
readonly LocalUser: "LOCAL_USER";
|
|
6723
|
+
readonly LocalAdmin: "LOCAL_ADMIN";
|
|
6724
|
+
readonly Invoice: "INVOICE";
|
|
6725
|
+
readonly PointOfSale: "POINT_OF_SALE";
|
|
6726
|
+
readonly Integration: "INTEGRATION";
|
|
6727
|
+
};
|
|
6728
|
+
export type UserType = typeof UserType[keyof typeof UserType];
|
|
6383
6729
|
/**
|
|
6384
6730
|
*
|
|
6385
6731
|
* @export
|
|
@@ -6406,7 +6752,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6406
6752
|
'totalNegative': DineroObjectResponse;
|
|
6407
6753
|
}
|
|
6408
6754
|
/**
|
|
6409
|
-
*
|
|
6755
|
+
* A `BaseUserResponse` augmented with a stable position index, used to keep ordered user lists (e.g. POS owner members) rendering in a consistent order across requests.
|
|
6410
6756
|
* @export
|
|
6411
6757
|
* @interface UserWithIndex
|
|
6412
6758
|
*/
|
|
@@ -6421,6 +6767,25 @@ export interface UserWithIndex {
|
|
|
6421
6767
|
/**
|
|
6422
6768
|
*
|
|
6423
6769
|
* @export
|
|
6770
|
+
* @interface ValidationResponse
|
|
6771
|
+
*/
|
|
6772
|
+
export interface ValidationResponse {
|
|
6773
|
+
/**
|
|
6774
|
+
* Whether the request passed validation.
|
|
6775
|
+
* @type {boolean}
|
|
6776
|
+
* @memberof ValidationResponse
|
|
6777
|
+
*/
|
|
6778
|
+
'valid': boolean;
|
|
6779
|
+
/**
|
|
6780
|
+
* List of validation error messages.
|
|
6781
|
+
* @type {Array<string>}
|
|
6782
|
+
* @memberof ValidationResponse
|
|
6783
|
+
*/
|
|
6784
|
+
'errors': Array<string>;
|
|
6785
|
+
}
|
|
6786
|
+
/**
|
|
6787
|
+
* API Response for a complete VAT declaration — one result table for a given year and period, containing one {@link VatDeclarationRow} per VAT group.
|
|
6788
|
+
* @export
|
|
6424
6789
|
* @interface VatDeclarationResponse
|
|
6425
6790
|
*/
|
|
6426
6791
|
export interface VatDeclarationResponse {
|
|
@@ -6444,7 +6809,7 @@ export interface VatDeclarationResponse {
|
|
|
6444
6809
|
'rows': Array<VatDeclarationRow>;
|
|
6445
6810
|
}
|
|
6446
6811
|
/**
|
|
6447
|
-
*
|
|
6812
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6448
6813
|
* @export
|
|
6449
6814
|
* @interface VatDeclarationRow
|
|
6450
6815
|
*/
|
|
@@ -6912,10 +7277,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6912
7277
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6913
7278
|
/**
|
|
6914
7279
|
*
|
|
6915
|
-
* @summary EAN
|
|
6916
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7280
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7281
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
6917
7282
|
* @param {*} [options] Override http request option.
|
|
6918
|
-
* @deprecated
|
|
6919
7283
|
* @throws {RequiredError}
|
|
6920
7284
|
*/
|
|
6921
7285
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6990,13 +7354,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6990
7354
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6991
7355
|
/**
|
|
6992
7356
|
*
|
|
6993
|
-
* @summary PIN
|
|
6994
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7357
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7358
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
6995
7359
|
* @param {*} [options] Override http request option.
|
|
6996
|
-
* @deprecated
|
|
6997
7360
|
* @throws {RequiredError}
|
|
6998
7361
|
*/
|
|
6999
|
-
|
|
7362
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7000
7363
|
/**
|
|
7001
7364
|
*
|
|
7002
7365
|
* @summary Mock login and hand out token.
|
|
@@ -7007,19 +7370,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7007
7370
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7008
7371
|
/**
|
|
7009
7372
|
*
|
|
7010
|
-
* @summary NFC
|
|
7011
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7373
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7374
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7012
7375
|
* @param {*} [options] Override http request option.
|
|
7013
|
-
* @deprecated
|
|
7014
7376
|
* @throws {RequiredError}
|
|
7015
7377
|
*/
|
|
7016
7378
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7017
7379
|
/**
|
|
7018
7380
|
*
|
|
7019
|
-
* @summary PIN
|
|
7020
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7381
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7382
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7021
7383
|
* @param {*} [options] Override http request option.
|
|
7022
|
-
* @deprecated
|
|
7023
7384
|
* @throws {RequiredError}
|
|
7024
7385
|
*/
|
|
7025
7386
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7046,38 +7407,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7046
7407
|
* @throws {RequiredError}
|
|
7047
7408
|
*/
|
|
7048
7409
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7049
|
-
/**
|
|
7050
|
-
*
|
|
7051
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7052
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7053
|
-
* @param {*} [options] Override http request option.
|
|
7054
|
-
* @throws {RequiredError}
|
|
7055
|
-
*/
|
|
7056
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7057
|
-
/**
|
|
7058
|
-
*
|
|
7059
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7060
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7061
|
-
* @param {*} [options] Override http request option.
|
|
7062
|
-
* @throws {RequiredError}
|
|
7063
|
-
*/
|
|
7064
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7065
|
-
/**
|
|
7066
|
-
*
|
|
7067
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7068
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7069
|
-
* @param {*} [options] Override http request option.
|
|
7070
|
-
* @throws {RequiredError}
|
|
7071
|
-
*/
|
|
7072
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7073
|
-
/**
|
|
7074
|
-
*
|
|
7075
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7076
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7077
|
-
* @param {*} [options] Override http request option.
|
|
7078
|
-
* @throws {RequiredError}
|
|
7079
|
-
*/
|
|
7080
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7081
7410
|
};
|
|
7082
7411
|
/**
|
|
7083
7412
|
* AuthenticateApi - functional programming interface
|
|
@@ -7110,10 +7439,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7110
7439
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7111
7440
|
/**
|
|
7112
7441
|
*
|
|
7113
|
-
* @summary EAN
|
|
7114
|
-
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login
|
|
7442
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7443
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7115
7444
|
* @param {*} [options] Override http request option.
|
|
7116
|
-
* @deprecated
|
|
7117
7445
|
* @throws {RequiredError}
|
|
7118
7446
|
*/
|
|
7119
7447
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7188,13 +7516,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7188
7516
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7189
7517
|
/**
|
|
7190
7518
|
*
|
|
7191
|
-
* @summary PIN
|
|
7192
|
-
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login
|
|
7519
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7520
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7193
7521
|
* @param {*} [options] Override http request option.
|
|
7194
|
-
* @deprecated
|
|
7195
7522
|
* @throws {RequiredError}
|
|
7196
7523
|
*/
|
|
7197
|
-
|
|
7524
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7198
7525
|
/**
|
|
7199
7526
|
*
|
|
7200
7527
|
* @summary Mock login and hand out token.
|
|
@@ -7205,19 +7532,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7205
7532
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7206
7533
|
/**
|
|
7207
7534
|
*
|
|
7208
|
-
* @summary NFC
|
|
7209
|
-
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login
|
|
7535
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7536
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7210
7537
|
* @param {*} [options] Override http request option.
|
|
7211
|
-
* @deprecated
|
|
7212
7538
|
* @throws {RequiredError}
|
|
7213
7539
|
*/
|
|
7214
7540
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7215
7541
|
/**
|
|
7216
7542
|
*
|
|
7217
|
-
* @summary PIN
|
|
7218
|
-
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login
|
|
7543
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7544
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7219
7545
|
* @param {*} [options] Override http request option.
|
|
7220
|
-
* @deprecated
|
|
7221
7546
|
* @throws {RequiredError}
|
|
7222
7547
|
*/
|
|
7223
7548
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7244,38 +7569,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7244
7569
|
* @throws {RequiredError}
|
|
7245
7570
|
*/
|
|
7246
7571
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7247
|
-
/**
|
|
7248
|
-
*
|
|
7249
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7250
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7251
|
-
* @param {*} [options] Override http request option.
|
|
7252
|
-
* @throws {RequiredError}
|
|
7253
|
-
*/
|
|
7254
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7255
|
-
/**
|
|
7256
|
-
*
|
|
7257
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7258
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7259
|
-
* @param {*} [options] Override http request option.
|
|
7260
|
-
* @throws {RequiredError}
|
|
7261
|
-
*/
|
|
7262
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7263
|
-
/**
|
|
7264
|
-
*
|
|
7265
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7266
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7267
|
-
* @param {*} [options] Override http request option.
|
|
7268
|
-
* @throws {RequiredError}
|
|
7269
|
-
*/
|
|
7270
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7271
|
-
/**
|
|
7272
|
-
*
|
|
7273
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7274
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7275
|
-
* @param {*} [options] Override http request option.
|
|
7276
|
-
* @throws {RequiredError}
|
|
7277
|
-
*/
|
|
7278
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7279
7572
|
};
|
|
7280
7573
|
/**
|
|
7281
7574
|
* AuthenticateApi - factory interface
|
|
@@ -7308,10 +7601,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7308
7601
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7309
7602
|
/**
|
|
7310
7603
|
*
|
|
7311
|
-
* @summary EAN
|
|
7604
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7312
7605
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7313
7606
|
* @param {*} [options] Override http request option.
|
|
7314
|
-
* @deprecated
|
|
7315
7607
|
* @throws {RequiredError}
|
|
7316
7608
|
*/
|
|
7317
7609
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7386,13 +7678,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7386
7678
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7387
7679
|
/**
|
|
7388
7680
|
*
|
|
7389
|
-
* @summary PIN
|
|
7390
|
-
* @param {
|
|
7681
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7682
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7391
7683
|
* @param {*} [options] Override http request option.
|
|
7392
|
-
* @deprecated
|
|
7393
7684
|
* @throws {RequiredError}
|
|
7394
7685
|
*/
|
|
7395
|
-
|
|
7686
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7396
7687
|
/**
|
|
7397
7688
|
*
|
|
7398
7689
|
* @summary Mock login and hand out token.
|
|
@@ -7403,19 +7694,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7403
7694
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7404
7695
|
/**
|
|
7405
7696
|
*
|
|
7406
|
-
* @summary NFC
|
|
7697
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7407
7698
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7408
7699
|
* @param {*} [options] Override http request option.
|
|
7409
|
-
* @deprecated
|
|
7410
7700
|
* @throws {RequiredError}
|
|
7411
7701
|
*/
|
|
7412
7702
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7413
7703
|
/**
|
|
7414
7704
|
*
|
|
7415
|
-
* @summary PIN
|
|
7705
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7416
7706
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7417
7707
|
* @param {*} [options] Override http request option.
|
|
7418
|
-
* @deprecated
|
|
7419
7708
|
* @throws {RequiredError}
|
|
7420
7709
|
*/
|
|
7421
7710
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7442,38 +7731,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7442
7731
|
* @throws {RequiredError}
|
|
7443
7732
|
*/
|
|
7444
7733
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7445
|
-
/**
|
|
7446
|
-
*
|
|
7447
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7448
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7449
|
-
* @param {*} [options] Override http request option.
|
|
7450
|
-
* @throws {RequiredError}
|
|
7451
|
-
*/
|
|
7452
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7453
|
-
/**
|
|
7454
|
-
*
|
|
7455
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7456
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7457
|
-
* @param {*} [options] Override http request option.
|
|
7458
|
-
* @throws {RequiredError}
|
|
7459
|
-
*/
|
|
7460
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7461
|
-
/**
|
|
7462
|
-
*
|
|
7463
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7464
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7465
|
-
* @param {*} [options] Override http request option.
|
|
7466
|
-
* @throws {RequiredError}
|
|
7467
|
-
*/
|
|
7468
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7469
|
-
/**
|
|
7470
|
-
*
|
|
7471
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7472
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7473
|
-
* @param {*} [options] Override http request option.
|
|
7474
|
-
* @throws {RequiredError}
|
|
7475
|
-
*/
|
|
7476
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7477
7734
|
};
|
|
7478
7735
|
/**
|
|
7479
7736
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7521,7 +7778,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7521
7778
|
*/
|
|
7522
7779
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7523
7780
|
/**
|
|
7524
|
-
* The EAN login
|
|
7781
|
+
* The EAN login request with posId
|
|
7525
7782
|
* @type {AuthenticationEanRequest}
|
|
7526
7783
|
* @memberof AuthenticateApiEanAuthentication
|
|
7527
7784
|
*/
|
|
@@ -7606,15 +7863,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7606
7863
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7607
7864
|
}
|
|
7608
7865
|
/**
|
|
7609
|
-
* Request parameters for
|
|
7866
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7610
7867
|
* @export
|
|
7611
|
-
* @interface
|
|
7868
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7612
7869
|
*/
|
|
7613
|
-
export interface
|
|
7870
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7614
7871
|
/**
|
|
7615
|
-
* The PIN login
|
|
7872
|
+
* The PIN login request with posId
|
|
7616
7873
|
* @type {MemberAuthenticationPinRequest}
|
|
7617
|
-
* @memberof
|
|
7874
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7618
7875
|
*/
|
|
7619
7876
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7620
7877
|
}
|
|
@@ -7638,7 +7895,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7638
7895
|
*/
|
|
7639
7896
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7640
7897
|
/**
|
|
7641
|
-
* The NFC login
|
|
7898
|
+
* The NFC login request with posId
|
|
7642
7899
|
* @type {AuthenticationNfcRequest}
|
|
7643
7900
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7644
7901
|
*/
|
|
@@ -7651,7 +7908,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7651
7908
|
*/
|
|
7652
7909
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7653
7910
|
/**
|
|
7654
|
-
* The PIN login
|
|
7911
|
+
* The PIN login request with posId
|
|
7655
7912
|
* @type {AuthenticationPinRequest}
|
|
7656
7913
|
* @memberof AuthenticateApiPinAuthentication
|
|
7657
7914
|
*/
|
|
@@ -7683,58 +7940,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7683
7940
|
*/
|
|
7684
7941
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7685
7942
|
}
|
|
7686
|
-
/**
|
|
7687
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7688
|
-
* @export
|
|
7689
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7690
|
-
*/
|
|
7691
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7692
|
-
/**
|
|
7693
|
-
* The EAN login request with posId
|
|
7694
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7695
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7696
|
-
*/
|
|
7697
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7698
|
-
}
|
|
7699
|
-
/**
|
|
7700
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7701
|
-
* @export
|
|
7702
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7703
|
-
*/
|
|
7704
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7705
|
-
/**
|
|
7706
|
-
* The PIN login request with posId
|
|
7707
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7708
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7709
|
-
*/
|
|
7710
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7711
|
-
}
|
|
7712
|
-
/**
|
|
7713
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7714
|
-
* @export
|
|
7715
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7716
|
-
*/
|
|
7717
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7718
|
-
/**
|
|
7719
|
-
* The NFC login request with posId
|
|
7720
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7721
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7722
|
-
*/
|
|
7723
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7724
|
-
}
|
|
7725
|
-
/**
|
|
7726
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7727
|
-
* @export
|
|
7728
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7729
|
-
*/
|
|
7730
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7731
|
-
/**
|
|
7732
|
-
* The PIN login request with posId
|
|
7733
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7734
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7735
|
-
*/
|
|
7736
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7737
|
-
}
|
|
7738
7943
|
/**
|
|
7739
7944
|
* AuthenticateApi - object-oriented interface
|
|
7740
7945
|
* @export
|
|
@@ -7771,10 +7976,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7771
7976
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7772
7977
|
/**
|
|
7773
7978
|
*
|
|
7774
|
-
* @summary EAN
|
|
7979
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7775
7980
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7776
7981
|
* @param {*} [options] Override http request option.
|
|
7777
|
-
* @deprecated
|
|
7778
7982
|
* @throws {RequiredError}
|
|
7779
7983
|
* @memberof AuthenticateApi
|
|
7780
7984
|
*/
|
|
@@ -7859,14 +8063,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7859
8063
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7860
8064
|
/**
|
|
7861
8065
|
*
|
|
7862
|
-
* @summary PIN
|
|
7863
|
-
* @param {
|
|
8066
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8067
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7864
8068
|
* @param {*} [options] Override http request option.
|
|
7865
|
-
* @deprecated
|
|
7866
8069
|
* @throws {RequiredError}
|
|
7867
8070
|
* @memberof AuthenticateApi
|
|
7868
8071
|
*/
|
|
7869
|
-
|
|
8072
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7870
8073
|
/**
|
|
7871
8074
|
*
|
|
7872
8075
|
* @summary Mock login and hand out token.
|
|
@@ -7878,20 +8081,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7878
8081
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7879
8082
|
/**
|
|
7880
8083
|
*
|
|
7881
|
-
* @summary NFC
|
|
8084
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7882
8085
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7883
8086
|
* @param {*} [options] Override http request option.
|
|
7884
|
-
* @deprecated
|
|
7885
8087
|
* @throws {RequiredError}
|
|
7886
8088
|
* @memberof AuthenticateApi
|
|
7887
8089
|
*/
|
|
7888
8090
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7889
8091
|
/**
|
|
7890
8092
|
*
|
|
7891
|
-
* @summary PIN
|
|
8093
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7892
8094
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7893
8095
|
* @param {*} [options] Override http request option.
|
|
7894
|
-
* @deprecated
|
|
7895
8096
|
* @throws {RequiredError}
|
|
7896
8097
|
* @memberof AuthenticateApi
|
|
7897
8098
|
*/
|
|
@@ -7922,42 +8123,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7922
8123
|
* @memberof AuthenticateApi
|
|
7923
8124
|
*/
|
|
7924
8125
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7925
|
-
/**
|
|
7926
|
-
*
|
|
7927
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7928
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7929
|
-
* @param {*} [options] Override http request option.
|
|
7930
|
-
* @throws {RequiredError}
|
|
7931
|
-
* @memberof AuthenticateApi
|
|
7932
|
-
*/
|
|
7933
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7934
|
-
/**
|
|
7935
|
-
*
|
|
7936
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7937
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7938
|
-
* @param {*} [options] Override http request option.
|
|
7939
|
-
* @throws {RequiredError}
|
|
7940
|
-
* @memberof AuthenticateApi
|
|
7941
|
-
*/
|
|
7942
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7943
|
-
/**
|
|
7944
|
-
*
|
|
7945
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7946
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7947
|
-
* @param {*} [options] Override http request option.
|
|
7948
|
-
* @throws {RequiredError}
|
|
7949
|
-
* @memberof AuthenticateApi
|
|
7950
|
-
*/
|
|
7951
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7952
|
-
/**
|
|
7953
|
-
*
|
|
7954
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7955
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7956
|
-
* @param {*} [options] Override http request option.
|
|
7957
|
-
* @throws {RequiredError}
|
|
7958
|
-
* @memberof AuthenticateApi
|
|
7959
|
-
*/
|
|
7960
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7961
8126
|
}
|
|
7962
8127
|
/**
|
|
7963
8128
|
* BalanceApi - axios parameter creator
|
|
@@ -7982,7 +8147,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7982
8147
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
7983
8148
|
* @param {number} [minFine] Minimum fine
|
|
7984
8149
|
* @param {number} [maxFine] Maximum fine
|
|
7985
|
-
* @param {
|
|
8150
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
7986
8151
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
7987
8152
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
7988
8153
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -7992,7 +8157,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7992
8157
|
* @param {*} [options] Override http request option.
|
|
7993
8158
|
* @throws {RequiredError}
|
|
7994
8159
|
*/
|
|
7995
|
-
getAllBalance: (date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8160
|
+
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>;
|
|
7996
8161
|
/**
|
|
7997
8162
|
*
|
|
7998
8163
|
* @summary Retrieves the requested balance
|
|
@@ -8032,7 +8197,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8032
8197
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8033
8198
|
* @param {number} [minFine] Minimum fine
|
|
8034
8199
|
* @param {number} [maxFine] Maximum fine
|
|
8035
|
-
* @param {
|
|
8200
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8036
8201
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8037
8202
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8038
8203
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8042,7 +8207,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8042
8207
|
* @param {*} [options] Override http request option.
|
|
8043
8208
|
* @throws {RequiredError}
|
|
8044
8209
|
*/
|
|
8045
|
-
getAllBalance(date?: string, minBalance?: number, maxBalance?: number, hasFine?: boolean, minFine?: number, maxFine?: number, userTypes?:
|
|
8210
|
+
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>>;
|
|
8046
8211
|
/**
|
|
8047
8212
|
*
|
|
8048
8213
|
* @summary Retrieves the requested balance
|
|
@@ -8159,10 +8324,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8159
8324
|
readonly maxFine?: number;
|
|
8160
8325
|
/**
|
|
8161
8326
|
* Filter based on user type.
|
|
8162
|
-
* @type {Array<
|
|
8327
|
+
* @type {Array<UserType>}
|
|
8163
8328
|
* @memberof BalanceApiGetAllBalance
|
|
8164
8329
|
*/
|
|
8165
|
-
readonly userTypes?:
|
|
8330
|
+
readonly userTypes?: Array<UserType>;
|
|
8166
8331
|
/**
|
|
8167
8332
|
* Column to order balance by - eg: id,amount
|
|
8168
8333
|
* @type {string}
|
|
@@ -8256,11 +8421,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8256
8421
|
*/
|
|
8257
8422
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8258
8423
|
}
|
|
8259
|
-
/**
|
|
8260
|
-
* @export
|
|
8261
|
-
*/
|
|
8262
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8263
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8264
8424
|
/**
|
|
8265
8425
|
* @export
|
|
8266
8426
|
*/
|
|
@@ -10681,7 +10841,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10681
10841
|
* @param {*} [options] Override http request option.
|
|
10682
10842
|
* @throws {RequiredError}
|
|
10683
10843
|
*/
|
|
10684
|
-
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10844
|
+
handoutInactiveAdministrativeCostsUsers(handoutInactiveAdministrativeCostsRequest: HandoutInactiveAdministrativeCostsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InactiveAdministrativeCostResponse>>>;
|
|
10685
10845
|
/**
|
|
10686
10846
|
*
|
|
10687
10847
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10759,7 +10919,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10759
10919
|
* @param {*} [options] Override http request option.
|
|
10760
10920
|
* @throws {RequiredError}
|
|
10761
10921
|
*/
|
|
10762
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10922
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10763
10923
|
/**
|
|
10764
10924
|
*
|
|
10765
10925
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10982,7 +11142,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
10982
11142
|
* @throws {RequiredError}
|
|
10983
11143
|
* @memberof InactiveAdministrativeCostsApi
|
|
10984
11144
|
*/
|
|
10985
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11145
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
10986
11146
|
/**
|
|
10987
11147
|
*
|
|
10988
11148
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11027,16 +11187,17 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11027
11187
|
* @summary Returns all invoices in the system.
|
|
11028
11188
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11029
11189
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11030
|
-
* @param {
|
|
11190
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11031
11191
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11032
11192
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11033
11193
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
11194
|
+
* @param {string} [description] Filter invoices by description (partial match)
|
|
11034
11195
|
* @param {number} [take] How many entries the endpoint should return
|
|
11035
11196
|
* @param {number} [skip] How many entries should be skipped (for pagination)
|
|
11036
11197
|
* @param {*} [options] Override http request option.
|
|
11037
11198
|
* @throws {RequiredError}
|
|
11038
11199
|
*/
|
|
11039
|
-
getAllInvoices: (toId?: number, invoiceId?: number, currentState?:
|
|
11200
|
+
getAllInvoices: (toId?: number, invoiceId?: number, currentState?: Array<GetAllInvoicesCurrentStateParameterInner>, returnEntries?: boolean, fromDate?: string, tillDate?: string, description?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11040
11201
|
/**
|
|
11041
11202
|
*
|
|
11042
11203
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11049,9 +11210,16 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11049
11210
|
getEligibleTransactions: (forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11050
11211
|
/**
|
|
11051
11212
|
*
|
|
11052
|
-
* @summary
|
|
11053
|
-
* @param {
|
|
11054
|
-
* @
|
|
11213
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11214
|
+
* @param {*} [options] Override http request option.
|
|
11215
|
+
* @throws {RequiredError}
|
|
11216
|
+
*/
|
|
11217
|
+
getInvoiceDrift: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11218
|
+
/**
|
|
11219
|
+
*
|
|
11220
|
+
* @summary Get an invoice pdf.
|
|
11221
|
+
* @param {number} id The id of the invoice to return
|
|
11222
|
+
* @param {boolean} [force] Force creation of pdf
|
|
11055
11223
|
* @param {*} [options] Override http request option.
|
|
11056
11224
|
* @throws {RequiredError}
|
|
11057
11225
|
*/
|
|
@@ -11126,16 +11294,17 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11126
11294
|
* @summary Returns all invoices in the system.
|
|
11127
11295
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11128
11296
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11129
|
-
* @param {
|
|
11297
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11130
11298
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11131
11299
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11132
11300
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
11301
|
+
* @param {string} [description] Filter invoices by description (partial match)
|
|
11133
11302
|
* @param {number} [take] How many entries the endpoint should return
|
|
11134
11303
|
* @param {number} [skip] How many entries should be skipped (for pagination)
|
|
11135
11304
|
* @param {*} [options] Override http request option.
|
|
11136
11305
|
* @throws {RequiredError}
|
|
11137
11306
|
*/
|
|
11138
|
-
getAllInvoices(toId?: number, invoiceId?: number, currentState?:
|
|
11307
|
+
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>>;
|
|
11139
11308
|
/**
|
|
11140
11309
|
*
|
|
11141
11310
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11145,7 +11314,14 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11145
11314
|
* @param {*} [options] Override http request option.
|
|
11146
11315
|
* @throws {RequiredError}
|
|
11147
11316
|
*/
|
|
11148
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11317
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11318
|
+
/**
|
|
11319
|
+
*
|
|
11320
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11321
|
+
* @param {*} [options] Override http request option.
|
|
11322
|
+
* @throws {RequiredError}
|
|
11323
|
+
*/
|
|
11324
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceDriftResponse>>>;
|
|
11149
11325
|
/**
|
|
11150
11326
|
*
|
|
11151
11327
|
* @summary Get an invoice pdf.
|
|
@@ -11154,7 +11330,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11154
11330
|
* @param {*} [options] Override http request option.
|
|
11155
11331
|
* @throws {RequiredError}
|
|
11156
11332
|
*/
|
|
11157
|
-
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11333
|
+
getInvoicePdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
|
|
11158
11334
|
/**
|
|
11159
11335
|
*
|
|
11160
11336
|
* @summary Returns a single invoice in the system.
|
|
@@ -11235,7 +11411,14 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11235
11411
|
* @param {*} [options] Override http request option.
|
|
11236
11412
|
* @throws {RequiredError}
|
|
11237
11413
|
*/
|
|
11238
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11414
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11415
|
+
/**
|
|
11416
|
+
*
|
|
11417
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11418
|
+
* @param {*} [options] Override http request option.
|
|
11419
|
+
* @throws {RequiredError}
|
|
11420
|
+
*/
|
|
11421
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): AxiosPromise<Array<InvoiceDriftResponse>>;
|
|
11239
11422
|
/**
|
|
11240
11423
|
*
|
|
11241
11424
|
* @summary Get an invoice pdf.
|
|
@@ -11243,7 +11426,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11243
11426
|
* @param {*} [options] Override http request option.
|
|
11244
11427
|
* @throws {RequiredError}
|
|
11245
11428
|
*/
|
|
11246
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11429
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11247
11430
|
/**
|
|
11248
11431
|
*
|
|
11249
11432
|
* @summary Returns a single invoice in the system.
|
|
@@ -11336,10 +11519,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11336
11519
|
readonly invoiceId?: number;
|
|
11337
11520
|
/**
|
|
11338
11521
|
* Filter based on Invoice State.
|
|
11339
|
-
* @type {Array<
|
|
11522
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11340
11523
|
* @memberof InvoicesApiGetAllInvoices
|
|
11341
11524
|
*/
|
|
11342
|
-
readonly currentState?:
|
|
11525
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11343
11526
|
/**
|
|
11344
11527
|
* Boolean if invoice entries should be returned
|
|
11345
11528
|
* @type {boolean}
|
|
@@ -11358,6 +11541,12 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11358
11541
|
* @memberof InvoicesApiGetAllInvoices
|
|
11359
11542
|
*/
|
|
11360
11543
|
readonly tillDate?: string;
|
|
11544
|
+
/**
|
|
11545
|
+
* Filter invoices by description (partial match)
|
|
11546
|
+
* @type {string}
|
|
11547
|
+
* @memberof InvoicesApiGetAllInvoices
|
|
11548
|
+
*/
|
|
11549
|
+
readonly description?: string;
|
|
11361
11550
|
/**
|
|
11362
11551
|
* How many entries the endpoint should return
|
|
11363
11552
|
* @type {number}
|
|
@@ -11452,142 +11641,631 @@ export interface InvoicesApiGetSingleInvoiceUserRequest {
|
|
|
11452
11641
|
* @export
|
|
11453
11642
|
* @interface InvoicesApiPutInvoiceUserRequest
|
|
11454
11643
|
*/
|
|
11455
|
-
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11644
|
+
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11645
|
+
/**
|
|
11646
|
+
* The id of the user to update
|
|
11647
|
+
* @type {number}
|
|
11648
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11649
|
+
*/
|
|
11650
|
+
readonly id: number;
|
|
11651
|
+
/**
|
|
11652
|
+
* The invoice user which should be updated
|
|
11653
|
+
* @type {UpdateInvoiceUserRequest}
|
|
11654
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11655
|
+
*/
|
|
11656
|
+
readonly updateInvoiceUserRequest: UpdateInvoiceUserRequest;
|
|
11657
|
+
}
|
|
11658
|
+
/**
|
|
11659
|
+
* Request parameters for updateInvoice operation in InvoicesApi.
|
|
11660
|
+
* @export
|
|
11661
|
+
* @interface InvoicesApiUpdateInvoiceRequest
|
|
11662
|
+
*/
|
|
11663
|
+
export interface InvoicesApiUpdateInvoiceRequest {
|
|
11664
|
+
/**
|
|
11665
|
+
* The id of the invoice which should be updated
|
|
11666
|
+
* @type {number}
|
|
11667
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11668
|
+
*/
|
|
11669
|
+
readonly id: number;
|
|
11670
|
+
/**
|
|
11671
|
+
* The invoice update to process
|
|
11672
|
+
* @type {UpdateInvoiceRequest}
|
|
11673
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11674
|
+
*/
|
|
11675
|
+
readonly updateInvoiceRequest: UpdateInvoiceRequest;
|
|
11676
|
+
}
|
|
11677
|
+
/**
|
|
11678
|
+
* InvoicesApi - object-oriented interface
|
|
11679
|
+
* @export
|
|
11680
|
+
* @class InvoicesApi
|
|
11681
|
+
* @extends {BaseAPI}
|
|
11682
|
+
*/
|
|
11683
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
11684
|
+
/**
|
|
11685
|
+
*
|
|
11686
|
+
* @summary Adds an invoice to the system.
|
|
11687
|
+
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
11688
|
+
* @param {*} [options] Override http request option.
|
|
11689
|
+
* @throws {RequiredError}
|
|
11690
|
+
* @memberof InvoicesApi
|
|
11691
|
+
*/
|
|
11692
|
+
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11693
|
+
/**
|
|
11694
|
+
*
|
|
11695
|
+
* @summary Deletes an invoice.
|
|
11696
|
+
* @param {InvoicesApiDeleteInvoiceRequest} requestParameters Request parameters.
|
|
11697
|
+
* @param {*} [options] Override http request option.
|
|
11698
|
+
* @throws {RequiredError}
|
|
11699
|
+
* @memberof InvoicesApi
|
|
11700
|
+
*/
|
|
11701
|
+
deleteInvoice(requestParameters: InvoicesApiDeleteInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11702
|
+
/**
|
|
11703
|
+
*
|
|
11704
|
+
* @summary Delete invoice user defaults.
|
|
11705
|
+
* @param {InvoicesApiDeleteInvoiceUserRequest} requestParameters Request parameters.
|
|
11706
|
+
* @param {*} [options] Override http request option.
|
|
11707
|
+
* @throws {RequiredError}
|
|
11708
|
+
* @memberof InvoicesApi
|
|
11709
|
+
*/
|
|
11710
|
+
deleteInvoiceUser(requestParameters: InvoicesApiDeleteInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11711
|
+
/**
|
|
11712
|
+
*
|
|
11713
|
+
* @summary Returns all invoices in the system.
|
|
11714
|
+
* @param {InvoicesApiGetAllInvoicesRequest} requestParameters Request parameters.
|
|
11715
|
+
* @param {*} [options] Override http request option.
|
|
11716
|
+
* @throws {RequiredError}
|
|
11717
|
+
* @memberof InvoicesApi
|
|
11718
|
+
*/
|
|
11719
|
+
getAllInvoices(requestParameters?: InvoicesApiGetAllInvoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedInvoiceResponse, any, {}>>;
|
|
11720
|
+
/**
|
|
11721
|
+
*
|
|
11722
|
+
* @summary Get eligible transactions for invoice creation.
|
|
11723
|
+
* @param {InvoicesApiGetEligibleTransactionsRequest} requestParameters Request parameters.
|
|
11724
|
+
* @param {*} [options] Override http request option.
|
|
11725
|
+
* @throws {RequiredError}
|
|
11726
|
+
* @memberof InvoicesApi
|
|
11727
|
+
*/
|
|
11728
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11729
|
+
/**
|
|
11730
|
+
*
|
|
11731
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11732
|
+
* @param {*} [options] Override http request option.
|
|
11733
|
+
* @throws {RequiredError}
|
|
11734
|
+
* @memberof InvoicesApi
|
|
11735
|
+
*/
|
|
11736
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11737
|
+
/**
|
|
11738
|
+
*
|
|
11739
|
+
* @summary Get an invoice pdf.
|
|
11740
|
+
* @param {InvoicesApiGetInvoicePdfRequest} requestParameters Request parameters.
|
|
11741
|
+
* @param {*} [options] Override http request option.
|
|
11742
|
+
* @throws {RequiredError}
|
|
11743
|
+
* @memberof InvoicesApi
|
|
11744
|
+
*/
|
|
11745
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11746
|
+
/**
|
|
11747
|
+
*
|
|
11748
|
+
* @summary Returns a single invoice in the system.
|
|
11749
|
+
* @param {InvoicesApiGetSingleInvoiceRequest} requestParameters Request parameters.
|
|
11750
|
+
* @param {*} [options] Override http request option.
|
|
11751
|
+
* @throws {RequiredError}
|
|
11752
|
+
* @memberof InvoicesApi
|
|
11753
|
+
*/
|
|
11754
|
+
getSingleInvoice(requestParameters: InvoicesApiGetSingleInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11755
|
+
/**
|
|
11756
|
+
*
|
|
11757
|
+
* @summary Get invoice user defaults.
|
|
11758
|
+
* @param {InvoicesApiGetSingleInvoiceUserRequest} requestParameters Request parameters.
|
|
11759
|
+
* @param {*} [options] Override http request option.
|
|
11760
|
+
* @throws {RequiredError}
|
|
11761
|
+
* @memberof InvoicesApi
|
|
11762
|
+
*/
|
|
11763
|
+
getSingleInvoiceUser(requestParameters: InvoicesApiGetSingleInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11764
|
+
/**
|
|
11765
|
+
*
|
|
11766
|
+
* @summary Update or create invoice user defaults.
|
|
11767
|
+
* @param {InvoicesApiPutInvoiceUserRequest} requestParameters Request parameters.
|
|
11768
|
+
* @param {*} [options] Override http request option.
|
|
11769
|
+
* @throws {RequiredError}
|
|
11770
|
+
* @memberof InvoicesApi
|
|
11771
|
+
*/
|
|
11772
|
+
putInvoiceUser(requestParameters: InvoicesApiPutInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11773
|
+
/**
|
|
11774
|
+
*
|
|
11775
|
+
* @summary Adds an invoice to the system.
|
|
11776
|
+
* @param {InvoicesApiUpdateInvoiceRequest} requestParameters Request parameters.
|
|
11777
|
+
* @param {*} [options] Override http request option.
|
|
11778
|
+
* @throws {RequiredError}
|
|
11779
|
+
* @memberof InvoicesApi
|
|
11780
|
+
*/
|
|
11781
|
+
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11785
|
+
* @export
|
|
11786
|
+
*/
|
|
11787
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11788
|
+
/**
|
|
11789
|
+
*
|
|
11790
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11791
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11792
|
+
* @param {*} [options] Override http request option.
|
|
11793
|
+
* @throws {RequiredError}
|
|
11794
|
+
*/
|
|
11795
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11796
|
+
/**
|
|
11797
|
+
*
|
|
11798
|
+
* @summary Create a new PaymentRequest.
|
|
11799
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11800
|
+
* @param {*} [options] Override http request option.
|
|
11801
|
+
* @throws {RequiredError}
|
|
11802
|
+
*/
|
|
11803
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11804
|
+
/**
|
|
11805
|
+
*
|
|
11806
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11807
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11808
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11809
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11810
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11811
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11812
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11813
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11814
|
+
* @param {*} [options] Override http request option.
|
|
11815
|
+
* @throws {RequiredError}
|
|
11816
|
+
*/
|
|
11817
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11818
|
+
/**
|
|
11819
|
+
*
|
|
11820
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11821
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11822
|
+
* @param {*} [options] Override http request option.
|
|
11823
|
+
* @throws {RequiredError}
|
|
11824
|
+
*/
|
|
11825
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11826
|
+
/**
|
|
11827
|
+
*
|
|
11828
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11829
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11830
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11831
|
+
* @param {*} [options] Override http request option.
|
|
11832
|
+
* @throws {RequiredError}
|
|
11833
|
+
*/
|
|
11834
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11835
|
+
/**
|
|
11836
|
+
*
|
|
11837
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11838
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11839
|
+
* @param {*} [options] Override http request option.
|
|
11840
|
+
* @throws {RequiredError}
|
|
11841
|
+
*/
|
|
11842
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11843
|
+
};
|
|
11844
|
+
/**
|
|
11845
|
+
* PaymentRequestsApi - functional programming interface
|
|
11846
|
+
* @export
|
|
11847
|
+
*/
|
|
11848
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11849
|
+
/**
|
|
11850
|
+
*
|
|
11851
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11852
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11853
|
+
* @param {*} [options] Override http request option.
|
|
11854
|
+
* @throws {RequiredError}
|
|
11855
|
+
*/
|
|
11856
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11857
|
+
/**
|
|
11858
|
+
*
|
|
11859
|
+
* @summary Create a new PaymentRequest.
|
|
11860
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11861
|
+
* @param {*} [options] Override http request option.
|
|
11862
|
+
* @throws {RequiredError}
|
|
11863
|
+
*/
|
|
11864
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11865
|
+
/**
|
|
11866
|
+
*
|
|
11867
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11868
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11869
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11870
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11871
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11872
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11873
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11874
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11875
|
+
* @param {*} [options] Override http request option.
|
|
11876
|
+
* @throws {RequiredError}
|
|
11877
|
+
*/
|
|
11878
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11879
|
+
/**
|
|
11880
|
+
*
|
|
11881
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11882
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11883
|
+
* @param {*} [options] Override http request option.
|
|
11884
|
+
* @throws {RequiredError}
|
|
11885
|
+
*/
|
|
11886
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11887
|
+
/**
|
|
11888
|
+
*
|
|
11889
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11890
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11891
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11892
|
+
* @param {*} [options] Override http request option.
|
|
11893
|
+
* @throws {RequiredError}
|
|
11894
|
+
*/
|
|
11895
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11896
|
+
/**
|
|
11897
|
+
*
|
|
11898
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11899
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11900
|
+
* @param {*} [options] Override http request option.
|
|
11901
|
+
* @throws {RequiredError}
|
|
11902
|
+
*/
|
|
11903
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11904
|
+
};
|
|
11905
|
+
/**
|
|
11906
|
+
* PaymentRequestsApi - factory interface
|
|
11907
|
+
* @export
|
|
11908
|
+
*/
|
|
11909
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11913
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11914
|
+
* @param {*} [options] Override http request option.
|
|
11915
|
+
* @throws {RequiredError}
|
|
11916
|
+
*/
|
|
11917
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11918
|
+
/**
|
|
11919
|
+
*
|
|
11920
|
+
* @summary Create a new PaymentRequest.
|
|
11921
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11922
|
+
* @param {*} [options] Override http request option.
|
|
11923
|
+
* @throws {RequiredError}
|
|
11924
|
+
*/
|
|
11925
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11926
|
+
/**
|
|
11927
|
+
*
|
|
11928
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11929
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11930
|
+
* @param {*} [options] Override http request option.
|
|
11931
|
+
* @throws {RequiredError}
|
|
11932
|
+
*/
|
|
11933
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11934
|
+
/**
|
|
11935
|
+
*
|
|
11936
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11937
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11938
|
+
* @param {*} [options] Override http request option.
|
|
11939
|
+
* @throws {RequiredError}
|
|
11940
|
+
*/
|
|
11941
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11942
|
+
/**
|
|
11943
|
+
*
|
|
11944
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11945
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11946
|
+
* @param {*} [options] Override http request option.
|
|
11947
|
+
* @throws {RequiredError}
|
|
11948
|
+
*/
|
|
11949
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11950
|
+
/**
|
|
11951
|
+
*
|
|
11952
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11953
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11954
|
+
* @param {*} [options] Override http request option.
|
|
11955
|
+
* @throws {RequiredError}
|
|
11956
|
+
*/
|
|
11957
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11958
|
+
};
|
|
11959
|
+
/**
|
|
11960
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11961
|
+
* @export
|
|
11962
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11963
|
+
*/
|
|
11964
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11965
|
+
/**
|
|
11966
|
+
* UUID v4 of the payment request.
|
|
11967
|
+
* @type {string}
|
|
11968
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11969
|
+
*/
|
|
11970
|
+
readonly id: string;
|
|
11971
|
+
}
|
|
11972
|
+
/**
|
|
11973
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11974
|
+
* @export
|
|
11975
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11976
|
+
*/
|
|
11977
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11978
|
+
/**
|
|
11979
|
+
* The request to create
|
|
11980
|
+
* @type {CreatePaymentRequestRequest}
|
|
11981
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11982
|
+
*/
|
|
11983
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11984
|
+
}
|
|
11985
|
+
/**
|
|
11986
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11987
|
+
* @export
|
|
11988
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11989
|
+
*/
|
|
11990
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11991
|
+
/**
|
|
11992
|
+
* Filter by beneficiary user id.
|
|
11993
|
+
* @type {number}
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11995
|
+
*/
|
|
11996
|
+
readonly forId?: number;
|
|
11997
|
+
/**
|
|
11998
|
+
* Filter by creator user id.
|
|
11999
|
+
* @type {number}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12001
|
+
*/
|
|
12002
|
+
readonly createdById?: number;
|
|
12003
|
+
/**
|
|
12004
|
+
* Comma-separated list of derived statuses.
|
|
12005
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
12006
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12007
|
+
*/
|
|
12008
|
+
readonly status?: GetAllPaymentRequestsStatusEnum;
|
|
12009
|
+
/**
|
|
12010
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
12011
|
+
* @type {string}
|
|
12012
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12013
|
+
*/
|
|
12014
|
+
readonly fromDate?: string;
|
|
12015
|
+
/**
|
|
12016
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
12017
|
+
* @type {string}
|
|
12018
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12019
|
+
*/
|
|
12020
|
+
readonly tillDate?: string;
|
|
12021
|
+
/**
|
|
12022
|
+
* How many rows the endpoint should return
|
|
12023
|
+
* @type {number}
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12025
|
+
*/
|
|
12026
|
+
readonly take?: number;
|
|
12027
|
+
/**
|
|
12028
|
+
* How many rows to skip (for pagination)
|
|
12029
|
+
* @type {number}
|
|
12030
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
12031
|
+
*/
|
|
12032
|
+
readonly skip?: number;
|
|
12033
|
+
}
|
|
12034
|
+
/**
|
|
12035
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
12036
|
+
* @export
|
|
12037
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
12038
|
+
*/
|
|
12039
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
12040
|
+
/**
|
|
12041
|
+
* UUID v4 of the payment request.
|
|
12042
|
+
* @type {string}
|
|
12043
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
12044
|
+
*/
|
|
12045
|
+
readonly id: string;
|
|
12046
|
+
}
|
|
12047
|
+
/**
|
|
12048
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
12049
|
+
* @export
|
|
12050
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
12051
|
+
*/
|
|
12052
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11456
12053
|
/**
|
|
11457
|
-
*
|
|
11458
|
-
* @type {
|
|
11459
|
-
* @memberof
|
|
12054
|
+
* UUID v4 of the payment request.
|
|
12055
|
+
* @type {string}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11460
12057
|
*/
|
|
11461
|
-
readonly id:
|
|
12058
|
+
readonly id: string;
|
|
11462
12059
|
/**
|
|
11463
|
-
* The
|
|
11464
|
-
* @type {
|
|
11465
|
-
* @memberof
|
|
12060
|
+
* The audit reason
|
|
12061
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12062
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11466
12063
|
*/
|
|
11467
|
-
readonly
|
|
12064
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11468
12065
|
}
|
|
11469
12066
|
/**
|
|
11470
|
-
* Request parameters for
|
|
12067
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11471
12068
|
* @export
|
|
11472
|
-
* @interface
|
|
12069
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11473
12070
|
*/
|
|
11474
|
-
export interface
|
|
11475
|
-
/**
|
|
11476
|
-
* The id of the invoice which should be updated
|
|
11477
|
-
* @type {number}
|
|
11478
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11479
|
-
*/
|
|
11480
|
-
readonly id: number;
|
|
12071
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11481
12072
|
/**
|
|
11482
|
-
*
|
|
11483
|
-
* @type {
|
|
11484
|
-
* @memberof
|
|
12073
|
+
* UUID v4 of the payment request.
|
|
12074
|
+
* @type {string}
|
|
12075
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11485
12076
|
*/
|
|
11486
|
-
readonly
|
|
12077
|
+
readonly id: string;
|
|
11487
12078
|
}
|
|
11488
12079
|
/**
|
|
11489
|
-
*
|
|
12080
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11490
12081
|
* @export
|
|
11491
|
-
* @class
|
|
12082
|
+
* @class PaymentRequestsApi
|
|
11492
12083
|
* @extends {BaseAPI}
|
|
11493
12084
|
*/
|
|
11494
|
-
export declare class
|
|
12085
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11495
12086
|
/**
|
|
11496
12087
|
*
|
|
11497
|
-
* @summary
|
|
11498
|
-
* @param {
|
|
12088
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12089
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11499
12090
|
* @param {*} [options] Override http request option.
|
|
11500
12091
|
* @throws {RequiredError}
|
|
11501
|
-
* @memberof
|
|
12092
|
+
* @memberof PaymentRequestsApi
|
|
11502
12093
|
*/
|
|
11503
|
-
|
|
12094
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11504
12095
|
/**
|
|
11505
12096
|
*
|
|
11506
|
-
* @summary
|
|
11507
|
-
* @param {
|
|
12097
|
+
* @summary Create a new PaymentRequest.
|
|
12098
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11508
12099
|
* @param {*} [options] Override http request option.
|
|
11509
12100
|
* @throws {RequiredError}
|
|
11510
|
-
* @memberof
|
|
12101
|
+
* @memberof PaymentRequestsApi
|
|
11511
12102
|
*/
|
|
11512
|
-
|
|
12103
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11513
12104
|
/**
|
|
11514
12105
|
*
|
|
11515
|
-
* @summary
|
|
11516
|
-
* @param {
|
|
12106
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12107
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11517
12108
|
* @param {*} [options] Override http request option.
|
|
11518
12109
|
* @throws {RequiredError}
|
|
11519
|
-
* @memberof
|
|
12110
|
+
* @memberof PaymentRequestsApi
|
|
11520
12111
|
*/
|
|
11521
|
-
|
|
12112
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11522
12113
|
/**
|
|
11523
12114
|
*
|
|
11524
|
-
* @summary
|
|
11525
|
-
* @param {
|
|
12115
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12116
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11526
12117
|
* @param {*} [options] Override http request option.
|
|
11527
12118
|
* @throws {RequiredError}
|
|
11528
|
-
* @memberof
|
|
12119
|
+
* @memberof PaymentRequestsApi
|
|
11529
12120
|
*/
|
|
11530
|
-
|
|
12121
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11531
12122
|
/**
|
|
11532
12123
|
*
|
|
11533
|
-
* @summary
|
|
11534
|
-
* @param {
|
|
12124
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
12125
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11535
12126
|
* @param {*} [options] Override http request option.
|
|
11536
12127
|
* @throws {RequiredError}
|
|
11537
|
-
* @memberof
|
|
12128
|
+
* @memberof PaymentRequestsApi
|
|
11538
12129
|
*/
|
|
11539
|
-
|
|
12130
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11540
12131
|
/**
|
|
11541
12132
|
*
|
|
11542
|
-
* @summary
|
|
11543
|
-
* @param {
|
|
12133
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12134
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11544
12135
|
* @param {*} [options] Override http request option.
|
|
11545
12136
|
* @throws {RequiredError}
|
|
11546
|
-
* @memberof
|
|
12137
|
+
* @memberof PaymentRequestsApi
|
|
11547
12138
|
*/
|
|
11548
|
-
|
|
12139
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12140
|
+
}
|
|
12141
|
+
/**
|
|
12142
|
+
* @export
|
|
12143
|
+
*/
|
|
12144
|
+
export declare const GetAllPaymentRequestsStatusEnum: {
|
|
12145
|
+
readonly Pending: "PENDING";
|
|
12146
|
+
readonly Paid: "PAID";
|
|
12147
|
+
readonly Expired: "EXPIRED";
|
|
12148
|
+
readonly Cancelled: "CANCELLED";
|
|
12149
|
+
};
|
|
12150
|
+
export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
|
|
12151
|
+
/**
|
|
12152
|
+
* PaymentRequestsPublicApi - axios parameter creator
|
|
12153
|
+
* @export
|
|
12154
|
+
*/
|
|
12155
|
+
export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11549
12156
|
/**
|
|
11550
12157
|
*
|
|
11551
|
-
* @summary Returns a
|
|
11552
|
-
* @param {
|
|
12158
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12159
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11553
12160
|
* @param {*} [options] Override http request option.
|
|
11554
12161
|
* @throws {RequiredError}
|
|
11555
|
-
* @memberof InvoicesApi
|
|
11556
12162
|
*/
|
|
11557
|
-
|
|
12163
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11558
12164
|
/**
|
|
11559
12165
|
*
|
|
11560
|
-
* @summary
|
|
11561
|
-
* @param {
|
|
12166
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12167
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11562
12168
|
* @param {*} [options] Override http request option.
|
|
11563
12169
|
* @throws {RequiredError}
|
|
11564
|
-
* @memberof InvoicesApi
|
|
11565
12170
|
*/
|
|
11566
|
-
|
|
12171
|
+
startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12172
|
+
};
|
|
12173
|
+
/**
|
|
12174
|
+
* PaymentRequestsPublicApi - functional programming interface
|
|
12175
|
+
* @export
|
|
12176
|
+
*/
|
|
12177
|
+
export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
|
|
11567
12178
|
/**
|
|
11568
12179
|
*
|
|
11569
|
-
* @summary
|
|
11570
|
-
* @param {
|
|
12180
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12181
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11571
12182
|
* @param {*} [options] Override http request option.
|
|
11572
12183
|
* @throws {RequiredError}
|
|
11573
|
-
* @memberof InvoicesApi
|
|
11574
12184
|
*/
|
|
11575
|
-
|
|
12185
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11576
12186
|
/**
|
|
11577
12187
|
*
|
|
11578
|
-
* @summary
|
|
11579
|
-
* @param {
|
|
12188
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12189
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11580
12190
|
* @param {*} [options] Override http request option.
|
|
11581
12191
|
* @throws {RequiredError}
|
|
11582
|
-
* @memberof InvoicesApi
|
|
11583
12192
|
*/
|
|
11584
|
-
|
|
12193
|
+
startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
12194
|
+
};
|
|
12195
|
+
/**
|
|
12196
|
+
* PaymentRequestsPublicApi - factory interface
|
|
12197
|
+
* @export
|
|
12198
|
+
*/
|
|
12199
|
+
export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12200
|
+
/**
|
|
12201
|
+
*
|
|
12202
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12203
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12204
|
+
* @param {*} [options] Override http request option.
|
|
12205
|
+
* @throws {RequiredError}
|
|
12206
|
+
*/
|
|
12207
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12208
|
+
/**
|
|
12209
|
+
*
|
|
12210
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12211
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12212
|
+
* @param {*} [options] Override http request option.
|
|
12213
|
+
* @throws {RequiredError}
|
|
12214
|
+
*/
|
|
12215
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12216
|
+
};
|
|
12217
|
+
/**
|
|
12218
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12219
|
+
* @export
|
|
12220
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12221
|
+
*/
|
|
12222
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12223
|
+
/**
|
|
12224
|
+
* UUID v4 of the payment request.
|
|
12225
|
+
* @type {string}
|
|
12226
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12227
|
+
*/
|
|
12228
|
+
readonly id: string;
|
|
12229
|
+
}
|
|
12230
|
+
/**
|
|
12231
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12232
|
+
* @export
|
|
12233
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12234
|
+
*/
|
|
12235
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12236
|
+
/**
|
|
12237
|
+
* UUID v4 of the payment request.
|
|
12238
|
+
* @type {string}
|
|
12239
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12240
|
+
*/
|
|
12241
|
+
readonly id: string;
|
|
11585
12242
|
}
|
|
11586
12243
|
/**
|
|
12244
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
11587
12245
|
* @export
|
|
12246
|
+
* @class PaymentRequestsPublicApi
|
|
12247
|
+
* @extends {BaseAPI}
|
|
11588
12248
|
*/
|
|
11589
|
-
export declare
|
|
11590
|
-
|
|
12249
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12250
|
+
/**
|
|
12251
|
+
*
|
|
12252
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12253
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12254
|
+
* @param {*} [options] Override http request option.
|
|
12255
|
+
* @throws {RequiredError}
|
|
12256
|
+
* @memberof PaymentRequestsPublicApi
|
|
12257
|
+
*/
|
|
12258
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12259
|
+
/**
|
|
12260
|
+
*
|
|
12261
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12262
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12263
|
+
* @param {*} [options] Override http request option.
|
|
12264
|
+
* @throws {RequiredError}
|
|
12265
|
+
* @memberof PaymentRequestsPublicApi
|
|
12266
|
+
*/
|
|
12267
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
12268
|
+
}
|
|
11591
12269
|
/**
|
|
11592
12270
|
* PayoutRequestsApi - axios parameter creator
|
|
11593
12271
|
* @export
|
|
@@ -14142,11 +14820,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
14142
14820
|
/**
|
|
14143
14821
|
* 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.
|
|
14144
14822
|
* @summary Get dry-run sync results for users
|
|
14145
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14823
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14146
14824
|
* @param {*} [options] Override http request option.
|
|
14147
14825
|
* @throws {RequiredError}
|
|
14148
14826
|
*/
|
|
14149
|
-
getUserSyncResults: (service?: GetUserSyncResultsServiceEnum
|
|
14827
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14150
14828
|
};
|
|
14151
14829
|
/**
|
|
14152
14830
|
* SyncApi - functional programming interface
|
|
@@ -14156,11 +14834,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
|
14156
14834
|
/**
|
|
14157
14835
|
* 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.
|
|
14158
14836
|
* @summary Get dry-run sync results for users
|
|
14159
|
-
* @param {GetUserSyncResultsServiceEnum} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14837
|
+
* @param {Array<GetUserSyncResultsServiceEnum>} [service] Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14160
14838
|
* @param {*} [options] Override http request option.
|
|
14161
14839
|
* @throws {RequiredError}
|
|
14162
14840
|
*/
|
|
14163
|
-
getUserSyncResults(service?: GetUserSyncResultsServiceEnum
|
|
14841
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14164
14842
|
};
|
|
14165
14843
|
/**
|
|
14166
14844
|
* SyncApi - factory interface
|
|
@@ -14184,10 +14862,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14184
14862
|
export interface SyncApiGetUserSyncResultsRequest {
|
|
14185
14863
|
/**
|
|
14186
14864
|
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14187
|
-
* @type {Array<
|
|
14865
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
14188
14866
|
* @memberof SyncApiGetUserSyncResults
|
|
14189
14867
|
*/
|
|
14190
|
-
readonly service?: GetUserSyncResultsServiceEnum
|
|
14868
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
14191
14869
|
}
|
|
14192
14870
|
/**
|
|
14193
14871
|
* SyncApi - object-oriented interface
|
|
@@ -14209,7 +14887,10 @@ export declare class SyncApi extends BaseAPI {
|
|
|
14209
14887
|
/**
|
|
14210
14888
|
* @export
|
|
14211
14889
|
*/
|
|
14212
|
-
export declare const GetUserSyncResultsServiceEnum: {
|
|
14890
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
14891
|
+
readonly Ldap: "LDAP";
|
|
14892
|
+
readonly Gewisdb: "GEWISDB";
|
|
14893
|
+
};
|
|
14213
14894
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14214
14895
|
/**
|
|
14215
14896
|
* TermsOfServiceApi - axios parameter creator
|
|
@@ -14959,12 +15640,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14959
15640
|
* @summary Returns all existing transfers
|
|
14960
15641
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
14961
15642
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15643
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15644
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15645
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
14962
15646
|
* @param {number} [take] How many transfers the endpoint should return
|
|
14963
15647
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
14964
15648
|
* @param {*} [options] Override http request option.
|
|
14965
15649
|
* @throws {RequiredError}
|
|
14966
15650
|
*/
|
|
14967
|
-
getAllTransfers: (fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15651
|
+
getAllTransfers: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14968
15652
|
/**
|
|
14969
15653
|
*
|
|
14970
15654
|
* @summary Returns the requested transfer
|
|
@@ -14980,7 +15664,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14980
15664
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
14981
15665
|
* @param {number} [fromId] Filter transfers from this user ID
|
|
14982
15666
|
* @param {number} [toId] Filter transfers to this user ID
|
|
14983
|
-
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15667
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
14984
15668
|
* @param {*} [options] Override http request option.
|
|
14985
15669
|
* @throws {RequiredError}
|
|
14986
15670
|
*/
|
|
@@ -14993,6 +15677,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
14993
15677
|
* @throws {RequiredError}
|
|
14994
15678
|
*/
|
|
14995
15679
|
getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15680
|
+
/**
|
|
15681
|
+
*
|
|
15682
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
15683
|
+
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15684
|
+
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15685
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15686
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15687
|
+
* @param {*} [options] Override http request option.
|
|
15688
|
+
* @throws {RequiredError}
|
|
15689
|
+
*/
|
|
15690
|
+
getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14996
15691
|
};
|
|
14997
15692
|
/**
|
|
14998
15693
|
* TransfersApi - functional programming interface
|
|
@@ -15020,12 +15715,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15020
15715
|
* @summary Returns all existing transfers
|
|
15021
15716
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15022
15717
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15718
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15719
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15720
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15023
15721
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15024
15722
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15025
15723
|
* @param {*} [options] Override http request option.
|
|
15026
15724
|
* @throws {RequiredError}
|
|
15027
15725
|
*/
|
|
15028
|
-
getAllTransfers(fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
15726
|
+
getAllTransfers(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, category?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTransferResponse>>;
|
|
15029
15727
|
/**
|
|
15030
15728
|
*
|
|
15031
15729
|
* @summary Returns the requested transfer
|
|
@@ -15041,7 +15739,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15041
15739
|
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15042
15740
|
* @param {number} [fromId] Filter transfers from this user ID
|
|
15043
15741
|
* @param {number} [toId] Filter transfers to this user ID
|
|
15044
|
-
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15742
|
+
* @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15045
15743
|
* @param {*} [options] Override http request option.
|
|
15046
15744
|
* @throws {RequiredError}
|
|
15047
15745
|
*/
|
|
@@ -15054,6 +15752,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15054
15752
|
* @throws {RequiredError}
|
|
15055
15753
|
*/
|
|
15056
15754
|
getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
15755
|
+
/**
|
|
15756
|
+
*
|
|
15757
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
15758
|
+
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15759
|
+
* @param {string} [tillDate] End date for selected transfers (exclusive)
|
|
15760
|
+
* @param {number} [fromId] Filter transfers from this user ID
|
|
15761
|
+
* @param {number} [toId] Filter transfers to this user ID
|
|
15762
|
+
* @param {*} [options] Override http request option.
|
|
15763
|
+
* @throws {RequiredError}
|
|
15764
|
+
*/
|
|
15765
|
+
getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
|
|
15057
15766
|
};
|
|
15058
15767
|
/**
|
|
15059
15768
|
* TransfersApi - factory interface
|
|
@@ -15083,7 +15792,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15083
15792
|
* @param {*} [options] Override http request option.
|
|
15084
15793
|
* @throws {RequiredError}
|
|
15085
15794
|
*/
|
|
15086
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15795
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15087
15796
|
/**
|
|
15088
15797
|
*
|
|
15089
15798
|
* @summary Returns the requested transfer
|
|
@@ -15108,6 +15817,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15108
15817
|
* @throws {RequiredError}
|
|
15109
15818
|
*/
|
|
15110
15819
|
getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
15820
|
+
/**
|
|
15821
|
+
*
|
|
15822
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
15823
|
+
* @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
|
|
15824
|
+
* @param {*} [options] Override http request option.
|
|
15825
|
+
* @throws {RequiredError}
|
|
15826
|
+
*/
|
|
15827
|
+
getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
|
|
15111
15828
|
};
|
|
15112
15829
|
/**
|
|
15113
15830
|
* Request parameters for createTransfer operation in TransfersApi.
|
|
@@ -15153,6 +15870,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15153
15870
|
* @memberof TransfersApiGetAllTransfers
|
|
15154
15871
|
*/
|
|
15155
15872
|
readonly tillDate?: string;
|
|
15873
|
+
/**
|
|
15874
|
+
* Filter transfers from this user ID
|
|
15875
|
+
* @type {number}
|
|
15876
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15877
|
+
*/
|
|
15878
|
+
readonly fromId?: number;
|
|
15879
|
+
/**
|
|
15880
|
+
* Filter transfers to this user ID
|
|
15881
|
+
* @type {number}
|
|
15882
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15883
|
+
*/
|
|
15884
|
+
readonly toId?: number;
|
|
15885
|
+
/**
|
|
15886
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost, manualCreation, manualDeletion
|
|
15887
|
+
* @type {string}
|
|
15888
|
+
* @memberof TransfersApiGetAllTransfers
|
|
15889
|
+
*/
|
|
15890
|
+
readonly category?: string;
|
|
15156
15891
|
/**
|
|
15157
15892
|
* How many transfers the endpoint should return
|
|
15158
15893
|
* @type {number}
|
|
@@ -15210,7 +15945,7 @@ export interface TransfersApiGetTransferAggregateRequest {
|
|
|
15210
15945
|
*/
|
|
15211
15946
|
readonly toId?: number;
|
|
15212
15947
|
/**
|
|
15213
|
-
* Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15948
|
+
* Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
|
|
15214
15949
|
* @type {string}
|
|
15215
15950
|
* @memberof TransfersApiGetTransferAggregate
|
|
15216
15951
|
*/
|
|
@@ -15229,6 +15964,37 @@ export interface TransfersApiGetTransferPdfRequest {
|
|
|
15229
15964
|
*/
|
|
15230
15965
|
readonly id: number;
|
|
15231
15966
|
}
|
|
15967
|
+
/**
|
|
15968
|
+
* Request parameters for getTransferSummary operation in TransfersApi.
|
|
15969
|
+
* @export
|
|
15970
|
+
* @interface TransfersApiGetTransferSummaryRequest
|
|
15971
|
+
*/
|
|
15972
|
+
export interface TransfersApiGetTransferSummaryRequest {
|
|
15973
|
+
/**
|
|
15974
|
+
* Start date for selected transfers (inclusive)
|
|
15975
|
+
* @type {string}
|
|
15976
|
+
* @memberof TransfersApiGetTransferSummary
|
|
15977
|
+
*/
|
|
15978
|
+
readonly fromDate?: string;
|
|
15979
|
+
/**
|
|
15980
|
+
* End date for selected transfers (exclusive)
|
|
15981
|
+
* @type {string}
|
|
15982
|
+
* @memberof TransfersApiGetTransferSummary
|
|
15983
|
+
*/
|
|
15984
|
+
readonly tillDate?: string;
|
|
15985
|
+
/**
|
|
15986
|
+
* Filter transfers from this user ID
|
|
15987
|
+
* @type {number}
|
|
15988
|
+
* @memberof TransfersApiGetTransferSummary
|
|
15989
|
+
*/
|
|
15990
|
+
readonly fromId?: number;
|
|
15991
|
+
/**
|
|
15992
|
+
* Filter transfers to this user ID
|
|
15993
|
+
* @type {number}
|
|
15994
|
+
* @memberof TransfersApiGetTransferSummary
|
|
15995
|
+
*/
|
|
15996
|
+
readonly toId?: number;
|
|
15997
|
+
}
|
|
15232
15998
|
/**
|
|
15233
15999
|
* TransfersApi - object-oriented interface
|
|
15234
16000
|
* @export
|
|
@@ -15262,7 +16028,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15262
16028
|
* @throws {RequiredError}
|
|
15263
16029
|
* @memberof TransfersApi
|
|
15264
16030
|
*/
|
|
15265
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16031
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15266
16032
|
/**
|
|
15267
16033
|
*
|
|
15268
16034
|
* @summary Returns the requested transfer
|
|
@@ -15290,6 +16056,15 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15290
16056
|
* @memberof TransfersApi
|
|
15291
16057
|
*/
|
|
15292
16058
|
getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
16059
|
+
/**
|
|
16060
|
+
*
|
|
16061
|
+
* @summary Returns an aggregate breakdown of transfers for every category plus an overall total
|
|
16062
|
+
* @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
|
|
16063
|
+
* @param {*} [options] Override http request option.
|
|
16064
|
+
* @throws {RequiredError}
|
|
16065
|
+
* @memberof TransfersApi
|
|
16066
|
+
*/
|
|
16067
|
+
getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
|
|
15293
16068
|
}
|
|
15294
16069
|
/**
|
|
15295
16070
|
* UserNotificationPreferencesApi - axios parameter creator
|
|
@@ -15654,6 +16429,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15654
16429
|
* @throws {RequiredError}
|
|
15655
16430
|
*/
|
|
15656
16431
|
getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16432
|
+
/**
|
|
16433
|
+
*
|
|
16434
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
16435
|
+
* @param {number} id The id of the beneficiary user.
|
|
16436
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16437
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16438
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16439
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16440
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16441
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16442
|
+
* @param {*} [options] Override http request option.
|
|
16443
|
+
* @throws {RequiredError}
|
|
16444
|
+
*/
|
|
16445
|
+
getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15657
16446
|
/**
|
|
15658
16447
|
*
|
|
15659
16448
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16016,6 +16805,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16016
16805
|
* @throws {RequiredError}
|
|
16017
16806
|
*/
|
|
16018
16807
|
getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
|
|
16808
|
+
/**
|
|
16809
|
+
*
|
|
16810
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
16811
|
+
* @param {number} id The id of the beneficiary user.
|
|
16812
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
16813
|
+
* @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
16814
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
16815
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
16816
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
16817
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
16818
|
+
* @param {*} [options] Override http request option.
|
|
16819
|
+
* @throws {RequiredError}
|
|
16820
|
+
*/
|
|
16821
|
+
getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
16019
16822
|
/**
|
|
16020
16823
|
*
|
|
16021
16824
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16360,6 +17163,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16360
17163
|
* @throws {RequiredError}
|
|
16361
17164
|
*/
|
|
16362
17165
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
|
|
17166
|
+
/**
|
|
17167
|
+
*
|
|
17168
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
17169
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
17170
|
+
* @param {*} [options] Override http request option.
|
|
17171
|
+
* @throws {RequiredError}
|
|
17172
|
+
*/
|
|
17173
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
16363
17174
|
/**
|
|
16364
17175
|
*
|
|
16365
17176
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16851,6 +17662,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16851
17662
|
*/
|
|
16852
17663
|
readonly skip?: number;
|
|
16853
17664
|
}
|
|
17665
|
+
/**
|
|
17666
|
+
* Request parameters for getUsersPaymentRequests operation in UsersApi.
|
|
17667
|
+
* @export
|
|
17668
|
+
* @interface UsersApiGetUsersPaymentRequestsRequest
|
|
17669
|
+
*/
|
|
17670
|
+
export interface UsersApiGetUsersPaymentRequestsRequest {
|
|
17671
|
+
/**
|
|
17672
|
+
* The id of the beneficiary user.
|
|
17673
|
+
* @type {number}
|
|
17674
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17675
|
+
*/
|
|
17676
|
+
readonly id: number;
|
|
17677
|
+
/**
|
|
17678
|
+
* Filter by creator user id.
|
|
17679
|
+
* @type {number}
|
|
17680
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17681
|
+
*/
|
|
17682
|
+
readonly createdById?: number;
|
|
17683
|
+
/**
|
|
17684
|
+
* Comma-separated list of derived statuses.
|
|
17685
|
+
* @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
|
|
17686
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17687
|
+
*/
|
|
17688
|
+
readonly status?: GetUsersPaymentRequestsStatusEnum;
|
|
17689
|
+
/**
|
|
17690
|
+
* Filter requests created on or after this ISO date (inclusive).
|
|
17691
|
+
* @type {string}
|
|
17692
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17693
|
+
*/
|
|
17694
|
+
readonly fromDate?: string;
|
|
17695
|
+
/**
|
|
17696
|
+
* Filter requests created strictly before this ISO date (exclusive).
|
|
17697
|
+
* @type {string}
|
|
17698
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17699
|
+
*/
|
|
17700
|
+
readonly tillDate?: string;
|
|
17701
|
+
/**
|
|
17702
|
+
* How many rows the endpoint should return
|
|
17703
|
+
* @type {number}
|
|
17704
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17705
|
+
*/
|
|
17706
|
+
readonly take?: number;
|
|
17707
|
+
/**
|
|
17708
|
+
* How many rows to skip (for pagination)
|
|
17709
|
+
* @type {number}
|
|
17710
|
+
* @memberof UsersApiGetUsersPaymentRequests
|
|
17711
|
+
*/
|
|
17712
|
+
readonly skip?: number;
|
|
17713
|
+
}
|
|
16854
17714
|
/**
|
|
16855
17715
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16856
17716
|
* @export
|
|
@@ -17517,6 +18377,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17517
18377
|
* @memberof UsersApi
|
|
17518
18378
|
*/
|
|
17519
18379
|
getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
|
|
18380
|
+
/**
|
|
18381
|
+
*
|
|
18382
|
+
* @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
|
|
18383
|
+
* @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
|
|
18384
|
+
* @param {*} [options] Override http request option.
|
|
18385
|
+
* @throws {RequiredError}
|
|
18386
|
+
* @memberof UsersApi
|
|
18387
|
+
*/
|
|
18388
|
+
getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
17520
18389
|
/**
|
|
17521
18390
|
*
|
|
17522
18391
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17712,6 +18581,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17712
18581
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17713
18582
|
};
|
|
17714
18583
|
export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
|
|
18584
|
+
/**
|
|
18585
|
+
* @export
|
|
18586
|
+
*/
|
|
18587
|
+
export declare const GetUsersPaymentRequestsStatusEnum: {
|
|
18588
|
+
readonly Pending: "PENDING";
|
|
18589
|
+
readonly Paid: "PAID";
|
|
18590
|
+
readonly Expired: "EXPIRED";
|
|
18591
|
+
readonly Cancelled: "CANCELLED";
|
|
18592
|
+
};
|
|
18593
|
+
export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
|
|
17715
18594
|
/**
|
|
17716
18595
|
* @export
|
|
17717
18596
|
*/
|