@gewis/sudosos-client 0.0.0-develop.c36a01f → 0.0.0-develop.d4e012a
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 +1236 -367
- 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}
|
|
@@ -6109,6 +6376,12 @@ export interface UpdateUserRequest {
|
|
|
6109
6376
|
* @memberof UpdateUserRequest
|
|
6110
6377
|
*/
|
|
6111
6378
|
'inactiveNotificationSend'?: boolean;
|
|
6379
|
+
/**
|
|
6380
|
+
* ISO date at which the account expires; pass null to clear
|
|
6381
|
+
* @type {string}
|
|
6382
|
+
* @memberof UpdateUserRequest
|
|
6383
|
+
*/
|
|
6384
|
+
'expiryDate'?: string | null;
|
|
6112
6385
|
}
|
|
6113
6386
|
/**
|
|
6114
6387
|
* API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
|
|
@@ -6325,6 +6598,12 @@ export interface UserResponse {
|
|
|
6325
6598
|
* @memberof UserResponse
|
|
6326
6599
|
*/
|
|
6327
6600
|
'pos'?: BasePointOfSaleInfoResponse;
|
|
6601
|
+
/**
|
|
6602
|
+
* ISO date at which the account expires (null for accounts without expiry)
|
|
6603
|
+
* @type {string}
|
|
6604
|
+
* @memberof UserResponse
|
|
6605
|
+
*/
|
|
6606
|
+
'expiryDate'?: string | null;
|
|
6328
6607
|
}
|
|
6329
6608
|
/**
|
|
6330
6609
|
*
|
|
@@ -6996,6 +7275,14 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
6996
7275
|
* @throws {RequiredError}
|
|
6997
7276
|
*/
|
|
6998
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>;
|
|
6999
7286
|
/**
|
|
7000
7287
|
*
|
|
7001
7288
|
* @summary Generate a QR code for authentication
|
|
@@ -7067,67 +7354,59 @@ export declare const AuthenticateApiAxiosParamCreator: (configuration?: Configur
|
|
|
7067
7354
|
localAuthentication: (authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7068
7355
|
/**
|
|
7069
7356
|
*
|
|
7070
|
-
* @summary
|
|
7071
|
-
* @param {
|
|
7072
|
-
* @param {*} [options] Override http request option.
|
|
7073
|
-
* @throws {RequiredError}
|
|
7074
|
-
*/
|
|
7075
|
-
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7076
|
-
/**
|
|
7077
|
-
*
|
|
7078
|
-
* @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
|
|
7079
7359
|
* @param {*} [options] Override http request option.
|
|
7080
7360
|
* @throws {RequiredError}
|
|
7081
7361
|
*/
|
|
7082
|
-
|
|
7362
|
+
memberPINAuthentication: (memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7083
7363
|
/**
|
|
7084
7364
|
*
|
|
7085
|
-
* @summary
|
|
7086
|
-
* @param {
|
|
7365
|
+
* @summary Mock login and hand out token.
|
|
7366
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7087
7367
|
* @param {*} [options] Override http request option.
|
|
7088
7368
|
* @throws {RequiredError}
|
|
7089
7369
|
*/
|
|
7090
|
-
|
|
7370
|
+
mockAuthentication: (authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7091
7371
|
/**
|
|
7092
7372
|
*
|
|
7093
|
-
* @summary
|
|
7094
|
-
* @param {
|
|
7373
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7374
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7095
7375
|
* @param {*} [options] Override http request option.
|
|
7096
7376
|
* @throws {RequiredError}
|
|
7097
7377
|
*/
|
|
7098
|
-
|
|
7378
|
+
nfcAuthentication: (authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7099
7379
|
/**
|
|
7100
7380
|
*
|
|
7101
|
-
* @summary
|
|
7102
|
-
* @param {
|
|
7381
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7382
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7103
7383
|
* @param {*} [options] Override http request option.
|
|
7104
7384
|
* @throws {RequiredError}
|
|
7105
7385
|
*/
|
|
7106
|
-
|
|
7386
|
+
pinAuthentication: (authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7107
7387
|
/**
|
|
7108
7388
|
*
|
|
7109
|
-
* @summary
|
|
7110
|
-
* @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
|
|
7111
7390
|
* @param {*} [options] Override http request option.
|
|
7112
7391
|
* @throws {RequiredError}
|
|
7113
7392
|
*/
|
|
7114
|
-
|
|
7393
|
+
refreshToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7115
7394
|
/**
|
|
7116
7395
|
*
|
|
7117
|
-
* @summary
|
|
7118
|
-
* @param {
|
|
7396
|
+
* @summary Creates a reset token for the local authentication
|
|
7397
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7119
7398
|
* @param {*} [options] Override http request option.
|
|
7120
7399
|
* @throws {RequiredError}
|
|
7121
7400
|
*/
|
|
7122
|
-
|
|
7401
|
+
resetLocal: (resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7123
7402
|
/**
|
|
7124
7403
|
*
|
|
7125
|
-
* @summary
|
|
7126
|
-
* @param {
|
|
7404
|
+
* @summary Reset local authentication using the provided token
|
|
7405
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7127
7406
|
* @param {*} [options] Override http request option.
|
|
7128
7407
|
* @throws {RequiredError}
|
|
7129
7408
|
*/
|
|
7130
|
-
|
|
7409
|
+
resetLocalWithToken: (authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7131
7410
|
};
|
|
7132
7411
|
/**
|
|
7133
7412
|
* AuthenticateApi - functional programming interface
|
|
@@ -7158,6 +7437,14 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7158
7437
|
* @throws {RequiredError}
|
|
7159
7438
|
*/
|
|
7160
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>>;
|
|
7161
7448
|
/**
|
|
7162
7449
|
*
|
|
7163
7450
|
* @summary Generate a QR code for authentication
|
|
@@ -7229,67 +7516,59 @@ export declare const AuthenticateApiFp: (configuration?: Configuration) => {
|
|
|
7229
7516
|
localAuthentication(authenticationLocalRequest: AuthenticationLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7230
7517
|
/**
|
|
7231
7518
|
*
|
|
7232
|
-
* @summary
|
|
7233
|
-
* @param {
|
|
7234
|
-
* @param {*} [options] Override http request option.
|
|
7235
|
-
* @throws {RequiredError}
|
|
7236
|
-
*/
|
|
7237
|
-
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7238
|
-
/**
|
|
7239
|
-
*
|
|
7240
|
-
* @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
|
|
7241
7521
|
* @param {*} [options] Override http request option.
|
|
7242
7522
|
* @throws {RequiredError}
|
|
7243
7523
|
*/
|
|
7244
|
-
|
|
7524
|
+
memberPINAuthentication(memberAuthenticationPinRequest: MemberAuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7245
7525
|
/**
|
|
7246
7526
|
*
|
|
7247
|
-
* @summary
|
|
7248
|
-
* @param {
|
|
7527
|
+
* @summary Mock login and hand out token.
|
|
7528
|
+
* @param {AuthenticationMockRequest} authenticationMockRequest The mock login.
|
|
7249
7529
|
* @param {*} [options] Override http request option.
|
|
7250
7530
|
* @throws {RequiredError}
|
|
7251
7531
|
*/
|
|
7252
|
-
|
|
7532
|
+
mockAuthentication(authenticationMockRequest: AuthenticationMockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7253
7533
|
/**
|
|
7254
7534
|
*
|
|
7255
|
-
* @summary
|
|
7256
|
-
* @param {
|
|
7535
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7536
|
+
* @param {AuthenticationNfcRequest} authenticationNfcRequest The NFC login request with posId
|
|
7257
7537
|
* @param {*} [options] Override http request option.
|
|
7258
7538
|
* @throws {RequiredError}
|
|
7259
7539
|
*/
|
|
7260
|
-
|
|
7540
|
+
nfcAuthentication(authenticationNfcRequest: AuthenticationNfcRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7261
7541
|
/**
|
|
7262
7542
|
*
|
|
7263
|
-
* @summary
|
|
7264
|
-
* @param {
|
|
7543
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7544
|
+
* @param {AuthenticationPinRequest} authenticationPinRequest The PIN login request with posId
|
|
7265
7545
|
* @param {*} [options] Override http request option.
|
|
7266
7546
|
* @throws {RequiredError}
|
|
7267
7547
|
*/
|
|
7268
|
-
|
|
7548
|
+
pinAuthentication(authenticationPinRequest: AuthenticationPinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7269
7549
|
/**
|
|
7270
7550
|
*
|
|
7271
|
-
* @summary
|
|
7272
|
-
* @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
|
|
7273
7552
|
* @param {*} [options] Override http request option.
|
|
7274
7553
|
* @throws {RequiredError}
|
|
7275
7554
|
*/
|
|
7276
|
-
|
|
7555
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResponse>>;
|
|
7277
7556
|
/**
|
|
7278
7557
|
*
|
|
7279
|
-
* @summary
|
|
7280
|
-
* @param {
|
|
7558
|
+
* @summary Creates a reset token for the local authentication
|
|
7559
|
+
* @param {ResetLocalRequest} resetLocalRequest The reset info.
|
|
7281
7560
|
* @param {*} [options] Override http request option.
|
|
7282
7561
|
* @throws {RequiredError}
|
|
7283
7562
|
*/
|
|
7284
|
-
|
|
7563
|
+
resetLocal(resetLocalRequest: ResetLocalRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7285
7564
|
/**
|
|
7286
7565
|
*
|
|
7287
|
-
* @summary
|
|
7288
|
-
* @param {
|
|
7566
|
+
* @summary Reset local authentication using the provided token
|
|
7567
|
+
* @param {AuthenticationResetTokenRequest} authenticationResetTokenRequest The reset token.
|
|
7289
7568
|
* @param {*} [options] Override http request option.
|
|
7290
7569
|
* @throws {RequiredError}
|
|
7291
7570
|
*/
|
|
7292
|
-
|
|
7571
|
+
resetLocalWithToken(authenticationResetTokenRequest: AuthenticationResetTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7293
7572
|
};
|
|
7294
7573
|
/**
|
|
7295
7574
|
* AuthenticateApi - factory interface
|
|
@@ -7320,6 +7599,14 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7320
7599
|
* @throws {RequiredError}
|
|
7321
7600
|
*/
|
|
7322
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>;
|
|
7323
7610
|
/**
|
|
7324
7611
|
*
|
|
7325
7612
|
* @summary Generate a QR code for authentication
|
|
@@ -7391,67 +7678,59 @@ export declare const AuthenticateApiFactory: (configuration?: Configuration, bas
|
|
|
7391
7678
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7392
7679
|
/**
|
|
7393
7680
|
*
|
|
7394
|
-
* @summary
|
|
7395
|
-
* @param {
|
|
7396
|
-
* @param {*} [options] Override http request option.
|
|
7397
|
-
* @throws {RequiredError}
|
|
7398
|
-
*/
|
|
7399
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7400
|
-
/**
|
|
7401
|
-
*
|
|
7402
|
-
* @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.
|
|
7403
7683
|
* @param {*} [options] Override http request option.
|
|
7404
7684
|
* @throws {RequiredError}
|
|
7405
7685
|
*/
|
|
7406
|
-
|
|
7686
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7407
7687
|
/**
|
|
7408
7688
|
*
|
|
7409
|
-
* @summary
|
|
7410
|
-
* @param {
|
|
7689
|
+
* @summary Mock login and hand out token.
|
|
7690
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7411
7691
|
* @param {*} [options] Override http request option.
|
|
7412
7692
|
* @throws {RequiredError}
|
|
7413
7693
|
*/
|
|
7414
|
-
|
|
7694
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7415
7695
|
/**
|
|
7416
7696
|
*
|
|
7417
|
-
* @summary
|
|
7418
|
-
* @param {
|
|
7697
|
+
* @summary NFC authentication that requires POS user authentication
|
|
7698
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7419
7699
|
* @param {*} [options] Override http request option.
|
|
7420
7700
|
* @throws {RequiredError}
|
|
7421
7701
|
*/
|
|
7422
|
-
|
|
7702
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7423
7703
|
/**
|
|
7424
7704
|
*
|
|
7425
|
-
* @summary
|
|
7426
|
-
* @param {
|
|
7705
|
+
* @summary PIN authentication that requires POS user authentication
|
|
7706
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7427
7707
|
* @param {*} [options] Override http request option.
|
|
7428
7708
|
* @throws {RequiredError}
|
|
7429
7709
|
*/
|
|
7430
|
-
|
|
7710
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7431
7711
|
/**
|
|
7432
7712
|
*
|
|
7433
|
-
* @summary
|
|
7434
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
7713
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7435
7714
|
* @param {*} [options] Override http request option.
|
|
7436
7715
|
* @throws {RequiredError}
|
|
7437
7716
|
*/
|
|
7438
|
-
|
|
7717
|
+
refreshToken(options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResponse>;
|
|
7439
7718
|
/**
|
|
7440
7719
|
*
|
|
7441
|
-
* @summary
|
|
7442
|
-
* @param {
|
|
7720
|
+
* @summary Creates a reset token for the local authentication
|
|
7721
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7443
7722
|
* @param {*} [options] Override http request option.
|
|
7444
7723
|
* @throws {RequiredError}
|
|
7445
7724
|
*/
|
|
7446
|
-
|
|
7725
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7447
7726
|
/**
|
|
7448
7727
|
*
|
|
7449
|
-
* @summary
|
|
7450
|
-
* @param {
|
|
7728
|
+
* @summary Reset local authentication using the provided token
|
|
7729
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7451
7730
|
* @param {*} [options] Override http request option.
|
|
7452
7731
|
* @throws {RequiredError}
|
|
7453
7732
|
*/
|
|
7454
|
-
|
|
7733
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7455
7734
|
};
|
|
7456
7735
|
/**
|
|
7457
7736
|
* Request parameters for authenticatePointOfSale operation in AuthenticateApi.
|
|
@@ -7492,6 +7771,19 @@ export interface AuthenticateApiConfirmQRCodeRequest {
|
|
|
7492
7771
|
*/
|
|
7493
7772
|
readonly sessionId: string;
|
|
7494
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
|
+
}
|
|
7495
7787
|
/**
|
|
7496
7788
|
* Request parameters for getQRStatus operation in AuthenticateApi.
|
|
7497
7789
|
* @export
|
|
@@ -7570,6 +7862,19 @@ export interface AuthenticateApiLocalAuthenticationRequest {
|
|
|
7570
7862
|
*/
|
|
7571
7863
|
readonly authenticationLocalRequest: AuthenticationLocalRequest;
|
|
7572
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
|
+
}
|
|
7573
7878
|
/**
|
|
7574
7879
|
* Request parameters for mockAuthentication operation in AuthenticateApi.
|
|
7575
7880
|
* @export
|
|
@@ -7583,6 +7888,32 @@ export interface AuthenticateApiMockAuthenticationRequest {
|
|
|
7583
7888
|
*/
|
|
7584
7889
|
readonly authenticationMockRequest: AuthenticationMockRequest;
|
|
7585
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
|
+
}
|
|
7586
7917
|
/**
|
|
7587
7918
|
* Request parameters for resetLocal operation in AuthenticateApi.
|
|
7588
7919
|
* @export
|
|
@@ -7609,58 +7940,6 @@ export interface AuthenticateApiResetLocalWithTokenRequest {
|
|
|
7609
7940
|
*/
|
|
7610
7941
|
readonly authenticationResetTokenRequest: AuthenticationResetTokenRequest;
|
|
7611
7942
|
}
|
|
7612
|
-
/**
|
|
7613
|
-
* Request parameters for secureEanAuthentication operation in AuthenticateApi.
|
|
7614
|
-
* @export
|
|
7615
|
-
* @interface AuthenticateApiSecureEanAuthenticationRequest
|
|
7616
|
-
*/
|
|
7617
|
-
export interface AuthenticateApiSecureEanAuthenticationRequest {
|
|
7618
|
-
/**
|
|
7619
|
-
* The EAN login request with posId
|
|
7620
|
-
* @type {AuthenticationSecureEanRequest}
|
|
7621
|
-
* @memberof AuthenticateApiSecureEanAuthentication
|
|
7622
|
-
*/
|
|
7623
|
-
readonly authenticationSecureEanRequest: AuthenticationSecureEanRequest;
|
|
7624
|
-
}
|
|
7625
|
-
/**
|
|
7626
|
-
* Request parameters for secureMemberPINAuthentication operation in AuthenticateApi.
|
|
7627
|
-
* @export
|
|
7628
|
-
* @interface AuthenticateApiSecureMemberPINAuthenticationRequest
|
|
7629
|
-
*/
|
|
7630
|
-
export interface AuthenticateApiSecureMemberPINAuthenticationRequest {
|
|
7631
|
-
/**
|
|
7632
|
-
* The PIN login request with posId
|
|
7633
|
-
* @type {MemberAuthenticationSecurePinRequest}
|
|
7634
|
-
* @memberof AuthenticateApiSecureMemberPINAuthentication
|
|
7635
|
-
*/
|
|
7636
|
-
readonly memberAuthenticationSecurePinRequest: MemberAuthenticationSecurePinRequest;
|
|
7637
|
-
}
|
|
7638
|
-
/**
|
|
7639
|
-
* Request parameters for secureNfcAuthentication operation in AuthenticateApi.
|
|
7640
|
-
* @export
|
|
7641
|
-
* @interface AuthenticateApiSecureNfcAuthenticationRequest
|
|
7642
|
-
*/
|
|
7643
|
-
export interface AuthenticateApiSecureNfcAuthenticationRequest {
|
|
7644
|
-
/**
|
|
7645
|
-
* The NFC login request with posId
|
|
7646
|
-
* @type {AuthenticationSecureNfcRequest}
|
|
7647
|
-
* @memberof AuthenticateApiSecureNfcAuthentication
|
|
7648
|
-
*/
|
|
7649
|
-
readonly authenticationSecureNfcRequest: AuthenticationSecureNfcRequest;
|
|
7650
|
-
}
|
|
7651
|
-
/**
|
|
7652
|
-
* Request parameters for securePINAuthentication operation in AuthenticateApi.
|
|
7653
|
-
* @export
|
|
7654
|
-
* @interface AuthenticateApiSecurePINAuthenticationRequest
|
|
7655
|
-
*/
|
|
7656
|
-
export interface AuthenticateApiSecurePINAuthenticationRequest {
|
|
7657
|
-
/**
|
|
7658
|
-
* The PIN login request with posId
|
|
7659
|
-
* @type {AuthenticationSecurePinRequest}
|
|
7660
|
-
* @memberof AuthenticateApiSecurePINAuthentication
|
|
7661
|
-
*/
|
|
7662
|
-
readonly authenticationSecurePinRequest: AuthenticationSecurePinRequest;
|
|
7663
|
-
}
|
|
7664
7943
|
/**
|
|
7665
7944
|
* AuthenticateApi - object-oriented interface
|
|
7666
7945
|
* @export
|
|
@@ -7695,6 +7974,15 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7695
7974
|
* @memberof AuthenticateApi
|
|
7696
7975
|
*/
|
|
7697
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, {}>>;
|
|
7698
7986
|
/**
|
|
7699
7987
|
*
|
|
7700
7988
|
* @summary Generate a QR code for authentication
|
|
@@ -7775,75 +8063,66 @@ export declare class AuthenticateApi extends BaseAPI {
|
|
|
7775
8063
|
localAuthentication(requestParameters: AuthenticateApiLocalAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7776
8064
|
/**
|
|
7777
8065
|
*
|
|
7778
|
-
* @summary
|
|
7779
|
-
* @param {
|
|
7780
|
-
* @param {*} [options] Override http request option.
|
|
7781
|
-
* @throws {RequiredError}
|
|
7782
|
-
* @memberof AuthenticateApi
|
|
7783
|
-
*/
|
|
7784
|
-
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7785
|
-
/**
|
|
7786
|
-
*
|
|
7787
|
-
* @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.
|
|
7788
8068
|
* @param {*} [options] Override http request option.
|
|
7789
8069
|
* @throws {RequiredError}
|
|
7790
8070
|
* @memberof AuthenticateApi
|
|
7791
8071
|
*/
|
|
7792
|
-
|
|
8072
|
+
memberPINAuthentication(requestParameters: AuthenticateApiMemberPINAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7793
8073
|
/**
|
|
7794
8074
|
*
|
|
7795
|
-
* @summary
|
|
7796
|
-
* @param {
|
|
8075
|
+
* @summary Mock login and hand out token.
|
|
8076
|
+
* @param {AuthenticateApiMockAuthenticationRequest} requestParameters Request parameters.
|
|
7797
8077
|
* @param {*} [options] Override http request option.
|
|
7798
8078
|
* @throws {RequiredError}
|
|
7799
8079
|
* @memberof AuthenticateApi
|
|
7800
8080
|
*/
|
|
7801
|
-
|
|
8081
|
+
mockAuthentication(requestParameters: AuthenticateApiMockAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7802
8082
|
/**
|
|
7803
8083
|
*
|
|
7804
|
-
* @summary
|
|
7805
|
-
* @param {
|
|
8084
|
+
* @summary NFC authentication that requires POS user authentication
|
|
8085
|
+
* @param {AuthenticateApiNfcAuthenticationRequest} requestParameters Request parameters.
|
|
7806
8086
|
* @param {*} [options] Override http request option.
|
|
7807
8087
|
* @throws {RequiredError}
|
|
7808
8088
|
* @memberof AuthenticateApi
|
|
7809
8089
|
*/
|
|
7810
|
-
|
|
8090
|
+
nfcAuthentication(requestParameters: AuthenticateApiNfcAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7811
8091
|
/**
|
|
7812
8092
|
*
|
|
7813
|
-
* @summary
|
|
7814
|
-
* @param {
|
|
8093
|
+
* @summary PIN authentication that requires POS user authentication
|
|
8094
|
+
* @param {AuthenticateApiPinAuthenticationRequest} requestParameters Request parameters.
|
|
7815
8095
|
* @param {*} [options] Override http request option.
|
|
7816
8096
|
* @throws {RequiredError}
|
|
7817
8097
|
* @memberof AuthenticateApi
|
|
7818
8098
|
*/
|
|
7819
|
-
|
|
8099
|
+
pinAuthentication(requestParameters: AuthenticateApiPinAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7820
8100
|
/**
|
|
7821
8101
|
*
|
|
7822
|
-
* @summary
|
|
7823
|
-
* @param {AuthenticateApiSecureMemberPINAuthenticationRequest} requestParameters Request parameters.
|
|
8102
|
+
* @summary Get a new JWT token, maintaining the same access level (posId) as the original token
|
|
7824
8103
|
* @param {*} [options] Override http request option.
|
|
7825
8104
|
* @throws {RequiredError}
|
|
7826
8105
|
* @memberof AuthenticateApi
|
|
7827
8106
|
*/
|
|
7828
|
-
|
|
8107
|
+
refreshToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResponse, any, {}>>;
|
|
7829
8108
|
/**
|
|
7830
8109
|
*
|
|
7831
|
-
* @summary
|
|
7832
|
-
* @param {
|
|
8110
|
+
* @summary Creates a reset token for the local authentication
|
|
8111
|
+
* @param {AuthenticateApiResetLocalRequest} requestParameters Request parameters.
|
|
7833
8112
|
* @param {*} [options] Override http request option.
|
|
7834
8113
|
* @throws {RequiredError}
|
|
7835
8114
|
* @memberof AuthenticateApi
|
|
7836
8115
|
*/
|
|
7837
|
-
|
|
8116
|
+
resetLocal(requestParameters: AuthenticateApiResetLocalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7838
8117
|
/**
|
|
7839
8118
|
*
|
|
7840
|
-
* @summary
|
|
7841
|
-
* @param {
|
|
8119
|
+
* @summary Reset local authentication using the provided token
|
|
8120
|
+
* @param {AuthenticateApiResetLocalWithTokenRequest} requestParameters Request parameters.
|
|
7842
8121
|
* @param {*} [options] Override http request option.
|
|
7843
8122
|
* @throws {RequiredError}
|
|
7844
8123
|
* @memberof AuthenticateApi
|
|
7845
8124
|
*/
|
|
7846
|
-
|
|
8125
|
+
resetLocalWithToken(requestParameters: AuthenticateApiResetLocalWithTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
7847
8126
|
}
|
|
7848
8127
|
/**
|
|
7849
8128
|
* BalanceApi - axios parameter creator
|
|
@@ -11035,7 +11314,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
11035
11314
|
* @param {*} [options] Override http request option.
|
|
11036
11315
|
* @throws {RequiredError}
|
|
11037
11316
|
*/
|
|
11038
|
-
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse
|
|
11317
|
+
getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
|
|
11039
11318
|
/**
|
|
11040
11319
|
*
|
|
11041
11320
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11132,7 +11411,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
11132
11411
|
* @param {*} [options] Override http request option.
|
|
11133
11412
|
* @throws {RequiredError}
|
|
11134
11413
|
*/
|
|
11135
|
-
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse
|
|
11414
|
+
getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
|
|
11136
11415
|
/**
|
|
11137
11416
|
*
|
|
11138
11417
|
* @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
|
|
@@ -11279,227 +11558,713 @@ export interface InvoicesApiGetAllInvoicesRequest {
|
|
|
11279
11558
|
* @type {number}
|
|
11280
11559
|
* @memberof InvoicesApiGetAllInvoices
|
|
11281
11560
|
*/
|
|
11282
|
-
readonly skip?: number;
|
|
11283
|
-
}
|
|
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
|
+
};
|
|
11284
11959
|
/**
|
|
11285
|
-
* Request parameters for
|
|
11960
|
+
* Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
|
|
11286
11961
|
* @export
|
|
11287
|
-
* @interface
|
|
11962
|
+
* @interface PaymentRequestsApiCancelPaymentRequestRequest
|
|
11288
11963
|
*/
|
|
11289
|
-
export interface
|
|
11964
|
+
export interface PaymentRequestsApiCancelPaymentRequestRequest {
|
|
11290
11965
|
/**
|
|
11291
|
-
*
|
|
11292
|
-
* @type {number}
|
|
11293
|
-
* @memberof InvoicesApiGetEligibleTransactions
|
|
11294
|
-
*/
|
|
11295
|
-
readonly forId: number;
|
|
11296
|
-
/**
|
|
11297
|
-
* Start date for selected transactions (inclusive)
|
|
11966
|
+
* UUID v4 of the payment request.
|
|
11298
11967
|
* @type {string}
|
|
11299
|
-
* @memberof
|
|
11968
|
+
* @memberof PaymentRequestsApiCancelPaymentRequest
|
|
11300
11969
|
*/
|
|
11301
|
-
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 {
|
|
11302
11978
|
/**
|
|
11303
|
-
*
|
|
11304
|
-
* @type {
|
|
11305
|
-
* @memberof
|
|
11979
|
+
* The request to create
|
|
11980
|
+
* @type {CreatePaymentRequestRequest}
|
|
11981
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
11306
11982
|
*/
|
|
11307
|
-
readonly
|
|
11983
|
+
readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
|
|
11308
11984
|
}
|
|
11309
11985
|
/**
|
|
11310
|
-
* Request parameters for
|
|
11986
|
+
* Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
|
|
11311
11987
|
* @export
|
|
11312
|
-
* @interface
|
|
11988
|
+
* @interface PaymentRequestsApiGetAllPaymentRequestsRequest
|
|
11313
11989
|
*/
|
|
11314
|
-
export interface
|
|
11990
|
+
export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
|
|
11315
11991
|
/**
|
|
11316
|
-
*
|
|
11992
|
+
* Filter by beneficiary user id.
|
|
11317
11993
|
* @type {number}
|
|
11318
|
-
* @memberof
|
|
11994
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11319
11995
|
*/
|
|
11320
|
-
readonly
|
|
11996
|
+
readonly forId?: number;
|
|
11321
11997
|
/**
|
|
11322
|
-
*
|
|
11323
|
-
* @type {
|
|
11324
|
-
* @memberof
|
|
11998
|
+
* Filter by creator user id.
|
|
11999
|
+
* @type {number}
|
|
12000
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11325
12001
|
*/
|
|
11326
|
-
readonly
|
|
11327
|
-
}
|
|
11328
|
-
/**
|
|
11329
|
-
* Request parameters for getSingleInvoice operation in InvoicesApi.
|
|
11330
|
-
* @export
|
|
11331
|
-
* @interface InvoicesApiGetSingleInvoiceRequest
|
|
11332
|
-
*/
|
|
11333
|
-
export interface InvoicesApiGetSingleInvoiceRequest {
|
|
12002
|
+
readonly createdById?: number;
|
|
11334
12003
|
/**
|
|
11335
|
-
*
|
|
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
|
|
11336
12023
|
* @type {number}
|
|
11337
|
-
* @memberof
|
|
12024
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11338
12025
|
*/
|
|
11339
|
-
readonly
|
|
12026
|
+
readonly take?: number;
|
|
11340
12027
|
/**
|
|
11341
|
-
*
|
|
11342
|
-
* @type {
|
|
11343
|
-
* @memberof
|
|
12028
|
+
* How many rows to skip (for pagination)
|
|
12029
|
+
* @type {number}
|
|
12030
|
+
* @memberof PaymentRequestsApiGetAllPaymentRequests
|
|
11344
12031
|
*/
|
|
11345
|
-
readonly
|
|
12032
|
+
readonly skip?: number;
|
|
11346
12033
|
}
|
|
11347
12034
|
/**
|
|
11348
|
-
* Request parameters for
|
|
12035
|
+
* Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
|
|
11349
12036
|
* @export
|
|
11350
|
-
* @interface
|
|
12037
|
+
* @interface PaymentRequestsApiGetSinglePaymentRequestRequest
|
|
11351
12038
|
*/
|
|
11352
|
-
export interface
|
|
12039
|
+
export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
|
|
11353
12040
|
/**
|
|
11354
|
-
*
|
|
11355
|
-
* @type {
|
|
11356
|
-
* @memberof
|
|
12041
|
+
* UUID v4 of the payment request.
|
|
12042
|
+
* @type {string}
|
|
12043
|
+
* @memberof PaymentRequestsApiGetSinglePaymentRequest
|
|
11357
12044
|
*/
|
|
11358
|
-
readonly id:
|
|
12045
|
+
readonly id: string;
|
|
11359
12046
|
}
|
|
11360
12047
|
/**
|
|
11361
|
-
* Request parameters for
|
|
12048
|
+
* Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
|
|
11362
12049
|
* @export
|
|
11363
|
-
* @interface
|
|
12050
|
+
* @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
|
|
11364
12051
|
*/
|
|
11365
|
-
export interface
|
|
12052
|
+
export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
|
|
11366
12053
|
/**
|
|
11367
|
-
*
|
|
11368
|
-
* @type {
|
|
11369
|
-
* @memberof
|
|
12054
|
+
* UUID v4 of the payment request.
|
|
12055
|
+
* @type {string}
|
|
12056
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11370
12057
|
*/
|
|
11371
|
-
readonly id:
|
|
12058
|
+
readonly id: string;
|
|
11372
12059
|
/**
|
|
11373
|
-
* The
|
|
11374
|
-
* @type {
|
|
11375
|
-
* @memberof
|
|
12060
|
+
* The audit reason
|
|
12061
|
+
* @type {MarkFulfilledExternallyRequest}
|
|
12062
|
+
* @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
|
|
11376
12063
|
*/
|
|
11377
|
-
readonly
|
|
12064
|
+
readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
|
|
11378
12065
|
}
|
|
11379
12066
|
/**
|
|
11380
|
-
* Request parameters for
|
|
12067
|
+
* Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
|
|
11381
12068
|
* @export
|
|
11382
|
-
* @interface
|
|
12069
|
+
* @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
|
|
11383
12070
|
*/
|
|
11384
|
-
export interface
|
|
11385
|
-
/**
|
|
11386
|
-
* The id of the invoice which should be updated
|
|
11387
|
-
* @type {number}
|
|
11388
|
-
* @memberof InvoicesApiUpdateInvoice
|
|
11389
|
-
*/
|
|
11390
|
-
readonly id: number;
|
|
12071
|
+
export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
|
|
11391
12072
|
/**
|
|
11392
|
-
*
|
|
11393
|
-
* @type {
|
|
11394
|
-
* @memberof
|
|
12073
|
+
* UUID v4 of the payment request.
|
|
12074
|
+
* @type {string}
|
|
12075
|
+
* @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
|
|
11395
12076
|
*/
|
|
11396
|
-
readonly
|
|
12077
|
+
readonly id: string;
|
|
11397
12078
|
}
|
|
11398
12079
|
/**
|
|
11399
|
-
*
|
|
12080
|
+
* PaymentRequestsApi - object-oriented interface
|
|
11400
12081
|
* @export
|
|
11401
|
-
* @class
|
|
12082
|
+
* @class PaymentRequestsApi
|
|
11402
12083
|
* @extends {BaseAPI}
|
|
11403
12084
|
*/
|
|
11404
|
-
export declare class
|
|
12085
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
11405
12086
|
/**
|
|
11406
12087
|
*
|
|
11407
|
-
* @summary
|
|
11408
|
-
* @param {
|
|
12088
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
12089
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11409
12090
|
* @param {*} [options] Override http request option.
|
|
11410
12091
|
* @throws {RequiredError}
|
|
11411
|
-
* @memberof
|
|
12092
|
+
* @memberof PaymentRequestsApi
|
|
11412
12093
|
*/
|
|
11413
|
-
|
|
12094
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11414
12095
|
/**
|
|
11415
12096
|
*
|
|
11416
|
-
* @summary
|
|
11417
|
-
* @param {
|
|
12097
|
+
* @summary Create a new PaymentRequest.
|
|
12098
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11418
12099
|
* @param {*} [options] Override http request option.
|
|
11419
12100
|
* @throws {RequiredError}
|
|
11420
|
-
* @memberof
|
|
12101
|
+
* @memberof PaymentRequestsApi
|
|
11421
12102
|
*/
|
|
11422
|
-
|
|
12103
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11423
12104
|
/**
|
|
11424
12105
|
*
|
|
11425
|
-
* @summary
|
|
11426
|
-
* @param {
|
|
12106
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
12107
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11427
12108
|
* @param {*} [options] Override http request option.
|
|
11428
12109
|
* @throws {RequiredError}
|
|
11429
|
-
* @memberof
|
|
12110
|
+
* @memberof PaymentRequestsApi
|
|
11430
12111
|
*/
|
|
11431
|
-
|
|
12112
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
|
|
11432
12113
|
/**
|
|
11433
12114
|
*
|
|
11434
|
-
* @summary
|
|
11435
|
-
* @param {
|
|
12115
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
12116
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11436
12117
|
* @param {*} [options] Override http request option.
|
|
11437
12118
|
* @throws {RequiredError}
|
|
11438
|
-
* @memberof
|
|
12119
|
+
* @memberof PaymentRequestsApi
|
|
11439
12120
|
*/
|
|
11440
|
-
|
|
12121
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11441
12122
|
/**
|
|
11442
12123
|
*
|
|
11443
|
-
* @summary
|
|
11444
|
-
* @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.
|
|
11445
12126
|
* @param {*} [options] Override http request option.
|
|
11446
12127
|
* @throws {RequiredError}
|
|
11447
|
-
* @memberof
|
|
12128
|
+
* @memberof PaymentRequestsApi
|
|
11448
12129
|
*/
|
|
11449
|
-
|
|
12130
|
+
markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
|
|
11450
12131
|
/**
|
|
11451
12132
|
*
|
|
11452
|
-
* @summary
|
|
12133
|
+
* @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
|
|
12134
|
+
* @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
|
|
11453
12135
|
* @param {*} [options] Override http request option.
|
|
11454
12136
|
* @throws {RequiredError}
|
|
11455
|
-
* @memberof
|
|
12137
|
+
* @memberof PaymentRequestsApi
|
|
11456
12138
|
*/
|
|
11457
|
-
|
|
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) => {
|
|
11458
12156
|
/**
|
|
11459
12157
|
*
|
|
11460
|
-
* @summary
|
|
11461
|
-
* @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.
|
|
11462
12160
|
* @param {*} [options] Override http request option.
|
|
11463
12161
|
* @throws {RequiredError}
|
|
11464
|
-
* @memberof InvoicesApi
|
|
11465
12162
|
*/
|
|
11466
|
-
|
|
12163
|
+
getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11467
12164
|
/**
|
|
11468
12165
|
*
|
|
11469
|
-
* @summary
|
|
11470
|
-
* @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.
|
|
11471
12168
|
* @param {*} [options] Override http request option.
|
|
11472
12169
|
* @throws {RequiredError}
|
|
11473
|
-
* @memberof InvoicesApi
|
|
11474
12170
|
*/
|
|
11475
|
-
|
|
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) => {
|
|
11476
12178
|
/**
|
|
11477
12179
|
*
|
|
11478
|
-
* @summary
|
|
11479
|
-
* @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.
|
|
11480
12182
|
* @param {*} [options] Override http request option.
|
|
11481
12183
|
* @throws {RequiredError}
|
|
11482
|
-
* @memberof InvoicesApi
|
|
11483
12184
|
*/
|
|
11484
|
-
|
|
12185
|
+
getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
|
|
11485
12186
|
/**
|
|
11486
12187
|
*
|
|
11487
|
-
* @summary
|
|
11488
|
-
* @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.
|
|
11489
12190
|
* @param {*} [options] Override http request option.
|
|
11490
12191
|
* @throws {RequiredError}
|
|
11491
|
-
* @memberof InvoicesApi
|
|
11492
12192
|
*/
|
|
11493
|
-
|
|
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) => {
|
|
11494
12200
|
/**
|
|
11495
12201
|
*
|
|
11496
|
-
* @summary
|
|
11497
|
-
* @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.
|
|
11498
12204
|
* @param {*} [options] Override http request option.
|
|
11499
12205
|
* @throws {RequiredError}
|
|
11500
|
-
* @memberof InvoicesApi
|
|
11501
12206
|
*/
|
|
11502
|
-
|
|
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, {}>>;
|
|
11503
12268
|
}
|
|
11504
12269
|
/**
|
|
11505
12270
|
* PayoutRequestsApi - axios parameter creator
|
|
@@ -15664,6 +16429,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15664
16429
|
* @throws {RequiredError}
|
|
15665
16430
|
*/
|
|
15666
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>;
|
|
15667
16446
|
/**
|
|
15668
16447
|
*
|
|
15669
16448
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16026,6 +16805,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16026
16805
|
* @throws {RequiredError}
|
|
16027
16806
|
*/
|
|
16028
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>>;
|
|
16029
16822
|
/**
|
|
16030
16823
|
*
|
|
16031
16824
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16370,6 +17163,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16370
17163
|
* @throws {RequiredError}
|
|
16371
17164
|
*/
|
|
16372
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>;
|
|
16373
17174
|
/**
|
|
16374
17175
|
*
|
|
16375
17176
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16861,6 +17662,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16861
17662
|
*/
|
|
16862
17663
|
readonly skip?: number;
|
|
16863
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
|
+
}
|
|
16864
17714
|
/**
|
|
16865
17715
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16866
17716
|
* @export
|
|
@@ -17527,6 +18377,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17527
18377
|
* @memberof UsersApi
|
|
17528
18378
|
*/
|
|
17529
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, {}>>;
|
|
17530
18389
|
/**
|
|
17531
18390
|
*
|
|
17532
18391
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17722,6 +18581,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17722
18581
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17723
18582
|
};
|
|
17724
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];
|
|
17725
18594
|
/**
|
|
17726
18595
|
* @export
|
|
17727
18596
|
*/
|