@naturalpay/sdk 1.6.27 → 1.6.29

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

@@ -0,0 +1,188 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Natural from "../../../index.mjs";
+export declare namespace AgenticPaymentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AgenticPaymentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AgenticPaymentsClient.Options>;
+    constructor(options?: AgenticPaymentsClient.Options);
+    /**
+     * List the party's usable mandates for the calling agent, or all of the owner's mandates
+     *
+     * @param {Natural.ListMandatesAgenticPaymentsRequest} request
+     * @param {AgenticPaymentsClient.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.agenticPayments.listMandates()
+     */
+    listMandates(request?: Natural.ListMandatesAgenticPaymentsRequest, requestOptions?: AgenticPaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.ListMandatesAgenticPaymentsResponse>;
+    private __listMandates;
+    /**
+     * Get the current budget and approval status
+     *
+     * @param {Natural.GetMandateAgenticPaymentsRequest} request
+     * @param {AgenticPaymentsClient.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.agenticPayments.getMandate({
+     *         mandateId: "mandateId"
+     *     })
+     */
+    getMandate(request: Natural.GetMandateAgenticPaymentsRequest, requestOptions?: AgenticPaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.GetMandateAgenticPaymentsResponse>;
+    private __getMandate;
+    /**
+     * Reserve budget for a purchase
+     *
+     * @param {Natural.CreatePurchaseAgenticPaymentsRequest} request
+     * @param {AgenticPaymentsClient.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.agenticPayments.createPurchase({
+     *         idempotencyKey: "Idempotency-Key",
+     *         mandateId: "amd_01a0e6466ba3713bba0f0d9d36803b92",
+     *         amount: 2450,
+     *         currency: "USD",
+     *         merchant: {
+     *             name: "Blue Bottle Coffee",
+     *             url: "https://bluebottlecoffee.com",
+     *             countryCode: "US"
+     *         },
+     *         ttlSeconds: 600
+     *     })
+     */
+    createPurchase(request: Natural.CreatePurchaseAgenticPaymentsRequest, requestOptions?: AgenticPaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.CreatePurchaseAgenticPaymentsResponse>;
+    private __createPurchase;
+    /**
+     * Get credential issuance status without the credential
+     *
+     * @param {Natural.GetPurchaseAgenticPaymentsRequest} request
+     * @param {AgenticPaymentsClient.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.agenticPayments.getPurchase({
+     *         purchaseId: "purchaseId"
+     *     })
+     */
+    getPurchase(request: Natural.GetPurchaseAgenticPaymentsRequest, requestOptions?: AgenticPaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.GetPurchaseAgenticPaymentsResponse>;
+    private __getPurchase;
+    /**
+     * Return the purchase credential exactly once
+     *
+     * @param {Natural.ClaimPurchaseAgenticPaymentsRequest} request
+     * @param {AgenticPaymentsClient.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.agenticPayments.claimPurchase({
+     *         purchaseId: "purchaseId"
+     *     })
+     */
+    claimPurchase(request: Natural.ClaimPurchaseAgenticPaymentsRequest, requestOptions?: AgenticPaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.ClaimPurchaseAgenticPaymentsResponse>;
+    private __claimPurchase;
+    /**
+     * Release budget reserved for a purchase that has not been claimed
+     *
+     * @param {Natural.CancelPurchaseAgenticPaymentsRequest} request
+     * @param {AgenticPaymentsClient.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.agenticPayments.cancelPurchase({
+     *         purchaseId: "purchaseId"
+     *     })
+     */
+    cancelPurchase(request: Natural.CancelPurchaseAgenticPaymentsRequest, requestOptions?: AgenticPaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.CancelPurchaseAgenticPaymentsResponse>;
+    private __cancelPurchase;
+}