@naturalpay/sdk 1.6.23 → 1.6.24

package/dist/esm/api/resources/paymentIntents/client/requests/CreatePaymentIntentsRequest.d.mts

@@ -0,0 +1,39 @@
+import type * as Natural from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         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"
+ *             }]
+ *     }
+ */
+export interface CreatePaymentIntentsRequest {
+    /** Unique key for safely retrying a request without creating duplicates. */
+    idempotencyKey: string;
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
+    customerPartyId?: string;
+    /** Total amount in US cents. */
+    amount: number;
+    /** Currency code. USD only. */
+    currency: Natural.CreatePaymentIntentsRequestCurrency;
+    /** What the payment is for. */
+    description?: string;
+    /** RFC 3339 timestamp after which no new payment attempt may start. */
+    expiresAt?: string;
+    /** Whether tax is added to or included in line amounts. */
+    taxMode?: Natural.CreatePaymentIntentsRequestTaxMode;
+    /** Tax in cents when lineItems is empty. Defaults to zero. */
+    taxAmount?: number;
+    /** Sale lines in display order. Totals are calculated by Natural. */
+    lineItems?: Natural.CreatePaymentIntentsRequestLineItemsItem[];
+}

package/dist/esm/api/resources/paymentIntents/client/requests/CreatePaymentIntentsRequest.mjs

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

package/dist/esm/api/resources/paymentIntents/client/requests/GetPaymentIntentsRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         paymentIntentId: "paymentIntentId"
+ *     }
+ */
+export interface GetPaymentIntentsRequest {
+    paymentIntentId: string;
+    customerPartyId?: string;
+}

package/dist/esm/api/resources/paymentIntents/client/requests/GetPaymentIntentsRequest.mjs

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

package/dist/esm/api/resources/paymentIntents/client/requests/ListPaymentIntentsRequest.d.mts

@@ -0,0 +1,13 @@
+import type * as Natural from "../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface ListPaymentIntentsRequest {
+    customerPartyId?: string;
+    status?: Natural.ListPaymentIntentsRequestStatus;
+    createdAfter?: string;
+    createdBefore?: string;
+    limit?: number;
+    cursor?: string;
+}

package/dist/esm/api/resources/paymentIntents/client/requests/ListPaymentIntentsRequest.mjs

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

package/dist/esm/api/resources/paymentIntents/client/requests/UpdatePaymentIntentsRequest.d.mts

@@ -0,0 +1,41 @@
+import type * as Natural from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         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
+ *             }]
+ *     }
+ */
+export interface UpdatePaymentIntentsRequest {
+    paymentIntentId: string;
+    /** Unique key for safely retrying a request without creating duplicates. */
+    idempotencyKey: string;
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
+    customerPartyId?: string;
+    /** New total amount in US cents. Must equal the line totals when lines exist. */
+    amount?: number;
+    /** What the payment is for. */
+    description?: string;
+    /** New RFC 3339 timestamp after which no new payment attempt may start. Must be in the future. */
+    expiresAt?: string;
+    /** Whether tax is added to or included in line amounts. */
+    taxMode?: Natural.UpdatePaymentIntentsRequestTaxMode;
+    /** Tax in cents when the intent has no line items. */
+    taxAmount?: number;
+    /** Replaces every line, in display order. Send an empty list to remove them. */
+    lineItems?: Natural.UpdatePaymentIntentsRequestLineItemsItem[];
+}

package/dist/esm/api/resources/paymentIntents/client/requests/UpdatePaymentIntentsRequest.mjs

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

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

@@ -0,0 +1,5 @@
+export type { CancelPaymentIntentsRequest } from "./CancelPaymentIntentsRequest.mjs";
+export type { CreatePaymentIntentsRequest } from "./CreatePaymentIntentsRequest.mjs";
+export type { GetPaymentIntentsRequest } from "./GetPaymentIntentsRequest.mjs";
+export type { ListPaymentIntentsRequest } from "./ListPaymentIntentsRequest.mjs";
+export type { UpdatePaymentIntentsRequest } from "./UpdatePaymentIntentsRequest.mjs";

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

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

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

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

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

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

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

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

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

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

package/dist/esm/api/resources/paymentIntents/types/CancelPaymentIntentsResponse.d.mts

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

package/dist/esm/api/resources/paymentIntents/types/CancelPaymentIntentsResponse.mjs

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

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsRequestCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency code. USD only. */
+export declare const CreatePaymentIntentsRequestCurrency: {
+    readonly Usd: "USD";
+};
+export type CreatePaymentIntentsRequestCurrency = (typeof CreatePaymentIntentsRequestCurrency)[keyof typeof CreatePaymentIntentsRequestCurrency];

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsRequestCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency code. USD only. */
+export const CreatePaymentIntentsRequestCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsRequestLineItemsItem.d.mts

