@naturalpay/sdk 1.6.8 → 1.6.10

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseMetaPagination.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/realtime/types/index.d.mts

@@ -0,0 +1,84 @@
+export * from "./CancelRealtimeResponse.mjs";
+export * from "./CancelRealtimeResponseData.mjs";
+export * from "./CancelRealtimeResponseDataAttributes.mjs";
+export * from "./CancelRealtimeResponseDataAttributesCurrency.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CancelRealtimeResponseDataAttributesStatus.mjs";
+export * from "./CancelRealtimeResponseDataRelationships.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsCustomerParty.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsCustomerPartyData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsCustomerPartyDataType.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalParty.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyAccount.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyAccountData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyDataType.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsWallet.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsWalletData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsWalletDataType.mjs";
+export * from "./CancelRealtimeResponseDataType.mjs";
+export * from "./CreateRealtimeRequestCurrency.mjs";
+export * from "./CreateRealtimeResponse.mjs";
+export * from "./CreateRealtimeResponseData.mjs";
+export * from "./CreateRealtimeResponseDataAttributes.mjs";
+export * from "./CreateRealtimeResponseDataAttributesCurrency.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CreateRealtimeResponseDataAttributesStatus.mjs";
+export * from "./CreateRealtimeResponseDataRelationships.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsCustomerParty.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsCustomerPartyData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsCustomerPartyDataType.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalParty.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyAccount.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyAccountData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyDataType.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsWallet.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsWalletData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsWalletDataType.mjs";
+export * from "./CreateRealtimeResponseDataType.mjs";
+export * from "./GetRealtimeResponse.mjs";
+export * from "./GetRealtimeResponseData.mjs";
+export * from "./GetRealtimeResponseDataAttributes.mjs";
+export * from "./GetRealtimeResponseDataAttributesCurrency.mjs";
+export * from "./GetRealtimeResponseDataAttributesFailure.mjs";
+export * from "./GetRealtimeResponseDataAttributesStatus.mjs";
+export * from "./GetRealtimeResponseDataRelationships.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsCustomerParty.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsCustomerPartyData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsCustomerPartyDataType.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalParty.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyAccount.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyAccountData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyDataType.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsWallet.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsWalletData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsWalletDataType.mjs";
+export * from "./GetRealtimeResponseDataType.mjs";
+export * from "./ListRealtimeRequestStatus.mjs";
+export * from "./ListRealtimeResponse.mjs";
+export * from "./ListRealtimeResponseDataItem.mjs";
+export * from "./ListRealtimeResponseDataItemAttributes.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesCurrency.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFailure.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesStatus.mjs";
+export * from "./ListRealtimeResponseDataItemRelationships.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsCustomerParty.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsCustomerPartyData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsCustomerPartyDataType.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalParty.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyAccount.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyAccountData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyDataType.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsWallet.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsWalletData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsWalletDataType.mjs";
+export * from "./ListRealtimeResponseDataItemType.mjs";
+export * from "./ListRealtimeResponseMeta.mjs";
+export * from "./ListRealtimeResponseMetaPagination.mjs";

package/dist/esm/api/resources/realtime/types/index.mjs

