@naturalpay/sdk 1.6.40 → 1.6.42

package/dist/cjs/api/resources/simulations/client/Client.d.ts

@@ -313,6 +313,216 @@ export declare class SimulationsClient {
      */
     failWire(request: Natural.FailWireSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FailWireSimulationsResponse>;
     private __failWire;
+    /**
+     * 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: Natural.DepositCheckSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DepositCheckSimulationsResponse>;
+    private __depositCheck;
+    /**
+     * 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: Natural.FailCheckSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FailCheckSimulationsResponse>;
+    private __failCheck;
+    /**
+     * 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: Natural.BounceCheckSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.BounceCheckSimulationsResponse>;
+    private __bounceCheck;
+    /**
+     * 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: Natural.VoidCheckSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.VoidCheckSimulationsResponse>;
+    private __voidCheck;
+    /**
+     * 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: Natural.StopCheckSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.StopCheckSimulationsResponse>;
+    private __stopCheck;
+    /**
+     * 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: Natural.DeliverCheckSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeliverCheckSimulationsResponse>;
+    private __deliverCheck;
+    /**
+     * 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: Natural.ReturnCheckToSenderSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.ReturnCheckToSenderSimulationsResponse>;
+    private __returnCheckToSender;
     /**
      * Simulate settlement of a successful card payment into the receiving wallet. Sandbox only.
      *