@@ -0,0 +1,14 @@
+export interface CreatePaymentIntentsRequestLineItemsItem {
+    /** Your reference for the line, such as a SKU. */
+    referenceId?: string;
+    /** What this line sells. */
+    description: string;
+    /** Unit count. */
+    quantity: number;
+    /** Per-unit amount in cents. */
+    unitAmount: number;
+    /** Total tax for this line in cents. Defaults to zero. */
+    taxAmount?: number;
+    /** Your tax code for this line. */
+    taxCode?: string;
+}

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsRequestLineItemsItem.mjs

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

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsRequestTaxMode.d.mts

@@ -0,0 +1,6 @@
+/** Whether tax is added to or included in line amounts. */
+export declare const CreatePaymentIntentsRequestTaxMode: {
+    readonly Exclusive: "exclusive";
+    readonly Inclusive: "inclusive";
+};
+export type CreatePaymentIntentsRequestTaxMode = (typeof CreatePaymentIntentsRequestTaxMode)[keyof typeof CreatePaymentIntentsRequestTaxMode];

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsRequestTaxMode.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether tax is added to or included in line amounts. */
+export const CreatePaymentIntentsRequestTaxMode = {
+    Exclusive: "exclusive",
+    Inclusive: "inclusive",
+};

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsResponse.d.mts

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

package/dist/esm/api/resources/paymentIntents/types/CreatePaymentIntentsResponse.mjs

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

package/dist/esm/api/resources/paymentIntents/types/GetPaymentIntentsResponse.d.mts

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

package/dist/esm/api/resources/paymentIntents/types/GetPaymentIntentsResponse.mjs

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

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsRequestStatus.d.mts

@@ -0,0 +1,10 @@
+/** Only intents with this status. */
+export declare const ListPaymentIntentsRequestStatus: {
+    readonly Open: "open";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Canceled: "canceled";
+    readonly Declined: "declined";
+    readonly Expired: "expired";
+};
+export type ListPaymentIntentsRequestStatus = (typeof ListPaymentIntentsRequestStatus)[keyof typeof ListPaymentIntentsRequestStatus];

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsRequestStatus.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Only intents with this status. */
+export const ListPaymentIntentsRequestStatus = {
+    Open: "open",
+    Processing: "processing",
+    Completed: "completed",
+    Canceled: "canceled",
+    Declined: "declined",
+    Expired: "expired",
+};

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsResponse.d.mts

@@ -0,0 +1,5 @@
+import type * as Natural from "../../../index.mjs";
+export interface ListPaymentIntentsResponse {
+    data: Natural.PaymentIntent[];
+    meta: Natural.ListPaymentIntentsResponseMeta;
+}

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsResponse.mjs

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

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsResponseMeta.d.mts

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

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsResponseMeta.mjs

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

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsResponseMetaPagination.d.mts

@@ -0,0 +1,6 @@
+export interface ListPaymentIntentsResponseMetaPagination {
+    /** Whether more results are available. */
+    hasMore: boolean;
+    /** Cursor for the next page, or null when there are no more results. */
+    nextCursor: string | null;
+}

package/dist/esm/api/resources/paymentIntents/types/ListPaymentIntentsResponseMetaPagination.mjs

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

package/dist/esm/api/resources/paymentIntents/types/UpdatePaymentIntentsRequestLineItemsItem.d.mts

@@ -0,0 +1,14 @@
+export interface UpdatePaymentIntentsRequestLineItemsItem {
+    /** Your reference for the line, such as a SKU. */
+    referenceId?: string;
+    /** What this line sells. */
+    description: string;
+    /** Unit count. */
+    quantity: number;
+    /** Per-unit amount in cents. */
+    unitAmount: number;
+    /** Total tax for this line in cents. Defaults to zero. */
+    taxAmount?: number;
+    /** Your tax code for this line. */
+    taxCode?: string;
+}

package/dist/esm/api/resources/paymentIntents/types/UpdatePaymentIntentsRequestLineItemsItem.mjs

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

package/dist/esm/api/resources/paymentIntents/types/UpdatePaymentIntentsRequestTaxMode.d.mts

