@gewis/sudosos-client 1.32.0 → 1.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +1222 -365
- package/dist/api.js +1046 -285
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -58,6 +58,25 @@ export interface AddRoleRequest {
|
|
|
58
58
|
*/
|
|
59
59
|
'roleId': number;
|
|
60
60
|
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
* @interface AuthenticationEanRequest
|
|
65
|
+
*/
|
|
66
|
+
export interface AuthenticationEanRequest {
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @type {string}
|
|
70
|
+
* @memberof AuthenticationEanRequest
|
|
71
|
+
*/
|
|
72
|
+
'eanCode': string;
|
|
73
|
+
/**
|
|
74
|
+
* POS identifier
|
|
75
|
+
* @type {number}
|
|
76
|
+
* @memberof AuthenticationEanRequest
|
|
77
|
+
*/
|
|
78
|
+
'posId': number;
|
|
79
|
+
}
|
|
61
80
|
/**
|
|
62
81
|
*
|
|
63
82
|
* @export
|
|
@@ -134,6 +153,50 @@ export interface AuthenticationMockRequest {
|
|
|
134
153
|
*/
|
|
135
154
|
'nonce': string;
|
|
136
155
|
}
|
|
156
|
+
/**
|
|
157
|
+
*
|
|
158
|
+
* @export
|
|
159
|
+
* @interface AuthenticationNfcRequest
|
|
160
|
+
*/
|
|
161
|
+
export interface AuthenticationNfcRequest {
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @type {string}
|
|
165
|
+
* @memberof AuthenticationNfcRequest
|
|
166
|
+
*/
|
|
167
|
+
'nfcCode': string;
|
|
168
|
+
/**
|
|
169
|
+
* POS identifier
|
|
170
|
+
* @type {number}
|
|
171
|
+
* @memberof AuthenticationNfcRequest
|
|
172
|
+
*/
|
|
173
|
+
'posId': number;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
*
|
|
177
|
+
* @export
|
|
178
|
+
* @interface AuthenticationPinRequest
|
|
179
|
+
*/
|
|
180
|
+
export interface AuthenticationPinRequest {
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @type {number}
|
|
184
|
+
* @memberof AuthenticationPinRequest
|
|
185
|
+
*/
|
|
186
|
+
'userId': number;
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof AuthenticationPinRequest
|
|
191
|
+
*/
|
|
192
|
+
'pin': string;
|
|
193
|
+
/**
|
|
194
|
+
* POS identifier
|
|
195
|
+
* @type {number}
|
|
196
|
+
* @memberof AuthenticationPinRequest
|
|
197
|
+
*/
|
|
198
|
+
'posId': number;
|
|
199
|
+
}
|
|
137
200
|
/**
|
|
138
201
|
*
|
|
139
202
|
* @export
|
|
@@ -215,69 +278,6 @@ export interface AuthenticationResponse {
|
|
|
215
278
|
*/
|
|
216
279
|
'rolesWithPermissions': Array<RoleWithPermissionsResponse>;
|
|
217
280
|
}
|
|
218
|
-
/**
|
|
219
|
-
*
|
|
220
|
-
* @export
|
|
221
|
-
* @interface AuthenticationSecureEanRequest
|
|
222
|
-
*/
|
|
223
|
-
export interface AuthenticationSecureEanRequest {
|
|
224
|
-
/**
|
|
225
|
-
*
|
|
226
|
-
* @type {string}
|
|
227
|
-
* @memberof AuthenticationSecureEanRequest
|
|
228
|
-
*/
|
|
229
|
-
'eanCode': string;
|
|
230
|
-
/**
|
|
231
|
-
* POS identifier
|
|
232
|
-
* @type {number}
|
|
233
|
-
* @memberof AuthenticationSecureEanRequest
|
|
234
|
-
*/
|
|
235
|
-
'posId': number;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
*
|
|
239
|
-
* @export
|
|
240
|
-
* @interface AuthenticationSecureNfcRequest
|
|
241
|
-
*/
|
|
242
|
-
export interface AuthenticationSecureNfcRequest {
|
|
243
|
-
/**
|
|
244
|
-
*
|
|
245
|
-
* @type {string}
|
|
246
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
247
|
-
*/
|
|
248
|
-
'nfcCode': string;
|
|
249
|
-
/**
|
|
250
|
-
* POS identifier
|
|
251
|
-
* @type {number}
|
|
252
|
-
* @memberof AuthenticationSecureNfcRequest
|
|
253
|
-
*/
|
|
254
|
-
'posId': number;
|
|
255
|
-
}
|
|
256
|
-
/**
|
|
257
|
-
*
|
|
258
|
-
* @export
|
|
259
|
-
* @interface AuthenticationSecurePinRequest
|
|
260
|
-
*/
|
|
261
|
-
export interface AuthenticationSecurePinRequest {
|
|
262
|
-
/**
|
|
263
|
-
*
|
|
264
|
-
* @type {number}
|
|
265
|
-
* @memberof AuthenticationSecurePinRequest
|
|
266
|
-
*/
|
|
267
|
-
'userId': number;
|
|
268
|
-
/**
|
|
269
|
-
*
|
|
270
|
-
* @type {string}
|
|
271
|
-
* @memberof AuthenticationSecurePinRequest
|
|
272
|
-
*/
|
|
273
|
-
'pin': string;
|
|
274
|
-
/**
|
|
275
|
-
* POS identifier (required for secure authentication)
|
|
276
|
-
* @type {number}
|
|
277
|
-
* @memberof AuthenticationSecurePinRequest
|
|
278
|
-
*/
|
|
279
|
-
'posId': number;
|
|
280
|
-
}
|
|
281
281
|
/**
|
|
282
282
|
*
|
|
283
283
|
* @export
|
|
@@ -901,6 +901,104 @@ export interface BaseInvoiceResponse {
|
|
|
901
901
|
*/
|
|
902
902
|
'totalInclVat': DineroObjectResponse;
|
|
903
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];
|
|
904
1002
|
/**
|
|
905
1003
|
*
|
|
906
1004
|
* @export
|
|
@@ -1141,6 +1239,31 @@ export interface BaseResponse {
|
|
|
1141
1239
|
*/
|
|
1142
1240
|
'version'?: number;
|
|
1143
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
|
+
}
|
|
1144
1267
|
/**
|
|
1145
1268
|
*
|
|
1146
1269
|
* @export
|
|
@@ -1779,6 +1902,37 @@ export interface CreateInvoiceRequest {
|
|
|
1779
1902
|
*/
|
|
1780
1903
|
'amount': DineroObjectRequest;
|
|
1781
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
|
+
}
|
|
1782
1936
|
/**
|
|
1783
1937
|
*
|
|
1784
1938
|
* @export
|
|
@@ -3109,25 +3263,38 @@ export interface InvoiceUserResponse {
|
|
|
3109
3263
|
/**
|
|
3110
3264
|
*
|
|
3111
3265
|
* @export
|
|
3112
|
-
* @interface
|
|
3266
|
+
* @interface MarkFulfilledExternallyRequest
|
|
3267
|
+
*/
|
|
3268
|
+
export interface MarkFulfilledExternallyRequest {
|
|
3269
|
+
/**
|
|
3270
|
+
* Why this request is being marked paid out-of-band (audit trail).
|
|
3271
|
+
* @type {string}
|
|
3272
|
+
* @memberof MarkFulfilledExternallyRequest
|
|
3273
|
+
*/
|
|
3274
|
+
'reason': string;
|
|
3275
|
+
}
|
|
3276
|
+
/**
|
|
3277
|
+
*
|
|
3278
|
+
* @export
|
|
3279
|
+
* @interface MemberAuthenticationPinRequest
|
|
3113
3280
|
*/
|
|
3114
|
-
export interface
|
|
3281
|
+
export interface MemberAuthenticationPinRequest {
|
|
3115
3282
|
/**
|
|
3116
3283
|
*
|
|
3117
3284
|
* @type {number}
|
|
3118
|
-
* @memberof
|
|
3285
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3119
3286
|
*/
|
|
3120
3287
|
'memberId': number;
|
|
3121
3288
|
/**
|
|
3122
3289
|
*
|
|
3123
3290
|
* @type {string}
|
|
3124
|
-
* @memberof
|
|
3291
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3125
3292
|
*/
|
|
3126
3293
|
'pin': string;
|
|
3127
3294
|
/**
|
|
3128
3295
|
* POS identifier
|
|
3129
3296
|
* @type {number}
|
|
3130
|
-
* @memberof
|
|
3297
|
+
* @memberof MemberAuthenticationPinRequest
|
|
3131
3298
|
*/
|
|
3132
3299
|
'posId': number;
|
|
3133
3300
|
}
|
|
@@ -3201,6 +3368,25 @@ export interface PaginatedBaseEventResponse {
|
|
|
3201
3368
|
*/
|
|
3202
3369
|
'records': Array<BaseEventResponse>;
|
|
3203
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
|
+
}
|
|
3204
3390
|
/**
|
|
3205
3391
|
*
|
|
3206
3392
|
* @export
|
|
@@ -3631,6 +3817,31 @@ export interface PatchUserTypeRequest {
|
|
|
3631
3817
|
*/
|
|
3632
3818
|
'userType': string;
|
|
3633
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
|
+
}
|
|
3634
3845
|
/**
|
|
3635
3846
|
*
|
|
3636
3847
|
* @export
|
|
@@ -4156,31 +4367,81 @@ export interface ProductResponse {
|
|
|
4156
4367
|
'priceList': boolean;
|
|
4157
4368
|
}
|
|
4158
4369
|
/**
|
|
4159
|
-
*
|
|
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.
|
|
4160
4371
|
* @export
|
|
4161
|
-
* @interface
|
|
4372
|
+
* @interface PublicPaymentRequestResponse
|
|
4162
4373
|
*/
|
|
4163
|
-
export interface
|
|
4374
|
+
export interface PublicPaymentRequestResponse {
|
|
4164
4375
|
/**
|
|
4165
|
-
*
|
|
4376
|
+
* UUID v4 identifier.
|
|
4166
4377
|
* @type {string}
|
|
4167
|
-
* @memberof
|
|
4378
|
+
* @memberof PublicPaymentRequestResponse
|
|
4168
4379
|
*/
|
|
4169
|
-
'
|
|
4380
|
+
'uuid': string;
|
|
4170
4381
|
/**
|
|
4171
|
-
*
|
|
4382
|
+
* Recipient display name (e.g. \"John D.\").
|
|
4172
4383
|
* @type {string}
|
|
4173
|
-
* @memberof
|
|
4384
|
+
* @memberof PublicPaymentRequestResponse
|
|
4174
4385
|
*/
|
|
4175
|
-
'
|
|
4386
|
+
'forDisplayName': string;
|
|
4176
4387
|
/**
|
|
4177
|
-
*
|
|
4388
|
+
*
|
|
4389
|
+
* @type {DineroObjectResponse}
|
|
4390
|
+
* @memberof PublicPaymentRequestResponse
|
|
4391
|
+
*/
|
|
4392
|
+
'amount': DineroObjectResponse;
|
|
4393
|
+
/**
|
|
4394
|
+
* ISO-8601 timestamp after which payments stop being accepted.
|
|
4178
4395
|
* @type {string}
|
|
4179
|
-
* @memberof
|
|
4396
|
+
* @memberof PublicPaymentRequestResponse
|
|
4180
4397
|
*/
|
|
4181
4398
|
'expiresAt': string;
|
|
4182
|
-
|
|
4183
|
-
|
|
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
|
+
/**
|
|
4184
4445
|
*
|
|
4185
4446
|
* @export
|
|
4186
4447
|
* @interface QRStatusResponse
|
|
@@ -5036,6 +5297,12 @@ export interface TermsOfServiceResponse {
|
|
|
5036
5297
|
* @memberof TermsOfServiceResponse
|
|
5037
5298
|
*/
|
|
5038
5299
|
'versionNumber': string;
|
|
5300
|
+
/**
|
|
5301
|
+
* The date this version took effect.
|
|
5302
|
+
* @type {string}
|
|
5303
|
+
* @memberof TermsOfServiceResponse
|
|
5304
|
+
*/
|
|
5305
|
+
'date': string;
|
|
5039
5306
|
/**
|
|
5040
5307
|
* The terms of service content.
|
|
5041
5308
|
* @type {string}
|
|
@@ -7008,6 +7275,14 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7008
7275
|
* @throws {RequiredError}
|
|
7009
7276
|
*/
|
|
7010
7277
|
confirmQRCode: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7278
|
+
/**
|
|
7279
|
+
*
|
|
7280
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7281
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7282
|
+
* @param {*} [options] Override http request option.
|
|
7283
|
+
* @throws {RequiredError}
|
|
7284
|
+
*/
|
|
7285
|
+
eanAuthentication: (authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7011
7286
|
/**
|
|
7012
7287
|
*
|
|
7013
7288
|
* @summary Generate a QR code for authentication
|
|
@@ -7079,67 +7354,59 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7079
7354
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7080
7355
|
/**
|
|
7081
7356
|
*
|
|
7082
|
-
* @summary
|
|
7083
|
-
* @param {
|
|
7084
|
-
* @param {*} [options] Override http request option.
|
|
7085
|
-
* @throws {RequiredError}
|
|
7086
|
-
*/
|
|
7087
|
-
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7088
|
-
/**
|
|
7089
|
-
*
|
|
7090
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7357
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7358
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7091
7359
|
* @param {*} [options] Override http request option.
|
|
7092
7360
|
* @throws {RequiredError}
|
|
7093
7361
|
*/
|
|
7094
|
-
|
|
7362
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7095
7363
|
/**
|
|
7096
7364
|
*
|
|
7097
|
-
* @summary
|
|
7098
|
-
* @param {
|
|
7365
|
+
* @summary Mock login and hand out token.
|
|
7366
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7099
7367
|
* @param {*} [options] Override http request option.
|
|
7100
7368
|
* @throws {RequiredError}
|
|
7101
7369
|
*/
|
|
7102
|
-
|
|
7370
|
+
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7103
7371
|
/**
|
|
7104
7372
|
*
|
|
7105
|
-
* @summary
|
|
7106
|
-
* @param {
|
|
7373
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7374
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7107
7375
|
* @param {*} [options] Override http request option.
|
|
7108
7376
|
* @throws {RequiredError}
|
|
7109
7377
|
*/
|
|
7110
|
-
|
|
7378
|
+
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7111
7379
|
/**
|
|
7112
7380
|
*
|
|
7113
|
-
* @summary
|
|
7114
|
-
* @param {
|
|
7381
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7382
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7115
7383
|
* @param {*} [options] Override http request option.
|
|
7116
7384
|
* @throws {RequiredError}
|
|
7117
7385
|
*/
|
|
7118
|
-
|
|
7386
|
+
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7119
7387
|
/**
|
|
7120
7388
|
*
|
|
7121
|
-
* @summary
|
|
7122
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7389
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7123
7390
|
* @param {*} [options] Override http request option.
|
|
7124
7391
|
* @throws {RequiredError}
|
|
7125
7392
|
*/
|
|
7126
|
-
|
|
7393
|
+
refreshToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7127
7394
|
/**
|
|
7128
7395
|
*
|
|
7129
|
-
* @summary
|
|
7130
|
-
* @param {
|
|
7396
|
+
* @summary Creates a reset token for the local authentication
|
|
7397
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7131
7398
|
* @param {*} [options] Override http request option.
|
|
7132
7399
|
* @throws {RequiredError}
|
|
7133
7400
|
*/
|
|
7134
|
-
|
|
7401
|
+
resetLocal: (resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7135
7402
|
/**
|
|
7136
7403
|
*
|
|
7137
|
-
* @summary
|
|
7138
|
-
* @param {
|
|
7404
|
+
* @summary Reset local authentication using the provided token
|
|
7405
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7139
7406
|
* @param {*} [options] Override http request option.
|
|
7140
7407
|
* @throws {RequiredError}
|
|
7141
7408
|
*/
|
|
7142
|
-
|
|
7409
|
+
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7143
7410
|
};
|
|
7144
7411
|
/**
|
|
7145
7412
|
* AuthenticateApi - functional programming interface
|
|
@@ -7170,6 +7437,14 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7170
7437
|
* @throws {RequiredError}
|
|
7171
7438
|
*/
|
|
7172
7439
|
confirmQRCode(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7440
|
+
/**
|
|
7441
|
+
*
|
|
7442
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7443
|
+
* @param {AuthenticationEanRequest} authenticationEanRequest The EAN login request with posId
|
|
7444
|
+
* @param {*} [options] Override http request option.
|
|
7445
|
+
* @throws {RequiredError}
|
|
7446
|
+
*/
|
|
7447
|
+
eanAuthentication(authenticationEanRequest: AuthenticationEanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7173
7448
|
/**
|
|
7174
7449
|
*
|
|
7175
7450
|
* @summary Generate a QR code for authentication
|
|
@@ -7241,67 +7516,59 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7241
7516
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7242
7517
|
/**
|
|
7243
7518
|
*
|
|
7244
|
-
* @summary
|
|
7245
|
-
* @param {
|
|
7246
|
-
* @param {*} [options] Override http request option.
|
|
7247
|
-
* @throws {RequiredError}
|
|
7248
|
-
*/
|
|
7249
|
-
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7250
|
-
/**
|
|
7251
|
-
*
|
|
7252
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7519
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7520
|
+
* @param {MemberAuthenticationPinRequest} memberAuthenticationPinRequest The PIN login request with posId
|
|
7253
7521
|
* @param {*} [options] Override http request option.
|
|
7254
7522
|
* @throws {RequiredError}
|
|
7255
7523
|
*/
|
|
7256
|
-
|
|
7524
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7257
7525
|
/**
|
|
7258
7526
|
*
|
|
7259
|
-
* @summary
|
|
7260
|
-
* @param {
|
|
7527
|
+
* @summary Mock login and hand out token.
|
|
7528
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7261
7529
|
* @param {*} [options] Override http request option.
|
|
7262
7530
|
* @throws {RequiredError}
|
|
7263
7531
|
*/
|
|
7264
|
-
|
|
7532
|
+
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7265
7533
|
/**
|
|
7266
7534
|
*
|
|
7267
|
-
* @summary
|
|
7268
|
-
* @param {
|
|
7535
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7536
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7269
7537
|
* @param {*} [options] Override http request option.
|
|
7270
7538
|
* @throws {RequiredError}
|
|
7271
7539
|
*/
|
|
7272
|
-
|
|
7540
|
+
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7273
7541
|
/**
|
|
7274
7542
|
*
|
|
7275
|
-
* @summary
|
|
7276
|
-
* @param {
|
|
7543
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7544
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7277
7545
|
* @param {*} [options] Override http request option.
|
|
7278
7546
|
* @throws {RequiredError}
|
|
7279
7547
|
*/
|
|
7280
|
-
|
|
7548
|
+
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7281
7549
|
/**
|
|
7282
7550
|
*
|
|
7283
|
-
* @summary
|
|
7284
|
-
* @param {MemberAuthenticationSecurePinRequest} memberAuthenticationSecurePinRequest The PIN login request with posId
|
|
7551
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7285
7552
|
* @param {*} [options] Override http request option.
|
|
7286
7553
|
* @throws {RequiredError}
|
|
7287
7554
|
*/
|
|
7288
|
-
|
|
7555
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7289
7556
|
/**
|
|
7290
7557
|
*
|
|
7291
|
-
* @summary
|
|
7292
|
-
* @param {
|
|
7558
|
+
* @summary Creates a reset token for the local authentication
|
|
7559
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7293
7560
|
* @param {*} [options] Override http request option.
|
|
7294
7561
|
* @throws {RequiredError}
|
|
7295
7562
|
*/
|
|
7296
|
-
|
|
7563
|
+
resetLocal(resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7297
7564
|
/**
|
|
7298
7565
|
*
|
|
7299
|
-
* @summary
|
|
7300
|
-
* @param {
|
|
7566
|
+
* @summary Reset local authentication using the provided token
|
|
7567
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7301
7568
|
* @param {*} [options] Override http request option.
|
|
7302
7569
|
* @throws {RequiredError}
|
|
7303
7570
|
*/
|
|
7304
|
-
|
|
7571
|
+
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7305
7572
|
};
|
|
7306
7573
|
/**
|
|
7307
7574
|
* AuthenticateApi - factory interface
|
|
@@ -7332,6 +7599,14 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7332
7599
|
* @throws {RequiredError}
|
|
7333
7600
|
*/
|
|
7334
7601
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7602
|
+
/**
|
|
7603
|
+
*
|
|
7604
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7605
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7606
|
+
* @param {*} [options] Override http request option.
|
|
7607
|
+
* @throws {RequiredError}
|
|
7608
|
+
*/
|
|
7609
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7335
7610
|
/**
|
|
7336
7611
|
*
|
|
7337
7612
|
* @summary Generate a QR code for authentication
|
|
@@ -7403,67 +7678,59 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7403
7678
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7404
7679
|
/**
|
|
7405
7680
|
*
|
|
7406
|
-
* @summary
|
|
7407
|
-
* @param {
|
|
7408
|
-
* @param {*} [options] Override http request option.
|
|
7409
|
-
* @throws {RequiredError}
|
|
7410
|
-
*/
|
|
7411
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7412
|
-
/**
|
|
7413
|
-
*
|
|
7414
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7681
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
7682
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7415
7683
|
* @param {*} [options] Override http request option.
|
|
7416
7684
|
* @throws {RequiredError}
|
|
7417
7685
|
*/
|
|
7418
|
-
|
|
7686
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7419
7687
|
/**
|
|
7420
7688
|
*
|
|
7421
|
-
* @summary
|
|
7422
|
-
* @param {
|
|
7689
|
+
* @summary Mock login and hand out token.
|
|
7690
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7423
7691
|
* @param {*} [options] Override http request option.
|
|
7424
7692
|
* @throws {RequiredError}
|
|
7425
7693
|
*/
|
|
7426
|
-
|
|
7694
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7427
7695
|
/**
|
|
7428
7696
|
*
|
|
7429
|
-
* @summary
|
|
7430
|
-
* @param {
|
|
7697
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7698
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7431
7699
|
* @param {*} [options] Override http request option.
|
|
7432
7700
|
* @throws {RequiredError}
|
|
7433
7701
|
*/
|
|
7434
|
-
|
|
7702
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7435
7703
|
/**
|
|
7436
7704
|
*
|
|
7437
|
-
* @summary
|
|
7438
|
-
* @param {
|
|
7705
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7706
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7439
7707
|
* @param {*} [options] Override http request option.
|
|
7440
7708
|
* @throws {RequiredError}
|
|
7441
7709
|
*/
|
|
7442
|
-
|
|
7710
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7443
7711
|
/**
|
|
7444
7712
|
*
|
|
7445
|
-
* @summary
|
|
7446
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7713
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7447
7714
|
* @param {*} [options] Override http request option.
|
|
7448
7715
|
* @throws {RequiredError}
|
|
7449
7716
|
*/
|
|
7450
|
-
|
|
7717
|
+
refreshToken(options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7451
7718
|
/**
|
|
7452
7719
|
*
|
|
7453
|
-
* @summary
|
|
7454
|
-
* @param {
|
|
7720
|
+
* @summary Creates a reset token for the local authentication
|
|
7721
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7455
7722
|
* @param {*} [options] Override http request option.
|
|
7456
7723
|
* @throws {RequiredError}
|
|
7457
7724
|
*/
|
|
7458
|
-
|
|
7725
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
7726
|
/**
|
|
7460
7727
|
*
|
|
7461
|
-
* @summary
|
|
7462
|
-
* @param {
|
|
7728
|
+
* @summary Reset local authentication using the provided token
|
|
7729
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7463
7730
|
* @param {*} [options] Override http request option.
|
|
7464
7731
|
* @throws {RequiredError}
|
|
7465
7732
|
*/
|
|
7466
|
-
|
|
7733
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7467
7734
|
};
|
|
7468
7735
|
/**
|
|
7469
7736
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7504,6 +7771,19 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7504
7771
|
*/
|
|
7505
7772
|
readonly sessionId: string;
|
|
7506
7773
|
}
|
|
7774
|
+
/**
|
|
7775
|
+
* Request parameters for eanAuthentication operation in AuthenticateApi.
|
|
7776
|
+
* @export
|
|
7777
|
+
* @interface AuthenticateApiEanAuthenticationRequest
|
|
7778
|
+
*/
|
|
7779
|
+
export interface AuthenticateApiEanAuthenticationRequest {
|
|
7780
|
+
/**
|
|
7781
|
+
* The EAN login request with posId
|
|
7782
|
+
* @type {AuthenticationEanRequest}
|
|
7783
|
+
* @memberof AuthenticateApiEanAuthentication
|
|
7784
|
+
*/
|
|
7785
|
+
readonly authenticationEanRequest: AuthenticationEanRequest;
|
|
7786
|
+
}
|
|
7507
7787
|
/**
|
|
7508
7788
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7509
7789
|
* @export
|
|
@@ -7582,6 +7862,19 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7582
7862
|
*/
|
|
7583
7863
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7584
7864
|
}
|
|
7865
|
+
/**
|
|
7866
|
+
* Request parameters for memberPINAuthentication operation in AuthenticateApi.
|
|
7867
|
+
* @export
|
|
7868
|
+
* @interface AuthenticateApiMemberPINAuthenticationRequest
|
|
7869
|
+
*/
|
|
7870
|
+
export interface AuthenticateApiMemberPINAuthenticationRequest {
|
|
7871
|
+
/**
|
|
7872
|
+
* The PIN login request with posId
|
|
7873
|
+
* @type {MemberAuthenticationPinRequest}
|
|
7874
|
+
* @memberof AuthenticateApiMemberPINAuthentication
|
|
7875
|
+
*/
|
|
7876
|
+
readonly memberAuthenticationPinRequest: MemberAuthenticationPinRequest;
|
|
7877
|
+
}
|
|
7585
7878
|
/**
|
|
7586
7879
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7587
7880
|
* @export
|
|
@@ -7595,6 +7888,32 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7595
7888
|
*/
|
|
7596
7889
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7597
7890
|
}
|
|
7891
|
+
/**
|
|
7892
|
+
* Request parameters for nfcAuthentication operation in AuthenticateApi.
|
|
7893
|
+
* @export
|
|
7894
|
+
* @interface AuthenticateApiNfcAuthenticationRequest
|
|
7895
|
+
*/
|
|
7896
|
+
export interface AuthenticateApiNfcAuthenticationRequest {
|
|
7897
|
+
/**
|
|
7898
|
+
* The NFC login request with posId
|
|
7899
|
+
* @type {AuthenticationNfcRequest}
|
|
7900
|
+
* @memberof AuthenticateApiNfcAuthentication
|
|
7901
|
+
*/
|
|
7902
|
+
readonly authenticationNfcRequest: AuthenticationNfcRequest;
|
|
7903
|
+
}
|
|
7904
|
+
/**
|
|
7905
|
+
* Request parameters for pinAuthentication operation in AuthenticateApi.
|
|
7906
|
+
* @export
|
|
7907
|
+
* @interface AuthenticateApiPinAuthenticationRequest
|
|
7908
|
+
*/
|
|
7909
|
+
export interface AuthenticateApiPinAuthenticationRequest {
|
|
7910
|
+
/**
|
|
7911
|
+
* The PIN login request with posId
|
|
7912
|
+
* @type {AuthenticationPinRequest}
|
|
7913
|
+
* @memberof AuthenticateApiPinAuthentication
|
|
7914
|
+
*/
|
|
7915
|
+
readonly authenticationPinRequest: AuthenticationPinRequest;
|
|
7916
|
+
}
|
|
7598
7917
|
/**
|
|
7599
7918
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7600
7919
|
* @export
|
|
@@ -7621,58 +7940,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7621
7940
|
*/
|
|
7622
7941
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7623
7942
|
}
|
|
7624
|
-
/**
|
|
7625
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7626
|
-
* @export
|
|
7627
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7628
|
-
*/
|
|
7629
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7630
|
-
/**
|
|
7631
|
-
* The EAN login request with posId
|
|
7632
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7633
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7634
|
-
*/
|
|
7635
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7636
|
-
}
|
|
7637
|
-
/**
|
|
7638
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7639
|
-
* @export
|
|
7640
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7641
|
-
*/
|
|
7642
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7643
|
-
/**
|
|
7644
|
-
* The PIN login request with posId
|
|
7645
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7646
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7647
|
-
*/
|
|
7648
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7649
|
-
}
|
|
7650
|
-
/**
|
|
7651
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7652
|
-
* @export
|
|
7653
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7654
|
-
*/
|
|
7655
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7656
|
-
/**
|
|
7657
|
-
* The NFC login request with posId
|
|
7658
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7659
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7660
|
-
*/
|
|
7661
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7662
|
-
}
|
|
7663
|
-
/**
|
|
7664
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7665
|
-
* @export
|
|
7666
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7667
|
-
*/
|
|
7668
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7669
|
-
/**
|
|
7670
|
-
* The PIN login request with posId
|
|
7671
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7672
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7673
|
-
*/
|
|
7674
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7675
|
-
}
|
|
7676
7943
|
/**
|
|
7677
7944
|
* AuthenticateApi - object-oriented interface
|
|
7678
7945
|
* @export
|
|
@@ -7707,6 +7974,15 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7707
7974
|
* @memberof AuthenticateApi
|
|
7708
7975
|
*/
|
|
7709
7976
|
confirmQRCode(requestParameters: AuthenticateApiConfirmQRCodeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7977
|
+
/**
|
|
7978
|
+
*
|
|
7979
|
+
* @summary EAN authentication that requires POS user authentication
|
|
7980
|
+
* @param {AuthenticateApiEanAuthenticationRequest} requestParameters Request parameters.
|
|
7981
|
+
* @param {*} [options] Override http request option.
|
|
7982
|
+
* @throws {RequiredError}
|
|
7983
|
+
* @memberof AuthenticateApi
|
|
7984
|
+
*/
|
|
7985
|
+
eanAuthentication(requestParameters: AuthenticateApiEanAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7710
7986
|
/**
|
|
7711
7987
|
*
|
|
7712
7988
|
* @summary Generate a QR code for authentication
|
|
@@ -7787,75 +8063,66 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7787
8063
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7788
8064
|
/**
|
|
7789
8065
|
*
|
|
7790
|
-
* @summary
|
|
7791
|
-
* @param {
|
|
7792
|
-
* @param {*} [options] Override http request option.
|
|
7793
|
-
* @throws {RequiredError}
|
|
7794
|
-
* @memberof AuthenticateApi
|
|
7795
|
-
*/
|
|
7796
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7797
|
-
/**
|
|
7798
|
-
*
|
|
7799
|
-
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
8066
|
+
* @summary Member PIN authentication that requires POS user authentication
|
|
8067
|
+
* @param {AuthenticateApiMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7800
8068
|
* @param {*} [options] Override http request option.
|
|
7801
8069
|
* @throws {RequiredError}
|
|
7802
8070
|
* @memberof AuthenticateApi
|
|
7803
8071
|
*/
|
|
7804
|
-
|
|
8072
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7805
8073
|
/**
|
|
7806
8074
|
*
|
|
7807
|
-
* @summary
|
|
7808
|
-
* @param {
|
|
8075
|
+
* @summary Mock login and hand out token.
|
|
8076
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7809
8077
|
* @param {*} [options] Override http request option.
|
|
7810
8078
|
* @throws {RequiredError}
|
|
7811
8079
|
* @memberof AuthenticateApi
|
|
7812
8080
|
*/
|
|
7813
|
-
|
|
8081
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7814
8082
|
/**
|
|
7815
8083
|
*
|
|
7816
|
-
* @summary
|
|
7817
|
-
* @param {
|
|
8084
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8085
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7818
8086
|
* @param {*} [options] Override http request option.
|
|
7819
8087
|
* @throws {RequiredError}
|
|
7820
8088
|
* @memberof AuthenticateApi
|
|
7821
8089
|
*/
|
|
7822
|
-
|
|
8090
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7823
8091
|
/**
|
|
7824
8092
|
*
|
|
7825
|
-
* @summary
|
|
7826
|
-
* @param {
|
|
8093
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8094
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7827
8095
|
* @param {*} [options] Override http request option.
|
|
7828
8096
|
* @throws {RequiredError}
|
|
7829
8097
|
* @memberof AuthenticateApi
|
|
7830
8098
|
*/
|
|
7831
|
-
|
|
8099
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7832
8100
|
/**
|
|
7833
8101
|
*
|
|
7834
|
-
* @summary
|
|
7835
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8102
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7836
8103
|
* @param {*} [options] Override http request option.
|
|
7837
8104
|
* @throws {RequiredError}
|
|
7838
8105
|
* @memberof AuthenticateApi
|
|
7839
8106
|
*/
|
|
7840
|
-
|
|
8107
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7841
8108
|
/**
|
|
7842
8109
|
*
|
|
7843
|
-
* @summary
|
|
7844
|
-
* @param {
|
|
8110
|
+
* @summary Creates a reset token for the local authentication
|
|
8111
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7845
8112
|
* @param {*} [options] Override http request option.
|
|
7846
8113
|
* @throws {RequiredError}
|
|
7847
8114
|
* @memberof AuthenticateApi
|
|
7848
8115
|
*/
|
|
7849
|
-
|
|
8116
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7850
8117
|
/**
|
|
7851
8118
|
*
|
|
7852
|
-
* @summary
|
|
7853
|
-
* @param {
|
|
8119
|
+
* @summary Reset local authentication using the provided token
|
|
8120
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7854
8121
|
* @param {*} [options] Override http request option.
|
|
7855
8122
|
* @throws {RequiredError}
|
|
7856
8123
|
* @memberof AuthenticateApi
|
|
7857
8124
|
*/
|
|
7858
|
-
|
|
8125
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7859
8126
|
}
|
|
7860
8127
|
/**
|
|
7861
8128
|
* BalanceApi - axios parameter creator
|
|
@@ -11291,227 +11558,713 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11291
11558
|
* @type {number}
|
|
11292
11559
|
* @memberof InvoicesApiGetAllInvoices
|
|
11293
11560
|
*/
|
|
11294
|
-
readonly skip?: number;
|
|
11295
|
-
}
|
|
11561
|
+
readonly skip?: number;
|
|
11562
|
+
}
|
|
11563
|
+
/**
|
|
11564
|
+
* Request parameters for getEligibleTransactions operation in InvoicesApi.
|
|
11565
|
+
* @export
|
|
11566
|
+
* @interface InvoicesApiGetEligibleTransactionsRequest
|
|
11567
|
+
*/
|
|
11568
|
+
export interface InvoicesApiGetEligibleTransactionsRequest {
|
|
11569
|
+
/**
|
|
11570
|
+
* Filter on Id of the debtor
|
|
11571
|
+
* @type {number}
|
|
11572
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11573
|
+
*/
|
|
11574
|
+
readonly forId: number;
|
|
11575
|
+
/**
|
|
11576
|
+
* Start date for selected transactions (inclusive)
|
|
11577
|
+
* @type {string}
|
|
11578
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11579
|
+
*/
|
|
11580
|
+
readonly fromDate: string;
|
|
11581
|
+
/**
|
|
11582
|
+
* End date for selected transactions (exclusive)
|
|
11583
|
+
* @type {string}
|
|
11584
|
+
* @memberof InvoicesApiGetEligibleTransactions
|
|
11585
|
+
*/
|
|
11586
|
+
readonly tillDate?: string;
|
|
11587
|
+
}
|
|
11588
|
+
/**
|
|
11589
|
+
* Request parameters for getInvoicePdf operation in InvoicesApi.
|
|
11590
|
+
* @export
|
|
11591
|
+
* @interface InvoicesApiGetInvoicePdfRequest
|
|
11592
|
+
*/
|
|
11593
|
+
export interface InvoicesApiGetInvoicePdfRequest {
|
|
11594
|
+
/**
|
|
11595
|
+
* The id of the invoice to return
|
|
11596
|
+
* @type {number}
|
|
11597
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11598
|
+
*/
|
|
11599
|
+
readonly id: number;
|
|
11600
|
+
/**
|
|
11601
|
+
* Force creation of pdf
|
|
11602
|
+
* @type {boolean}
|
|
11603
|
+
* @memberof InvoicesApiGetInvoicePdf
|
|
11604
|
+
*/
|
|
11605
|
+
readonly force?: boolean;
|
|
11606
|
+
}
|
|
11607
|
+
/**
|
|
11608
|
+
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11609
|
+
* @export
|
|
11610
|
+
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11611
|
+
*/
|
|
11612
|
+
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
11613
|
+
/**
|
|
11614
|
+
* The id of the requested invoice
|
|
11615
|
+
* @type {number}
|
|
11616
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11617
|
+
*/
|
|
11618
|
+
readonly id: number;
|
|
11619
|
+
/**
|
|
11620
|
+
* Boolean if invoice entries should be returned, defaults to true.
|
|
11621
|
+
* @type {boolean}
|
|
11622
|
+
* @memberof InvoicesApiGetSingleInvoice
|
|
11623
|
+
*/
|
|
11624
|
+
readonly returnEntries?: boolean;
|
|
11625
|
+
}
|
|
11626
|
+
/**
|
|
11627
|
+
* Request parameters for getSingleInvoiceUser operation in InvoicesApi.
|
|
11628
|
+
* @export
|
|
11629
|
+
* @interface InvoicesApiGetSingleInvoiceUserRequest
|
|
11630
|
+
*/
|
|
11631
|
+
export interface InvoicesApiGetSingleInvoiceUserRequest {
|
|
11632
|
+
/**
|
|
11633
|
+
* The id of the invoice user to return.
|
|
11634
|
+
* @type {number}
|
|
11635
|
+
* @memberof InvoicesApiGetSingleInvoiceUser
|
|
11636
|
+
*/
|
|
11637
|
+
readonly id: number;
|
|
11638
|
+
}
|
|
11639
|
+
/**
|
|
11640
|
+
* Request parameters for putInvoiceUser operation in InvoicesApi.
|
|
11641
|
+
* @export
|
|
11642
|
+
* @interface InvoicesApiPutInvoiceUserRequest
|
|
11643
|
+
*/
|
|
11644
|
+
export interface InvoicesApiPutInvoiceUserRequest {
|
|
11645
|
+
/**
|
|
11646
|
+
* The id of the user to update
|
|
11647
|
+
* @type {number}
|
|
11648
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11649
|
+
*/
|
|
11650
|
+
readonly id: number;
|
|
11651
|
+
/**
|
|
11652
|
+
* The invoice user which should be updated
|
|
11653
|
+
* @type {UpdateInvoiceUserRequest}
|
|
11654
|
+
* @memberof InvoicesApiPutInvoiceUser
|
|
11655
|
+
*/
|
|
11656
|
+
readonly updateInvoiceUserRequest: UpdateInvoiceUserRequest;
|
|
11657
|
+
}
|
|
11658
|
+
/**
|
|
11659
|
+
* Request parameters for updateInvoice operation in InvoicesApi.
|
|
11660
|
+
* @export
|
|
11661
|
+
* @interface InvoicesApiUpdateInvoiceRequest
|
|
11662
|
+
*/
|
|
11663
|
+
export interface InvoicesApiUpdateInvoiceRequest {
|
|
11664
|
+
/**
|
|
11665
|
+
* The id of the invoice which should be updated
|
|
11666
|
+
* @type {number}
|
|
11667
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11668
|
+
*/
|
|
11669
|
+
readonly id: number;
|
|
11670
|
+
/**
|
|
11671
|
+
* The invoice update to process
|
|
11672
|
+
* @type {UpdateInvoiceRequest}
|
|
11673
|
+
* @memberof InvoicesApiUpdateInvoice
|
|
11674
|
+
*/
|
|
11675
|
+
readonly updateInvoiceRequest: UpdateInvoiceRequest;
|
|
11676
|
+
}
|
|
11677
|
+
/**
|
|
11678
|
+
* InvoicesApi - object-oriented interface
|
|
11679
|
+
* @export
|
|
11680
|
+
* @class InvoicesApi
|
|
11681
|
+
* @extends {BaseAPI}
|
|
11682
|
+
*/
|
|
11683
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
11684
|
+
/**
|
|
11685
|
+
*
|
|
11686
|
+
* @summary Adds an invoice to the system.
|
|
11687
|
+
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
11688
|
+
* @param {*} [options] Override http request option.
|
|
11689
|
+
* @throws {RequiredError}
|
|
11690
|
+
* @memberof InvoicesApi
|
|
11691
|
+
*/
|
|
11692
|
+
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11693
|
+
/**
|
|
11694
|
+
*
|
|
11695
|
+
* @summary Deletes an invoice.
|
|
11696
|
+
* @param {InvoicesApiDeleteInvoiceRequest} requestParameters Request parameters.
|
|
11697
|
+
* @param {*} [options] Override http request option.
|
|
11698
|
+
* @throws {RequiredError}
|
|
11699
|
+
* @memberof InvoicesApi
|
|
11700
|
+
*/
|
|
11701
|
+
deleteInvoice(requestParameters: InvoicesApiDeleteInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11702
|
+
/**
|
|
11703
|
+
*
|
|
11704
|
+
* @summary Delete invoice user defaults.
|
|
11705
|
+
* @param {InvoicesApiDeleteInvoiceUserRequest} requestParameters Request parameters.
|
|
11706
|
+
* @param {*} [options] Override http request option.
|
|
11707
|
+
* @throws {RequiredError}
|
|
11708
|
+
* @memberof InvoicesApi
|
|
11709
|
+
*/
|
|
11710
|
+
deleteInvoiceUser(requestParameters: InvoicesApiDeleteInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11711
|
+
/**
|
|
11712
|
+
*
|
|
11713
|
+
* @summary Returns all invoices in the system.
|
|
11714
|
+
* @param {InvoicesApiGetAllInvoicesRequest} requestParameters Request parameters.
|
|
11715
|
+
* @param {*} [options] Override http request option.
|
|
11716
|
+
* @throws {RequiredError}
|
|
11717
|
+
* @memberof InvoicesApi
|
|
11718
|
+
*/
|
|
11719
|
+
getAllInvoices(requestParameters?: InvoicesApiGetAllInvoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedInvoiceResponse, any, {}>>;
|
|
11720
|
+
/**
|
|
11721
|
+
*
|
|
11722
|
+
* @summary Get eligible transactions for invoice creation.
|
|
11723
|
+
* @param {InvoicesApiGetEligibleTransactionsRequest} requestParameters Request parameters.
|
|
11724
|
+
* @param {*} [options] Override http request option.
|
|
11725
|
+
* @throws {RequiredError}
|
|
11726
|
+
* @memberof InvoicesApi
|
|
11727
|
+
*/
|
|
11728
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
|
|
11729
|
+
/**
|
|
11730
|
+
*
|
|
11731
|
+
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
11732
|
+
* @param {*} [options] Override http request option.
|
|
11733
|
+
* @throws {RequiredError}
|
|
11734
|
+
* @memberof InvoicesApi
|
|
11735
|
+
*/
|
|
11736
|
+
getInvoiceDrift(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceDriftResponse[], any, {}>>;
|
|
11737
|
+
/**
|
|
11738
|
+
*
|
|
11739
|
+
* @summary Get an invoice pdf.
|
|
11740
|
+
* @param {InvoicesApiGetInvoicePdfRequest} requestParameters Request parameters.
|
|
11741
|
+
* @param {*} [options] Override http request option.
|
|
11742
|
+
* @throws {RequiredError}
|
|
11743
|
+
* @memberof InvoicesApi
|
|
11744
|
+
*/
|
|
11745
|
+
getInvoicePdf(requestParameters: InvoicesApiGetInvoicePdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfUrlResponse, any, {}>>;
|
|
11746
|
+
/**
|
|
11747
|
+
*
|
|
11748
|
+
* @summary Returns a single invoice in the system.
|
|
11749
|
+
* @param {InvoicesApiGetSingleInvoiceRequest} requestParameters Request parameters.
|
|
11750
|
+
* @param {*} [options] Override http request option.
|
|
11751
|
+
* @throws {RequiredError}
|
|
11752
|
+
* @memberof InvoicesApi
|
|
11753
|
+
*/
|
|
11754
|
+
getSingleInvoice(requestParameters: InvoicesApiGetSingleInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
|
|
11755
|
+
/**
|
|
11756
|
+
*
|
|
11757
|
+
* @summary Get invoice user defaults.
|
|
11758
|
+
* @param {InvoicesApiGetSingleInvoiceUserRequest} requestParameters Request parameters.
|
|
11759
|
+
* @param {*} [options] Override http request option.
|
|
11760
|
+
* @throws {RequiredError}
|
|
11761
|
+
* @memberof InvoicesApi
|
|
11762
|
+
*/
|
|
11763
|
+
getSingleInvoiceUser(requestParameters: InvoicesApiGetSingleInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11764
|
+
/**
|
|
11765
|
+
*
|
|
11766
|
+
* @summary Update or create invoice user defaults.
|
|
11767
|
+
* @param {InvoicesApiPutInvoiceUserRequest} requestParameters Request parameters.
|
|
11768
|
+
* @param {*} [options] Override http request option.
|
|
11769
|
+
* @throws {RequiredError}
|
|
11770
|
+
* @memberof InvoicesApi
|
|
11771
|
+
*/
|
|
11772
|
+
putInvoiceUser(requestParameters: InvoicesApiPutInvoiceUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceUserResponse, any, {}>>;
|
|
11773
|
+
/**
|
|
11774
|
+
*
|
|
11775
|
+
* @summary Adds an invoice to the system.
|
|
11776
|
+
* @param {InvoicesApiUpdateInvoiceRequest} requestParameters Request parameters.
|
|
11777
|
+
* @param {*} [options] Override http request option.
|
|
11778
|
+
* @throws {RequiredError}
|
|
11779
|
+
* @memberof InvoicesApi
|
|
11780
|
+
*/
|
|
11781
|
+
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11785
|
+
* @export
|
|
11786
|
+
*/
|
|
11787
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11788
|
+
/**
|
|
11789
|
+
*
|
|
11790
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11791
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11792
|
+
* @param {*} [options] Override http request option.
|
|
11793
|
+
* @throws {RequiredError}
|
|
11794
|
+
*/
|
|
11795
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11796
|
+
/**
|
|
11797
|
+
*
|
|
11798
|
+
* @summary Create a new PaymentRequest.
|
|
11799
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11800
|
+
* @param {*} [options] Override http request option.
|
|
11801
|
+
* @throws {RequiredError}
|
|
11802
|
+
*/
|
|
11803
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11804
|
+
/**
|
|
11805
|
+
*
|
|
11806
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11807
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11808
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11809
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11810
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11811
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11812
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11813
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11814
|
+
* @param {*} [options] Override http request option.
|
|
11815
|
+
* @throws {RequiredError}
|
|
11816
|
+
*/
|
|
11817
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11818
|
+
/**
|
|
11819
|
+
*
|
|
11820
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11821
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11822
|
+
* @param {*} [options] Override http request option.
|
|
11823
|
+
* @throws {RequiredError}
|
|
11824
|
+
*/
|
|
11825
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11826
|
+
/**
|
|
11827
|
+
*
|
|
11828
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11829
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11830
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11831
|
+
* @param {*} [options] Override http request option.
|
|
11832
|
+
* @throws {RequiredError}
|
|
11833
|
+
*/
|
|
11834
|
+
markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11835
|
+
/**
|
|
11836
|
+
*
|
|
11837
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11838
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11839
|
+
* @param {*} [options] Override http request option.
|
|
11840
|
+
* @throws {RequiredError}
|
|
11841
|
+
*/
|
|
11842
|
+
startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11843
|
+
};
|
|
11844
|
+
/**
|
|
11845
|
+
* PaymentRequestsApi - functional programming interface
|
|
11846
|
+
* @export
|
|
11847
|
+
*/
|
|
11848
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11849
|
+
/**
|
|
11850
|
+
*
|
|
11851
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11852
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11853
|
+
* @param {*} [options] Override http request option.
|
|
11854
|
+
* @throws {RequiredError}
|
|
11855
|
+
*/
|
|
11856
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11857
|
+
/**
|
|
11858
|
+
*
|
|
11859
|
+
* @summary Create a new PaymentRequest.
|
|
11860
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11861
|
+
* @param {*} [options] Override http request option.
|
|
11862
|
+
* @throws {RequiredError}
|
|
11863
|
+
*/
|
|
11864
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11865
|
+
/**
|
|
11866
|
+
*
|
|
11867
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11868
|
+
* @param {number} [forId] Filter by beneficiary user id.
|
|
11869
|
+
* @param {number} [createdById] Filter by creator user id.
|
|
11870
|
+
* @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
|
|
11871
|
+
* @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
|
|
11872
|
+
* @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
|
|
11873
|
+
* @param {number} [take] How many rows the endpoint should return
|
|
11874
|
+
* @param {number} [skip] How many rows to skip (for pagination)
|
|
11875
|
+
* @param {*} [options] Override http request option.
|
|
11876
|
+
* @throws {RequiredError}
|
|
11877
|
+
*/
|
|
11878
|
+
getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
|
|
11879
|
+
/**
|
|
11880
|
+
*
|
|
11881
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11882
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11883
|
+
* @param {*} [options] Override http request option.
|
|
11884
|
+
* @throws {RequiredError}
|
|
11885
|
+
*/
|
|
11886
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11887
|
+
/**
|
|
11888
|
+
*
|
|
11889
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11890
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11891
|
+
* @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
|
|
11892
|
+
* @param {*} [options] Override http request option.
|
|
11893
|
+
* @throws {RequiredError}
|
|
11894
|
+
*/
|
|
11895
|
+
markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11896
|
+
/**
|
|
11897
|
+
*
|
|
11898
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11899
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11900
|
+
* @param {*} [options] Override http request option.
|
|
11901
|
+
* @throws {RequiredError}
|
|
11902
|
+
*/
|
|
11903
|
+
startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
|
|
11904
|
+
};
|
|
11905
|
+
/**
|
|
11906
|
+
* PaymentRequestsApi - factory interface
|
|
11907
|
+
* @export
|
|
11908
|
+
*/
|
|
11909
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11913
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11914
|
+
* @param {*} [options] Override http request option.
|
|
11915
|
+
* @throws {RequiredError}
|
|
11916
|
+
*/
|
|
11917
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11918
|
+
/**
|
|
11919
|
+
*
|
|
11920
|
+
* @summary Create a new PaymentRequest.
|
|
11921
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11922
|
+
* @param {*} [options] Override http request option.
|
|
11923
|
+
* @throws {RequiredError}
|
|
11924
|
+
*/
|
|
11925
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11926
|
+
/**
|
|
11927
|
+
*
|
|
11928
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11929
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11930
|
+
* @param {*} [options] Override http request option.
|
|
11931
|
+
* @throws {RequiredError}
|
|
11932
|
+
*/
|
|
11933
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11934
|
+
/**
|
|
11935
|
+
*
|
|
11936
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11937
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11938
|
+
* @param {*} [options] Override http request option.
|
|
11939
|
+
* @throws {RequiredError}
|
|
11940
|
+
*/
|
|
11941
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11942
|
+
/**
|
|
11943
|
+
*
|
|
11944
|
+
* @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
|
|
11945
|
+
* @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
|
|
11946
|
+
* @param {*} [options] Override http request option.
|
|
11947
|
+
* @throws {RequiredError}
|
|
11948
|
+
*/
|
|
11949
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11950
|
+
/**
|
|
11951
|
+
*
|
|
11952
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
11953
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11954
|
+
* @param {*} [options] Override http request option.
|
|
11955
|
+
* @throws {RequiredError}
|
|
11956
|
+
*/
|
|
11957
|
+
startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
11958
|
+
};
|
|
11296
11959
|
/**
|
|
11297
|
-
* Request parameters for
|
|
11960
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11298
11961
|
* @export
|
|
11299
|
-
* @interface
|
|
11962
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11300
11963
|
*/
|
|
11301
|
-
export interface
|
|
11302
|
-
/**
|
|
11303
|
-
* Filter on Id of the debtor
|
|
11304
|
-
* @type {number}
|
|
11305
|
-
* @memberof InvoicesApiGetEligibleTransactions
|
|
11306
|
-
*/
|
|
11307
|
-
readonly forId: number;
|
|
11964
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11308
11965
|
/**
|
|
11309
|
-
*
|
|
11966
|
+
* UUID v4 of the payment request.
|
|
11310
11967
|
* @type {string}
|
|
11311
|
-
* @memberof
|
|
11968
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11312
11969
|
*/
|
|
11313
|
-
readonly
|
|
11970
|
+
readonly id: string;
|
|
11971
|
+
}
|
|
11972
|
+
/**
|
|
11973
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
11974
|
+
* @export
|
|
11975
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
11976
|
+
*/
|
|
11977
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
11314
11978
|
/**
|
|
11315
|
-
*
|
|
11316
|
-
* @type {
|
|
11317
|
-
* @memberof
|
|
11979
|
+
* The request to create
|
|
11980
|
+
* @type {CreatePaymentRequestRequest}
|
|
11981
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11318
11982
|
*/
|
|
11319
|
-
readonly
|
|
11983
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11320
11984
|
}
|
|
11321
11985
|
/**
|
|
11322
|
-
* Request parameters for
|
|
11986
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11323
11987
|
* @export
|
|
11324
|
-
* @interface
|
|
11988
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11325
11989
|
*/
|
|
11326
|
-
export interface
|
|
11990
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11327
11991
|
/**
|
|
11328
|
-
*
|
|
11992
|
+
* Filter by beneficiary user id.
|
|
11329
11993
|
* @type {number}
|
|
11330
|
-
* @memberof
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11331
11995
|
*/
|
|
11332
|
-
readonly
|
|
11996
|
+
readonly forId?: number;
|
|
11333
11997
|
/**
|
|
11334
|
-
*
|
|
11335
|
-
* @type {
|
|
11336
|
-
* @memberof
|
|
11998
|
+
* Filter by creator user id.
|
|
11999
|
+
* @type {number}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11337
12001
|
*/
|
|
11338
|
-
readonly
|
|
11339
|
-
}
|
|
11340
|
-
/**
|
|
11341
|
-
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11342
|
-
* @export
|
|
11343
|
-
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11344
|
-
*/
|
|
11345
|
-
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
12002
|
+
readonly createdById?: number;
|
|
11346
12003
|
/**
|
|
11347
|
-
*
|
|
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
|
|
11348
12023
|
* @type {number}
|
|
11349
|
-
* @memberof
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11350
12025
|
*/
|
|
11351
|
-
readonly
|
|
12026
|
+
readonly take?: number;
|
|
11352
12027
|
/**
|
|
11353
|
-
*
|
|
11354
|
-
* @type {
|
|
11355
|
-
* @memberof
|
|
12028
|
+
* How many rows to skip (for pagination)
|
|
12029
|
+
* @type {number}
|
|
12030
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11356
12031
|
*/
|
|
11357
|
-
readonly
|
|
12032
|
+
readonly skip?: number;
|
|
11358
12033
|
}
|
|
11359
12034
|
/**
|
|
11360
|
-
* Request parameters for
|
|
12035
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11361
12036
|
* @export
|
|
11362
|
-
* @interface
|
|
12037
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11363
12038
|
*/
|
|
11364
|
-
export interface
|
|
12039
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11365
12040
|
/**
|
|
11366
|
-
*
|
|
11367
|
-
* @type {
|
|
11368
|
-
* @memberof
|
|
12041
|
+
* UUID v4 of the payment request.
|
|
12042
|
+
* @type {string}
|
|
12043
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11369
12044
|
*/
|
|
11370
|
-
readonly id:
|
|
12045
|
+
readonly id: string;
|
|
11371
12046
|
}
|
|
11372
12047
|
/**
|
|
11373
|
-
* Request parameters for
|
|
12048
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11374
12049
|
* @export
|
|
11375
|
-
* @interface
|
|
12050
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11376
12051
|
*/
|
|
11377
|
-
export interface
|
|
12052
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11378
12053
|
/**
|
|
11379
|
-
*
|
|
11380
|
-
* @type {
|
|
11381
|
-
* @memberof
|
|
12054
|
+
* UUID v4 of the payment request.
|
|
12055
|
+
* @type {string}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11382
12057
|
*/
|
|
11383
|
-
readonly id:
|
|
12058
|
+
readonly id: string;
|
|
11384
12059
|
/**
|
|
11385
|
-
* The
|
|
11386
|
-
* @type {
|
|
11387
|
-
* @memberof
|
|
12060
|
+
* The audit reason
|
|
12061
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12062
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11388
12063
|
*/
|
|
11389
|
-
readonly
|
|
12064
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11390
12065
|
}
|
|
11391
12066
|
/**
|
|
11392
|
-
* Request parameters for
|
|
12067
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11393
12068
|
* @export
|
|
11394
|
-
* @interface
|
|
12069
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11395
12070
|
*/
|
|
11396
|
-
export interface
|
|
11397
|
-
/**
|
|
11398
|
-
* The id of the invoice which should be updated
|
|
11399
|
-
* @type {number}
|
|
11400
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11401
|
-
*/
|
|
11402
|
-
readonly id: number;
|
|
12071
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11403
12072
|
/**
|
|
11404
|
-
*
|
|
11405
|
-
* @type {
|
|
11406
|
-
* @memberof
|
|
12073
|
+
* UUID v4 of the payment request.
|
|
12074
|
+
* @type {string}
|
|
12075
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11407
12076
|
*/
|
|
11408
|
-
readonly
|
|
12077
|
+
readonly id: string;
|
|
11409
12078
|
}
|
|
11410
12079
|
/**
|
|
11411
|
-
*
|
|
12080
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11412
12081
|
* @export
|
|
11413
|
-
* @class
|
|
12082
|
+
* @class PaymentRequestsApi
|
|
11414
12083
|
* @extends {BaseAPI}
|
|
11415
12084
|
*/
|
|
11416
|
-
export declare class
|
|
12085
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11417
12086
|
/**
|
|
11418
12087
|
*
|
|
11419
|
-
* @summary
|
|
11420
|
-
* @param {
|
|
12088
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12089
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11421
12090
|
* @param {*} [options] Override http request option.
|
|
11422
12091
|
* @throws {RequiredError}
|
|
11423
|
-
* @memberof
|
|
12092
|
+
* @memberof PaymentRequestsApi
|
|
11424
12093
|
*/
|
|
11425
|
-
|
|
12094
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11426
12095
|
/**
|
|
11427
12096
|
*
|
|
11428
|
-
* @summary
|
|
11429
|
-
* @param {
|
|
12097
|
+
* @summary Create a new PaymentRequest.
|
|
12098
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11430
12099
|
* @param {*} [options] Override http request option.
|
|
11431
12100
|
* @throws {RequiredError}
|
|
11432
|
-
* @memberof
|
|
12101
|
+
* @memberof PaymentRequestsApi
|
|
11433
12102
|
*/
|
|
11434
|
-
|
|
12103
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11435
12104
|
/**
|
|
11436
12105
|
*
|
|
11437
|
-
* @summary
|
|
11438
|
-
* @param {
|
|
12106
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12107
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11439
12108
|
* @param {*} [options] Override http request option.
|
|
11440
12109
|
* @throws {RequiredError}
|
|
11441
|
-
* @memberof
|
|
12110
|
+
* @memberof PaymentRequestsApi
|
|
11442
12111
|
*/
|
|
11443
|
-
|
|
12112
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11444
12113
|
/**
|
|
11445
12114
|
*
|
|
11446
|
-
* @summary
|
|
11447
|
-
* @param {
|
|
12115
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12116
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11448
12117
|
* @param {*} [options] Override http request option.
|
|
11449
12118
|
* @throws {RequiredError}
|
|
11450
|
-
* @memberof
|
|
12119
|
+
* @memberof PaymentRequestsApi
|
|
11451
12120
|
*/
|
|
11452
|
-
|
|
12121
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11453
12122
|
/**
|
|
11454
12123
|
*
|
|
11455
|
-
* @summary
|
|
11456
|
-
* @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.
|
|
11457
12126
|
* @param {*} [options] Override http request option.
|
|
11458
12127
|
* @throws {RequiredError}
|
|
11459
|
-
* @memberof
|
|
12128
|
+
* @memberof PaymentRequestsApi
|
|
11460
12129
|
*/
|
|
11461
|
-
|
|
12130
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11462
12131
|
/**
|
|
11463
12132
|
*
|
|
11464
|
-
* @summary
|
|
12133
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12134
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11465
12135
|
* @param {*} [options] Override http request option.
|
|
11466
12136
|
* @throws {RequiredError}
|
|
11467
|
-
* @memberof
|
|
12137
|
+
* @memberof PaymentRequestsApi
|
|
11468
12138
|
*/
|
|
11469
|
-
|
|
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) => {
|
|
11470
12156
|
/**
|
|
11471
12157
|
*
|
|
11472
|
-
* @summary
|
|
11473
|
-
* @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.
|
|
11474
12160
|
* @param {*} [options] Override http request option.
|
|
11475
12161
|
* @throws {RequiredError}
|
|
11476
|
-
* @memberof InvoicesApi
|
|
11477
12162
|
*/
|
|
11478
|
-
|
|
12163
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11479
12164
|
/**
|
|
11480
12165
|
*
|
|
11481
|
-
* @summary
|
|
11482
|
-
* @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.
|
|
11483
12168
|
* @param {*} [options] Override http request option.
|
|
11484
12169
|
* @throws {RequiredError}
|
|
11485
|
-
* @memberof InvoicesApi
|
|
11486
12170
|
*/
|
|
11487
|
-
|
|
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) => {
|
|
11488
12178
|
/**
|
|
11489
12179
|
*
|
|
11490
|
-
* @summary
|
|
11491
|
-
* @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.
|
|
11492
12182
|
* @param {*} [options] Override http request option.
|
|
11493
12183
|
* @throws {RequiredError}
|
|
11494
|
-
* @memberof InvoicesApi
|
|
11495
12184
|
*/
|
|
11496
|
-
|
|
12185
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11497
12186
|
/**
|
|
11498
12187
|
*
|
|
11499
|
-
* @summary
|
|
11500
|
-
* @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.
|
|
11501
12190
|
* @param {*} [options] Override http request option.
|
|
11502
12191
|
* @throws {RequiredError}
|
|
11503
|
-
* @memberof InvoicesApi
|
|
11504
12192
|
*/
|
|
11505
|
-
|
|
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) => {
|
|
11506
12200
|
/**
|
|
11507
12201
|
*
|
|
11508
|
-
* @summary
|
|
11509
|
-
* @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.
|
|
11510
12204
|
* @param {*} [options] Override http request option.
|
|
11511
12205
|
* @throws {RequiredError}
|
|
11512
|
-
* @memberof InvoicesApi
|
|
11513
12206
|
*/
|
|
11514
|
-
|
|
12207
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
|
|
12208
|
+
/**
|
|
12209
|
+
*
|
|
12210
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12211
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12212
|
+
* @param {*} [options] Override http request option.
|
|
12213
|
+
* @throws {RequiredError}
|
|
12214
|
+
*/
|
|
12215
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
|
|
12216
|
+
};
|
|
12217
|
+
/**
|
|
12218
|
+
* Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
|
|
12219
|
+
* @export
|
|
12220
|
+
* @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
|
|
12221
|
+
*/
|
|
12222
|
+
export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
|
|
12223
|
+
/**
|
|
12224
|
+
* UUID v4 of the payment request.
|
|
12225
|
+
* @type {string}
|
|
12226
|
+
* @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
|
|
12227
|
+
*/
|
|
12228
|
+
readonly id: string;
|
|
12229
|
+
}
|
|
12230
|
+
/**
|
|
12231
|
+
* Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
|
|
12232
|
+
* @export
|
|
12233
|
+
* @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
|
|
12234
|
+
*/
|
|
12235
|
+
export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
|
|
12236
|
+
/**
|
|
12237
|
+
* UUID v4 of the payment request.
|
|
12238
|
+
* @type {string}
|
|
12239
|
+
* @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
|
|
12240
|
+
*/
|
|
12241
|
+
readonly id: string;
|
|
12242
|
+
}
|
|
12243
|
+
/**
|
|
12244
|
+
* PaymentRequestsPublicApi - object-oriented interface
|
|
12245
|
+
* @export
|
|
12246
|
+
* @class PaymentRequestsPublicApi
|
|
12247
|
+
* @extends {BaseAPI}
|
|
12248
|
+
*/
|
|
12249
|
+
export declare class PaymentRequestsPublicApi extends BaseAPI {
|
|
12250
|
+
/**
|
|
12251
|
+
*
|
|
12252
|
+
* @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
|
|
12253
|
+
* @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
|
|
12254
|
+
* @param {*} [options] Override http request option.
|
|
12255
|
+
* @throws {RequiredError}
|
|
12256
|
+
* @memberof PaymentRequestsPublicApi
|
|
12257
|
+
*/
|
|
12258
|
+
getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
|
|
12259
|
+
/**
|
|
12260
|
+
*
|
|
12261
|
+
* @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
|
|
12262
|
+
* @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
|
|
12263
|
+
* @param {*} [options] Override http request option.
|
|
12264
|
+
* @throws {RequiredError}
|
|
12265
|
+
* @memberof PaymentRequestsPublicApi
|
|
12266
|
+
*/
|
|
12267
|
+
startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
|
|
11515
12268
|
}
|
|
11516
12269
|
/**
|
|
11517
12270
|
* PayoutRequestsApi - axios parameter creator
|
|
@@ -15676,6 +16429,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15676
16429
|
* @throws {RequiredError}
|
|
15677
16430
|
*/
|
|
15678
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>;
|
|
15679
16446
|
/**
|
|
15680
16447
|
*
|
|
15681
16448
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16038,6 +16805,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16038
16805
|
* @throws {RequiredError}
|
|
16039
16806
|
*/
|
|
16040
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>>;
|
|
16041
16822
|
/**
|
|
16042
16823
|
*
|
|
16043
16824
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16382,6 +17163,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16382
17163
|
* @throws {RequiredError}
|
|
16383
17164
|
*/
|
|
16384
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>;
|
|
16385
17174
|
/**
|
|
16386
17175
|
*
|
|
16387
17176
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16873,6 +17662,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16873
17662
|
*/
|
|
16874
17663
|
readonly skip?: number;
|
|
16875
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
|
+
}
|
|
16876
17714
|
/**
|
|
16877
17715
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16878
17716
|
* @export
|
|
@@ -17539,6 +18377,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17539
18377
|
* @memberof UsersApi
|
|
17540
18378
|
*/
|
|
17541
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, {}>>;
|
|
17542
18389
|
/**
|
|
17543
18390
|
*
|
|
17544
18391
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17734,6 +18581,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17734
18581
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17735
18582
|
};
|
|
17736
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];
|
|
17737
18594
|
/**
|
|
17738
18595
|
* @export
|
|
17739
18596
|
*/
|