@gewis/sudosos-client 1.32.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.
- package/dist/api.d.ts +851 -0
- package/dist/api.js +839 -78
- package/package.json +2 -2
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
|
|
@@ -11513,6 +11774,492 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
11513
11774
|
*/
|
|
11514
11775
|
updateInvoice(requestParameters: InvoicesApiUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseInvoiceResponse, any, {}>>;
|
|
11515
11776
|
}
|
|
11777
|
+
/**
|
|
11778
|
+
* PaymentRequestsApi - axios parameter creator
|
|
11779
|
+
* @export
|
|
11780
|
+
*/
|
|
11781
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11782
|
+
/**
|
|
11783
|
+
*
|
|
11784
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11785
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11786
|
+
* @param {*} [options] Override http request option.
|
|
11787
|
+
* @throws {RequiredError}
|
|
11788
|
+
*/
|
|
11789
|
+
cancelPaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11790
|
+
/**
|
|
11791
|
+
*
|
|
11792
|
+
* @summary Create a new PaymentRequest.
|
|
11793
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11794
|
+
* @param {*} [options] Override http request option.
|
|
11795
|
+
* @throws {RequiredError}
|
|
11796
|
+
*/
|
|
11797
|
+
createPaymentRequest: (createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11798
|
+
/**
|
|
11799
|
+
*
|
|
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)
|
|
11808
|
+
* @param {*} [options] Override http request option.
|
|
11809
|
+
* @throws {RequiredError}
|
|
11810
|
+
*/
|
|
11811
|
+
getAllPaymentRequests: (forId?: number, createdById?: number, status?: GetAllPaymentRequestsStatusEnum, fromDate?: string, tillDate?: string, take?: number, skip?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11812
|
+
/**
|
|
11813
|
+
*
|
|
11814
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11815
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11816
|
+
* @param {*} [options] Override http request option.
|
|
11817
|
+
* @throws {RequiredError}
|
|
11818
|
+
*/
|
|
11819
|
+
getSinglePaymentRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11820
|
+
/**
|
|
11821
|
+
*
|
|
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
|
|
11825
|
+
* @param {*} [options] Override http request option.
|
|
11826
|
+
* @throws {RequiredError}
|
|
11827
|
+
*/
|
|
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>;
|
|
11837
|
+
};
|
|
11838
|
+
/**
|
|
11839
|
+
* PaymentRequestsApi - functional programming interface
|
|
11840
|
+
* @export
|
|
11841
|
+
*/
|
|
11842
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
11843
|
+
/**
|
|
11844
|
+
*
|
|
11845
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11846
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11847
|
+
* @param {*} [options] Override http request option.
|
|
11848
|
+
* @throws {RequiredError}
|
|
11849
|
+
*/
|
|
11850
|
+
cancelPaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11851
|
+
/**
|
|
11852
|
+
*
|
|
11853
|
+
* @summary Create a new PaymentRequest.
|
|
11854
|
+
* @param {CreatePaymentRequestRequest} createPaymentRequestRequest The request to create
|
|
11855
|
+
* @param {*} [options] Override http request option.
|
|
11856
|
+
* @throws {RequiredError}
|
|
11857
|
+
*/
|
|
11858
|
+
createPaymentRequest(createPaymentRequestRequest: CreatePaymentRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11859
|
+
/**
|
|
11860
|
+
*
|
|
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)
|
|
11869
|
+
* @param {*} [options] Override http request option.
|
|
11870
|
+
* @throws {RequiredError}
|
|
11871
|
+
*/
|
|
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>>;
|
|
11873
|
+
/**
|
|
11874
|
+
*
|
|
11875
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11876
|
+
* @param {string} id UUID v4 of the payment request.
|
|
11877
|
+
* @param {*} [options] Override http request option.
|
|
11878
|
+
* @throws {RequiredError}
|
|
11879
|
+
*/
|
|
11880
|
+
getSinglePaymentRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BasePaymentRequestResponse>>;
|
|
11881
|
+
/**
|
|
11882
|
+
*
|
|
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
|
|
11886
|
+
* @param {*} [options] Override http request option.
|
|
11887
|
+
* @throws {RequiredError}
|
|
11888
|
+
*/
|
|
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>>;
|
|
11898
|
+
};
|
|
11899
|
+
/**
|
|
11900
|
+
* PaymentRequestsApi - factory interface
|
|
11901
|
+
* @export
|
|
11902
|
+
*/
|
|
11903
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @summary Cancel a PENDING PaymentRequest.
|
|
11907
|
+
* @param {PaymentRequestsApiCancelPaymentRequestRequest} requestParameters Request parameters.
|
|
11908
|
+
* @param {*} [options] Override http request option.
|
|
11909
|
+
* @throws {RequiredError}
|
|
11910
|
+
*/
|
|
11911
|
+
cancelPaymentRequest(requestParameters: PaymentRequestsApiCancelPaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11912
|
+
/**
|
|
11913
|
+
*
|
|
11914
|
+
* @summary Create a new PaymentRequest.
|
|
11915
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
11916
|
+
* @param {*} [options] Override http request option.
|
|
11917
|
+
* @throws {RequiredError}
|
|
11918
|
+
*/
|
|
11919
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11920
|
+
/**
|
|
11921
|
+
*
|
|
11922
|
+
* @summary List PaymentRequests (paginated, with filtering by beneficiary, creator, and status)
|
|
11923
|
+
* @param {PaymentRequestsApiGetAllPaymentRequestsRequest} requestParameters Request parameters.
|
|
11924
|
+
* @param {*} [options] Override http request option.
|
|
11925
|
+
* @throws {RequiredError}
|
|
11926
|
+
*/
|
|
11927
|
+
getAllPaymentRequests(requestParameters?: PaymentRequestsApiGetAllPaymentRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedBasePaymentRequestResponse>;
|
|
11928
|
+
/**
|
|
11929
|
+
*
|
|
11930
|
+
* @summary Fetch a single PaymentRequest by id.
|
|
11931
|
+
* @param {PaymentRequestsApiGetSinglePaymentRequestRequest} requestParameters Request parameters.
|
|
11932
|
+
* @param {*} [options] Override http request option.
|
|
11933
|
+
* @throws {RequiredError}
|
|
11934
|
+
*/
|
|
11935
|
+
getSinglePaymentRequest(requestParameters: PaymentRequestsApiGetSinglePaymentRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<BasePaymentRequestResponse>;
|
|
11936
|
+
/**
|
|
11937
|
+
*
|
|
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.
|
|
11940
|
+
* @param {*} [options] Override http request option.
|
|
11941
|
+
* @throws {RequiredError}
|
|
11942
|
+
*/
|
|
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
|
+
}
|
|
11516
12263
|
/**
|
|
11517
12264
|
* PayoutRequestsApi - axios parameter creator
|
|
11518
12265
|
* @export
|
|
@@ -15676,6 +16423,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15676
16423
|
* @throws {RequiredError}
|
|
15677
16424
|
*/
|
|
15678
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>;
|
|
15679
16440
|
/**
|
|
15680
16441
|
*
|
|
15681
16442
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16038,6 +16799,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
16038
16799
|
* @throws {RequiredError}
|
|
16039
16800
|
*/
|
|
16040
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>>;
|
|
16041
16816
|
/**
|
|
16042
16817
|
*
|
|
16043
16818
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16382,6 +17157,14 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
16382
17157
|
* @throws {RequiredError}
|
|
16383
17158
|
*/
|
|
16384
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>;
|
|
16385
17168
|
/**
|
|
16386
17169
|
*
|
|
16387
17170
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -16873,6 +17656,55 @@ export interface UsersApiGetUsersFinancialMutationsRequest {
|
|
|
16873
17656
|
*/
|
|
16874
17657
|
readonly skip?: number;
|
|
16875
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
|
+
}
|
|
16876
17708
|
/**
|
|
16877
17709
|
* Request parameters for getUsersPointsOfSale operation in UsersApi.
|
|
16878
17710
|
* @export
|
|
@@ -17539,6 +18371,15 @@ export declare class UsersApi extends BaseAPI {
|
|
|
17539
18371
|
* @memberof UsersApi
|
|
17540
18372
|
*/
|
|
17541
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, {}>>;
|
|
17542
18383
|
/**
|
|
17543
18384
|
*
|
|
17544
18385
|
* @summary Returns the user\'s Points of Sale
|
|
@@ -17734,6 +18575,16 @@ export declare const GetAllUsersTypeEnum: {
|
|
|
17734
18575
|
readonly AutomaticInvoice: "AUTOMATIC_INVOICE";
|
|
17735
18576
|
};
|
|
17736
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];
|
|
17737
18588
|
/**
|
|
17738
18589
|
* @export
|
|
17739
18590
|
*/
|