@gewis/sudosos-client 0.0.0-develop.ac42a8c → 0.0.0-develop.aea2cd7
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 +1171 -509
- package/dist/api.js +907 -382
- 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
|
*/
|
|
@@ -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
|
|
@@ -3149,44 +3263,38 @@ export interface InvoiceUserResponse {
|
|
|
3149
3263
|
/**
|
|
3150
3264
|
*
|
|
3151
3265
|
* @export
|
|
3152
|
-
* @interface
|
|
3266
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3153
3267
|
*/
|
|
3154
|
-
export interface
|
|
3155
|
-
/**
|
|
3156
|
-
*
|
|
3157
|
-
* @type {number}
|
|
3158
|
-
* @memberof MemberAuthenticationPinRequest
|
|
3159
|
-
*/
|
|
3160
|
-
'memberId': number;
|
|
3268
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3161
3269
|
/**
|
|
3162
|
-
*
|
|
3270
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3163
3271
|
* @type {string}
|
|
3164
|
-
* @memberof
|
|
3272
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3165
3273
|
*/
|
|
3166
|
-
'
|
|
3274
|
+
'reason': string;
|
|
3167
3275
|
}
|
|
3168
3276
|
/**
|
|
3169
3277
|
*
|
|
3170
3278
|
* @export
|
|
3171
|
-
* @interface
|
|
3279
|
+
* @interface MemberAuthenticationPinRequest
|
|
3172
3280
|
*/
|
|
3173
|
-
export interface
|
|
3281
|
+
export interface MemberAuthenticationPinRequest {
|
|
3174
3282
|
/**
|
|
3175
3283
|
*
|
|
3176
3284
|
* @type {number}
|
|
3177
|
-
* @memberof
|
|
3285
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3178
3286
|
*/
|
|
3179
3287
|
'memberId': number;
|
|
3180
3288
|
/**
|
|
3181
3289
|
*
|
|
3182
3290
|
* @type {string}
|
|
3183
|
-
* @memberof
|
|
3291
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3184
3292
|
*/
|
|
3185
3293
|
'pin': string;
|
|
3186
3294
|
/**
|
|
3187
3295
|
* POS identifier
|
|
3188
3296
|
* @type {number}
|
|
3189
|
-
* @memberof
|
|
3297
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3190
3298
|
*/
|
|
3191
3299
|
'posId': number;
|
|
3192
3300
|
}
|
|
@@ -3214,13 +3322,13 @@ export interface PaginatedBalanceResponse {
|
|
|
3214
3322
|
* @type {PaginationResult}
|
|
3215
3323
|
* @memberof PaginatedBalanceResponse
|
|
3216
3324
|
*/
|
|
3217
|
-
'_pagination'
|
|
3325
|
+
'_pagination': PaginationResult;
|
|
3218
3326
|
/**
|
|
3219
3327
|
* Returned balance responses
|
|
3220
3328
|
* @type {Array<BalanceResponse>}
|
|
3221
3329
|
* @memberof PaginatedBalanceResponse
|
|
3222
3330
|
*/
|
|
3223
|
-
'records'
|
|
3331
|
+
'records': Array<BalanceResponse>;
|
|
3224
3332
|
}
|
|
3225
3333
|
/**
|
|
3226
3334
|
* Paginated API Response for the `banner` entity.
|
|
@@ -3233,13 +3341,13 @@ export interface PaginatedBannerResponse {
|
|
|
3233
3341
|
* @type {PaginationResult}
|
|
3234
3342
|
* @memberof PaginatedBannerResponse
|
|
3235
3343
|
*/
|
|
3236
|
-
'_pagination'
|
|
3344
|
+
'_pagination': PaginationResult;
|
|
3237
3345
|
/**
|
|
3238
3346
|
* Returned banners
|
|
3239
3347
|
* @type {Array<BannerResponse>}
|
|
3240
3348
|
* @memberof PaginatedBannerResponse
|
|
3241
3349
|
*/
|
|
3242
|
-
'records'
|
|
3350
|
+
'records': Array<BannerResponse>;
|
|
3243
3351
|
}
|
|
3244
3352
|
/**
|
|
3245
3353
|
*
|
|
@@ -3260,6 +3368,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3260
3368
|
*/
|
|
3261
3369
|
'records': Array<BaseEventResponse>;
|
|
3262
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
|
+
}
|
|
3263
3390
|
/**
|
|
3264
3391
|
*
|
|
3265
3392
|
* @export
|
|
@@ -3299,7 +3426,7 @@ export interface PaginatedBaseTransactionResponse {
|
|
|
3299
3426
|
'records': Array<BaseTransactionResponse>;
|
|
3300
3427
|
}
|
|
3301
3428
|
/**
|
|
3302
|
-
*
|
|
3429
|
+
* Paginated API Response for the `container` entity.
|
|
3303
3430
|
* @export
|
|
3304
3431
|
* @interface PaginatedContainerResponse
|
|
3305
3432
|
*/
|
|
@@ -3318,7 +3445,7 @@ export interface PaginatedContainerResponse {
|
|
|
3318
3445
|
'records': Array<ContainerResponse>;
|
|
3319
3446
|
}
|
|
3320
3447
|
/**
|
|
3321
|
-
*
|
|
3448
|
+
* Paginated API Response for the `container` entity, with each container\'s products inlined.
|
|
3322
3449
|
* @export
|
|
3323
3450
|
* @interface PaginatedContainerWithProductResponse
|
|
3324
3451
|
*/
|
|
@@ -3404,13 +3531,13 @@ export interface PaginatedInactiveAdministrativeCostResponse {
|
|
|
3404
3531
|
* @type {PaginationResult}
|
|
3405
3532
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3406
3533
|
*/
|
|
3407
|
-
'_pagination'
|
|
3534
|
+
'_pagination': PaginationResult;
|
|
3408
3535
|
/**
|
|
3409
3536
|
* Returned InactiveAdministrativeCost
|
|
3410
3537
|
* @type {Array<InactiveAdministrativeCostResponse>}
|
|
3411
3538
|
* @memberof PaginatedInactiveAdministrativeCostResponse
|
|
3412
3539
|
*/
|
|
3413
|
-
'records'
|
|
3540
|
+
'records': Array<InactiveAdministrativeCostResponse>;
|
|
3414
3541
|
}
|
|
3415
3542
|
/**
|
|
3416
3543
|
*
|
|
@@ -3432,7 +3559,7 @@ export interface PaginatedInvoiceResponse {
|
|
|
3432
3559
|
'records': Array<InvoiceResponseTypes>;
|
|
3433
3560
|
}
|
|
3434
3561
|
/**
|
|
3435
|
-
*
|
|
3562
|
+
* Paginated API Response for the `point of sale` entity.
|
|
3436
3563
|
* @export
|
|
3437
3564
|
* @interface PaginatedPointOfSaleResponse
|
|
3438
3565
|
*/
|
|
@@ -3451,7 +3578,7 @@ export interface PaginatedPointOfSaleResponse {
|
|
|
3451
3578
|
'records': Array<PointOfSaleResponse>;
|
|
3452
3579
|
}
|
|
3453
3580
|
/**
|
|
3454
|
-
*
|
|
3581
|
+
* Paginated API Response for the `product category` entity.
|
|
3455
3582
|
* @export
|
|
3456
3583
|
* @interface PaginatedProductCategoryResponse
|
|
3457
3584
|
*/
|
|
@@ -3470,7 +3597,7 @@ export interface PaginatedProductCategoryResponse {
|
|
|
3470
3597
|
'records': Array<ProductCategoryResponse>;
|
|
3471
3598
|
}
|
|
3472
3599
|
/**
|
|
3473
|
-
*
|
|
3600
|
+
* Paginated API Response for the `product` entity.
|
|
3474
3601
|
* @export
|
|
3475
3602
|
* @interface PaginatedProductResponse
|
|
3476
3603
|
*/
|
|
@@ -3565,7 +3692,7 @@ export interface PaginatedUserResponse {
|
|
|
3565
3692
|
'records': Array<UserResponse>;
|
|
3566
3693
|
}
|
|
3567
3694
|
/**
|
|
3568
|
-
*
|
|
3695
|
+
* Paginated API Response for the `vat group` entity.
|
|
3569
3696
|
* @export
|
|
3570
3697
|
* @interface PaginatedVatGroupResponse
|
|
3571
3698
|
*/
|
|
@@ -3690,6 +3817,31 @@ export interface PatchUserTypeRequest {
|
|
|
3690
3817
|
*/
|
|
3691
3818
|
'userType': string;
|
|
3692
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
|
+
}
|
|
3693
3845
|
/**
|
|
3694
3846
|
*
|
|
3695
3847
|
* @export
|
|
@@ -3897,7 +4049,7 @@ export interface PermissionResponse {
|
|
|
3897
4049
|
'actions': Array<ActionResponse>;
|
|
3898
4050
|
}
|
|
3899
4051
|
/**
|
|
3900
|
-
*
|
|
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).
|
|
3901
4053
|
* @export
|
|
3902
4054
|
* @interface PointOfSaleAssociateUsersResponse
|
|
3903
4055
|
*/
|
|
@@ -4050,7 +4202,7 @@ export interface PointOfSaleWithContainersResponse {
|
|
|
4050
4202
|
'containers': Array<ContainerWithProductsResponse>;
|
|
4051
4203
|
}
|
|
4052
4204
|
/**
|
|
4053
|
-
*
|
|
4205
|
+
* API Request for creating or updating a `product category` entity.
|
|
4054
4206
|
* @export
|
|
4055
4207
|
* @interface ProductCategoryRequest
|
|
4056
4208
|
*/
|
|
@@ -4215,35 +4367,85 @@ export interface ProductResponse {
|
|
|
4215
4367
|
'priceList': boolean;
|
|
4216
4368
|
}
|
|
4217
4369
|
/**
|
|
4218
|
-
*
|
|
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.
|
|
4219
4371
|
* @export
|
|
4220
|
-
* @interface
|
|
4372
|
+
* @interface PublicPaymentRequestResponse
|
|
4221
4373
|
*/
|
|
4222
|
-
export interface
|
|
4374
|
+
export interface PublicPaymentRequestResponse {
|
|
4223
4375
|
/**
|
|
4224
|
-
*
|
|
4376
|
+
* UUID v4 identifier.
|
|
4225
4377
|
* @type {string}
|
|
4226
|
-
* @memberof
|
|
4378
|
+
* @memberof PublicPaymentRequestResponse
|
|
4227
4379
|
*/
|
|
4228
|
-
'
|
|
4380
|
+
'uuid': string;
|
|
4229
4381
|
/**
|
|
4230
|
-
*
|
|
4382
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4231
4383
|
* @type {string}
|
|
4232
|
-
* @memberof
|
|
4384
|
+
* @memberof PublicPaymentRequestResponse
|
|
4233
4385
|
*/
|
|
4234
|
-
'
|
|
4386
|
+
'forDisplayName': string;
|
|
4235
4387
|
/**
|
|
4236
|
-
*
|
|
4388
|
+
*
|
|
4389
|
+
* @type {DineroObjectResponse}
|
|
4390
|
+
* @memberof PublicPaymentRequestResponse
|
|
4391
|
+
*/
|
|
4392
|
+
'amount': DineroObjectResponse;
|
|
4393
|
+
/**
|
|
4394
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4237
4395
|
* @type {string}
|
|
4238
|
-
* @memberof
|
|
4396
|
+
* @memberof PublicPaymentRequestResponse
|
|
4239
4397
|
*/
|
|
4240
4398
|
'expiresAt': string;
|
|
4241
|
-
|
|
4242
|
-
|
|
4243
|
-
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
|
|
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];
|
|
4419
|
+
/**
|
|
4420
|
+
*
|
|
4421
|
+
* @export
|
|
4422
|
+
* @interface QRCodeResponse
|
|
4423
|
+
*/
|
|
4424
|
+
export interface QRCodeResponse {
|
|
4425
|
+
/**
|
|
4426
|
+
* The session ID
|
|
4427
|
+
* @type {string}
|
|
4428
|
+
* @memberof QRCodeResponse
|
|
4429
|
+
*/
|
|
4430
|
+
'sessionId': string;
|
|
4431
|
+
/**
|
|
4432
|
+
* The QR code URL
|
|
4433
|
+
* @type {string}
|
|
4434
|
+
* @memberof QRCodeResponse
|
|
4435
|
+
*/
|
|
4436
|
+
'qrCodeUrl': string;
|
|
4437
|
+
/**
|
|
4438
|
+
* The expiry date of the QR code
|
|
4439
|
+
* @type {string}
|
|
4440
|
+
* @memberof QRCodeResponse
|
|
4441
|
+
*/
|
|
4442
|
+
'expiresAt': string;
|
|
4443
|
+
}
|
|
4444
|
+
/**
|
|
4445
|
+
*
|
|
4446
|
+
* @export
|
|
4447
|
+
* @interface QRStatusResponse
|
|
4448
|
+
*/
|
|
4247
4449
|
export interface QRStatusResponse {
|
|
4248
4450
|
/**
|
|
4249
4451
|
* The status of the QR code
|
|
@@ -5095,6 +5297,12 @@ export interface TermsOfServiceResponse {
|
|
|
5095
5297
|
* @memberof TermsOfServiceResponse
|
|
5096
5298
|
*/
|
|
5097
5299
|
'versionNumber': string;
|
|
5300
|
+
/**
|
|
5301
|
+
* The date this version took effect.
|
|
5302
|
+
* @type {string}
|
|
5303
|
+
* @memberof TermsOfServiceResponse
|
|
5304
|
+
*/
|
|
5305
|
+
'date': string;
|
|
5098
5306
|
/**
|
|
5099
5307
|
* The terms of service content.
|
|
5100
5308
|
* @type {string}
|
|
@@ -5115,23 +5323,23 @@ export interface TotalBalanceResponse {
|
|
|
5115
5323
|
*/
|
|
5116
5324
|
'date': string;
|
|
5117
5325
|
/**
|
|
5118
|
-
*
|
|
5119
|
-
* @type {
|
|
5326
|
+
*
|
|
5327
|
+
* @type {DineroObjectResponse}
|
|
5120
5328
|
* @memberof TotalBalanceResponse
|
|
5121
5329
|
*/
|
|
5122
|
-
'totalPositive':
|
|
5330
|
+
'totalPositive': DineroObjectResponse;
|
|
5123
5331
|
/**
|
|
5124
|
-
*
|
|
5125
|
-
* @type {
|
|
5332
|
+
*
|
|
5333
|
+
* @type {DineroObjectResponse}
|
|
5126
5334
|
* @memberof TotalBalanceResponse
|
|
5127
5335
|
*/
|
|
5128
|
-
'totalNegative':
|
|
5336
|
+
'totalNegative': DineroObjectResponse;
|
|
5129
5337
|
/**
|
|
5130
|
-
*
|
|
5131
|
-
* @type {UserTypeTotalBalanceResponse}
|
|
5338
|
+
* The total balances for the different user types
|
|
5339
|
+
* @type {Array<UserTypeTotalBalanceResponse>}
|
|
5132
5340
|
* @memberof TotalBalanceResponse
|
|
5133
5341
|
*/
|
|
5134
|
-
'userTypeBalances': UserTypeTotalBalanceResponse
|
|
5342
|
+
'userTypeBalances': Array<UserTypeTotalBalanceResponse>;
|
|
5135
5343
|
}
|
|
5136
5344
|
/**
|
|
5137
5345
|
*
|
|
@@ -5716,7 +5924,7 @@ export interface TransferSummaryResponse {
|
|
|
5716
5924
|
'manualDeletions': TransferAggregateResponse;
|
|
5717
5925
|
}
|
|
5718
5926
|
/**
|
|
5719
|
-
*
|
|
5927
|
+
* API Request for updating a `container` entity.
|
|
5720
5928
|
* @export
|
|
5721
5929
|
* @interface UpdateContainerRequest
|
|
5722
5930
|
*/
|
|
@@ -5966,7 +6174,7 @@ export interface UpdatePinRequest {
|
|
|
5966
6174
|
'pin': string;
|
|
5967
6175
|
}
|
|
5968
6176
|
/**
|
|
5969
|
-
*
|
|
6177
|
+
* API Request for updating a `point of sale` entity.
|
|
5970
6178
|
* @export
|
|
5971
6179
|
* @interface UpdatePointOfSaleRequest
|
|
5972
6180
|
*/
|
|
@@ -6003,7 +6211,7 @@ export interface UpdatePointOfSaleRequest {
|
|
|
6003
6211
|
'cashierRoleIds'?: Array<number>;
|
|
6004
6212
|
}
|
|
6005
6213
|
/**
|
|
6006
|
-
*
|
|
6214
|
+
* API Request for updating a `product` entity.
|
|
6007
6215
|
* @export
|
|
6008
6216
|
* @interface UpdateProductRequest
|
|
6009
6217
|
*/
|
|
@@ -6168,9 +6376,15 @@ export interface UpdateUserRequest {
|
|
|
6168
6376
|
* @memberof UpdateUserRequest
|
|
6169
6377
|
*/
|
|
6170
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;
|
|
6171
6385
|
}
|
|
6172
6386
|
/**
|
|
6173
|
-
*
|
|
6387
|
+
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
6174
6388
|
* @export
|
|
6175
6389
|
* @interface UpdateVatGroupRequest
|
|
6176
6390
|
*/
|
|
@@ -6384,6 +6598,12 @@ export interface UserResponse {
|
|
|
6384
6598
|
* @memberof UserResponse
|
|
6385
6599
|
*/
|
|
6386
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;
|
|
6387
6607
|
}
|
|
6388
6608
|
/**
|
|
6389
6609
|
*
|
|
@@ -6490,6 +6710,22 @@ export interface UserToInactiveAdministrativeCostResponse {
|
|
|
6490
6710
|
*/
|
|
6491
6711
|
'nickname'?: string;
|
|
6492
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];
|
|
6493
6729
|
/**
|
|
6494
6730
|
*
|
|
6495
6731
|
* @export
|
|
@@ -6516,7 +6752,7 @@ export interface UserTypeTotalBalanceResponse {
|
|
|
6516
6752
|
'totalNegative': DineroObjectResponse;
|
|
6517
6753
|
}
|
|
6518
6754
|
/**
|
|
6519
|
-
*
|
|
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.
|
|
6520
6756
|
* @export
|
|
6521
6757
|
* @interface UserWithIndex
|
|
6522
6758
|
*/
|
|
@@ -6531,6 +6767,25 @@ export interface UserWithIndex {
|
|
|
6531
6767
|
/**
|
|
6532
6768
|
*
|
|
6533
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
|
|
6534
6789
|
* @interface VatDeclarationResponse
|
|
6535
6790
|
*/
|
|
6536
6791
|
export interface VatDeclarationResponse {
|
|
@@ -6554,7 +6809,7 @@ export interface VatDeclarationResponse {
|
|
|
6554
6809
|
'rows': Array<VatDeclarationRow>;
|
|
6555
6810
|
}
|
|
6556
6811
|
/**
|
|
6557
|
-
*
|
|
6812
|
+
* One row of a VAT declaration — the VAT collected for a single group, broken down by period.
|
|
6558
6813
|
* @export
|
|
6559
6814
|
* @interface VatDeclarationRow
|
|
6560
6815
|
*/
|
|
@@ -7022,10 +7277,9 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7022
7277
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7023
7278
|
/**
|
|
7024
7279
|
*
|
|
7025
|
-
* @summary EAN
|
|
7026
|
-
* @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
|
|
7027
7282
|
* @param {*} [options] Override http request option.
|
|
7028
|
-
* @deprecated
|
|
7029
7283
|
* @throws {RequiredError}
|
|
7030
7284
|
*/
|
|
7031
7285
|
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7100,13 +7354,12 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7100
7354
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7101
7355
|
/**
|
|
7102
7356
|
*
|
|
7103
|
-
* @summary PIN
|
|
7104
|
-
* @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
|
|
7105
7359
|
* @param {*} [options] Override http request option.
|
|
7106
|
-
* @deprecated
|
|
7107
7360
|
* @throws {RequiredError}
|
|
7108
7361
|
*/
|
|
7109
|
-
|
|
7362
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7110
7363
|
/**
|
|
7111
7364
|
*
|
|
7112
7365
|
* @summary Mock login and hand out token.
|
|
@@ -7117,19 +7370,17 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7117
7370
|
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7118
7371
|
/**
|
|
7119
7372
|
*
|
|
7120
|
-
* @summary NFC
|
|
7121
|
-
* @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
|
|
7122
7375
|
* @param {*} [options] Override http request option.
|
|
7123
|
-
* @deprecated
|
|
7124
7376
|
* @throws {RequiredError}
|
|
7125
7377
|
*/
|
|
7126
7378
|
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7127
7379
|
/**
|
|
7128
7380
|
*
|
|
7129
|
-
* @summary PIN
|
|
7130
|
-
* @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
|
|
7131
7383
|
* @param {*} [options] Override http request option.
|
|
7132
|
-
* @deprecated
|
|
7133
7384
|
* @throws {RequiredError}
|
|
7134
7385
|
*/
|
|
7135
7386
|
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7156,38 +7407,6 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7156
7407
|
* @throws {RequiredError}
|
|
7157
7408
|
*/
|
|
7158
7409
|
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7159
|
-
/**
|
|
7160
|
-
*
|
|
7161
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7162
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7163
|
-
* @param {*} [options] Override http request option.
|
|
7164
|
-
* @throws {RequiredError}
|
|
7165
|
-
*/
|
|
7166
|
-
secureEanAuthentication: (authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
|
-
/**
|
|
7168
|
-
*
|
|
7169
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7170
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7171
|
-
* @param {*} [options] Override http request option.
|
|
7172
|
-
* @throws {RequiredError}
|
|
7173
|
-
*/
|
|
7174
|
-
secureMemberPINAuthentication: (memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7175
|
-
/**
|
|
7176
|
-
*
|
|
7177
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7178
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7179
|
-
* @param {*} [options] Override http request option.
|
|
7180
|
-
* @throws {RequiredError}
|
|
7181
|
-
*/
|
|
7182
|
-
secureNfcAuthentication: (authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7183
|
-
/**
|
|
7184
|
-
*
|
|
7185
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7186
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7187
|
-
* @param {*} [options] Override http request option.
|
|
7188
|
-
* @throws {RequiredError}
|
|
7189
|
-
*/
|
|
7190
|
-
securePINAuthentication: (authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7191
7410
|
};
|
|
7192
7411
|
/**
|
|
7193
7412
|
* AuthenticateApi - functional programming interface
|
|
@@ -7220,10 +7439,9 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7220
7439
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7221
7440
|
/**
|
|
7222
7441
|
*
|
|
7223
|
-
* @summary EAN
|
|
7224
|
-
* @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
|
|
7225
7444
|
* @param {*} [options] Override http request option.
|
|
7226
|
-
* @deprecated
|
|
7227
7445
|
* @throws {RequiredError}
|
|
7228
7446
|
*/
|
|
7229
7447
|
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7298,13 +7516,12 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7298
7516
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7299
7517
|
/**
|
|
7300
7518
|
*
|
|
7301
|
-
* @summary PIN
|
|
7302
|
-
* @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
|
|
7303
7521
|
* @param {*} [options] Override http request option.
|
|
7304
|
-
* @deprecated
|
|
7305
7522
|
* @throws {RequiredError}
|
|
7306
7523
|
*/
|
|
7307
|
-
|
|
7524
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7308
7525
|
/**
|
|
7309
7526
|
*
|
|
7310
7527
|
* @summary Mock login and hand out token.
|
|
@@ -7315,19 +7532,17 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7315
7532
|
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7316
7533
|
/**
|
|
7317
7534
|
*
|
|
7318
|
-
* @summary NFC
|
|
7319
|
-
* @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
|
|
7320
7537
|
* @param {*} [options] Override http request option.
|
|
7321
|
-
* @deprecated
|
|
7322
7538
|
* @throws {RequiredError}
|
|
7323
7539
|
*/
|
|
7324
7540
|
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7325
7541
|
/**
|
|
7326
7542
|
*
|
|
7327
|
-
* @summary PIN
|
|
7328
|
-
* @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
|
|
7329
7545
|
* @param {*} [options] Override http request option.
|
|
7330
|
-
* @deprecated
|
|
7331
7546
|
* @throws {RequiredError}
|
|
7332
7547
|
*/
|
|
7333
7548
|
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
@@ -7354,38 +7569,6 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7354
7569
|
* @throws {RequiredError}
|
|
7355
7570
|
*/
|
|
7356
7571
|
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7357
|
-
/**
|
|
7358
|
-
*
|
|
7359
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7360
|
-
* @param {AuthenticationSecureEanRequest} authenticationSecureEanRequest The EAN login request with posId
|
|
7361
|
-
* @param {*} [options] Override http request option.
|
|
7362
|
-
* @throws {RequiredError}
|
|
7363
|
-
*/
|
|
7364
|
-
secureEanAuthentication(authenticationSecureEanRequest: AuthenticationSecureEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7365
|
-
/**
|
|
7366
|
-
*
|
|
7367
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7368
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7369
|
-
* @param {*} [options] Override http request option.
|
|
7370
|
-
* @throws {RequiredError}
|
|
7371
|
-
*/
|
|
7372
|
-
secureMemberPINAuthentication(memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7373
|
-
/**
|
|
7374
|
-
*
|
|
7375
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7376
|
-
* @param {AuthenticationSecureNfcRequest} authenticationSecureNfcRequest The NFC login request with posId
|
|
7377
|
-
* @param {*} [options] Override http request option.
|
|
7378
|
-
* @throws {RequiredError}
|
|
7379
|
-
*/
|
|
7380
|
-
secureNfcAuthentication(authenticationSecureNfcRequest: AuthenticationSecureNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7381
|
-
/**
|
|
7382
|
-
*
|
|
7383
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7384
|
-
* @param {AuthenticationSecurePinRequest} authenticationSecurePinRequest The PIN login request with posId
|
|
7385
|
-
* @param {*} [options] Override http request option.
|
|
7386
|
-
* @throws {RequiredError}
|
|
7387
|
-
*/
|
|
7388
|
-
securePINAuthentication(authenticationSecurePinRequest: AuthenticationSecurePinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7389
7572
|
};
|
|
7390
7573
|
/**
|
|
7391
7574
|
* AuthenticateApi - factory interface
|
|
@@ -7418,10 +7601,9 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7418
7601
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7419
7602
|
/**
|
|
7420
7603
|
*
|
|
7421
|
-
* @summary EAN
|
|
7604
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7422
7605
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7423
7606
|
* @param {*} [options] Override http request option.
|
|
7424
|
-
* @deprecated
|
|
7425
7607
|
* @throws {RequiredError}
|
|
7426
7608
|
*/
|
|
7427
7609
|
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7496,13 +7678,12 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7496
7678
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7497
7679
|
/**
|
|
7498
7680
|
*
|
|
7499
|
-
* @summary PIN
|
|
7500
|
-
* @param {
|
|
7681
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7682
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7501
7683
|
* @param {*} [options] Override http request option.
|
|
7502
|
-
* @deprecated
|
|
7503
7684
|
* @throws {RequiredError}
|
|
7504
7685
|
*/
|
|
7505
|
-
|
|
7686
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7506
7687
|
/**
|
|
7507
7688
|
*
|
|
7508
7689
|
* @summary Mock login and hand out token.
|
|
@@ -7513,19 +7694,17 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7513
7694
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7514
7695
|
/**
|
|
7515
7696
|
*
|
|
7516
|
-
* @summary NFC
|
|
7697
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7517
7698
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7518
7699
|
* @param {*} [options] Override http request option.
|
|
7519
|
-
* @deprecated
|
|
7520
7700
|
* @throws {RequiredError}
|
|
7521
7701
|
*/
|
|
7522
7702
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7523
7703
|
/**
|
|
7524
7704
|
*
|
|
7525
|
-
* @summary PIN
|
|
7705
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7526
7706
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7527
7707
|
* @param {*} [options] Override http request option.
|
|
7528
|
-
* @deprecated
|
|
7529
7708
|
* @throws {RequiredError}
|
|
7530
7709
|
*/
|
|
7531
7710
|
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
@@ -7552,38 +7731,6 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7552
7731
|
* @throws {RequiredError}
|
|
7553
7732
|
*/
|
|
7554
7733
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7555
|
-
/**
|
|
7556
|
-
*
|
|
7557
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
7558
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
7559
|
-
* @param {*} [options] Override http request option.
|
|
7560
|
-
* @throws {RequiredError}
|
|
7561
|
-
*/
|
|
7562
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7563
|
-
/**
|
|
7564
|
-
*
|
|
7565
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
7566
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7567
|
-
* @param {*} [options] Override http request option.
|
|
7568
|
-
* @throws {RequiredError}
|
|
7569
|
-
*/
|
|
7570
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7571
|
-
/**
|
|
7572
|
-
*
|
|
7573
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
7574
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7575
|
-
* @param {*} [options] Override http request option.
|
|
7576
|
-
* @throws {RequiredError}
|
|
7577
|
-
*/
|
|
7578
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7579
|
-
/**
|
|
7580
|
-
*
|
|
7581
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
7582
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
7583
|
-
* @param {*} [options] Override http request option.
|
|
7584
|
-
* @throws {RequiredError}
|
|
7585
|
-
*/
|
|
7586
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7587
7734
|
};
|
|
7588
7735
|
/**
|
|
7589
7736
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7631,7 +7778,7 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7631
7778
|
*/
|
|
7632
7779
|
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7633
7780
|
/**
|
|
7634
|
-
* The EAN login
|
|
7781
|
+
* The EAN login request with posId
|
|
7635
7782
|
* @type {AuthenticationEanRequest}
|
|
7636
7783
|
* @memberof AuthenticateApiEanAuthentication
|
|
7637
7784
|
*/
|
|
@@ -7716,15 +7863,15 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7716
7863
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7717
7864
|
}
|
|
7718
7865
|
/**
|
|
7719
|
-
* Request parameters for
|
|
7866
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7720
7867
|
* @export
|
|
7721
|
-
* @interface
|
|
7868
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7722
7869
|
*/
|
|
7723
|
-
export interface
|
|
7870
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7724
7871
|
/**
|
|
7725
|
-
* The PIN login
|
|
7872
|
+
* The PIN login request with posId
|
|
7726
7873
|
* @type {MemberAuthenticationPinRequest}
|
|
7727
|
-
* @memberof
|
|
7874
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7728
7875
|
*/
|
|
7729
7876
|
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7730
7877
|
}
|
|
@@ -7748,7 +7895,7 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7748
7895
|
*/
|
|
7749
7896
|
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7750
7897
|
/**
|
|
7751
|
-
* The NFC login
|
|
7898
|
+
* The NFC login request with posId
|
|
7752
7899
|
* @type {AuthenticationNfcRequest}
|
|
7753
7900
|
* @memberof AuthenticateApiNfcAuthentication
|
|
7754
7901
|
*/
|
|
@@ -7761,7 +7908,7 @@ export interface AuthenticateApiNfcAuthenticationRequest {
|
|
|
7761
7908
|
*/
|
|
7762
7909
|
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7763
7910
|
/**
|
|
7764
|
-
* The PIN login
|
|
7911
|
+
* The PIN login request with posId
|
|
7765
7912
|
* @type {AuthenticationPinRequest}
|
|
7766
7913
|
* @memberof AuthenticateApiPinAuthentication
|
|
7767
7914
|
*/
|
|
@@ -7793,58 +7940,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7793
7940
|
*/
|
|
7794
7941
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7795
7942
|
}
|
|
7796
|
-
/**
|
|
7797
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7798
|
-
* @export
|
|
7799
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7800
|
-
*/
|
|
7801
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7802
|
-
/**
|
|
7803
|
-
* The EAN login request with posId
|
|
7804
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7805
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7806
|
-
*/
|
|
7807
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7808
|
-
}
|
|
7809
|
-
/**
|
|
7810
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7811
|
-
* @export
|
|
7812
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7813
|
-
*/
|
|
7814
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7815
|
-
/**
|
|
7816
|
-
* The PIN login request with posId
|
|
7817
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7818
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7819
|
-
*/
|
|
7820
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7821
|
-
}
|
|
7822
|
-
/**
|
|
7823
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7824
|
-
* @export
|
|
7825
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7826
|
-
*/
|
|
7827
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7828
|
-
/**
|
|
7829
|
-
* The NFC login request with posId
|
|
7830
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7831
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7832
|
-
*/
|
|
7833
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7834
|
-
}
|
|
7835
|
-
/**
|
|
7836
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7837
|
-
* @export
|
|
7838
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7839
|
-
*/
|
|
7840
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7841
|
-
/**
|
|
7842
|
-
* The PIN login request with posId
|
|
7843
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7844
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7845
|
-
*/
|
|
7846
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7847
|
-
}
|
|
7848
7943
|
/**
|
|
7849
7944
|
* AuthenticateApi - object-oriented interface
|
|
7850
7945
|
* @export
|
|
@@ -7881,10 +7976,9 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7881
7976
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7882
7977
|
/**
|
|
7883
7978
|
*
|
|
7884
|
-
* @summary EAN
|
|
7979
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7885
7980
|
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7886
7981
|
* @param {*} [options] Override http request option.
|
|
7887
|
-
* @deprecated
|
|
7888
7982
|
* @throws {RequiredError}
|
|
7889
7983
|
* @memberof AuthenticateApi
|
|
7890
7984
|
*/
|
|
@@ -7969,14 +8063,13 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7969
8063
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7970
8064
|
/**
|
|
7971
8065
|
*
|
|
7972
|
-
* @summary PIN
|
|
7973
|
-
* @param {
|
|
8066
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8067
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7974
8068
|
* @param {*} [options] Override http request option.
|
|
7975
|
-
* @deprecated
|
|
7976
8069
|
* @throws {RequiredError}
|
|
7977
8070
|
* @memberof AuthenticateApi
|
|
7978
8071
|
*/
|
|
7979
|
-
|
|
8072
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7980
8073
|
/**
|
|
7981
8074
|
*
|
|
7982
8075
|
* @summary Mock login and hand out token.
|
|
@@ -7988,20 +8081,18 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7988
8081
|
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7989
8082
|
/**
|
|
7990
8083
|
*
|
|
7991
|
-
* @summary NFC
|
|
8084
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7992
8085
|
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7993
8086
|
* @param {*} [options] Override http request option.
|
|
7994
|
-
* @deprecated
|
|
7995
8087
|
* @throws {RequiredError}
|
|
7996
8088
|
* @memberof AuthenticateApi
|
|
7997
8089
|
*/
|
|
7998
8090
|
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7999
8091
|
/**
|
|
8000
8092
|
*
|
|
8001
|
-
* @summary PIN
|
|
8093
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8002
8094
|
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
8003
8095
|
* @param {*} [options] Override http request option.
|
|
8004
|
-
* @deprecated
|
|
8005
8096
|
* @throws {RequiredError}
|
|
8006
8097
|
* @memberof AuthenticateApi
|
|
8007
8098
|
*/
|
|
@@ -8032,42 +8123,6 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
8032
8123
|
* @memberof AuthenticateApi
|
|
8033
8124
|
*/
|
|
8034
8125
|
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8035
|
-
/**
|
|
8036
|
-
*
|
|
8037
|
-
* @summary Secure EAN authentication that requires POS user authentication
|
|
8038
|
-
* @param {AuthenticateApiSecureEanAuthenticationRequest} requestParameters Request parameters.
|
|
8039
|
-
* @param {*} [options] Override http request option.
|
|
8040
|
-
* @throws {RequiredError}
|
|
8041
|
-
* @memberof AuthenticateApi
|
|
8042
|
-
*/
|
|
8043
|
-
secureEanAuthentication(requestParameters: AuthenticateApiSecureEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8044
|
-
/**
|
|
8045
|
-
*
|
|
8046
|
-
* @summary Secure member PIN authentication that requires POS user authentication
|
|
8047
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8048
|
-
* @param {*} [options] Override http request option.
|
|
8049
|
-
* @throws {RequiredError}
|
|
8050
|
-
* @memberof AuthenticateApi
|
|
8051
|
-
*/
|
|
8052
|
-
secureMemberPINAuthentication(requestParameters: AuthenticateApiSecureMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8053
|
-
/**
|
|
8054
|
-
*
|
|
8055
|
-
* @summary Secure NFC authentication that requires POS user authentication
|
|
8056
|
-
* @param {AuthenticateApiSecureNfcAuthenticationRequest} requestParameters Request parameters.
|
|
8057
|
-
* @param {*} [options] Override http request option.
|
|
8058
|
-
* @throws {RequiredError}
|
|
8059
|
-
* @memberof AuthenticateApi
|
|
8060
|
-
*/
|
|
8061
|
-
secureNfcAuthentication(requestParameters: AuthenticateApiSecureNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8062
|
-
/**
|
|
8063
|
-
*
|
|
8064
|
-
* @summary Secure PIN authentication that requires POS user authentication
|
|
8065
|
-
* @param {AuthenticateApiSecurePINAuthenticationRequest} requestParameters Request parameters.
|
|
8066
|
-
* @param {*} [options] Override http request option.
|
|
8067
|
-
* @throws {RequiredError}
|
|
8068
|
-
* @memberof AuthenticateApi
|
|
8069
|
-
*/
|
|
8070
|
-
securePINAuthentication(requestParameters: AuthenticateApiSecurePINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
8071
8126
|
}
|
|
8072
8127
|
/**
|
|
8073
8128
|
* BalanceApi - axios parameter creator
|
|
@@ -8092,7 +8147,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8092
8147
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8093
8148
|
* @param {number} [minFine] Minimum fine
|
|
8094
8149
|
* @param {number} [maxFine] Maximum fine
|
|
8095
|
-
* @param {
|
|
8150
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8096
8151
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8097
8152
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8098
8153
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8102,7 +8157,7 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8102
8157
|
* @param {*} [options] Override http request option.
|
|
8103
8158
|
* @throws {RequiredError}
|
|
8104
8159
|
*/
|
|
8105
|
-
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>;
|
|
8106
8161
|
/**
|
|
8107
8162
|
*
|
|
8108
8163
|
* @summary Retrieves the requested balance
|
|
@@ -8142,7 +8197,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8142
8197
|
* @param {boolean} [hasFine] Only users with(out) fines
|
|
8143
8198
|
* @param {number} [minFine] Minimum fine
|
|
8144
8199
|
* @param {number} [maxFine] Maximum fine
|
|
8145
|
-
* @param {
|
|
8200
|
+
* @param {Array<UserType>} [userTypes] Filter based on user type.
|
|
8146
8201
|
* @param {string} [orderBy] Column to order balance by - eg: id,amount
|
|
8147
8202
|
* @param {GetAllBalanceOrderDirectionEnum} [orderDirection] Order direction
|
|
8148
8203
|
* @param {boolean} [allowDeleted] Whether to include deleted users
|
|
@@ -8152,7 +8207,7 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
|
8152
8207
|
* @param {*} [options] Override http request option.
|
|
8153
8208
|
* @throws {RequiredError}
|
|
8154
8209
|
*/
|
|
8155
|
-
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>>;
|
|
8156
8211
|
/**
|
|
8157
8212
|
*
|
|
8158
8213
|
* @summary Retrieves the requested balance
|
|
@@ -8269,10 +8324,10 @@ export interface BalanceApiGetAllBalanceRequest {
|
|
|
8269
8324
|
readonly maxFine?: number;
|
|
8270
8325
|
/**
|
|
8271
8326
|
* Filter based on user type.
|
|
8272
|
-
* @type {Array<
|
|
8327
|
+
* @type {Array<UserType>}
|
|
8273
8328
|
* @memberof BalanceApiGetAllBalance
|
|
8274
8329
|
*/
|
|
8275
|
-
readonly userTypes?:
|
|
8330
|
+
readonly userTypes?: Array<UserType>;
|
|
8276
8331
|
/**
|
|
8277
8332
|
* Column to order balance by - eg: id,amount
|
|
8278
8333
|
* @type {string}
|
|
@@ -8366,11 +8421,6 @@ export declare class BalanceApi extends BaseAPI {
|
|
|
8366
8421
|
*/
|
|
8367
8422
|
getBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
|
|
8368
8423
|
}
|
|
8369
|
-
/**
|
|
8370
|
-
* @export
|
|
8371
|
-
*/
|
|
8372
|
-
export declare const GetAllBalanceUserTypesEnum: {};
|
|
8373
|
-
export type GetAllBalanceUserTypesEnum = typeof GetAllBalanceUserTypesEnum[keyof typeof GetAllBalanceUserTypesEnum];
|
|
8374
8424
|
/**
|
|
8375
8425
|
* @export
|
|
8376
8426
|
*/
|
|
@@ -10791,7 +10841,7 @@ export declare const InactiveAdministrativeCostsApiFp: (configuration?: Configur
|
|
|
10791
10841
|
* @param {*} [options] Override http request option.
|
|
10792
10842
|
* @throws {RequiredError}
|
|
10793
10843
|
*/
|
|
10794
|
-
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>>>;
|
|
10795
10845
|
/**
|
|
10796
10846
|
*
|
|
10797
10847
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -10869,7 +10919,7 @@ export declare const InactiveAdministrativeCostsApiFactory: (configuration?: Con
|
|
|
10869
10919
|
* @param {*} [options] Override http request option.
|
|
10870
10920
|
* @throws {RequiredError}
|
|
10871
10921
|
*/
|
|
10872
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10922
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<InactiveAdministrativeCostResponse>>;
|
|
10873
10923
|
/**
|
|
10874
10924
|
*
|
|
10875
10925
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11092,7 +11142,7 @@ export declare class InactiveAdministrativeCostsApi extends BaseAPI {
|
|
|
11092
11142
|
* @throws {RequiredError}
|
|
11093
11143
|
* @memberof InactiveAdministrativeCostsApi
|
|
11094
11144
|
*/
|
|
11095
|
-
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11145
|
+
handoutInactiveAdministrativeCostsUsers(requestParameters: InactiveAdministrativeCostsApiHandoutInactiveAdministrativeCostsUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InactiveAdministrativeCostResponse[], any, {}>>;
|
|
11096
11146
|
/**
|
|
11097
11147
|
*
|
|
11098
11148
|
* @summary Notify all users which will pay administrative costs within a year
|
|
@@ -11137,7 +11187,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11137
11187
|
* @summary Returns all invoices in the system.
|
|
11138
11188
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11139
11189
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11140
|
-
* @param {
|
|
11190
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11141
11191
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11142
11192
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11143
11193
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11147,7 +11197,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
11147
11197
|
* @param {*} [options] Override http request option.
|
|
11148
11198
|
* @throws {RequiredError}
|
|
11149
11199
|
*/
|
|
11150
|
-
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>;
|
|
11151
11201
|
/**
|
|
11152
11202
|
*
|
|
11153
11203
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11244,7 +11294,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11244
11294
|
* @summary Returns all invoices in the system.
|
|
11245
11295
|
* @param {number} [toId] Filter on Id of the debtor
|
|
11246
11296
|
* @param {number} [invoiceId] Filter on invoice ID
|
|
11247
|
-
* @param {
|
|
11297
|
+
* @param {Array<GetAllInvoicesCurrentStateParameterInner>} [currentState] Filter based on Invoice State.
|
|
11248
11298
|
* @param {boolean} [returnEntries] Boolean if invoice entries should be returned
|
|
11249
11299
|
* @param {string} [fromDate] Start date for selected invoices (inclusive)
|
|
11250
11300
|
* @param {string} [tillDate] End date for selected invoices (exclusive)
|
|
@@ -11254,7 +11304,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11254
11304
|
* @param {*} [options] Override http request option.
|
|
11255
11305
|
* @throws {RequiredError}
|
|
11256
11306
|
*/
|
|
11257
|
-
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>>;
|
|
11258
11308
|
/**
|
|
11259
11309
|
*
|
|
11260
11310
|
* @summary Get eligible transactions for invoice creation.
|
|
@@ -11264,7 +11314,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11264
11314
|
* @param {*} [options] Override http request option.
|
|
11265
11315
|
* @throws {RequiredError}
|
|
11266
11316
|
*/
|
|
11267
|
-
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>>>;
|
|
11268
11318
|
/**
|
|
11269
11319
|
*
|
|
11270
11320
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11280,7 +11330,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11280
11330
|
* @param {*} [options] Override http request option.
|
|
11281
11331
|
* @throws {RequiredError}
|
|
11282
11332
|
*/
|
|
11283
|
-
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>>;
|
|
11284
11334
|
/**
|
|
11285
11335
|
*
|
|
11286
11336
|
* @summary Returns a single invoice in the system.
|
|
@@ -11361,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11361
11411
|
* @param {*} [options] Override http request option.
|
|
11362
11412
|
* @throws {RequiredError}
|
|
11363
11413
|
*/
|
|
11364
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11414
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11365
11415
|
/**
|
|
11366
11416
|
*
|
|
11367
11417
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11376,7 +11426,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11376
11426
|
* @param {*} [options] Override http request option.
|
|
11377
11427
|
* @throws {RequiredError}
|
|
11378
11428
|
*/
|
|
11379
|
-
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11429
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
|
|
11380
11430
|
/**
|
|
11381
11431
|
*
|
|
11382
11432
|
* @summary Returns a single invoice in the system.
|
|
@@ -11469,10 +11519,10 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11469
11519
|
readonly invoiceId?: number;
|
|
11470
11520
|
/**
|
|
11471
11521
|
* Filter based on Invoice State.
|
|
11472
|
-
* @type {Array<
|
|
11522
|
+
* @type {Array<GetAllInvoicesCurrentStateParameterInner>}
|
|
11473
11523
|
* @memberof InvoicesApiGetAllInvoices
|
|
11474
11524
|
*/
|
|
11475
|
-
readonly currentState?:
|
|
11525
|
+
readonly currentState?: Array<GetAllInvoicesCurrentStateParameterInner>;
|
|
11476
11526
|
/**
|
|
11477
11527
|
* Boolean if invoice entries should be returned
|
|
11478
11528
|
* @type {boolean}
|
|
@@ -11531,210 +11581,691 @@ export interface InvoicesApiGetEligibleTransactionsRequest {
|
|
|
11531
11581
|
/**
|
|
11532
11582
|
* End date for selected transactions (exclusive)
|
|
11533
11583
|
* @type {string}
|
|
11534
|
-
* @memberof InvoicesApiGetEligibleTransactions
|
|
11584
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11585
|
+
*/
|
|
11586
|
+
readonly tillDate?: string;
|
|
11587
|
+
}
|
|
11588
|
+
/**
|
|
11589
|
+
* Request parameters for getInvoicePdf operation in InvoicesApi.
|
|
11590
|
+
* @export
|
|
11591
|
+
* @interface InvoicesApiGetInvoicePdfRequest
|
|
11592
|
+
*/
|
|
11593
|
+
export interface InvoicesApiGetInvoicePdfRequest {
|
|
11594
|
+
/**
|
|
11595
|
+
* The id of the invoice to return
|
|
11596
|
+
* @type {number}
|
|
11597
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11598
|
+
*/
|
|
11599
|
+
readonly id: number;
|
|
11600
|
+
/**
|
|
11601
|
+
* Force creation of pdf
|
|
11602
|
+
* @type {boolean}
|
|
11603
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11604
|
+
*/
|
|
11605
|
+
readonly force?: boolean;
|
|
11606
|
+
}
|
|
11607
|
+
/**
|
|
11608
|
+
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11609
|
+
* @export
|
|
11610
|
+
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11611
|
+
*/
|
|
11612
|
+
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11613
|
+
/**
|
|
11614
|
+
* The id of the requested invoice
|
|
11615
|
+
* @type {number}
|
|
11616
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11617
|
+
*/
|
|
11618
|
+
readonly id: number;
|
|
11619
|
+
/**
|
|
11620
|
+
* Boolean if invoice entries should be returned, defaults to true.
|
|
11621
|
+
* @type {boolean}
|
|
11622
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11623
|
+
*/
|
|
11624
|
+
readonly returnEntries?: boolean;
|
|
11625
|
+
}
|
|
11626
|
+
/**
|
|
11627
|
+
* Request parameters for getSingleInvoiceUser operation in InvoicesApi.
|
|
11628
|
+
* @export
|
|
11629
|
+
* @interface InvoicesApiGetSingleInvoiceUserRequest
|
|
11630
|
+
*/
|
|
11631
|
+
export interface InvoicesApiGetSingleInvoiceUserRequest {
|
|
11632
|
+
/**
|
|
11633
|
+
* The id of the invoice user to return.
|
|
11634
|
+
* @type {number}
|
|
11635
|
+
* @memberof InvoicesApiGetSingleInvoiceUser
|
|
11636
|
+
*/
|
|
11637
|
+
readonly id: number;
|
|
11638
|
+
}
|
|
11639
|
+
/**
|
|
11640
|
+
* Request parameters for putInvoiceUser operation in InvoicesApi.
|
|
11641
|
+
* @export
|
|
11642
|
+
* @interface InvoicesApiPutInvoiceUserRequest
|
|
11643
|
+
*/
|
|
11644
|
+
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11645
|
+
/**
|
|
11646
|
+
* The id of the user to update
|
|
11647
|
+
* @type {number}
|
|
11648
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11649
|
+
*/
|
|
11650
|
+
readonly id: number;
|
|
11651
|
+
/**
|
|
11652
|
+
* The invoice user which should be updated
|
|
11653
|
+
* @type {UpdateInvoiceUserRequest}
|
|
11654
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11655
|
+
*/
|
|
11656
|
+
readonly updateInvoiceUserRequest: UpdateInvoiceUserRequest;
|
|
11657
|
+
}
|
|
11658
|
+
/**
|
|
11659
|
+
* Request parameters for updateInvoice operation in InvoicesApi.
|
|
11660
|
+
* @export
|
|
11661
|
+
* @interface InvoicesApiUpdateInvoiceRequest
|
|
11662
|
+
*/
|
|
11663
|
+
export interface InvoicesApiUpdateInvoiceRequest {
|
|
11664
|
+
/**
|
|
11665
|
+
* The id of the invoice which should be updated
|
|
11666
|
+
* @type {number}
|
|
11667
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11668
|
+
*/
|
|
11669
|
+
readonly id: number;
|
|
11670
|
+
/**
|
|
11671
|
+
* The invoice update to process
|
|
11672
|
+
* @type {UpdateInvoiceRequest}
|
|
11673
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11674
|
+
*/
|
|
11675
|
+
readonly updateInvoiceRequest: UpdateInvoiceRequest;
|
|
11676
|
+
}
|
|
11677
|
+
/**
|
|
11678
|
+
* InvoicesApi - object-oriented interface
|
|
11679
|
+
* @export
|
|
11680
|
+
* @class InvoicesApi
|
|
11681
|
+
* @extends {BaseAPI}
|
|
11682
|
+
*/
|
|
11683
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
11684
|
+
/**
|
|
11685
|
+
*
|
|
11686
|
+
* @summary Adds an invoice to the system.
|
|
11687
|
+
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
11688
|
+
* @param {*} [options] Override http request option.
|
|
11689
|
+
* @throws {RequiredError}
|
|
11690
|
+
* @memberof InvoicesApi
|
|
11691
|
+
*/
|
|
11692
|
+
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11693
|
+
/**
|
|
11694
|
+
*
|
|
11695
|
+
* @summary Deletes an invoice.
|
|
11696
|
+
* @param {InvoicesApiDeleteInvoiceRequest} requestParameters Request parameters.
|
|
11697
|
+
* @param {*} [options] Override http request option.
|
|
11698
|
+
* @throws {RequiredError}
|
|
11699
|
+
* @memberof InvoicesApi
|
|
11700
|
+
*/
|
|
11701
|
+
deleteInvoice(requestParameters: InvoicesApiDeleteInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11702
|
+
/**
|
|
11703
|
+
*
|
|
11704
|
+
* @summary Delete invoice user defaults.
|
|
11705
|
+
* @param {InvoicesApiDeleteInvoiceUserRequest} requestParameters Request parameters.
|
|
11706
|
+
* @param {*} [options] Override http request option.
|
|
11707
|
+
* @throws {RequiredError}
|
|
11708
|
+
* @memberof InvoicesApi
|
|
11709
|
+
*/
|
|
11710
|
+
deleteInvoiceUser(requestParameters: InvoicesApiDeleteInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11711
|
+
/**
|
|
11712
|
+
*
|
|
11713
|
+
* @summary Returns all invoices in the system.
|
|
11714
|
+
* @param {InvoicesApiGetAllInvoicesRequest} requestParameters Request parameters.
|
|
11715
|
+
* @param {*} [options] Override http request option.
|
|
11716
|
+
* @throws {RequiredError}
|
|
11717
|
+
* @memberof InvoicesApi
|
|
11718
|
+
*/
|
|
11719
|
+
getAllInvoices(requestParameters?: InvoicesApiGetAllInvoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedInvoiceResponse, any, {}>>;
|
|
11720
|
+
/**
|
|
11721
|
+
*
|
|
11722
|
+
* @summary Get eligible transactions for invoice creation.
|
|
11723
|
+
* @param {InvoicesApiGetEligibleTransactionsRequest} requestParameters Request parameters.
|
|
11724
|
+
* @param {*} [options] Override http request option.
|
|
11725
|
+
* @throws {RequiredError}
|
|
11726
|
+
* @memberof InvoicesApi
|
|
11727
|
+
*/
|
|
11728
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11729
|
+
/**
|
|
11730
|
+
*
|
|
11731
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11732
|
+
* @param {*} [options] Override http request option.
|
|
11733
|
+
* @throws {RequiredError}
|
|
11734
|
+
* @memberof InvoicesApi
|
|
11735
|
+
*/
|
|
11736
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11737
|
+
/**
|
|
11738
|
+
*
|
|
11739
|
+
* @summary Get an invoice pdf.
|
|
11740
|
+
* @param {InvoicesApiGetInvoicePdfRequest} requestParameters Request parameters.
|
|
11741
|
+
* @param {*} [options] Override http request option.
|
|
11742
|
+
* @throws {RequiredError}
|
|
11743
|
+
* @memberof InvoicesApi
|
|
11744
|
+
*/
|
|
11745
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11746
|
+
/**
|
|
11747
|
+
*
|
|
11748
|
+
* @summary Returns a single invoice in the system.
|
|
11749
|
+
* @param {InvoicesApiGetSingleInvoiceRequest} requestParameters Request parameters.
|
|
11750
|
+
* @param {*} [options] Override http request option.
|
|
11751
|
+
* @throws {RequiredError}
|
|
11752
|
+
* @memberof InvoicesApi
|
|
11753
|
+
*/
|
|
11754
|
+
getSingleInvoice(requestParameters: InvoicesApiGetSingleInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11755
|
+
/**
|
|
11756
|
+
*
|
|
11757
|
+
* @summary Get invoice user defaults.
|
|
11758
|
+
* @param {InvoicesApiGetSingleInvoiceUserRequest} requestParameters Request parameters.
|
|
11759
|
+
* @param {*} [options] Override http request option.
|
|
11760
|
+
* @throws {RequiredError}
|
|
11761
|
+
* @memberof InvoicesApi
|
|
11762
|
+
*/
|
|
11763
|
+
getSingleInvoiceUser(requestParameters: InvoicesApiGetSingleInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11764
|
+
/**
|
|
11765
|
+
*
|
|
11766
|
+
* @summary Update or create invoice user defaults.
|
|
11767
|
+
* @param {InvoicesApiPutInvoiceUserRequest} requestParameters Request parameters.
|
|
11768
|
+
* @param {*} [options] Override http request option.
|
|
11769
|
+
* @throws {RequiredError}
|
|
11770
|
+
* @memberof InvoicesApi
|
|
11771
|
+
*/
|
|
11772
|
+
putInvoiceUser(requestParameters: InvoicesApiPutInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11773
|
+
/**
|
|
11774
|
+
*
|
|
11775
|
+
* @summary Adds an invoice to the system.
|
|
11776
|
+
* @param {InvoicesApiUpdateInvoiceRequest} requestParameters Request parameters.
|
|
11777
|
+
* @param {*} [options] Override http request option.
|
|
11778
|
+
* @throws {RequiredError}
|
|
11779
|
+
* @memberof InvoicesApi
|
|
11780
|
+
*/
|
|
11781
|
+
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11785
|
+
* @export
|
|
11786
|
+
*/
|
|
11787
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11788
|
+
/**
|
|
11789
|
+
*
|
|
11790
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11791
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11792
|
+
* @param {*} [options] Override http request option.
|
|
11793
|
+
* @throws {RequiredError}
|
|
11794
|
+
*/
|
|
11795
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11796
|
+
/**
|
|
11797
|
+
*
|
|
11798
|
+
* @summary Create a new PaymentRequest.
|
|
11799
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11800
|
+
* @param {*} [options] Override http request option.
|
|
11801
|
+
* @throws {RequiredError}
|
|
11802
|
+
*/
|
|
11803
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11804
|
+
/**
|
|
11805
|
+
*
|
|
11806
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11807
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11808
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11809
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11810
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11811
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11812
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11813
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11814
|
+
* @param {*} [options] Override http request option.
|
|
11815
|
+
* @throws {RequiredError}
|
|
11816
|
+
*/
|
|
11817
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11818
|
+
/**
|
|
11819
|
+
*
|
|
11820
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11821
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11822
|
+
* @param {*} [options] Override http request option.
|
|
11823
|
+
* @throws {RequiredError}
|
|
11824
|
+
*/
|
|
11825
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11826
|
+
/**
|
|
11827
|
+
*
|
|
11828
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11829
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11830
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11831
|
+
* @param {*} [options] Override http request option.
|
|
11832
|
+
* @throws {RequiredError}
|
|
11833
|
+
*/
|
|
11834
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11835
|
+
/**
|
|
11836
|
+
*
|
|
11837
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11838
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11839
|
+
* @param {*} [options] Override http request option.
|
|
11840
|
+
* @throws {RequiredError}
|
|
11841
|
+
*/
|
|
11842
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11843
|
+
};
|
|
11844
|
+
/**
|
|
11845
|
+
* PaymentRequestsApi - functional programming interface
|
|
11846
|
+
* @export
|
|
11847
|
+
*/
|
|
11848
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11849
|
+
/**
|
|
11850
|
+
*
|
|
11851
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11852
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11853
|
+
* @param {*} [options] Override http request option.
|
|
11854
|
+
* @throws {RequiredError}
|
|
11855
|
+
*/
|
|
11856
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11857
|
+
/**
|
|
11858
|
+
*
|
|
11859
|
+
* @summary Create a new PaymentRequest.
|
|
11860
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11861
|
+
* @param {*} [options] Override http request option.
|
|
11862
|
+
* @throws {RequiredError}
|
|
11863
|
+
*/
|
|
11864
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11865
|
+
/**
|
|
11866
|
+
*
|
|
11867
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11868
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11869
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11870
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11871
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11872
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11873
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11874
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11875
|
+
* @param {*} [options] Override http request option.
|
|
11876
|
+
* @throws {RequiredError}
|
|
11877
|
+
*/
|
|
11878
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11879
|
+
/**
|
|
11880
|
+
*
|
|
11881
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11882
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11883
|
+
* @param {*} [options] Override http request option.
|
|
11884
|
+
* @throws {RequiredError}
|
|
11885
|
+
*/
|
|
11886
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11887
|
+
/**
|
|
11888
|
+
*
|
|
11889
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11890
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11891
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11892
|
+
* @param {*} [options] Override http request option.
|
|
11893
|
+
* @throws {RequiredError}
|
|
11894
|
+
*/
|
|
11895
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11896
|
+
/**
|
|
11897
|
+
*
|
|
11898
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11899
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11900
|
+
* @param {*} [options] Override http request option.
|
|
11901
|
+
* @throws {RequiredError}
|
|
11902
|
+
*/
|
|
11903
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11904
|
+
};
|
|
11905
|
+
/**
|
|
11906
|
+
* PaymentRequestsApi - factory interface
|
|
11907
|
+
* @export
|
|
11908
|
+
*/
|
|
11909
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11913
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11914
|
+
* @param {*} [options] Override http request option.
|
|
11915
|
+
* @throws {RequiredError}
|
|
11916
|
+
*/
|
|
11917
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11918
|
+
/**
|
|
11919
|
+
*
|
|
11920
|
+
* @summary Create a new PaymentRequest.
|
|
11921
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11922
|
+
* @param {*} [options] Override http request option.
|
|
11923
|
+
* @throws {RequiredError}
|
|
11924
|
+
*/
|
|
11925
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11926
|
+
/**
|
|
11927
|
+
*
|
|
11928
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11929
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11930
|
+
* @param {*} [options] Override http request option.
|
|
11931
|
+
* @throws {RequiredError}
|
|
11932
|
+
*/
|
|
11933
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11934
|
+
/**
|
|
11935
|
+
*
|
|
11936
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11937
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11938
|
+
* @param {*} [options] Override http request option.
|
|
11939
|
+
* @throws {RequiredError}
|
|
11940
|
+
*/
|
|
11941
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11942
|
+
/**
|
|
11943
|
+
*
|
|
11944
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11945
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11946
|
+
* @param {*} [options] Override http request option.
|
|
11947
|
+
* @throws {RequiredError}
|
|
11948
|
+
*/
|
|
11949
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11950
|
+
/**
|
|
11951
|
+
*
|
|
11952
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11953
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11954
|
+
* @param {*} [options] Override http request option.
|
|
11955
|
+
* @throws {RequiredError}
|
|
11956
|
+
*/
|
|
11957
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11958
|
+
};
|
|
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
|
|
11535
11969
|
*/
|
|
11536
|
-
readonly
|
|
11970
|
+
readonly id: string;
|
|
11537
11971
|
}
|
|
11538
11972
|
/**
|
|
11539
|
-
* Request parameters for
|
|
11973
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11540
11974
|
* @export
|
|
11541
|
-
* @interface
|
|
11975
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11542
11976
|
*/
|
|
11543
|
-
export interface
|
|
11544
|
-
/**
|
|
11545
|
-
* The id of the invoice to return
|
|
11546
|
-
* @type {number}
|
|
11547
|
-
* @memberof InvoicesApiGetInvoicePdf
|
|
11548
|
-
*/
|
|
11549
|
-
readonly id: number;
|
|
11977
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11550
11978
|
/**
|
|
11551
|
-
*
|
|
11552
|
-
* @type {
|
|
11553
|
-
* @memberof
|
|
11979
|
+
* The request to create
|
|
11980
|
+
* @type {CreatePaymentRequestRequest}
|
|
11981
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11554
11982
|
*/
|
|
11555
|
-
readonly
|
|
11983
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11556
11984
|
}
|
|
11557
11985
|
/**
|
|
11558
|
-
* Request parameters for
|
|
11986
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11559
11987
|
* @export
|
|
11560
|
-
* @interface
|
|
11988
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11561
11989
|
*/
|
|
11562
|
-
export interface
|
|
11990
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11563
11991
|
/**
|
|
11564
|
-
*
|
|
11992
|
+
* Filter by beneficiary user id.
|
|
11565
11993
|
* @type {number}
|
|
11566
|
-
* @memberof
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11567
11995
|
*/
|
|
11568
|
-
readonly
|
|
11996
|
+
readonly forId?: number;
|
|
11569
11997
|
/**
|
|
11570
|
-
*
|
|
11571
|
-
* @type {
|
|
11572
|
-
* @memberof
|
|
11998
|
+
* Filter by creator user id.
|
|
11999
|
+
* @type {number}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11573
12001
|
*/
|
|
11574
|
-
readonly
|
|
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;
|
|
11575
12033
|
}
|
|
11576
12034
|
/**
|
|
11577
|
-
* Request parameters for
|
|
12035
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11578
12036
|
* @export
|
|
11579
|
-
* @interface
|
|
12037
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11580
12038
|
*/
|
|
11581
|
-
export interface
|
|
12039
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11582
12040
|
/**
|
|
11583
|
-
*
|
|
11584
|
-
* @type {
|
|
11585
|
-
* @memberof
|
|
12041
|
+
* UUID v4 of the payment request.
|
|
12042
|
+
* @type {string}
|
|
12043
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11586
12044
|
*/
|
|
11587
|
-
readonly id:
|
|
12045
|
+
readonly id: string;
|
|
11588
12046
|
}
|
|
11589
12047
|
/**
|
|
11590
|
-
* Request parameters for
|
|
12048
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11591
12049
|
* @export
|
|
11592
|
-
* @interface
|
|
12050
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11593
12051
|
*/
|
|
11594
|
-
export interface
|
|
12052
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11595
12053
|
/**
|
|
11596
|
-
*
|
|
11597
|
-
* @type {
|
|
11598
|
-
* @memberof
|
|
12054
|
+
* UUID v4 of the payment request.
|
|
12055
|
+
* @type {string}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11599
12057
|
*/
|
|
11600
|
-
readonly id:
|
|
12058
|
+
readonly id: string;
|
|
11601
12059
|
/**
|
|
11602
|
-
* The
|
|
11603
|
-
* @type {
|
|
11604
|
-
* @memberof
|
|
12060
|
+
* The audit reason
|
|
12061
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12062
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11605
12063
|
*/
|
|
11606
|
-
readonly
|
|
12064
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11607
12065
|
}
|
|
11608
12066
|
/**
|
|
11609
|
-
* Request parameters for
|
|
12067
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11610
12068
|
* @export
|
|
11611
|
-
* @interface
|
|
12069
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11612
12070
|
*/
|
|
11613
|
-
export interface
|
|
11614
|
-
/**
|
|
11615
|
-
* The id of the invoice which should be updated
|
|
11616
|
-
* @type {number}
|
|
11617
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11618
|
-
*/
|
|
11619
|
-
readonly id: number;
|
|
12071
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11620
12072
|
/**
|
|
11621
|
-
*
|
|
11622
|
-
* @type {
|
|
11623
|
-
* @memberof
|
|
12073
|
+
* UUID v4 of the payment request.
|
|
12074
|
+
* @type {string}
|
|
12075
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11624
12076
|
*/
|
|
11625
|
-
readonly
|
|
12077
|
+
readonly id: string;
|
|
11626
12078
|
}
|
|
11627
12079
|
/**
|
|
11628
|
-
*
|
|
12080
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11629
12081
|
* @export
|
|
11630
|
-
* @class
|
|
12082
|
+
* @class PaymentRequestsApi
|
|
11631
12083
|
* @extends {BaseAPI}
|
|
11632
12084
|
*/
|
|
11633
|
-
export declare class
|
|
12085
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11634
12086
|
/**
|
|
11635
12087
|
*
|
|
11636
|
-
* @summary
|
|
11637
|
-
* @param {
|
|
12088
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12089
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11638
12090
|
* @param {*} [options] Override http request option.
|
|
11639
12091
|
* @throws {RequiredError}
|
|
11640
|
-
* @memberof
|
|
12092
|
+
* @memberof PaymentRequestsApi
|
|
11641
12093
|
*/
|
|
11642
|
-
|
|
12094
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11643
12095
|
/**
|
|
11644
12096
|
*
|
|
11645
|
-
* @summary
|
|
11646
|
-
* @param {
|
|
12097
|
+
* @summary Create a new PaymentRequest.
|
|
12098
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11647
12099
|
* @param {*} [options] Override http request option.
|
|
11648
12100
|
* @throws {RequiredError}
|
|
11649
|
-
* @memberof
|
|
12101
|
+
* @memberof PaymentRequestsApi
|
|
11650
12102
|
*/
|
|
11651
|
-
|
|
12103
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11652
12104
|
/**
|
|
11653
12105
|
*
|
|
11654
|
-
* @summary
|
|
11655
|
-
* @param {
|
|
12106
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12107
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11656
12108
|
* @param {*} [options] Override http request option.
|
|
11657
12109
|
* @throws {RequiredError}
|
|
11658
|
-
* @memberof
|
|
12110
|
+
* @memberof PaymentRequestsApi
|
|
11659
12111
|
*/
|
|
11660
|
-
|
|
12112
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11661
12113
|
/**
|
|
11662
12114
|
*
|
|
11663
|
-
* @summary
|
|
11664
|
-
* @param {
|
|
12115
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12116
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11665
12117
|
* @param {*} [options] Override http request option.
|
|
11666
12118
|
* @throws {RequiredError}
|
|
11667
|
-
* @memberof
|
|
12119
|
+
* @memberof PaymentRequestsApi
|
|
11668
12120
|
*/
|
|
11669
|
-
|
|
12121
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11670
12122
|
/**
|
|
11671
12123
|
*
|
|
11672
|
-
* @summary
|
|
11673
|
-
* @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.
|
|
11674
12126
|
* @param {*} [options] Override http request option.
|
|
11675
12127
|
* @throws {RequiredError}
|
|
11676
|
-
* @memberof
|
|
12128
|
+
* @memberof PaymentRequestsApi
|
|
11677
12129
|
*/
|
|
11678
|
-
|
|
12130
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11679
12131
|
/**
|
|
11680
12132
|
*
|
|
11681
|
-
* @summary
|
|
12133
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12134
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11682
12135
|
* @param {*} [options] Override http request option.
|
|
11683
12136
|
* @throws {RequiredError}
|
|
11684
|
-
* @memberof
|
|
12137
|
+
* @memberof PaymentRequestsApi
|
|
11685
12138
|
*/
|
|
11686
|
-
|
|
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) => {
|
|
11687
12156
|
/**
|
|
11688
12157
|
*
|
|
11689
|
-
* @summary
|
|
11690
|
-
* @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.
|
|
11691
12160
|
* @param {*} [options] Override http request option.
|
|
11692
12161
|
* @throws {RequiredError}
|
|
11693
|
-
* @memberof InvoicesApi
|
|
11694
12162
|
*/
|
|
11695
|
-
|
|
12163
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11696
12164
|
/**
|
|
11697
12165
|
*
|
|
11698
|
-
* @summary
|
|
11699
|
-
* @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.
|
|
11700
12168
|
* @param {*} [options] Override http request option.
|
|
11701
12169
|
* @throws {RequiredError}
|
|
11702
|
-
* @memberof InvoicesApi
|
|
11703
12170
|
*/
|
|
11704
|
-
|
|
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) => {
|
|
11705
12178
|
/**
|
|
11706
12179
|
*
|
|
11707
|
-
* @summary
|
|
11708
|
-
* @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.
|
|
11709
12182
|
* @param {*} [options] Override http request option.
|
|
11710
12183
|
* @throws {RequiredError}
|
|
11711
|
-
* @memberof InvoicesApi
|
|
11712
12184
|
*/
|
|
11713
|
-
|
|
12185
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11714
12186
|
/**
|
|
11715
12187
|
*
|
|
11716
|
-
* @summary
|
|
11717
|
-
* @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.
|
|
11718
12190
|
* @param {*} [options] Override http request option.
|
|
11719
12191
|
* @throws {RequiredError}
|
|
11720
|
-
* @memberof InvoicesApi
|
|
11721
12192
|
*/
|
|
11722
|
-
|
|
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) => {
|
|
11723
12200
|
/**
|
|
11724
12201
|
*
|
|
11725
|
-
* @summary
|
|
11726
|
-
* @param {
|
|
12202
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12203
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
11727
12204
|
* @param {*} [options] Override http request option.
|
|
11728
12205
|
* @throws {RequiredError}
|
|
11729
|
-
* @memberof InvoicesApi
|
|
11730
12206
|
*/
|
|
11731
|
-
|
|
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;
|
|
11732
12242
|
}
|
|
11733
12243
|
/**
|
|
12244
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
11734
12245
|
* @export
|
|
12246
|
+
* @class PaymentRequestsPublicApi
|
|
12247
|
+
* @extends {BaseAPI}
|
|
11735
12248
|
*/
|
|
11736
|
-
export declare
|
|
11737
|
-
|
|
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
|
+
}
|
|
11738
12269
|
/**
|
|
11739
12270
|
* PayoutRequestsApi - axios parameter creator
|
|
11740
12271
|
* @export
|
|
@@ -14289,11 +14820,11 @@ export declare const SyncApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
14289
14820
|
/**
|
|
14290
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.
|
|
14291
14822
|
* @summary Get dry-run sync results for users
|
|
14292
|
-
* @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.
|
|
14293
14824
|
* @param {*} [options] Override http request option.
|
|
14294
14825
|
* @throws {RequiredError}
|
|
14295
14826
|
*/
|
|
14296
|
-
getUserSyncResults: (service?: GetUserSyncResultsServiceEnum
|
|
14827
|
+
getUserSyncResults: (service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14297
14828
|
};
|
|
14298
14829
|
/**
|
|
14299
14830
|
* SyncApi - functional programming interface
|
|
@@ -14303,11 +14834,11 @@ export declare const SyncApiFp: (configuration?: Configuration) => {
|
|
|
14303
14834
|
/**
|
|
14304
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.
|
|
14305
14836
|
* @summary Get dry-run sync results for users
|
|
14306
|
-
* @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.
|
|
14307
14838
|
* @param {*} [options] Override http request option.
|
|
14308
14839
|
* @throws {RequiredError}
|
|
14309
14840
|
*/
|
|
14310
|
-
getUserSyncResults(service?: GetUserSyncResultsServiceEnum
|
|
14841
|
+
getUserSyncResults(service?: Array<GetUserSyncResultsServiceEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14311
14842
|
};
|
|
14312
14843
|
/**
|
|
14313
14844
|
* SyncApi - factory interface
|
|
@@ -14331,10 +14862,10 @@ export declare const SyncApiFactory: (configuration?: Configuration, basePath?:
|
|
|
14331
14862
|
export interface SyncApiGetUserSyncResultsRequest {
|
|
14332
14863
|
/**
|
|
14333
14864
|
* Array of sync services to use (ldap, gewisdb). If not provided, all available services will be used.
|
|
14334
|
-
* @type {Array<
|
|
14865
|
+
* @type {Array<'LDAP' | 'GEWISDB'>}
|
|
14335
14866
|
* @memberof SyncApiGetUserSyncResults
|
|
14336
14867
|
*/
|
|
14337
|
-
readonly service?: GetUserSyncResultsServiceEnum
|
|
14868
|
+
readonly service?: Array<GetUserSyncResultsServiceEnum>;
|
|
14338
14869
|
}
|
|
14339
14870
|
/**
|
|
14340
14871
|
* SyncApi - object-oriented interface
|
|
@@ -14356,7 +14887,10 @@ export declare class SyncApi extends BaseAPI {
|
|
|
14356
14887
|
/**
|
|
14357
14888
|
* @export
|
|
14358
14889
|
*/
|
|
14359
|
-
export declare const GetUserSyncResultsServiceEnum: {
|
|
14890
|
+
export declare const GetUserSyncResultsServiceEnum: {
|
|
14891
|
+
readonly Ldap: "LDAP";
|
|
14892
|
+
readonly Gewisdb: "GEWISDB";
|
|
14893
|
+
};
|
|
14360
14894
|
export type GetUserSyncResultsServiceEnum = typeof GetUserSyncResultsServiceEnum[keyof typeof GetUserSyncResultsServiceEnum];
|
|
14361
14895
|
/**
|
|
14362
14896
|
* TermsOfServiceApi - axios parameter creator
|
|
@@ -15106,12 +15640,15 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
15106
15640
|
* @summary Returns all existing transfers
|
|
15107
15641
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15108
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
|
|
15109
15646
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15110
15647
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15111
15648
|
* @param {*} [options] Override http request option.
|
|
15112
15649
|
* @throws {RequiredError}
|
|
15113
15650
|
*/
|
|
15114
|
-
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>;
|
|
15115
15652
|
/**
|
|
15116
15653
|
*
|
|
15117
15654
|
* @summary Returns the requested transfer
|
|
@@ -15178,12 +15715,15 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
|
|
|
15178
15715
|
* @summary Returns all existing transfers
|
|
15179
15716
|
* @param {string} [fromDate] Start date for selected transfers (inclusive)
|
|
15180
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
|
|
15181
15721
|
* @param {number} [take] How many transfers the endpoint should return
|
|
15182
15722
|
* @param {number} [skip] How many transfers should be skipped (for pagination)
|
|
15183
15723
|
* @param {*} [options] Override http request option.
|
|
15184
15724
|
* @throws {RequiredError}
|
|
15185
15725
|
*/
|
|
15186
|
-
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>>;
|
|
15187
15727
|
/**
|
|
15188
15728
|
*
|
|
15189
15729
|
* @summary Returns the requested transfer
|
|
@@ -15252,7 +15792,7 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
|
|
|
15252
15792
|
* @param {*} [options] Override http request option.
|
|
15253
15793
|
* @throws {RequiredError}
|
|
15254
15794
|
*/
|
|
15255
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15795
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTransferResponse>;
|
|
15256
15796
|
/**
|
|
15257
15797
|
*
|
|
15258
15798
|
* @summary Returns the requested transfer
|
|
@@ -15330,6 +15870,24 @@ export interface TransfersApiGetAllTransfersRequest {
|
|
|
15330
15870
|
* @memberof TransfersApiGetAllTransfers
|
|
15331
15871
|
*/
|
|
15332
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;
|
|
15333
15891
|
/**
|
|
15334
15892
|
* How many transfers the endpoint should return
|
|
15335
15893
|
* @type {number}
|
|
@@ -15470,7 +16028,7 @@ export declare class TransfersApi extends BaseAPI {
|
|
|
15470
16028
|
* @throws {RequiredError}
|
|
15471
16029
|
* @memberof TransfersApi
|
|
15472
16030
|
*/
|
|
15473
|
-
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
16031
|
+
getAllTransfers(requestParameters?: TransfersApiGetAllTransfersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTransferResponse, any, {}>>;
|
|
15474
16032
|
/**
|
|
15475
16033
|
*
|
|
15476
16034
|
* @summary Returns the requested transfer
|
|
@@ -15871,6 +16429,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15871
16429
|
* @throws {RequiredError}
|
|
15872
16430
|
*/
|
|
15873
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>;
|
|
15874
16446
|
/**
|
|
15875
16447
|
*
|
|
15876
16448
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16233,6 +16805,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16233
16805
|
* @throws {RequiredError}
|
|
16234
16806
|
*/
|
|
16235
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>>;
|
|
16236
16822
|
/**
|
|
16237
16823
|
*
|
|
16238
16824
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16577,6 +17163,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16577
17163
|
* @throws {RequiredError}
|
|
16578
17164
|
*/
|
|
16579
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>;
|
|
16580
17174
|
/**
|
|
16581
17175
|
*
|
|
16582
17176
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17068,6 +17662,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
17068
17662
|
*/
|
|
17069
17663
|
readonly skip?: number;
|
|
17070
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
|
+
}
|
|
17071
17714
|
/**
|
|
17072
17715
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
17073
17716
|
* @export
|
|
@@ -17734,6 +18377,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17734
18377
|
* @memberof UsersApi
|
|
17735
18378
|
*/
|
|
17736
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, {}>>;
|
|
17737
18389
|
/**
|
|
17738
18390
|
*
|
|
17739
18391
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17929,6 +18581,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17929
18581
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17930
18582
|
};
|
|
17931
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];
|
|
17932
18594
|
/**
|
|
17933
18595
|
* @export
|
|
17934
18596
|
*/
|