@naturalpay/sdk 1.6.40 → 1.6.41

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

@@ -0,0 +1,479 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as serializers from "../../../../serialization/index.mjs";
+import * as Natural from "../../../index.mjs";
+/**
+ * Mail paper checks to external parties
+ */
+export class CheckClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * List your check payments
+     *
+     * @param {Natural.ListCheckRequest} request
+     * @param {CheckClient.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.check.list()
+     */
+    list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+                const { customerPartyId, status, externalPartyId, limit, cursor } = request;
+                const _queryParams = {
+                    customerPartyId,
+                    status: status != null
+                        ? serializers.ListCheckRequestStatus.jsonOrThrow(status, {
+                            unrecognizedObjectKeys: "strip",
+                            omitUndefined: true,
+                        })
+                        : undefined,
+                    externalPartyId,
+                    limit,
+                    cursor,
+                };
+                const _authRequest = yield this._options.authProvider.getAuthRequest();
+                const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
+                    "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, "check"),
+                    method: "GET",
+                    headers: _headers,
+                    queryString: core.url
+                        .queryBuilder()
+                        .addMany(_queryParams)
+                        .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                        .build(),
+                    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.ListCheckResponse.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, "GET", "/check");
+            }));
+            const dataWithRawResponse = yield list(request).withRawResponse();
+            return new core.Page({
+                response: dataWithRawResponse.data,
+                rawResponse: dataWithRawResponse.rawResponse,
+                hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.meta.pagination.nextCursor) != null &&
+                    !(typeof (response === null || response === void 0 ? void 0 : response.meta.pagination.nextCursor) === "string" &&
+                        (response === null || response === void 0 ? void 0 : response.meta.pagination.nextCursor) === ""),
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (response) => {
+                    return list(core.setObjectProperty(request, "cursor", response === null || response === void 0 ? void 0 : response.meta.pagination.nextCursor));
+                },
+            });
+        });
+    }
+    /**
+     * Create a check payment mailed to an external party
+     *
+     * @param {Natural.CreateCheckRequest} request
+     * @param {CheckClient.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.check.create({
+     *         idempotencyKey: "Idempotency-Key",
+     *         amount: 25000,
+     *         currency: "USD",
+     *         externalPartyId: "epty_019cd1798d8d6873421613705e3c1415",
+     *         memo: "Invoice 1042",
+     *         message: "Thank you for your business",
+     *         internalDescription: "Q3 vendor true-up",
+     *         deliveryMethod: "USPS_FIRST_CLASS"
+     *     })
+     */
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    __create(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { idempotencyKey } = request, _body = __rest(request, ["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, "check"),
+                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.CreateCheckRequest.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.CreateCheckResponse.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", "/check");
+        });
+    }
+    /**
+     * Get a check payment
+     *
+     * @param {Natural.GetCheckRequest} request
+     * @param {CheckClient.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.check.get({
+     *         checkId: "checkId"
+     *     })
+     */
+    get(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
+    }
+    __get(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, customerPartyId } = request;
+            const _queryParams = {
+                customerPartyId,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "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, `check/${core.url.encodePathParam(checkId)}`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
+                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.GetCheckResponse.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, "GET", "/check/{checkId}");
+        });
+    }
+    /**
+     * Cancel a check payment before submission
+     *
+     * @param {Natural.CancelCheckRequest} request
+     * @param {CheckClient.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.check.cancel({
+     *         idempotencyKey: "Idempotency-Key",
+     *         checkId: "checkId",
+     *         reason: "Duplicate payment"
+     *     })
+     */
+    cancel(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__cancel(request, requestOptions));
+    }
+    __cancel(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, `check/${core.url.encodePathParam(checkId)}/cancel`),
+                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.CancelCheckRequest.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.CancelCheckResponse.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", "/check/{checkId}/cancel");
+        });
+    }
+}

package/dist/esm/api/resources/check/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/check/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/check/client/requests/CancelCheckRequest.d.mts

@@ -0,0 +1,18 @@
+/**
+ * @example
+ *     {
+ *         idempotencyKey: "Idempotency-Key",
+ *         checkId: "checkId",
+ *         reason: "Duplicate payment"
+ *     }
+ */
+export interface CancelCheckRequest {
+    /** Check ID (chk_*). */
+    checkId: string;
+    /** Unique key for safely retrying a request without creating duplicates. */
+    idempotencyKey: string;
+    /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
+    customerPartyId?: string;
+    /** Why the check is being canceled. Maximum 500 characters. */
+    reason: string;
+}

