@naturalpay/sdk 1.6.39 → 1.6.42

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

@@ -1074,6 +1074,748 @@ export class SimulationsClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/simulations/wire/{wireId}/fail");
         });
     }
+    /**
+     * Drive a sandbox check payment to settlement (deposit side)
+     *
+     * @param {Natural.DepositCheckSimulationsRequest} 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.depositCheck({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    depositCheck(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__depositCheck(request, requestOptions));
+    }
+    __depositCheck(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/deposit`),
+                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.DepositCheckSimulationsRequest.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.DepositCheckSimulationsResponse.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/check/{checkId}/deposit");
+        });
+    }
+    /**
+     * Drive a sandbox check payment to a terminal pre-settlement rejection
+     *
+     * @param {Natural.FailCheckSimulationsRequest} 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.failCheck({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    failCheck(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__failCheck(request, requestOptions));
+    }
+    __failCheck(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/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.FailCheckSimulationsRequest.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.FailCheckSimulationsResponse.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/check/{checkId}/fail");
+        });
+    }
+    /**
+     * Drive a sandbox check payment through a non-terminal presentment return; the check stays outstanding and depositable
+     *
+     * @param {Natural.BounceCheckSimulationsRequest} 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.bounceCheck({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    bounceCheck(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__bounceCheck(request, requestOptions));
+    }
+    __bounceCheck(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/bounce`),
+                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.BounceCheckSimulationsRequest.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.BounceCheckSimulationsResponse.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/check/{checkId}/bounce");
+        });
+    }
+    /**
+     * Drive a sandbox check payment to CANCELED through a second presentment return after a failed reclear
+     *
+     * @param {Natural.VoidCheckSimulationsRequest} 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.voidCheck({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    voidCheck(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__voidCheck(request, requestOptions));
+    }
+    __voidCheck(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/void`),
+                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.VoidCheckSimulationsRequest.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.VoidCheckSimulationsResponse.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/check/{checkId}/void");
+        });
+    }
+    /**
+     * Drive a sandbox check payment to CANCELED through a confirmed stop payment
+     *
+     * @param {Natural.StopCheckSimulationsRequest} 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.stopCheck({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    stopCheck(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__stopCheck(request, requestOptions));
+    }
+    __stopCheck(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/stop`),
+                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.StopCheckSimulationsRequest.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.StopCheckSimulationsResponse.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/check/{checkId}/stop");
+        });
+    }
+    /**
+     * Drive a sandbox check mail delivery through to delivered (created → rendered_pdf → mailed → in_transit → delivered)
+     *
+     * @param {Natural.DeliverCheckSimulationsRequest} 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.deliverCheck({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    deliverCheck(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deliverCheck(request, requestOptions));
+    }
+    __deliverCheck(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/deliver`),
+                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.DeliverCheckSimulationsRequest.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.DeliverCheckSimulationsResponse.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/check/{checkId}/deliver");
+        });
+    }
+    /**
+     * Drive a sandbox check mail delivery to returned-to-sender, firing the returned-to-sender webhook
+     *
+     * @param {Natural.ReturnCheckToSenderSimulationsRequest} 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.returnCheckToSender({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+     *     })
+     */
+    returnCheckToSender(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__returnCheckToSender(request, requestOptions));
+    }
+    __returnCheckToSender(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { checkId, idempotencyKey } = request, _body = __rest(request, ["checkId", "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/check/${core.url.encodePathParam(checkId)}/return-to-sender`),
+                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.ReturnCheckToSenderSimulationsRequest.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.ReturnCheckToSenderSimulationsResponse.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/check/{checkId}/return-to-sender");
+        });
+    }
     /**
      * Simulate settlement of a successful card payment into the receiving wallet. Sandbox only.
      *