@@ -0,0 +1,6 @@
+/** Whether tax is added to or included in line amounts. */
+export declare const UpdatePaymentIntentsRequestTaxMode: {
+    readonly Exclusive: "exclusive";
+    readonly Inclusive: "inclusive";
+};
+export type UpdatePaymentIntentsRequestTaxMode = (typeof UpdatePaymentIntentsRequestTaxMode)[keyof typeof UpdatePaymentIntentsRequestTaxMode];

package/dist/esm/api/resources/paymentIntents/types/UpdatePaymentIntentsRequestTaxMode.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether tax is added to or included in line amounts. */
+export const UpdatePaymentIntentsRequestTaxMode = {
+    Exclusive: "exclusive",
+    Inclusive: "inclusive",
+};

package/dist/esm/api/resources/paymentIntents/types/UpdatePaymentIntentsResponse.d.mts

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

package/dist/esm/api/resources/paymentIntents/types/UpdatePaymentIntentsResponse.mjs

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

package/dist/esm/api/resources/paymentIntents/types/index.d.mts

@@ -0,0 +1,13 @@
+export * from "./CancelPaymentIntentsResponse.mjs";
+export * from "./CreatePaymentIntentsRequestCurrency.mjs";
+export * from "./CreatePaymentIntentsRequestLineItemsItem.mjs";
+export * from "./CreatePaymentIntentsRequestTaxMode.mjs";
+export * from "./CreatePaymentIntentsResponse.mjs";
+export * from "./GetPaymentIntentsResponse.mjs";
+export * from "./ListPaymentIntentsRequestStatus.mjs";
+export * from "./ListPaymentIntentsResponse.mjs";
+export * from "./ListPaymentIntentsResponseMeta.mjs";
+export * from "./ListPaymentIntentsResponseMetaPagination.mjs";
+export * from "./UpdatePaymentIntentsRequestLineItemsItem.mjs";
+export * from "./UpdatePaymentIntentsRequestTaxMode.mjs";
+export * from "./UpdatePaymentIntentsResponse.mjs";

package/dist/esm/api/resources/paymentIntents/types/index.mjs

@@ -0,0 +1,13 @@
+export * from "./CancelPaymentIntentsResponse.mjs";
+export * from "./CreatePaymentIntentsRequestCurrency.mjs";
+export * from "./CreatePaymentIntentsRequestLineItemsItem.mjs";
+export * from "./CreatePaymentIntentsRequestTaxMode.mjs";
+export * from "./CreatePaymentIntentsResponse.mjs";
+export * from "./GetPaymentIntentsResponse.mjs";
+export * from "./ListPaymentIntentsRequestStatus.mjs";
+export * from "./ListPaymentIntentsResponse.mjs";
+export * from "./ListPaymentIntentsResponseMeta.mjs";
+export * from "./ListPaymentIntentsResponseMetaPagination.mjs";
+export * from "./UpdatePaymentIntentsRequestLineItemsItem.mjs";
+export * from "./UpdatePaymentIntentsRequestTaxMode.mjs";
+export * from "./UpdatePaymentIntentsResponse.mjs";

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

@@ -0,0 +1,100 @@
+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 RefundsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Return card payments to the payer
+ */
+export declare class RefundsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RefundsClient.Options>;
+    constructor(options?: RefundsClient.Options);
+    /**
+     * List refunds, newest first
+     *
+     * @param {Natural.ListRefundsRequest} request
+     * @param {RefundsClient.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.refunds.list()
+     */
+    list(request?: Natural.ListRefundsRequest, requestOptions?: RefundsClient.RequestOptions): Promise<core.Page<Natural.Refund, Natural.ListRefundsResponse>>;
+    /**
+     * Refund a card payment
+     *
+     * @param {Natural.CreateRefundsRequest} request
+     * @param {RefundsClient.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.refunds.create({
+     *         idempotencyKey: "Idempotency-Key",
+     *         paymentIntentId: "pmi_019d0a1b2c3d4e5f60718293a4b5c6d7",
+     *         amount: 1000,
+     *         reason: "requestedByPayer"
+     *     })
+     */
+    create(request: Natural.CreateRefundsRequest, requestOptions?: RefundsClient.RequestOptions): core.HttpResponsePromise<Natural.CreateRefundsResponse>;
+    private __create;
+    /**
+     * Get a refund
+     *
+     * @param {Natural.GetRefundsRequest} request
+     * @param {RefundsClient.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.refunds.get({
+     *         refundId: "refundId"
+     *     })
+     */
+    get(request: Natural.GetRefundsRequest, requestOptions?: RefundsClient.RequestOptions): core.HttpResponsePromise<Natural.GetRefundsResponse>;
+    private __get;
+}