@faiber/faiber-payment 0.24.1 → 1.0.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/README.md +23 -4
- package/dist/.tsbuildinfo +1 -1
- package/dist/contracts.types.d.ts +9 -8
- package/dist/contracts.types.d.ts.map +1 -1
- package/dist/index.d.ts +46 -15
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +36 -4
- package/dist/index.js.map +1 -1
- package/dist/operations.d.ts +153 -137
- package/dist/operations.d.ts.map +1 -1
- package/dist/operations.js +125 -105
- package/dist/operations.js.map +1 -1
- package/dist/operations.types.d.ts +45 -402
- package/dist/operations.types.d.ts.map +1 -1
- package/dist/types.d.ts +207 -35
- package/dist/types.d.ts.map +1 -1
- package/package.json +4 -3
- package/provenance.json +27 -0
package/dist/operations.d.ts
CHANGED
|
@@ -1,304 +1,320 @@
|
|
|
1
|
-
import { ServiceApi, type
|
|
1
|
+
import { ServiceApi, type RequestOptions } from "@faiber/sdk-core";
|
|
2
2
|
import type * as T from "./operations.types.js";
|
|
3
3
|
export declare class PaymentOperations extends ServiceApi {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Read process version with required status/message/data at HTTP 200. Does not probe database, broker or provider readiness.
|
|
6
|
+
* Calls `GET /` through the shared IDP-aware Faiber client.
|
|
7
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
8
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
9
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
10
|
+
*/
|
|
11
|
+
routerRootStatusGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentHealthResponse, unknown, {}, any>>;
|
|
12
|
+
/**
|
|
13
|
+
* Read raw Utoipa OpenAPI JSON at HTTP 200, without envelope. Annotations omit mounted routes and do not establish complete endpoint coverage.
|
|
6
14
|
* Calls `GET /api/openapi.json` through the shared IDP-aware Faiber client.
|
|
7
15
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
8
|
-
* @returns The complete Axios response, including the typed
|
|
9
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
16
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
17
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
10
18
|
*/
|
|
11
|
-
routerOpenapiJsonGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
19
|
+
routerOpenapiJsonGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("@faiber/sdk-core").ServiceOpenApiDocument, unknown, {}, any>>;
|
|
12
20
|
/**
|
|
13
|
-
*
|
|
21
|
+
* Read ingress-derived user UUID, roles and permissions at HTTP 200. Requires a non-nil authenticated user; missing identity returns 401.
|
|
14
22
|
* Calls `GET /api/v1/auth/self` through the shared IDP-aware Faiber client.
|
|
15
23
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
16
|
-
* @returns The complete Axios response, including the typed
|
|
17
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
24
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
25
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; authenticated session; no additional permission (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
18
26
|
*/
|
|
19
|
-
sessionGetSelfGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
27
|
+
sessionGetSelfGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentSessionResponse, unknown, {}, any>>;
|
|
20
28
|
/**
|
|
21
|
-
*
|
|
29
|
+
* List gateways ordered by ascending priority. Exact active/inactive status filter; invalid status is ignored. Bracket pagination defaults 1/20, page floors at 1 and size clamps 1..100. Returns a nested page at HTTP 200.
|
|
22
30
|
* Calls `GET /api/v1/gateways` through the shared IDP-aware Faiber client.
|
|
23
31
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
24
32
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
25
|
-
* @returns The complete Axios response, including the typed
|
|
26
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:read.
|
|
33
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
34
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
27
35
|
*/
|
|
28
|
-
gatewayIndexGet(params?: T.GatewayIndexGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
36
|
+
gatewayIndexGet(params?: T.GatewayIndexGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").GatewayListResponse, unknown, {}, any>>;
|
|
29
37
|
/**
|
|
30
|
-
*
|
|
38
|
+
* Create gateway at HTTP 200. provider must be zarinpal/parsian/aqayepardakht/mock (422 otherwise); priority is i16, default 0. Absent/null/invalid status becomes inactive. Options are encrypted; explicit sandbox is stored in options. Non-Zarinpal sandbox response is null.
|
|
31
39
|
* Calls `POST /api/v1/gateways` through the shared IDP-aware Faiber client.
|
|
32
40
|
* @param data Typed JSON request body.
|
|
33
41
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
34
|
-
* @returns The complete Axios response, including the typed
|
|
35
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:create.
|
|
42
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
43
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:create (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
36
44
|
*/
|
|
37
|
-
gatewayStorePost(data: T.GatewayStorePostInput, options?: RequestOptions<T.GatewayStorePostInput>): Promise<import("axios").AxiosResponse<
|
|
45
|
+
gatewayStorePost(data: T.GatewayStorePostInput, options?: RequestOptions<T.GatewayStorePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").GatewayResponse, import("./types.js").CreateGatewayInput, {}, any>>;
|
|
38
46
|
/**
|
|
39
|
-
*
|
|
47
|
+
* Hard-delete integer gateway ID and return the removed gateway record at HTTP 200; missing ID returns 404. This is a record envelope, not a boolean or empty response.
|
|
40
48
|
* Calls `DELETE /api/v1/gateways/{id}` through the shared IDP-aware Faiber client.
|
|
41
49
|
* @param id Backend path identifier `id`.
|
|
42
50
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
43
|
-
* @returns The complete Axios response, including the typed
|
|
44
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:delete.
|
|
51
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
52
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:delete (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
45
53
|
*/
|
|
46
|
-
gatewayDestroyDelete(id:
|
|
54
|
+
gatewayDestroyDelete(id: number, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").GatewayResponse, unknown, {}, any>>;
|
|
47
55
|
/**
|
|
48
|
-
*
|
|
56
|
+
* Read integer gateway ID; missing ID returns 404. Response options may contain encrypted values; do not copy them into credential editing fields.
|
|
49
57
|
* Calls `GET /api/v1/gateways/{id}` through the shared IDP-aware Faiber client.
|
|
50
58
|
* @param id Backend path identifier `id`.
|
|
51
59
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
52
|
-
* @returns The complete Axios response, including the typed
|
|
53
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:read.
|
|
60
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
61
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
54
62
|
*/
|
|
55
|
-
gatewayShowGet(id:
|
|
63
|
+
gatewayShowGet(id: number, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").GatewayResponse, unknown, {}, any>>;
|
|
56
64
|
/**
|
|
57
|
-
*
|
|
65
|
+
* Update integer gateway ID at HTTP 200; missing ID returns 404, invalid provider returns 422. Absent/null fields preserve existing values, invalid status is ignored; options replace supplied map and sandbox merges into it.
|
|
58
66
|
* Calls `PATCH /api/v1/gateways/{id}` through the shared IDP-aware Faiber client.
|
|
59
67
|
* @param id Backend path identifier `id`.
|
|
60
68
|
* @param data Typed JSON request body.
|
|
61
69
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
62
|
-
* @returns The complete Axios response, including the typed
|
|
63
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:update.
|
|
70
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
71
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:update (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
64
72
|
*/
|
|
65
|
-
gatewayUpdatePatch(id:
|
|
73
|
+
gatewayUpdatePatch(id: number, data: T.GatewayUpdatePatchInput, options?: RequestOptions<T.GatewayUpdatePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").GatewayResponse, import("./types.js").UpdateGatewayInput, {}, any>>;
|
|
66
74
|
/**
|
|
67
|
-
*
|
|
75
|
+
* Read provider/status label-value arrays at HTTP 200; no pagination.
|
|
68
76
|
* Calls `GET /api/v1/gateways/options` through the shared IDP-aware Faiber client.
|
|
69
77
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
70
|
-
* @returns The complete Axios response, including the typed
|
|
71
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:read.
|
|
78
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
79
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
72
80
|
*/
|
|
73
|
-
gatewayOptionsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
81
|
+
gatewayOptionsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").GatewayOptionsResponse, unknown, {}, any>>;
|
|
74
82
|
/**
|
|
75
|
-
*
|
|
83
|
+
* Inspect active production gateway credentials at HTTP 200 without creating a purchase. May call Zarinpal credential verification; configured differs from providerVerified and non-Zarinpal providers require manual verification. Database/provider-client setup failure returns 500.
|
|
76
84
|
* Calls `POST /api/v1/gateways/setup-check` through the shared IDP-aware Faiber client.
|
|
77
85
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
78
|
-
* @returns The complete Axios response, including the typed
|
|
79
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:read.
|
|
86
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
87
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
80
88
|
*/
|
|
81
|
-
gatewaySetupCheckPost(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").PaymentSetupResponse, unknown, {}>>;
|
|
89
|
+
gatewaySetupCheckPost(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").PaymentSetupResponse, unknown, {}, any>>;
|
|
82
90
|
/**
|
|
83
|
-
*
|
|
91
|
+
* Read HTTP integration queue/base URL hints, event fields and SDK code snippets. Absent optional direct metadata members are omitted (never null). HTTP 200 does not verify broker/provider connectivity.
|
|
84
92
|
* Calls `GET /api/v1/integration/docs` through the shared IDP-aware Faiber client.
|
|
85
93
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
86
|
-
* @returns The complete Axios response, including the typed
|
|
87
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:integration:read.
|
|
94
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
95
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Declared IDP permission admin:integration:read; no native auth/permission gate in this handler. Production ingress enforcement must be verified.
|
|
88
96
|
*/
|
|
89
|
-
integrationIntegrationDocsShowGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
97
|
+
integrationIntegrationDocsShowGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentIntegrationDocsResponse, unknown, {}, any>>;
|
|
90
98
|
/**
|
|
91
|
-
*
|
|
99
|
+
* Read concrete flow integration queue and event payload field metadata at HTTP 200; no broker readiness probe.
|
|
92
100
|
* Calls `GET /api/v1/integration/flow` through the shared IDP-aware Faiber client.
|
|
93
101
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
94
|
-
* @returns The complete Axios response, including the typed
|
|
95
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
102
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
103
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
96
104
|
*/
|
|
97
|
-
integrationFlowIntegrationShowGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
105
|
+
integrationFlowIntegrationShowGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentFlowIntegrationResponse, unknown, {}, any>>;
|
|
98
106
|
/**
|
|
99
|
-
*
|
|
107
|
+
* Read available/sandbox booleans for configured 2Done callback routing at HTTP 200. Availability is routing availability, not successful settlement or live-provider proof.
|
|
100
108
|
* Calls `GET /api/v1/internal/2done/availability` through the shared IDP-aware Faiber client.
|
|
101
109
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
102
|
-
* @returns The complete Axios response, including the typed
|
|
103
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server
|
|
110
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
111
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer token matching PRODUCT_PAYMENT_SERVICE_TOKEN (minimum configured length 32); 401 mismatch, 503 missing configuration.
|
|
104
112
|
*/
|
|
105
|
-
productPlansAvailabilityGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ProductPaymentAvailabilityResponse, unknown, {}>>;
|
|
113
|
+
productPlansAvailabilityGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ProductPaymentAvailabilityResponse, unknown, {}, any>>;
|
|
106
114
|
/**
|
|
107
|
-
*
|
|
115
|
+
* Create trusted 2Done subscription link at HTTP 200. service_name=2done, service_model=2done_subscription, UUID service_id, idempotency_key=2done:{order}, configured origin callback /app/plans?order={order}; amount 10..20000000 divisible by 10. Invalid order returns 422; mismatched contract returns 403; idempotency conflict returns 409.
|
|
108
116
|
* Calls `POST /api/v1/internal/2done/payment` through the shared IDP-aware Faiber client.
|
|
109
117
|
* @param data Typed JSON request body.
|
|
110
118
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
111
|
-
* @returns The complete Axios response, including the typed
|
|
112
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
119
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
120
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer PRODUCT_PAYMENT_SERVICE_TOKEN; 401 mismatch, 503 missing configuration.
|
|
113
121
|
*/
|
|
114
|
-
productPlansCreatePost(data: T.ProductPlansCreatePostInput, options?: RequestOptions<T.ProductPlansCreatePostInput>): Promise<import("axios").AxiosResponse<
|
|
122
|
+
productPlansCreatePost(data: T.ProductPlansCreatePostInput, options?: RequestOptions<T.ProductPlansCreatePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CreatePaymentResponse, import("./types.js").CreatePaymentInput, {}, any>>;
|
|
115
123
|
/**
|
|
116
|
-
*
|
|
124
|
+
* Read transaction receipt by UUID at HTTP 200; requires stored 2done/2done_subscription ownership. Missing transaction returns 404, different product returns 403. Retains nullable database fields; receipt alone does not verify current provider settlement.
|
|
117
125
|
* Calls `GET /api/v1/internal/2done/transactions/{id}` through the shared IDP-aware Faiber client.
|
|
118
126
|
* @param id Backend path identifier `id`.
|
|
119
127
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
120
|
-
* @returns The complete Axios response, including the typed
|
|
121
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server
|
|
128
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
129
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer PRODUCT_PAYMENT_SERVICE_TOKEN; 401 mismatch, 503 missing configuration.
|
|
122
130
|
*/
|
|
123
|
-
productPlansReceiptGet(id:
|
|
131
|
+
productPlansReceiptGet(id: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ProductPaymentReceiptResponse, unknown, {}, any>>;
|
|
124
132
|
/**
|
|
125
|
-
*
|
|
133
|
+
* Read raw IRR purchase receipt by purchase UUID (not transaction UUID), using asset:purchase:{id}. Requires asset and topup/subscription/plan/points_pack; wrong ownership/model or nonlive provider returns 409, missing receipt 404, unavailable verification 503. May call provider.verify; status is pending/accepted/rejected and providerVerified is false while pending.
|
|
126
134
|
* Calls `GET /api/v1/internal/asset/purchases/{id}` through the shared IDP-aware Faiber client.
|
|
127
135
|
* @param id Backend path identifier `id`.
|
|
128
136
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
129
|
-
* @returns The complete Axios response, including the typed
|
|
130
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-
|
|
137
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
138
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server x-asset-payment-token matching ASSET_PAYMENT_TOKEN; 401 mismatch, 503 missing configuration.
|
|
131
139
|
*/
|
|
132
|
-
assetCheckoutReceiptGet(id:
|
|
140
|
+
assetCheckoutReceiptGet(id: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").VerifiedAssetPurchaseReceipt, unknown, {}, any>>;
|
|
133
141
|
/**
|
|
134
|
-
*
|
|
142
|
+
* Create trusted fitness link at HTTP 200 with positive amount, UUID service_id, configured project service_name, service_model=fitness_order and idempotency_key=fitness:{order}. Advisory lock serializes order creation; gateway must meet live or project-scoped sandbox opt-in policy. Invalid order/amount returns 422; contract mismatch 403; unsuitable provider 503.
|
|
135
143
|
* Calls `POST /api/v1/internal/fitness/payment` through the shared IDP-aware Faiber client.
|
|
136
144
|
* @param data Typed JSON request body.
|
|
137
145
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
138
|
-
* @returns The complete Axios response, including the typed
|
|
139
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
146
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
147
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer FITNESS_PROFILE_SERVICE_TOKEN; 401 mismatch, 503 missing configuration.
|
|
140
148
|
*/
|
|
141
|
-
fitnessCreatePost(data: T.FitnessCreatePostInput, options?: RequestOptions<T.FitnessCreatePostInput>): Promise<import("axios").AxiosResponse<
|
|
149
|
+
fitnessCreatePost(data: T.FitnessCreatePostInput, options?: RequestOptions<T.FitnessCreatePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CreatePaymentResponse, import("./types.js").CreatePaymentInput, {}, any>>;
|
|
142
150
|
/**
|
|
143
|
-
*
|
|
151
|
+
* Read configured fitness project receipt by transaction UUID at HTTP 200. Missing transaction returns 404, wrong project/model 403; gateway must satisfy live or explicit sandbox policy (503 otherwise). Nullable transaction fields remain present.
|
|
144
152
|
* Calls `GET /api/v1/internal/fitness/transactions/{id}` through the shared IDP-aware Faiber client.
|
|
145
153
|
* @param id Backend path identifier `id`.
|
|
146
154
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
147
|
-
* @returns The complete Axios response, including the typed
|
|
148
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server
|
|
155
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
156
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer FITNESS_PROFILE_SERVICE_TOKEN; 401 mismatch, 503 missing configuration.
|
|
149
157
|
*/
|
|
150
|
-
fitnessReceiptGet(id:
|
|
158
|
+
fitnessReceiptGet(id: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ProductPaymentReceiptResponse, unknown, {}, any>>;
|
|
151
159
|
/**
|
|
152
|
-
*
|
|
160
|
+
* Retry a stored rejected fitness transaction UUID using its persisted amount and metadata; idempotency_key=fitness-retry:{id}. Other state/project/model returns 409; missing transaction 404. Returns link at HTTP 200; no body is read.
|
|
153
161
|
* Calls `POST /api/v1/internal/fitness/transactions/{id}/retry` through the shared IDP-aware Faiber client.
|
|
154
162
|
* @param id Backend path identifier `id`.
|
|
155
163
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
156
|
-
* @returns The complete Axios response, including the typed
|
|
157
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
164
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
165
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer FITNESS_PROFILE_SERVICE_TOKEN; 401 mismatch, 503 missing configuration.
|
|
158
166
|
*/
|
|
159
|
-
fitnessRetryPost(id:
|
|
167
|
+
fitnessRetryPost(id: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CreatePaymentResponse, unknown, {}, any>>;
|
|
160
168
|
/**
|
|
161
|
-
*
|
|
169
|
+
* Create trusted storefront link at HTTP 200: non-nil UUID service_id, configured site service_name, service_model=storefront_order, queue_name=modules_queue, idempotency_key=shop:{id}, callback exactly SHOP_RETURN_URL?checkout={id} with HTTPS return URL. Invalid UUID/amount returns 422, mismatch 403; requires live Zarinpal proof cached within 20 minutes (503 otherwise).
|
|
162
170
|
* Calls `POST /api/v1/internal/shop/payment` through the shared IDP-aware Faiber client.
|
|
163
171
|
* @param data Typed JSON request body.
|
|
164
172
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
165
|
-
* @returns The complete Axios response, including the typed
|
|
166
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
173
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
174
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer SHOP_PAYMENT_TOKEN and configured SHOP_SITE_SLUG; 401 mismatch, 503 missing configuration.
|
|
167
175
|
*/
|
|
168
|
-
shopCheckoutCreatePost(data: T.ShopCheckoutCreatePostInput, options?: RequestOptions<T.ShopCheckoutCreatePostInput>): Promise<import("axios").AxiosResponse<
|
|
176
|
+
shopCheckoutCreatePost(data: T.ShopCheckoutCreatePostInput, options?: RequestOptions<T.ShopCheckoutCreatePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CreatePaymentResponse, import("./types.js").CreatePaymentInput, {}, any>>;
|
|
169
177
|
/**
|
|
170
|
-
*
|
|
178
|
+
* Read raw configured boolean at HTTP 200. May call credential verification and cache live Zarinpal proof in database; this GET is not a pure liveness check. Missing setup or gateway can fail with 503/404.
|
|
171
179
|
* Calls `GET /api/v1/internal/shop/readiness` through the shared IDP-aware Faiber client.
|
|
172
180
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
173
|
-
* @returns The complete Axios response, including the typed
|
|
174
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server
|
|
181
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
182
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer SHOP_PAYMENT_TOKEN and configured SHOP_SITE_SLUG; 401 mismatch, 503 missing configuration.
|
|
175
183
|
*/
|
|
176
|
-
shopCheckoutReadinessGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ShopPaymentReadiness, unknown, {}>>;
|
|
184
|
+
shopCheckoutReadinessGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ShopPaymentReadiness, unknown, {}, any>>;
|
|
177
185
|
/**
|
|
178
|
-
*
|
|
186
|
+
* Read site-owned storefront transaction UUID receipt at HTTP 200. Missing/wrong-site row returns 404; proof/gateway mismatch returns 409. May perform pending provider verification and persist settlement. providerVerified:true describes the proof path and is also returned for pending receipts; inspect status.
|
|
179
187
|
* Calls `GET /api/v1/internal/shop/transactions/{id}` through the shared IDP-aware Faiber client.
|
|
180
188
|
* @param id Backend path identifier `id`.
|
|
181
189
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
182
|
-
* @returns The complete Axios response, including the typed
|
|
183
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server
|
|
190
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
191
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Trusted server Bearer SHOP_PAYMENT_TOKEN and configured SHOP_SITE_SLUG; 401 mismatch, 503 missing configuration.
|
|
184
192
|
*/
|
|
185
|
-
shopCheckoutReceiptGet(id:
|
|
193
|
+
shopCheckoutReceiptGet(id: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./contracts.types.js").ShopPaymentReceiptResponse, unknown, {}, any>>;
|
|
186
194
|
/**
|
|
187
|
-
*
|
|
195
|
+
* Create generic positive integer payment link at HTTP 200. Body idempotency_key reuses matching amount/service/model/id and returns 409 on mismatch. Dedicated 2Done/fitness/storefront reservations are rejected with 403. Asset protected requests require x-asset-payment-token when configured. Missing active gateway returns 404, invalid amount 422, provider pay failure 502. Backend declares no currency field; callers must follow their service currency contract.
|
|
188
196
|
* Calls `POST /api/v1/payment` through the shared IDP-aware Faiber client.
|
|
189
197
|
* @param data Typed JSON request body.
|
|
190
198
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
191
|
-
* @returns The complete Axios response, including the typed
|
|
192
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
199
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
200
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified; conditional Asset trusted header enforcement.
|
|
193
201
|
*/
|
|
194
|
-
paymentCreatePaymentPost(data: T.PaymentCreatePaymentPostInput, options?: RequestOptions<T.PaymentCreatePaymentPostInput>): Promise<import("axios").AxiosResponse<
|
|
202
|
+
paymentCreatePaymentPost(data: T.PaymentCreatePaymentPostInput, options?: RequestOptions<T.PaymentCreatePaymentPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CreatePaymentResponse, import("./types.js").CreatePaymentInput, {}, any>>;
|
|
195
203
|
/**
|
|
196
|
-
*
|
|
204
|
+
* Read configured safe fallback URL or https://faiber.ir default at HTTP 200.
|
|
197
205
|
* Calls `GET /api/v1/settings` through the shared IDP-aware Faiber client.
|
|
198
206
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
199
|
-
* @returns The complete Axios response, including the typed
|
|
200
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:read.
|
|
207
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
208
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
201
209
|
*/
|
|
202
|
-
settingsShowGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
210
|
+
settingsShowGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentSettingsResponse, unknown, {}, any>>;
|
|
203
211
|
/**
|
|
204
|
-
*
|
|
212
|
+
* Save safe fallback URL at HTTP 200. Trim and normalize absolute HTTP/HTTPS URL, require host and reject embedded credentials; invalid URL returns 422.
|
|
205
213
|
* Calls `PATCH /api/v1/settings` through the shared IDP-aware Faiber client.
|
|
206
214
|
* @param data Typed JSON request body.
|
|
207
215
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
208
|
-
* @returns The complete Axios response, including the typed
|
|
209
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:gateway:update.
|
|
216
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
217
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:gateway:update (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
210
218
|
*/
|
|
211
|
-
settingsUpdatePatch(data: T.SettingsUpdatePatchInput, options?: RequestOptions<T.SettingsUpdatePatchInput>): Promise<import("axios").AxiosResponse<
|
|
219
|
+
settingsUpdatePatch(data: T.SettingsUpdatePatchInput, options?: RequestOptions<T.SettingsUpdatePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").PaymentSettingsResponse, import("./types.js").UpdatePaymentSettingsInput, {}, any>>;
|
|
212
220
|
/**
|
|
213
|
-
*
|
|
221
|
+
* List newest-first transactions with gateway summaries, nested page, filtered monetary status/service-model totals, all service names and gateway options. Exact status/service/gateway filters; tracking/card substring filters; UTC YYYY-MM-DD dates inclusive (invalid dates/status ignored). Bracket page defaults 1/20 and size clamps 1..100. Summary fields are sums, not counts.
|
|
214
222
|
* Calls `GET /api/v1/transactions` through the shared IDP-aware Faiber client.
|
|
215
223
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
216
224
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
217
|
-
* @returns The complete Axios response, including the typed
|
|
218
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:transaction:read.
|
|
225
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
226
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:transaction:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
219
227
|
*/
|
|
220
|
-
transactionIndexGet(params?: T.TransactionIndexGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
228
|
+
transactionIndexGet(params?: T.TransactionIndexGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").TransactionListResponse, unknown, {}, any>>;
|
|
221
229
|
/**
|
|
222
|
-
*
|
|
230
|
+
* Read status only by transaction UUID at HTTP 200 (null stored status becomes pending); no transaction detail record is returned. Missing transaction returns 404.
|
|
223
231
|
* Calls `GET /api/v1/transactions/{uuid}` through the shared IDP-aware Faiber client.
|
|
224
232
|
* @param uuid Backend path identifier `uuid`.
|
|
225
233
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
226
|
-
* @returns The complete Axios response, including the typed
|
|
227
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
234
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
235
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
228
236
|
*/
|
|
229
|
-
routerShowStatusGet(uuid:
|
|
237
|
+
routerShowStatusGet(uuid: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").TransactionResponse, unknown, {}, any>>;
|
|
230
238
|
/**
|
|
231
|
-
*
|
|
239
|
+
* Reject only pending UUID transaction and record authenticated verifier and unsuccessful verification; emit result. Returns both records at HTTP 200; nonpending state returns 409, missing row 404. No request body.
|
|
232
240
|
* Calls `POST /api/v1/transactions/{uuid}/reject` through the shared IDP-aware Faiber client.
|
|
233
241
|
* @param uuid Backend path identifier `uuid`.
|
|
234
242
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
235
|
-
* @returns The complete Axios response, including the typed
|
|
236
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:transaction:verify.
|
|
243
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
244
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:transaction:verify (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
237
245
|
*/
|
|
238
|
-
transactionRejectPaymentPost(uuid:
|
|
246
|
+
transactionRejectPaymentPost(uuid: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").VerifyPaymentResponse, unknown, {}, any>>;
|
|
239
247
|
/**
|
|
240
|
-
*
|
|
248
|
+
* Read verification log array newest-first by created_at for transaction UUID at HTTP 200; empty history is [], missing transaction returns 404.
|
|
241
249
|
* Calls `GET /api/v1/transactions/{uuid}/verifications` through the shared IDP-aware Faiber client.
|
|
242
250
|
* @param uuid Backend path identifier `uuid`.
|
|
243
251
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
244
|
-
* @returns The complete Axios response, including the typed
|
|
245
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:transaction:read.
|
|
252
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
253
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:transaction:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
246
254
|
*/
|
|
247
|
-
transactionVerificationLogsGet(uuid:
|
|
255
|
+
transactionVerificationLogsGet(uuid: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentVerificationLogsResponse, unknown, {}, any>>;
|
|
248
256
|
/**
|
|
249
|
-
*
|
|
257
|
+
* Verify UUID using stored gateway/authority and persist verifier log; accepted transactions retain success without provider call. Provider failure is represented by HTTP 200 with verification.successful=false and rejected resulting status. May dispatch payment result; missing transaction/gateway returns 404. No request body.
|
|
250
258
|
* Calls `POST /api/v1/transactions/{uuid}/verify` through the shared IDP-aware Faiber client.
|
|
251
259
|
* @param uuid Backend path identifier `uuid`.
|
|
252
260
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
253
|
-
* @returns The complete Axios response, including the typed
|
|
254
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:transaction:verify.
|
|
261
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
262
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:transaction:verify (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
255
263
|
*/
|
|
256
|
-
transactionVerifyPaymentPost(uuid:
|
|
264
|
+
transactionVerifyPaymentPost(uuid: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").VerifyPaymentResponse, unknown, {}, any>>;
|
|
257
265
|
/**
|
|
258
|
-
*
|
|
266
|
+
* Read accepted income by UTC date with zeros for missing dates. days is unsigned u32, defaults 30 and clamps 1..90; returns date/amount points at HTTP 200, no count.
|
|
259
267
|
* Calls `GET /api/v1/transactions/daily-income` through the shared IDP-aware Faiber client.
|
|
260
268
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
261
269
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
262
|
-
* @returns The complete Axios response, including the typed
|
|
263
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:transaction:read.
|
|
270
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
271
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: Authenticated non-nil IDP user; admin:transaction:read (payment: prefix, * and payment:* accepted). Bearer/secure cookies use shared FaiberClient; ingress must authenticate and strip forwarded identity headers.
|
|
264
272
|
*/
|
|
265
|
-
transactionDailyIncomeGet(params?: T.TransactionDailyIncomeGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
273
|
+
transactionDailyIncomeGet(params?: T.TransactionDailyIncomeGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").DailyIncomeResponse, unknown, {}, any>>;
|
|
266
274
|
/**
|
|
267
|
-
*
|
|
275
|
+
* Read process version with required status/message/data at HTTP 200. Does not probe database, broker or provider readiness.
|
|
268
276
|
* Calls `GET /health` through the shared IDP-aware Faiber client.
|
|
269
277
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
270
|
-
* @returns The complete Axios response, including the typed
|
|
271
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
278
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
279
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
272
280
|
*/
|
|
273
|
-
routerStatusRouteGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
281
|
+
routerStatusRouteGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentHealthResponse, unknown, {}, any>>;
|
|
274
282
|
/**
|
|
275
|
-
*
|
|
283
|
+
* Return raw provider navigation HTML at HTTP 200 for transaction UUID, optionally recording forwarded IP. Missing transaction/gateway returns 404, missing authority or invalid IP 400, unavailable provider 503; resolved storefront or changed proof returns 409. This endpoint is not JSON.
|
|
276
284
|
* Calls `GET /payments/{uuid}/redirect` through the shared IDP-aware Faiber client.
|
|
277
285
|
* @param uuid Backend path identifier `uuid`.
|
|
278
286
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
279
|
-
* @returns The complete Axios response, including the typed
|
|
280
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
287
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
288
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
281
289
|
*/
|
|
282
|
-
paymentWebRedirectGet(uuid:
|
|
290
|
+
paymentWebRedirectGet(uuid: string, options?: RequestOptions): Promise<import("axios").AxiosResponse<string, unknown, {}, any>>;
|
|
283
291
|
/**
|
|
284
|
-
*
|
|
292
|
+
* Process provider callback using query Authority, then transid, then paymentNumber; POST body is ignored. Missing authority returns 422, wrong provider 400, missing transaction 404, transient verification 503. May contact provider, persist state and emit result. Returns raw HTML 200 even for declined payments, or empty 303 with Location for allowed HTTPS callback origin. In Node use maxRedirects:0 and accept 303 to inspect redirect.
|
|
285
293
|
* Calls `GET /payments/callbacks/{provider}` through the shared IDP-aware Faiber client.
|
|
286
294
|
* @param provider Backend path identifier `provider`.
|
|
287
295
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
288
296
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
289
|
-
* @returns The complete Axios response, including the typed
|
|
290
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
297
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
298
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
291
299
|
*/
|
|
292
|
-
paymentWebCallbackGet(provider:
|
|
300
|
+
paymentWebCallbackGet(provider: string, params?: T.PaymentWebCallbackGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<string, unknown, {}, any>>;
|
|
293
301
|
/**
|
|
294
|
-
*
|
|
302
|
+
* Process provider callback using query Authority, then transid, then paymentNumber; POST body is ignored. Missing authority returns 422, wrong provider 400, missing transaction 404, transient verification 503. May contact provider, persist state and emit result. Returns raw HTML 200 even for declined payments, or empty 303 with Location for allowed HTTPS callback origin. In Node use maxRedirects:0 and accept 303 to inspect redirect.
|
|
295
303
|
* Calls `POST /payments/callbacks/{provider}` through the shared IDP-aware Faiber client.
|
|
296
304
|
* @param provider Backend path identifier `provider`.
|
|
297
305
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
298
306
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
299
|
-
* @returns The complete Axios response, including the typed
|
|
300
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
307
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
308
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
309
|
+
*/
|
|
310
|
+
paymentWebCallbackPost(provider: string, params?: T.PaymentWebCallbackPostQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<string, unknown, {}, any>>;
|
|
311
|
+
/**
|
|
312
|
+
* Read process version with required status/message/data at HTTP 200. Does not probe database, broker or provider readiness.
|
|
313
|
+
* Calls `GET /up` through the shared IDP-aware Faiber client.
|
|
314
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
315
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
316
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; configured credentials still use shared FaiberClient. Production ingress authority is separately verified.
|
|
301
317
|
*/
|
|
302
|
-
|
|
318
|
+
routerUpGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PaymentHealthResponse, unknown, {}, any>>;
|
|
303
319
|
}
|
|
304
320
|
//# sourceMappingURL=operations.d.ts.map
|
package/dist/operations.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../src/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,
|
|
1
|
+
{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../src/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAA+B,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAChG,OAAO,KAAK,KAAK,CAAC,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,iBAAkB,SAAQ,UAAU;IAC/C;;;;;;OAMG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,cAAc;IAG5C;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,cAAc;IAG7C;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,cAAc;IAG1C;;;;;;;OAOG;IACH,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc;IAGzE;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,qBAAqB,CAAC;IAGjG;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGzD;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGnD;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,uBAAuB,CAAC;IAGnH;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,cAAc;IAG1C;;;;;;OAMG;IACH,qBAAqB,CAAC,OAAO,CAAC,EAAE,cAAc;IAG9C;;;;;;OAMG;IACH,iCAAiC,CAAC,OAAO,CAAC,EAAE,cAAc;IAG1D;;;;;;OAMG;IACH,iCAAiC,CAAC,OAAO,CAAC,EAAE,cAAc;IAG1D;;;;;;OAMG;IACH,2BAA2B,CAAC,OAAO,CAAC,EAAE,cAAc;IAGpD;;;;;;;OAOG;IACH,sBAAsB,CAAC,IAAI,EAAE,CAAC,CAAC,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,2BAA2B,CAAC;IAGnH;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAG3D;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAG5D;;;;;;;OAOG;IACH,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,sBAAsB,CAAC;IAGpG;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGtD;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGrD;;;;;;;OAOG;IACH,sBAAsB,CAAC,IAAI,EAAE,CAAC,CAAC,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,2BAA2B,CAAC;IAGnH;;;;;;OAMG;IACH,wBAAwB,CAAC,OAAO,CAAC,EAAE,cAAc;IAGjD;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAG3D;;;;;;;OAOG;IACH,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,6BAA6B,CAAC;IAGzH;;;;;;OAMG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc;IAGxC;;;;;;;OAOG;IACH,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,wBAAwB,CAAC;IAG1G;;;;;;;OAOG;IACH,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc;IAGjF;;;;;;;OAOG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAG1D;;;;;;;OAOG;IACH,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGnE;;;;;;;OAOG;IACH,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGrE;;;;;;;OAOG;IACH,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAGnE;;;;;;;OAOG;IACH,yBAAyB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,8BAA8B,EAAE,OAAO,CAAC,EAAE,cAAc;IAG7F;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,cAAc;IAG7C;;;;;;;OAOG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAG5D;;;;;;;;OAQG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc;IAGvG;;;;;;;;OAQG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc;IAGzG;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc;CAGrC"}
|