package/dist/esm/api/resources/check/client/requests/CancelCheckRequest.mjs

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

package/dist/esm/api/resources/check/client/requests/CreateCheckRequest.d.mts

@@ -0,0 +1,36 @@
+import type * as Natural from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         idempotencyKey: "Idempotency-Key",
+ *         amount: 25000,
+ *         currency: "USD",
+ *         externalPartyId: "epty_019cd1798d8d6873421613705e3c1415",
+ *         memo: "Invoice 1042",
+ *         message: "Thank you for your business",
+ *         internalDescription: "Q3 vendor true-up",
+ *         deliveryMethod: "USPS_FIRST_CLASS"
+ *     }
+ */
+export interface CreateCheckRequest {
+    /** Unique key for safely retrying a request without creating duplicates. */
+    idempotencyKey: string;
+    /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
+    customerPartyId?: string;
+    /** Amount in cents. */
+    amount: number;
+    /** Currency code. Defaults to USD. */
+    currency?: Natural.CreateCheckRequestCurrency;
+    /** Wallet (wal_*) to pay from. Defaults to the party's default wallet. */
+    walletId?: string;
+    /** External party (epty_*) to mail the check to. The check is addressed to the party's mailing address. */
+    externalPartyId: string;
+    /** Memo printed on the check and visible to the payee. Maximum 40 printable characters: letters, digits, spaces, and / - ? : ( ) . , ' +. */
+    memo: string;
+    /** Optional message printed on the check and visible to the payee. Maximum 1000 printable characters: letters, digits, spaces, and / - ? : ( ) . , ' +. */
+    message?: string;
+    /** Description for your internal reference. Never printed on the check or shared with the counterparty. Maximum 255 characters. */
+    internalDescription?: string;
+    /** How the check is mailed. Defaults to USPS_FIRST_CLASS. */
+    deliveryMethod?: Natural.CreateCheckRequestDeliveryMethod;
+}

package/dist/esm/api/resources/check/client/requests/CreateCheckRequest.mjs

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

package/dist/esm/api/resources/check/client/requests/GetCheckRequest.d.mts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         checkId: "checkId"
+ *     }
+ */
+export interface GetCheckRequest {
+    /** Check ID (chk_*). */
+    checkId: string;
+    /** Customer party to act for (pty_*). Omit to act as your own 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/check/client/requests/GetCheckRequest.mjs

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

package/dist/esm/api/resources/check/client/requests/ListCheckRequest.d.mts

@@ -0,0 +1,17 @@
+import type * as Natural from "../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface ListCheckRequest {
+    /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
+    customerPartyId?: string;
+    /** Filter by status. */
+    status?: Natural.ListCheckRequestStatus;
+    /** Only checks to this external party (epty_*). */
+    externalPartyId?: string;
+    /** Maximum results per page. */
+    limit?: number;
+    /** Cursor from the previous page. */
+    cursor?: string;
+}

package/dist/esm/api/resources/check/client/requests/ListCheckRequest.mjs

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

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

@@ -0,0 +1,4 @@
+export type { CancelCheckRequest } from "./CancelCheckRequest.mjs";
+export type { CreateCheckRequest } from "./CreateCheckRequest.mjs";
+export type { GetCheckRequest } from "./GetCheckRequest.mjs";
+export type { ListCheckRequest } from "./ListCheckRequest.mjs";

package/dist/esm/api/resources/check/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/check/exports.d.mts

@@ -0,0 +1,2 @@
+export { CheckClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/check/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { CheckClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/check/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/check/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/check/types/CancelCheckResponse.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponse.mjs

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

package/dist/esm/api/resources/check/types/CancelCheckResponseData.d.mts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.mjs";
+export interface CancelCheckResponseData {
+    /** Resource type. Always `check`. */
+    type: Natural.CancelCheckResponseDataType;
+    /** Check ID (chk_*). */
+    id: string;
+    attributes: Natural.CancelCheckResponseDataAttributes;
+    relationships: Natural.CancelCheckResponseDataRelationships;
+}

package/dist/esm/api/resources/check/types/CancelCheckResponseData.mjs

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