@gewis/sudosos-client 1.31.0 → 1.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/api.d.ts +934 -71
  2. package/dist/api.js +839 -78
  3. package/package.json +3 -3
package/dist/api.d.ts CHANGED
@@ -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
@@ -3106,6 +3260,19 @@ export interface InvoiceUserResponse {
3106
3260
  */
3107
3261
  'automatic': boolean;
3108
3262
  }
3263
+ /**
3264
+ *
3265
+ * @export
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
+ }
3109
3276
  /**
3110
3277
  *
3111
3278
  * @export
@@ -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
@@ -4155,6 +4366,56 @@ export interface ProductResponse {
4155
4366
  */
4156
4367
  'priceList': boolean;
4157
4368
  }
4369
+ /**
4370
+ * Minimal response returned to unauthenticated callers of the public share link endpoint. It deliberately omits `createdBy`, `cancelledBy`, and other internal audit fields — anyone with the link can see it, so we leak as little user info as possible.
4371
+ * @export
4372
+ * @interface PublicPaymentRequestResponse
4373
+ */
4374
+ export interface PublicPaymentRequestResponse {
4375
+ /**
4376
+ * UUID v4 identifier.
4377
+ * @type {string}
4378
+ * @memberof PublicPaymentRequestResponse
4379
+ */
4380
+ 'uuid': string;
4381
+ /**
4382
+ * Recipient display name (e.g. \"John D.\").
4383
+ * @type {string}
4384
+ * @memberof PublicPaymentRequestResponse
4385
+ */
4386
+ 'forDisplayName': string;
4387
+ /**
4388
+ *
4389
+ * @type {DineroObjectResponse}
4390
+ * @memberof PublicPaymentRequestResponse
4391
+ */
4392
+ 'amount': DineroObjectResponse;
4393
+ /**
4394
+ * ISO-8601 timestamp after which payments stop being accepted.
4395
+ * @type {string}
4396
+ * @memberof PublicPaymentRequestResponse
4397
+ */
4398
+ 'expiresAt': string;
4399
+ /**
4400
+ * Optional human-readable description.
4401
+ * @type {string}
4402
+ * @memberof PublicPaymentRequestResponse
4403
+ */
4404
+ 'description'?: string;
4405
+ /**
4406
+ * Derived lifecycle status.
4407
+ * @type {string}
4408
+ * @memberof PublicPaymentRequestResponse
4409
+ */
4410
+ 'status': PublicPaymentRequestResponseStatusEnum;
4411
+ }
4412
+ export declare const PublicPaymentRequestResponseStatusEnum: {
4413
+ readonly Pending: "PENDING";
4414
+ readonly Paid: "PAID";
4415
+ readonly Expired: "EXPIRED";
4416
+ readonly Cancelled: "CANCELLED";
4417
+ };
4418
+ export type PublicPaymentRequestResponseStatusEnum = typeof PublicPaymentRequestResponseStatusEnum[keyof typeof PublicPaymentRequestResponseStatusEnum];
4158
4419
  /**
4159
4420
  *
4160
4421
  * @export
@@ -6109,6 +6370,12 @@ export interface UpdateUserRequest {
6109
6370
  * @memberof UpdateUserRequest
6110
6371
  */
6111
6372
  'inactiveNotificationSend'?: boolean;
6373
+ /**
6374
+ * ISO date at which the account expires; pass null to clear
6375
+ * @type {string}
6376
+ * @memberof UpdateUserRequest
6377
+ */
6378
+ 'expiryDate'?: string | null;
6112
6379
  }
6113
6380
  /**
6114
6381
  * API Request for updating an existing `vat group` entity. Only mutable fields; the rate itself cannot change on an existing group.
@@ -6325,6 +6592,12 @@ export interface UserResponse {
6325
6592
  * @memberof UserResponse
6326
6593
  */
6327
6594
  'pos'?: BasePointOfSaleInfoResponse;
6595
+ /**
6596
+ * ISO date at which the account expires (null for accounts without expiry)
6597
+ * @type {string}
6598
+ * @memberof UserResponse
6599
+ */
6600
+ 'expiryDate'?: string | null;
6328
6601
  }
6329
6602
  /**
6330
6603
  *
@@ -11035,7 +11308,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
11035
11308
  * @param {*} [options] Override http request option.
11036
11309
  * @throws {RequiredError}
11037
11310
  */