@@ -0,0 +1,84 @@
+export * from "./CancelRealtimeResponse.mjs";
+export * from "./CancelRealtimeResponseData.mjs";
+export * from "./CancelRealtimeResponseDataAttributes.mjs";
+export * from "./CancelRealtimeResponseDataAttributesCurrency.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CancelRealtimeResponseDataAttributesStatus.mjs";
+export * from "./CancelRealtimeResponseDataRelationships.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsCustomerParty.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsCustomerPartyData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsCustomerPartyDataType.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalParty.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyAccount.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyAccountData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsExternalPartyDataType.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsWallet.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsWalletData.mjs";
+export * from "./CancelRealtimeResponseDataRelationshipsWalletDataType.mjs";
+export * from "./CancelRealtimeResponseDataType.mjs";
+export * from "./CreateRealtimeRequestCurrency.mjs";
+export * from "./CreateRealtimeResponse.mjs";
+export * from "./CreateRealtimeResponseData.mjs";
+export * from "./CreateRealtimeResponseDataAttributes.mjs";
+export * from "./CreateRealtimeResponseDataAttributesCurrency.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CreateRealtimeResponseDataAttributesStatus.mjs";
+export * from "./CreateRealtimeResponseDataRelationships.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsCustomerParty.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsCustomerPartyData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsCustomerPartyDataType.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalParty.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyAccount.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyAccountData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsExternalPartyDataType.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsWallet.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsWalletData.mjs";
+export * from "./CreateRealtimeResponseDataRelationshipsWalletDataType.mjs";
+export * from "./CreateRealtimeResponseDataType.mjs";
+export * from "./GetRealtimeResponse.mjs";
+export * from "./GetRealtimeResponseData.mjs";
+export * from "./GetRealtimeResponseDataAttributes.mjs";
+export * from "./GetRealtimeResponseDataAttributesCurrency.mjs";
+export * from "./GetRealtimeResponseDataAttributesFailure.mjs";
+export * from "./GetRealtimeResponseDataAttributesStatus.mjs";
+export * from "./GetRealtimeResponseDataRelationships.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsCustomerParty.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsCustomerPartyData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsCustomerPartyDataType.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalParty.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyAccount.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyAccountData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsExternalPartyDataType.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsWallet.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsWalletData.mjs";
+export * from "./GetRealtimeResponseDataRelationshipsWalletDataType.mjs";
+export * from "./GetRealtimeResponseDataType.mjs";
+export * from "./ListRealtimeRequestStatus.mjs";
+export * from "./ListRealtimeResponse.mjs";
+export * from "./ListRealtimeResponseDataItem.mjs";
+export * from "./ListRealtimeResponseDataItemAttributes.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesCurrency.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFailure.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesStatus.mjs";
+export * from "./ListRealtimeResponseDataItemRelationships.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsCustomerParty.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsCustomerPartyData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsCustomerPartyDataType.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalParty.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyAccount.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyAccountData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyAccountDataType.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsExternalPartyDataType.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsWallet.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsWalletData.mjs";
+export * from "./ListRealtimeResponseDataItemRelationshipsWalletDataType.mjs";
+export * from "./ListRealtimeResponseDataItemType.mjs";
+export * from "./ListRealtimeResponseMeta.mjs";
+export * from "./ListRealtimeResponseMetaPagination.mjs";

package/dist/esm/api/resources/simulations/client/Client.d.mts

