@naturalpay/sdk 1.6.23 → 1.6.25

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

@@ -0,0 +1,181 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Natural from "../../../index.js";
+export declare namespace PaymentIntentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Accept card payments by link or voice
+ */
+export declare class PaymentIntentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PaymentIntentsClient.Options>;
+    constructor(options?: PaymentIntentsClient.Options);
+    /**
+     * List payment intents, newest first
+     *
+     * @param {Natural.ListPaymentIntentsRequest} request
+     * @param {PaymentIntentsClient.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.paymentIntents.list()
+     */
+    list(request?: Natural.ListPaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): Promise<core.Page<Natural.PaymentIntent, Natural.ListPaymentIntentsResponse>>;
+    /**
+     * Create a payment intent with a hosted checkout link
+     *
+     * @param {Natural.CreatePaymentIntentsRequest} request
+     * @param {PaymentIntentsClient.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.paymentIntents.create({
+     *         idempotencyKey: "Idempotency-Key",
+     *         amount: 3920,
+     *         currency: "USD",
+     *         description: "Order 8842",
+     *         taxMode: "exclusive",
+     *         lineItems: [{
+     *                 referenceId: "menu_item_31",
+     *                 description: "Margherita pizza",
+     *                 quantity: 2,
+     *                 unitAmount: 1800,
+     *                 taxAmount: 320,
+     *                 taxCode: "prepared_food"
+     *             }]
+     *     })
+     */
+    create(request: Natural.CreatePaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): core.HttpResponsePromise<Natural.CreatePaymentIntentsResponse>;
+    private __create;
+    /**
+     * Get a payment intent
+     *
+     * @param {Natural.GetPaymentIntentsRequest} request
+     * @param {PaymentIntentsClient.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.paymentIntents.get({
+     *         paymentIntentId: "paymentIntentId"
+     *     })
+     */
+    get(request: Natural.GetPaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): core.HttpResponsePromise<Natural.GetPaymentIntentsResponse>;
+    private __get;
+    /**
+     * Change the amount, line items, or other details of an open payment intent
+     *
+     * @param {Natural.UpdatePaymentIntentsRequest} request
+     * @param {PaymentIntentsClient.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.paymentIntents.update({
+     *         idempotencyKey: "Idempotency-Key",
+     *         paymentIntentId: "paymentIntentId",
+     *         amount: 5840,
+     *         lineItems: [{
+     *                 referenceId: "menu_item_31",
+     *                 description: "Margherita pizza",
+     *                 quantity: 2,
+     *                 unitAmount: 1800,
+     *                 taxAmount: 320,
+     *                 taxCode: "prepared_food"
+     *             }, {
+     *                 description: "Garlic knots",
+     *                 quantity: 1,
+     *                 unitAmount: 1800,
+     *                 taxAmount: 120
+     *             }]
+     *     })
+     */
+    update(request: Natural.UpdatePaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): core.HttpResponsePromise<Natural.UpdatePaymentIntentsResponse>;
+    private __update;
+    /**
+     * Cancel an open payment intent
+     *
+     * @param {Natural.CancelPaymentIntentsRequest} request
+     * @param {PaymentIntentsClient.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.paymentIntents.cancel({
+     *         idempotencyKey: "Idempotency-Key",
+     *         paymentIntentId: "paymentIntentId"
+     *     })
+     */
+    cancel(request: Natural.CancelPaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): core.HttpResponsePromise<Natural.CancelPaymentIntentsResponse>;
+    private __cancel;
+}