11038
- getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionResponse>>;
11311
+ getEligibleTransactions(forId: number, fromDate: string, tillDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TransactionResponse>>>;
11039
11312
  /**
11040
11313
  *
11041
11314
  * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
@@ -11132,7 +11405,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
11132
11405
  * @param {*} [options] Override http request option.
11133
11406
  * @throws {RequiredError}
11134
11407
  */
11135
- getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionResponse>;
11408
+ getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<TransactionResponse>>;
11136
11409
  /**
11137
11410
  *
11138
11411
  * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
@@ -11446,7 +11719,7 @@ export declare class InvoicesApi extends BaseAPI {
11446
11719
  * @throws {RequiredError}
11447
11720
  * @memberof InvoicesApi
11448
11721
  */
11449
- getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse, any, {}>>;
11722
+ getEligibleTransactions(requestParameters: InvoicesApiGetEligibleTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionResponse[], any, {}>>;
11450
11723
  /**
11451
11724
  *
11452
11725
  * @summary Returns all invoices with transfer amount drift: for active invoices transfer != row sum; for deleted invoices transfer != credit transfer.
@@ -11502,159 +11775,645 @@ export declare class InvoicesApi extends BaseAPI {
11502
11775
  updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
11503
11776
  }
11504
11777
  /**
11505
- * PayoutRequestsApi - axios parameter creator
11778
+ * PaymentRequestsApi - axios parameter creator
11506
11779
  * @export
11507
11780
  */
11508
- export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
11781
+ export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
11509
11782
  /**
11510
11783
  *
11511
- * @summary Create a new payout request
11512
- * @param {PayoutRequestRequest} payoutRequestRequest New payout request
11784
+ * @summary Cancel a PENDING PaymentRequest.
11785
+ * @param {string} id UUID v4 of the payment request.
11513
11786
  * @param {*} [options] Override http request option.
11514
11787
  * @throws {RequiredError}
11515
11788
  */
11516
- createPayoutRequest: (payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11789
+ cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11517
11790
  /**
11518
11791
  *
11519
- * @summary Returns all payout requests given the filter parameters
11520
- * @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
11521
- * @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
11522
- * @param {string} [fromDate] Start date for selected transactions (inclusive)
11523
- * @param {string} [tillDate] End date for selected transactions (exclusive)
11524
- * @param {string} [status] Status of the payout requests (OR relation)
11525
- * @param {number} [take] How many payout requests the endpoint should return
11526
- * @param {number} [skip] How many payout requests should be skipped (for pagination)
11792
+ * @summary Create a new PaymentRequest.
11793
+ * @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
11527
11794
  * @param {*} [options] Override http request option.
11528
11795
  * @throws {RequiredError}
11529
11796
  */
11530
- getAllPayoutRequests: (requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11797
+ createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11531
11798
  /**
11532
11799
  *
11533
- * @summary Get a payout request pdf
11534
- * @param {number} id The ID of the payout request object that should be returned
11535
- * @param {boolean} [force] Whether to force regeneration of the pdf
11800
+ * @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
11801
+ * @param {number} [forId] Filter by beneficiary user id.
11802
+ * @param {number} [createdById] Filter by creator user id.
11803
+ * @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
11804
+ * @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
11805
+ * @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
11806
+ * @param {number} [take] How many rows the endpoint should return
11807
+ * @param {number} [skip] How many rows to skip (for pagination)
11536
11808
  * @param {*} [options] Override http request option.
11537
11809
  * @throws {RequiredError}
11538
11810
  */
11539
- getPayoutRequestPdf: (id: number, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11811
+ getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11540
11812
  /**
11541
11813
  *
11542
- * @summary Get a single payout request
11543
- * @param {number} id The ID of the payout request object that should be returned
11814
+ * @summary Fetch a single PaymentRequest by id.
11815
+ * @param {string} id UUID v4 of the payment request.
11544
11816
  * @param {*} [options] Override http request option.
11545
11817
  * @throws {RequiredError}
11546
11818
  */
11547
- getSinglePayoutRequest: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11819
+ getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11548
11820
  /**
11549
11821
  *
11550
- * @summary Create a new status for a payout request
11551
- * @param {number} id The ID of the payout request object that should be returned
11552
- * @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
11822
+ * @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
11823
+ * @param {string} id UUID v4 of the payment request.
11824
+ * @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
11553
11825
  * @param {*} [options] Override http request option.
11554
11826
  * @throws {RequiredError}
11555
11827
  */
11556
- setPayoutRequestStatus: (id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11828
+ markPaymentRequestFulfilledExternally: (id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11829
+ /**
11830
+ *
11831
+ * @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
11832
+ * @param {string} id UUID v4 of the payment request.
11833
+ * @param {*} [options] Override http request option.
11834
+ * @throws {RequiredError}
11835
+ */
11836
+ startPaymentRequestAuthenticated: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11557
11837
  };
11558
11838
  /**
11559
- * PayoutRequestsApi - functional programming interface
11839
+ * PaymentRequestsApi - functional programming interface
11560
11840
  * @export
11561
11841
  */
11562
- export declare const PayoutRequestsApiFp: (configuration?: Configuration) => {
11842
+ export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
11563
11843
  /**
11564
11844
  *
11565
- * @summary Create a new payout request
11566
- * @param {PayoutRequestRequest} payoutRequestRequest New payout request
11845
+ * @summary Cancel a PENDING PaymentRequest.
11846
+ * @param {string} id UUID v4 of the payment request.
11567
11847
  * @param {*} [options] Override http request option.
11568
11848
  * @throws {RequiredError}
11569
11849
  */
11570
- createPayoutRequest(payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
11850
+ cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
11571
11851
  /**
11572
11852
  *
11573
- * @summary Returns all payout requests given the filter parameters
11574
- * @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
11575
- * @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
11576
- * @param {string} [fromDate] Start date for selected transactions (inclusive)
11577
- * @param {string} [tillDate] End date for selected transactions (exclusive)
11578
- * @param {string} [status] Status of the payout requests (OR relation)
11579
- * @param {number} [take] How many payout requests the endpoint should return
11580
- * @param {number} [skip] How many payout requests should be skipped (for pagination)
11853
+ * @summary Create a new PaymentRequest.
11854
+ * @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
11581
11855
  * @param {*} [options] Override http request option.
11582
11856
  * @throws {RequiredError}
11583
11857
  */
11584
- getAllPayoutRequests(requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePayoutRequestResponse>>;
11858
+ createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
11585
11859
  /**
11586
11860
  *
11587
- * @summary Get a payout request pdf
11588
- * @param {number} id The ID of the payout request object that should be returned
11589
- * @param {boolean} [force] Whether to force regeneration of the pdf
11861
+ * @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
11862
+ * @param {number} [forId] Filter by beneficiary user id.
11863
+ * @param {number} [createdById] Filter by creator user id.
11864
+ * @param {GetAllPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
11865
+ * @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
11866
+ * @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
11867
+ * @param {number} [take] How many rows the endpoint should return
11868
+ * @param {number} [skip] How many rows to skip (for pagination)
11590
11869
  * @param {*} [options] Override http request option.
11591
11870
  * @throws {RequiredError}
11592
11871
  */
11593
- getPayoutRequestPdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
11872
+ getAllPaymentRequests(forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
11594
11873
  /**
11595
11874
  *
11596
- * @summary Get a single payout request
11597
- * @param {number} id The ID of the payout request object that should be returned
11875
+ * @summary Fetch a single PaymentRequest by id.
11876
+ * @param {string} id UUID v4 of the payment request.
11598
11877
  * @param {*} [options] Override http request option.
11599
11878
  * @throws {RequiredError}
11600
11879
  */
11601
- getSinglePayoutRequest(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
11880
+ getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
11602
11881
  /**
11603
11882
  *
11604
- * @summary Create a new status for a payout request
11605
- * @param {number} id The ID of the payout request object that should be returned
11606
- * @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
11883
+ * @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
11884
+ * @param {string} id UUID v4 of the payment request.
11885
+ * @param {MarkFulfilledExternallyRequest} markFulfilledExternallyRequest The audit reason
11607
11886
  * @param {*} [options] Override http request option.
11608
11887
  * @throws {RequiredError}
11609
11888
  */
11610
- setPayoutRequestStatus(id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
11889
+ markPaymentRequestFulfilledExternally(id: string, markFulfilledExternallyRequest: MarkFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
11890
+ /**
11891
+ *
11892
+ * @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
11893
+ * @param {string} id UUID v4 of the payment request.
11894
+ * @param {*} [options] Override http request option.
11895
+ * @throws {RequiredError}
11896
+ */
11897
+ startPaymentRequestAuthenticated(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
11611
11898
  };
11612
11899
  /**
11613
- * PayoutRequestsApi - factory interface
11900
+ * PaymentRequestsApi - factory interface
11614
11901
  * @export
11615
11902
  */
11616
- export declare const PayoutRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11903
+ export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11617
11904
  /**
11618
11905
  *
11619
- * @summary Create a new payout request
11620
- * @param {PayoutRequestsApiCreatePayoutRequestRequest} requestParameters Request parameters.
11906
+ * @summary Cancel a PENDING PaymentRequest.
11907
+ * @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
11621
11908
  * @param {*} [options] Override http request option.
11622
11909
  * @throws {RequiredError}
11623
11910
  */
11624
- createPayoutRequest(requestParameters: PayoutRequestsApiCreatePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
11911
+ cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
11625
11912
  /**
11626
11913
  *
11627
- * @summary Returns all payout requests given the filter parameters
11628
- * @param {PayoutRequestsApiGetAllPayoutRequestsRequest} requestParameters Request parameters.
11914
+ * @summary Create a new PaymentRequest.
11915
+ * @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
11629
11916
  * @param {*} [options] Override http request option.
11630
11917
  * @throws {RequiredError}
11631
11918
  */
11632
- getAllPayoutRequests(requestParameters?: PayoutRequestsApiGetAllPayoutRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePayoutRequestResponse>;
11919
+ createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
11633
11920
  /**
11634
11921
  *
11635
- * @summary Get a payout request pdf
11636
- * @param {PayoutRequestsApiGetPayoutRequestPdfRequest} requestParameters Request parameters.
11922
+ * @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
11923
+ * @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
11637
11924
  * @param {*} [options] Override http request option.
11638
11925
  * @throws {RequiredError}
11639
11926
  */
11640
- getPayoutRequestPdf(requestParameters: PayoutRequestsApiGetPayoutRequestPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
11927
+ getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
11641
11928
  /**
11642
11929
  *
11643
- * @summary Get a single payout request
11644
- * @param {PayoutRequestsApiGetSinglePayoutRequestRequest} requestParameters Request parameters.
11930
+ * @summary Fetch a single PaymentRequest by id.
11931
+ * @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
11645
11932
  * @param {*} [options] Override http request option.
11646
11933
  * @throws {RequiredError}
11647
11934
  */
11648
- getSinglePayoutRequest(requestParameters: PayoutRequestsApiGetSinglePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
11935
+ getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
11649
11936
  /**
11650
11937
  *
11651
- * @summary Create a new status for a payout request
11652
- * @param {PayoutRequestsApiSetPayoutRequestStatusRequest} requestParameters Request parameters.
11938
+ * @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
11939
+ * @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
11653
11940
  * @param {*} [options] Override http request option.
11654
11941
  * @throws {RequiredError}
11655
11942
  */
11656
- setPayoutRequestStatus(requestParameters: PayoutRequestsApiSetPayoutRequestStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
11657
- };
11943
+ markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
11944
+ /**
11945
+ *
11946
+ * @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
11947
+ * @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
11948
+ * @param {*} [options] Override http request option.
11949
+ * @throws {RequiredError}
11950
+ */
11951
+ startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
11952
+ };
11953
+ /**
11954
+ * Request parameters for cancelPaymentRequest operation in PaymentRequestsApi.
11955
+ * @export
11956
+ * @interface PaymentRequestsApiCancelPaymentRequestRequest
11957
+ */
11958
+ export interface PaymentRequestsApiCancelPaymentRequestRequest {
11959
+ /**
11960
+ * UUID v4 of the payment request.
11961
+ * @type {string}
11962
+ * @memberof PaymentRequestsApiCancelPaymentRequest
11963
+ */
11964
+ readonly id: string;
11965
+ }
11966
+ /**
11967
+ * Request parameters for createPaymentRequest operation in PaymentRequestsApi.
11968
+ * @export
11969
+ * @interface PaymentRequestsApiCreatePaymentRequestRequest
11970
+ */
11971
+ export interface PaymentRequestsApiCreatePaymentRequestRequest {
11972
+ /**
11973
+ * The request to create
11974
+ * @type {CreatePaymentRequestRequest}
11975
+ * @memberof PaymentRequestsApiCreatePaymentRequest
11976
+ */
11977
+ readonly createPaymentRequestRequest: CreatePaymentRequestRequest;
11978
+ }
11979
+ /**
11980
+ * Request parameters for getAllPaymentRequests operation in PaymentRequestsApi.
11981
+ * @export
11982
+ * @interface PaymentRequestsApiGetAllPaymentRequestsRequest
11983
+ */
11984
+ export interface PaymentRequestsApiGetAllPaymentRequestsRequest {
11985
+ /**
11986
+ * Filter by beneficiary user id.
11987
+ * @type {number}
11988
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
11989
+ */
11990
+ readonly forId?: number;
11991
+ /**
11992
+ * Filter by creator user id.
11993
+ * @type {number}
11994
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
11995
+ */
11996
+ readonly createdById?: number;
11997
+ /**
11998
+ * Comma-separated list of derived statuses.
11999
+ * @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
12000
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
12001
+ */
12002
+ readonly status?: GetAllPaymentRequestsStatusEnum;
12003
+ /**
12004
+ * Filter requests created on or after this ISO date (inclusive).
12005
+ * @type {string}
12006
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
12007
+ */
12008
+ readonly fromDate?: string;
12009
+ /**
12010
+ * Filter requests created strictly before this ISO date (exclusive).
12011
+ * @type {string}
12012
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
12013
+ */
12014
+ readonly tillDate?: string;
12015
+ /**
12016
+ * How many rows the endpoint should return
12017
+ * @type {number}
12018
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
12019
+ */
12020
+ readonly take?: number;
12021
+ /**
12022
+ * How many rows to skip (for pagination)
12023
+ * @type {number}
12024
+ * @memberof PaymentRequestsApiGetAllPaymentRequests
12025
+ */
12026
+ readonly skip?: number;
12027
+ }
12028
+ /**
12029
+ * Request parameters for getSinglePaymentRequest operation in PaymentRequestsApi.
12030
+ * @export
12031
+ * @interface PaymentRequestsApiGetSinglePaymentRequestRequest
12032
+ */
12033
+ export interface PaymentRequestsApiGetSinglePaymentRequestRequest {
12034
+ /**
12035
+ * UUID v4 of the payment request.
12036
+ * @type {string}
12037
+ * @memberof PaymentRequestsApiGetSinglePaymentRequest
12038
+ */
12039
+ readonly id: string;
12040
+ }
12041
+ /**
12042
+ * Request parameters for markPaymentRequestFulfilledExternally operation in PaymentRequestsApi.
12043
+ * @export
12044
+ * @interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest
12045
+ */
12046
+ export interface PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest {
12047
+ /**
12048
+ * UUID v4 of the payment request.
12049
+ * @type {string}
12050
+ * @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
12051
+ */
12052
+ readonly id: string;
12053
+ /**
12054
+ * The audit reason
12055
+ * @type {MarkFulfilledExternallyRequest}
12056
+ * @memberof PaymentRequestsApiMarkPaymentRequestFulfilledExternally
12057
+ */
12058
+ readonly markFulfilledExternallyRequest: MarkFulfilledExternallyRequest;
12059
+ }
12060
+ /**
12061
+ * Request parameters for startPaymentRequestAuthenticated operation in PaymentRequestsApi.
12062
+ * @export
12063
+ * @interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest
12064
+ */
12065
+ export interface PaymentRequestsApiStartPaymentRequestAuthenticatedRequest {
12066
+ /**
12067
+ * UUID v4 of the payment request.
12068
+ * @type {string}
12069
+ * @memberof PaymentRequestsApiStartPaymentRequestAuthenticated
12070
+ */
12071
+ readonly id: string;
12072
+ }
12073
+ /**
12074
+ * PaymentRequestsApi - object-oriented interface
12075
+ * @export
12076
+ * @class PaymentRequestsApi
12077
+ * @extends {BaseAPI}
12078
+ */
12079
+ export declare class PaymentRequestsApi extends BaseAPI {
12080
+ /**
12081
+ *
12082
+ * @summary Cancel a PENDING PaymentRequest.
12083
+ * @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
12084
+ * @param {*} [options] Override http request option.
12085
+ * @throws {RequiredError}
12086
+ * @memberof PaymentRequestsApi
12087
+ */
12088
+ cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
12089
+ /**
12090
+ *
12091
+ * @summary Create a new PaymentRequest.
12092
+ * @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
12093
+ * @param {*} [options] Override http request option.
12094
+ * @throws {RequiredError}
12095
+ * @memberof PaymentRequestsApi
12096
+ */
12097
+ createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
12098
+ /**
12099
+ *
12100
+ * @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
12101
+ * @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
12102
+ * @param {*} [options] Override http request option.
12103
+ * @throws {RequiredError}
12104
+ * @memberof PaymentRequestsApi
12105
+ */
12106
+ getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
12107
+ /**
12108
+ *
12109
+ * @summary Fetch a single PaymentRequest by id.
12110
+ * @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
12111
+ * @param {*} [options] Override http request option.
12112
+ * @throws {RequiredError}
12113
+ * @memberof PaymentRequestsApi
12114
+ */
12115
+ getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
12116
+ /**
12117
+ *
12118
+ * @summary Admin escape hatch: mark a PaymentRequest paid out-of-band (e.g. bank transfer). Creates a void->user credit Transfer manually.
12119
+ * @param {PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest} requestParameters Request parameters.
12120
+ * @param {*} [options] Override http request option.
12121
+ * @throws {RequiredError}
12122
+ * @memberof PaymentRequestsApi
12123
+ */
12124
+ markPaymentRequestFulfilledExternally(requestParameters: PaymentRequestsApiMarkPaymentRequestFulfilledExternallyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BasePaymentRequestResponse, any, {}>>;
12125
+ /**
12126
+ *
12127
+ * @summary Start a Stripe payment session for the given PaymentRequest while authenticated.
12128
+ * @param {PaymentRequestsApiStartPaymentRequestAuthenticatedRequest} requestParameters Request parameters.
12129
+ * @param {*} [options] Override http request option.
12130
+ * @throws {RequiredError}
12131
+ * @memberof PaymentRequestsApi
12132
+ */
12133
+ startPaymentRequestAuthenticated(requestParameters: PaymentRequestsApiStartPaymentRequestAuthenticatedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
12134
+ }
12135
+ /**
12136
+ * @export
12137
+ */
12138
+ export declare const GetAllPaymentRequestsStatusEnum: {
12139
+ readonly Pending: "PENDING";
12140
+ readonly Paid: "PAID";
12141
+ readonly Expired: "EXPIRED";
12142
+ readonly Cancelled: "CANCELLED";
12143
+ };
12144
+ export type GetAllPaymentRequestsStatusEnum = typeof GetAllPaymentRequestsStatusEnum[keyof typeof GetAllPaymentRequestsStatusEnum];
12145
+ /**
12146
+ * PaymentRequestsPublicApi - axios parameter creator
12147
+ * @export
12148
+ */
12149
+ export declare const PaymentRequestsPublicApiAxiosParamCreator: (configuration?: Configuration) => {
12150
+ /**
12151
+ *
12152
+ * @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
12153
+ * @param {string} id UUID v4 of the payment request.
12154
+ * @param {*} [options] Override http request option.
12155
+ * @throws {RequiredError}
12156
+ */
12157
+ getPublicPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12158
+ /**
12159
+ *
12160
+ * @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
12161
+ * @param {string} id UUID v4 of the payment request.
12162
+ * @param {*} [options] Override http request option.
12163
+ * @throws {RequiredError}
12164
+ */
12165
+ startPaymentRequestPublic: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12166
+ };
12167
+ /**
12168
+ * PaymentRequestsPublicApi - functional programming interface
12169
+ * @export
12170
+ */
12171
+ export declare const PaymentRequestsPublicApiFp: (configuration?: Configuration) => {
12172
+ /**
12173
+ *
12174
+ * @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
12175
+ * @param {string} id UUID v4 of the payment request.
12176
+ * @param {*} [options] Override http request option.
12177
+ * @throws {RequiredError}
12178
+ */
12179
+ getPublicPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicPaymentRequestResponse>>;
12180
+ /**
12181
+ *
12182
+ * @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
12183
+ * @param {string} id UUID v4 of the payment request.
12184
+ * @param {*} [options] Override http request option.
12185
+ * @throws {RequiredError}
12186
+ */
12187
+ startPaymentRequestPublic(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentRequestStartResponse>>;
12188
+ };
12189
+ /**
12190
+ * PaymentRequestsPublicApi - factory interface
12191
+ * @export
12192
+ */
12193
+ export declare const PaymentRequestsPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12194
+ /**
12195
+ *
12196
+ * @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
12197
+ * @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
12198
+ * @param {*} [options] Override http request option.
12199
+ * @throws {RequiredError}
12200
+ */
12201
+ getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicPaymentRequestResponse>;
12202
+ /**
12203
+ *
12204
+ * @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
12205
+ * @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
12206
+ * @param {*} [options] Override http request option.
12207
+ * @throws {RequiredError}
12208
+ */
12209
+ startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaymentRequestStartResponse>;
12210
+ };
12211
+ /**
12212
+ * Request parameters for getPublicPaymentRequest operation in PaymentRequestsPublicApi.
12213
+ * @export
12214
+ * @interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest
12215
+ */
12216
+ export interface PaymentRequestsPublicApiGetPublicPaymentRequestRequest {
12217
+ /**
12218
+ * UUID v4 of the payment request.
12219
+ * @type {string}
12220
+ * @memberof PaymentRequestsPublicApiGetPublicPaymentRequest
12221
+ */
12222
+ readonly id: string;
12223
+ }
12224
+ /**
12225
+ * Request parameters for startPaymentRequestPublic operation in PaymentRequestsPublicApi.
12226
+ * @export
12227
+ * @interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest
12228
+ */
12229
+ export interface PaymentRequestsPublicApiStartPaymentRequestPublicRequest {
12230
+ /**
12231
+ * UUID v4 of the payment request.
12232
+ * @type {string}
12233
+ * @memberof PaymentRequestsPublicApiStartPaymentRequestPublic
12234
+ */
12235
+ readonly id: string;
12236
+ }
12237
+ /**
12238
+ * PaymentRequestsPublicApi - object-oriented interface
12239
+ * @export
12240
+ * @class PaymentRequestsPublicApi
12241
+ * @extends {BaseAPI}
12242
+ */
12243
+ export declare class PaymentRequestsPublicApi extends BaseAPI {
12244
+ /**
12245
+ *
12246
+ * @summary Fetch a PaymentRequest via the public share link. Returns a trimmed response that omits internal audit fields.
12247
+ * @param {PaymentRequestsPublicApiGetPublicPaymentRequestRequest} requestParameters Request parameters.
12248
+ * @param {*} [options] Override http request option.
12249
+ * @throws {RequiredError}
12250
+ * @memberof PaymentRequestsPublicApi
12251
+ */
12252
+ getPublicPaymentRequest(requestParameters: PaymentRequestsPublicApiGetPublicPaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicPaymentRequestResponse, any, {}>>;
12253
+ /**
12254
+ *
12255
+ * @summary Start a Stripe payment session for the given PaymentRequest without authentication — the share link IS the credential.
12256
+ * @param {PaymentRequestsPublicApiStartPaymentRequestPublicRequest} requestParameters Request parameters.
12257
+ * @param {*} [options] Override http request option.
12258
+ * @throws {RequiredError}
12259
+ * @memberof PaymentRequestsPublicApi
12260
+ */
12261
+ startPaymentRequestPublic(requestParameters: PaymentRequestsPublicApiStartPaymentRequestPublicRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentRequestStartResponse, any, {}>>;
12262
+ }
12263
+ /**
12264
+ * PayoutRequestsApi - axios parameter creator
12265
+ * @export
12266
+ */
12267
+ export declare const PayoutRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
12268
+ /**
12269
+ *
12270
+ * @summary Create a new payout request
12271
+ * @param {PayoutRequestRequest} payoutRequestRequest New payout request
12272
+ * @param {*} [options] Override http request option.
12273
+ * @throws {RequiredError}
12274
+ */
12275
+ createPayoutRequest: (payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12276
+ /**
12277
+ *
12278
+ * @summary Returns all payout requests given the filter parameters
12279
+ * @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
12280
+ * @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
12281
+ * @param {string} [fromDate] Start date for selected transactions (inclusive)
12282
+ * @param {string} [tillDate] End date for selected transactions (exclusive)
12283
+ * @param {string} [status] Status of the payout requests (OR relation)
12284
+ * @param {number} [take] How many payout requests the endpoint should return
12285
+ * @param {number} [skip] How many payout requests should be skipped (for pagination)
12286
+ * @param {*} [options] Override http request option.
12287
+ * @throws {RequiredError}
12288
+ */
12289
+ getAllPayoutRequests: (requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12290
+ /**
12291
+ *
12292
+ * @summary Get a payout request pdf
12293
+ * @param {number} id The ID of the payout request object that should be returned
12294
+ * @param {boolean} [force] Whether to force regeneration of the pdf
12295
+ * @param {*} [options] Override http request option.
12296
+ * @throws {RequiredError}
12297
+ */
12298
+ getPayoutRequestPdf: (id: number, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12299
+ /**
12300
+ *
12301
+ * @summary Get a single payout request
12302
+ * @param {number} id The ID of the payout request object that should be returned
12303
+ * @param {*} [options] Override http request option.
12304
+ * @throws {RequiredError}
12305
+ */
12306
+ getSinglePayoutRequest: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12307
+ /**
12308
+ *
12309
+ * @summary Create a new status for a payout request
12310
+ * @param {number} id The ID of the payout request object that should be returned
12311
+ * @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
12312
+ * @param {*} [options] Override http request option.
12313
+ * @throws {RequiredError}
12314
+ */
12315
+ setPayoutRequestStatus: (id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12316
+ };
12317
+ /**
12318
+ * PayoutRequestsApi - functional programming interface
12319
+ * @export
12320
+ */
12321
+ export declare const PayoutRequestsApiFp: (configuration?: Configuration) => {
12322
+ /**
12323
+ *
12324
+ * @summary Create a new payout request
12325
+ * @param {PayoutRequestRequest} payoutRequestRequest New payout request
12326
+ * @param {*} [options] Override http request option.
12327
+ * @throws {RequiredError}
12328
+ */
12329
+ createPayoutRequest(payoutRequestRequest: PayoutRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
12330
+ /**
12331
+ *
12332
+ * @summary Returns all payout requests given the filter parameters
12333
+ * @param {GetAllPayoutRequestsRequestedByIdParameter} [requestedById] ID of user(s) who requested a payout
12334
+ * @param {GetAllPayoutRequestsRequestedByIdParameter} [approvedById] ID of user(s) who approved a payout
12335
+ * @param {string} [fromDate] Start date for selected transactions (inclusive)
12336
+ * @param {string} [tillDate] End date for selected transactions (exclusive)
12337
+ * @param {string} [status] Status of the payout requests (OR relation)
12338
+ * @param {number} [take] How many payout requests the endpoint should return
12339
+ * @param {number} [skip] How many payout requests should be skipped (for pagination)
12340
+ * @param {*} [options] Override http request option.
12341
+ * @throws {RequiredError}
12342
+ */
12343
+ getAllPayoutRequests(requestedById?: GetAllPayoutRequestsRequestedByIdParameter, approvedById?: GetAllPayoutRequestsRequestedByIdParameter, fromDate?: string, tillDate?: string, status?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePayoutRequestResponse>>;
12344
+ /**
12345
+ *
12346
+ * @summary Get a payout request pdf
12347
+ * @param {number} id The ID of the payout request object that should be returned
12348
+ * @param {boolean} [force] Whether to force regeneration of the pdf
12349
+ * @param {*} [options] Override http request option.
12350
+ * @throws {RequiredError}
12351
+ */
12352
+ getPayoutRequestPdf(id: number, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfUrlResponse>>;
12353
+ /**
12354
+ *
12355
+ * @summary Get a single payout request
12356
+ * @param {number} id The ID of the payout request object that should be returned
12357
+ * @param {*} [options] Override http request option.
12358
+ * @throws {RequiredError}
12359
+ */
12360
+ getSinglePayoutRequest(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
12361
+ /**
12362
+ *
12363
+ * @summary Create a new status for a payout request
12364
+ * @param {number} id The ID of the payout request object that should be returned
12365
+ * @param {PayoutRequestStatusRequest} payoutRequestStatusRequest New state of payout request
12366
+ * @param {*} [options] Override http request option.
12367
+ * @throws {RequiredError}
12368
+ */
12369
+ setPayoutRequestStatus(id: number, payoutRequestStatusRequest: PayoutRequestStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutRequestResponse>>;
12370
+ };
12371
+ /**
12372
+ * PayoutRequestsApi - factory interface
12373
+ * @export
12374
+ */
12375
+ export declare const PayoutRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
12376
+ /**
12377
+ *
12378
+ * @summary Create a new payout request
12379
+ * @param {PayoutRequestsApiCreatePayoutRequestRequest} requestParameters Request parameters.
12380
+ * @param {*} [options] Override http request option.
12381
+ * @throws {RequiredError}
12382
+ */
12383
+ createPayoutRequest(requestParameters: PayoutRequestsApiCreatePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
12384
+ /**
12385
+ *
12386
+ * @summary Returns all payout requests given the filter parameters
12387
+ * @param {PayoutRequestsApiGetAllPayoutRequestsRequest} requestParameters Request parameters.
12388
+ * @param {*} [options] Override http request option.
12389
+ * @throws {RequiredError}
12390
+ */
12391
+ getAllPayoutRequests(requestParameters?: PayoutRequestsApiGetAllPayoutRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePayoutRequestResponse>;
12392
+ /**
12393
+ *
12394
+ * @summary Get a payout request pdf
12395
+ * @param {PayoutRequestsApiGetPayoutRequestPdfRequest} requestParameters Request parameters.
12396
+ * @param {*} [options] Override http request option.
12397
+ * @throws {RequiredError}
12398
+ */
12399
+ getPayoutRequestPdf(requestParameters: PayoutRequestsApiGetPayoutRequestPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfUrlResponse>;
12400
+ /**
12401
+ *
12402
+ * @summary Get a single payout request
12403
+ * @param {PayoutRequestsApiGetSinglePayoutRequestRequest} requestParameters Request parameters.
12404
+ * @param {*} [options] Override http request option.
12405
+ * @throws {RequiredError}
12406
+ */
12407
+ getSinglePayoutRequest(requestParameters: PayoutRequestsApiGetSinglePayoutRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
12408
+ /**
12409
+ *
12410
+ * @summary Create a new status for a payout request
12411
+ * @param {PayoutRequestsApiSetPayoutRequestStatusRequest} requestParameters Request parameters.
12412
+ * @param {*} [options] Override http request option.
12413
+ * @throws {RequiredError}
12414
+ */
12415
+ setPayoutRequestStatus(requestParameters: PayoutRequestsApiSetPayoutRequestStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<PayoutRequestResponse>;
12416
+ };
11658
12417
  /**
11659
12418
  * Request parameters for createPayoutRequest operation in PayoutRequestsApi.
11660
12419
  * @export
@@ -15664,6 +16423,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
15664
16423
  * @throws {RequiredError}
15665
16424
  */
15666
16425
  getUsersFinancialMutations: (id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16426
+ /**
16427
+ *
16428
+ * @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
16429
+ * @param {number} id The id of the beneficiary user.
16430
+ * @param {number} [createdById] Filter by creator user id.
16431
+ * @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
16432
+ * @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
16433
+ * @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
16434
+ * @param {number} [take] How many rows the endpoint should return
16435
+ * @param {number} [skip] How many rows to skip (for pagination)
16436
+ * @param {*} [options] Override http request option.
16437
+ * @throws {RequiredError}
16438
+ */
16439
+ getUsersPaymentRequests: (id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15667
16440
  /**
15668
16441
  *
15669
16442
  * @summary Returns the user\'s Points of Sale
@@ -16026,6 +16799,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
16026
16799
  * @throws {RequiredError}
16027
16800
  */
16028
16801
  getUsersFinancialMutations(id: number, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedFinancialMutationResponse>>;
16802
+ /**
16803
+ *
16804
+ * @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
16805
+ * @param {number} id The id of the beneficiary user.
16806
+ * @param {number} [createdById] Filter by creator user id.
16807
+ * @param {GetUsersPaymentRequestsStatusEnum} [status] Comma-separated list of derived statuses.
16808
+ * @param {string} [fromDate] Filter requests created on or after this ISO date (inclusive).
16809
+ * @param {string} [tillDate] Filter requests created strictly before this ISO date (exclusive).
16810
+ * @param {number} [take] How many rows the endpoint should return
16811
+ * @param {number} [skip] How many rows to skip (for pagination)
16812
+ * @param {*} [options] Override http request option.
16813
+ * @throws {RequiredError}
16814
+ */
16815
+ getUsersPaymentRequests(id: number, createdById?: number, status?: GetUsersPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedBasePaymentRequestResponse>>;
16029
16816
  /**
16030
16817
  *
16031
16818
  * @summary Returns the user\'s Points of Sale
@@ -16370,6 +17157,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
16370
17157
  * @throws {RequiredError}
16371
17158
  */
16372
17159
  getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedFinancialMutationResponse>;
17160
+ /**
17161
+ *
17162
+ * @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
17163
+ * @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
17164
+ * @param {*} [options] Override http request option.
17165
+ * @throws {RequiredError}
17166
+ */
17167
+ getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
16373
17168
  /**
16374
17169
  *
16375
17170
  * @summary Returns the user\'s Points of Sale
@@ -16861,6 +17656,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
16861
17656
  */
16862
17657
  readonly skip?: number;
16863
17658
  }
17659
+ /**
17660
+ * Request parameters for getUsersPaymentRequests operation in UsersApi.
17661
+ * @export
17662
+ * @interface UsersApiGetUsersPaymentRequestsRequest
17663
+ */
17664
+ export interface UsersApiGetUsersPaymentRequestsRequest {
17665
+ /**
17666
+ * The id of the beneficiary user.
17667
+ * @type {number}
17668
+ * @memberof UsersApiGetUsersPaymentRequests
17669
+ */
17670
+ readonly id: number;
17671
+ /**
17672
+ * Filter by creator user id.
17673
+ * @type {number}
17674
+ * @memberof UsersApiGetUsersPaymentRequests
17675
+ */
17676
+ readonly createdById?: number;
17677
+ /**
17678
+ * Comma-separated list of derived statuses.
17679
+ * @type {'PENDING' | 'PAID' | 'EXPIRED' | 'CANCELLED'}
17680
+ * @memberof UsersApiGetUsersPaymentRequests
17681
+ */
17682
+ readonly status?: GetUsersPaymentRequestsStatusEnum;
17683
+ /**
17684
+ * Filter requests created on or after this ISO date (inclusive).
17685
+ * @type {string}
17686
+ * @memberof UsersApiGetUsersPaymentRequests
17687
+ */
17688
+ readonly fromDate?: string;
17689
+ /**
17690
+ * Filter requests created strictly before this ISO date (exclusive).
17691
+ * @type {string}
17692
+ * @memberof UsersApiGetUsersPaymentRequests
17693
+ */
17694
+ readonly tillDate?: string;
17695
+ /**
17696
+ * How many rows the endpoint should return
17697
+ * @type {number}
17698
+ * @memberof UsersApiGetUsersPaymentRequests
17699
+ */
17700
+ readonly take?: number;
17701
+ /**
17702
+ * How many rows to skip (for pagination)
17703
+ * @type {number}
17704
+ * @memberof UsersApiGetUsersPaymentRequests
17705
+ */
17706
+ readonly skip?: number;
17707
+ }
16864
17708
  /**
16865
17709
  * Request parameters for getUsersPointsOfSale operation in UsersApi.
16866
17710
  * @export
@@ -17527,6 +18371,15 @@ export declare class UsersApi extends BaseAPI {
17527
18371
  * @memberof UsersApi
17528
18372
  */
17529
18373
  getUsersFinancialMutations(requestParameters: UsersApiGetUsersFinancialMutationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedFinancialMutationResponse, any, {}>>;
18374
+ /**
18375
+ *
18376
+ * @summary Get the PaymentRequests where the given user is the beneficiary. Regular users can hit this for their own id; admins can hit it for any user.
18377
+ * @param {UsersApiGetUsersPaymentRequestsRequest} requestParameters Request parameters.
18378
+ * @param {*} [options] Override http request option.
18379
+ * @throws {RequiredError}
18380
+ * @memberof UsersApi
18381
+ */
18382
+ getUsersPaymentRequests(requestParameters: UsersApiGetUsersPaymentRequestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedBasePaymentRequestResponse, any, {}>>;
17530
18383
  /**
17531
18384
  *
17532
18385
  * @summary Returns the user\'s Points of Sale
@@ -17722,6 +18575,16 @@ export declare const GetAllUsersTypeEnum: {
17722
18575
  readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
17723
18576
  };
17724
18577
  export type GetAllUsersTypeEnum = typeof GetAllUsersTypeEnum[keyof typeof GetAllUsersTypeEnum];
18578
+ /**
18579
+ * @export
18580
+ */
18581
+ export declare const GetUsersPaymentRequestsStatusEnum: {
18582
+ readonly Pending: "PENDING";
18583
+ readonly Paid: "PAID";
18584
+ readonly Expired: "EXPIRED";
18585
+ readonly Cancelled: "CANCELLED";
18586
+ };
18587
+ export type GetUsersPaymentRequestsStatusEnum = typeof GetUsersPaymentRequestsStatusEnum[keyof typeof GetUsersPaymentRequestsStatusEnum];
17725
18588
  /**
17726
18589
  * @export
17727
18590
  */