@@ -193,6 +193,66 @@ export declare class SimulationsClient {
      */
     declinePaymentRequest(request: Natural.DeclinePaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclinePaymentRequestSimulationsResponse>;
     private __declinePaymentRequest;
+    /**
+     * Drive a sandbox realtime payment to settlement
+     *
+     * @param {Natural.SettleRealtimeSimulationsRequest} request
+     * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.simulations.settleRealtime({
+     *         idempotencyKey: "Idempotency-Key",
+     *         realtimeId: "realtimeId",
+     *         customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+     *     })
+     */
+    settleRealtime(request: Natural.SettleRealtimeSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.SettleRealtimeSimulationsResponse>;
+    private __settleRealtime;
+    /**
+     * Drive a sandbox realtime payment to a terminal network rejection
+     *
+     * @param {Natural.FailRealtimeSimulationsRequest} request
+     * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.simulations.failRealtime({
+     *         idempotencyKey: "Idempotency-Key",
+     *         realtimeId: "realtimeId",
+     *         customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+     *     })
+     */
+    failRealtime(request: Natural.FailRealtimeSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FailRealtimeSimulationsResponse>;
+    private __failRealtime;
     /**
      * Accept a pending customer invitation as the test customer it is addressed to
      *

package/dist/esm/api/resources/simulations/client/Client.mjs

@@ -650,6 +650,218 @@ export class SimulationsClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/simulations/payment-requests/{paymentRequestId}/decline");
         });
     }
+    /**
+     * Drive a sandbox realtime payment to settlement
+     *
+     * @param {Natural.SettleRealtimeSimulationsRequest} request
+     * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.simulations.settleRealtime({
+     *         idempotencyKey: "Idempotency-Key",
+     *         realtimeId: "realtimeId",
+     *         customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+     *     })
+     */
+    settleRealtime(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__settleRealtime(request, requestOptions));
+    }
+    __settleRealtime(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { realtimeId, idempotencyKey } = request, _body = __rest(request, ["realtimeId", "idempotencyKey"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
+                "Idempotency-Key": idempotencyKey,
+                "X-Instance-ID": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.instanceId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.instanceId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.NaturalEnvironment.Production, `simulations/realtime/${core.url.encodePathParam(realtimeId)}/settle`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: mergeAdditionalBodyParameters(serializers.SettleRealtimeSimulationsRequest.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.SettleRealtimeSimulationsResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Natural.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Natural.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Natural.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Natural.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Natural.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Natural.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 428:
+                        throw new Natural.PreconditionError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Natural.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Natural.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Natural.NotImplementedError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new Natural.BadGatewayError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Natural.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.NaturalError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/simulations/realtime/{realtimeId}/settle");
+        });
+    }
+    /**
+     * Drive a sandbox realtime payment to a terminal network rejection
+     *
+     * @param {Natural.FailRealtimeSimulationsRequest} request
+     * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.simulations.failRealtime({
+     *         idempotencyKey: "Idempotency-Key",
+     *         realtimeId: "realtimeId",
+     *         customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+     *     })
+     */
+    failRealtime(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__failRealtime(request, requestOptions));
+    }
+    __failRealtime(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { realtimeId, idempotencyKey } = request, _body = __rest(request, ["realtimeId", "idempotencyKey"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
+                "Idempotency-Key": idempotencyKey,
+                "X-Instance-ID": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.instanceId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.instanceId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.NaturalEnvironment.Production, `simulations/realtime/${core.url.encodePathParam(realtimeId)}/fail`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: mergeAdditionalBodyParameters(serializers.FailRealtimeSimulationsRequest.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.FailRealtimeSimulationsResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Natural.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Natural.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Natural.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Natural.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Natural.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Natural.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 428:
+                        throw new Natural.PreconditionError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Natural.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Natural.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Natural.NotImplementedError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new Natural.BadGatewayError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Natural.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.NaturalError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/simulations/realtime/{realtimeId}/fail");
+        });
+    }
     /**
      * Accept a pending customer invitation as the test customer it is addressed to
      *

package/dist/esm/api/resources/simulations/client/requests/FailRealtimeSimulationsRequest.d.mts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         idempotencyKey: "Idempotency-Key",
+ *         realtimeId: "realtimeId",
+ *         customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+ *     }
+ */
+export interface FailRealtimeSimulationsRequest {
+    realtimeId: string;
+    /** Unique key for safely retrying a request without creating duplicates. */
+    idempotencyKey: string;
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
+    customerPartyId?: string;
+}

package/dist/esm/api/resources/simulations/client/requests/FailRealtimeSimulationsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/client/requests/SettleRealtimeSimulationsRequest.d.mts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         idempotencyKey: "Idempotency-Key",
+ *         realtimeId: "realtimeId",
+ *         customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+ *     }
+ */
+export interface SettleRealtimeSimulationsRequest {
+    realtimeId: string;
+    /** Unique key for safely retrying a request without creating duplicates. */
+    idempotencyKey: string;
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
+    customerPartyId?: string;
+}

package/dist/esm/api/resources/simulations/client/requests/SettleRealtimeSimulationsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/client/requests/index.d.mts

@@ -3,8 +3,10 @@ export type { CompletePaymentClaimSimulationsRequest } from "./CompletePaymentCl
 export type { DeclineCustomerInvitationSimulationsRequest } from "./DeclineCustomerInvitationSimulationsRequest.mjs";
 export type { DeclinePaymentRequestSimulationsRequest } from "./DeclinePaymentRequestSimulationsRequest.mjs";
 export type { DisconnectCustomerSimulationsRequest } from "./DisconnectCustomerSimulationsRequest.mjs";
+export type { FailRealtimeSimulationsRequest } from "./FailRealtimeSimulationsRequest.mjs";
 export type { FulfillPaymentRequestSimulationsRequest } from "./FulfillPaymentRequestSimulationsRequest.mjs";
 export type { FundCustomerSimulationsRequest } from "./FundCustomerSimulationsRequest.mjs";
 export type { InviteCustomerSimulationsRequest } from "./InviteCustomerSimulationsRequest.mjs";
 export type { LinkExternalAccountSimulationsRequest } from "./LinkExternalAccountSimulationsRequest.mjs";
 export type { RevokeAgentConnectionSimulationsRequest } from "./RevokeAgentConnectionSimulationsRequest.mjs";
+export type { SettleRealtimeSimulationsRequest } from "./SettleRealtimeSimulationsRequest.mjs";

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponse.d.mts

@@ -0,0 +1,4 @@
+import type * as Natural from "../../../index.mjs";
+export interface FailRealtimeSimulationsResponse {
+    data: Natural.FailRealtimeSimulationsResponseData;
+}

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseData.d.mts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../index.mjs";
+export interface FailRealtimeSimulationsResponseData {
+    type: Natural.FailRealtimeSimulationsResponseDataType;
+    /** The realtime payment the action was applied to. */
+    id: string;
+    attributes: Natural.FailRealtimeSimulationsResponseDataAttributes;
+}

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseDataAttributes.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface FailRealtimeSimulationsResponseDataAttributes {
+    /** Lifecycle action applied. */
+    action: Natural.FailRealtimeSimulationsResponseDataAttributesAction;
+    /** Money-movement request the fixtures were fired against. */
+    mmRequestId: string;
+    /** Fixture scenario fired on the money-movement side. */
+    scenario: string;
+    /** Number of webhook fixtures fired. */
+    fixturesFired: number;
+}

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseDataAttributes.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseDataAttributesAction.d.mts

@@ -0,0 +1,6 @@
+/** Lifecycle action applied. */
+export declare const FailRealtimeSimulationsResponseDataAttributesAction: {
+    readonly Settle: "settle";
+    readonly Fail: "fail";
+};
+export type FailRealtimeSimulationsResponseDataAttributesAction = (typeof FailRealtimeSimulationsResponseDataAttributesAction)[keyof typeof FailRealtimeSimulationsResponseDataAttributesAction];

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseDataAttributesAction.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Lifecycle action applied. */
+export const FailRealtimeSimulationsResponseDataAttributesAction = {
+    Settle: "settle",
+    Fail: "fail",
+};

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseDataType.d.mts

@@ -0,0 +1,4 @@
+export declare const FailRealtimeSimulationsResponseDataType: {
+    readonly RealtimeSimulation: "realtime-simulation";
+};
+export type FailRealtimeSimulationsResponseDataType = (typeof FailRealtimeSimulationsResponseDataType)[keyof typeof FailRealtimeSimulationsResponseDataType];

package/dist/esm/api/resources/simulations/types/FailRealtimeSimulationsResponseDataType.mjs

@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+export const FailRealtimeSimulationsResponseDataType = {
+    RealtimeSimulation: "realtime-simulation",
+};

package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.mts

@@ -16,5 +16,6 @@ export declare const InviteCustomerSimulationsRequestPermissionsItem: {
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
+    readonly PaymentIntentsCreate: "payment_intents.create";
 };
 export type InviteCustomerSimulationsRequestPermissionsItem = (typeof InviteCustomerSimulationsRequestPermissionsItem)[keyof typeof InviteCustomerSimulationsRequestPermissionsItem];

package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.mjs

@@ -17,4 +17,5 @@ export const InviteCustomerSimulationsRequestPermissionsItem = {
     WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
+    PaymentIntentsCreate: "payment_intents.create",
 };

package/dist/esm/api/resources/simulations/types/SettleRealtimeSimulationsResponse.d.mts

@@ -0,0 +1,4 @@
+import type * as Natural from "../../../index.mjs";
+export interface SettleRealtimeSimulationsResponse {
+    data: Natural.SettleRealtimeSimulationsResponseData;
+}

package/dist/esm/api/resources/simulations/types/SettleRealtimeSimulationsResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/SettleRealtimeSimulationsResponseData.d.mts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../index.mjs";
+export interface SettleRealtimeSimulationsResponseData {
+    type: Natural.SettleRealtimeSimulationsResponseDataType;
+    /** The realtime payment the action was applied to. */
+    id: string;
+    attributes: Natural.SettleRealtimeSimulationsResponseDataAttributes;
+}

package/dist/esm/api/resources/simulations/types/SettleRealtimeSimulationsResponseData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};