@payabli/sdk-node 0.0.135 → 0.0.137

package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @example
+ *     {
+ *         vendorId: 42,
+ *         expenseLimit: 500,
+ *         amount: 500,
+ *         maxNumberOfUses: 3,
+ *         exactAmount: false,
+ *         expenseLimitPeriod: "monthly",
+ *         billingCycle: "monthly",
+ *         billingCycleDay: "1",
+ *         dailyTransactionCount: 5,
+ *         dailyAmountLimit: 200,
+ *         transactionAmountLimit: 100,
+ *         mcc: "5411",
+ *         tcc: "R",
+ *         misc1: "PO-98765",
+ *         misc2: "Dept-Finance"
+ *     }
+ */
+export interface CreateGhostCardRequestBody {
+    /** ID of the vendor who receives the card. The vendor must belong to the paypoint and have an active status. */
+    vendorId: number;
+    /** Spending limit for the card. Must be greater than `0` and can't exceed the paypoint's configured payout credit limit. */
+    expenseLimit: number;
+    /** Requested expiration date for the card. If not provided, defaults to 30 days from creation. */
+    expirationDate?: string;
+    /** Initial load amount for the card. */
+    amount: number;
+    /** Maximum number of times the card can be used. Ignored and set to `1` when `exactAmount` is `true`. */
+    maxNumberOfUses: number;
+    /** When `true`, restricts the card to a single use. `maxNumberOfUses` is automatically set to `1` regardless of any other value provided. */
+    exactAmount: boolean;
+    /** Time period over which `expenseLimit` applies (for example, `monthly` or `weekly`). */
+    expenseLimitPeriod: string;
+    /** Billing cycle identifier. */
+    billingCycle: string;
+    /** Day within the billing cycle. */
+    billingCycleDay: string;
+    /** Maximum number of transactions allowed per day. */
+    dailyTransactionCount: number;
+    /** Maximum total spend allowed per day. */
+    dailyAmountLimit: number;
+    /** Maximum spend allowed per single transaction. */
+    transactionAmountLimit: number;
+    /** Merchant Category Code to restrict where the card can be used. Must be a valid MCC if provided. */
+    mcc?: string;
+    /** Transaction Category Code to restrict where the card can be used. Must be a valid TCC if provided. */
+    tcc?: string;
+    /** Custom metadata field. Stored on the card record. */
+    misc1?: string;
+    /** Custom metadata field. Stored on the card record. */
+    misc2?: string;
+}

package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.ts

@@ -0,0 +1,14 @@
+import type * as Payabli from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         cardToken: "gc_abc123def456",
+ *         status: "Cancelled"
+ *     }
+ */
+export interface UpdateCardRequestBody {
+    /** Token that uniquely identifies the card. This is the `ReferenceId` returned when the card was created. */
+    cardToken: string;
+    /** The new status to set on the card. */
+    status?: Payabli.CardStatus;
+}

package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/ghostCard/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export type { CreateGhostCardRequestBody } from "./CreateGhostCardRequestBody.js";
+export type { UpdateCardRequestBody } from "./UpdateCardRequestBody.js";

package/dist/cjs/api/resources/ghostCard/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/ghostCard/exports.d.ts

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

package/dist/cjs/api/resources/ghostCard/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GhostCardClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "GhostCardClient", { enumerable: true, get: function () { return Client_js_1.GhostCardClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/ghostCard/index.d.ts

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

package/dist/cjs/api/resources/ghostCard/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/ghostCard/types/CardStatus.d.ts

@@ -0,0 +1,8 @@
+/** The status to set on the card. Not all transitions are valid: `Active` can change to `Inactive`, `Cancelled`, or `Expired`. `Inactive` can change to `Active`. `Expired` can change to `Active` (renews the card). `Cancelled` is terminal and can't be changed. */
+export declare const CardStatus: {
+    readonly Active: "Active";
+    readonly Inactive: "Inactive";
+    readonly Cancelled: "Cancelled";
+    readonly Expired: "Expired";
+};
+export type CardStatus = (typeof CardStatus)[keyof typeof CardStatus];

package/dist/cjs/api/resources/ghostCard/types/CardStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardStatus = void 0;
+/** The status to set on the card. Not all transitions are valid: `Active` can change to `Inactive`, `Cancelled`, or `Expired`. `Inactive` can change to `Active`. `Expired` can change to `Active` (renews the card). `Cancelled` is terminal and can't be changed. */
+exports.CardStatus = {
+    Active: "Active",
+    Inactive: "Inactive",
+    Cancelled: "Cancelled",
+    Expired: "Expired",
+};

package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.d.ts

@@ -0,0 +1,17 @@
+import type * as Payabli from "../../../index.js";
+/**
+ * Response for creating a ghost card.
+ */
+export interface CreateGhostCardResponse {
+    isSuccess?: Payabli.IsSuccess | undefined;
+    responseText: Payabli.ResponseText;
+    responseData?: CreateGhostCardResponse.ResponseData | undefined;
+}
+export declare namespace CreateGhostCardResponse {
+    interface ResponseData {
+        /** Card token for the ghost card. Use this value to reference the card in subsequent operations (update, cancel, etc.). */
+        ReferenceId?: string | undefined;
+        ResultCode?: Payabli.ResultCode | undefined;
+        ResultText?: Payabli.Resulttext | undefined;
+    }
+}

package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/ghostCard/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./CardStatus.js";
+export * from "./CreateGhostCardResponse.js";

package/dist/cjs/api/resources/ghostCard/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CardStatus.js"), exports);
+__exportStar(require("./CreateGhostCardResponse.js"), exports);

package/dist/cjs/api/resources/index.d.ts

@@ -18,6 +18,9 @@ export * as customer from "./customer/index.js";
 export * from "./export/client/requests/index.js";
 export * as export_ from "./export/index.js";
 export * from "./export/types/index.js";
+export * from "./ghostCard/client/requests/index.js";
+export * as ghostCard from "./ghostCard/index.js";
+export * from "./ghostCard/types/index.js";
 export * from "./hostedPaymentPages/client/requests/index.js";
 export * as hostedPaymentPages from "./hostedPaymentPages/index.js";
 export * from "./import/client/requests/index.js";
@@ -52,6 +55,9 @@ export * from "./paymentLink/types/index.js";
 export * from "./paymentMethodDomain/client/requests/index.js";
 export * as paymentMethodDomain from "./paymentMethodDomain/index.js";
 export * from "./paymentMethodDomain/types/index.js";
+export * from "./payoutSubscription/client/requests/index.js";
+export * as payoutSubscription from "./payoutSubscription/index.js";
+export * from "./payoutSubscription/types/index.js";
 export * from "./paypoint/client/requests/index.js";
 export * as paypoint from "./paypoint/index.js";
 export * from "./paypoint/types/index.js";

package/dist/cjs/api/resources/index.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wallet = exports.vendor = exports.v2MoneyInTypes = exports.user = exports.tokenStorage = exports.templates = exports.subscription = exports.statistic = exports.queryTypes = exports.query = exports.paypoint = exports.paymentMethodDomain = exports.paymentLink = exports.organization = exports.ocr = exports.notificationlogs = exports.notification = exports.moneyOutTypes = exports.moneyOut = exports.moneyIn = exports.lineItem = exports.invoice = exports.import_ = exports.hostedPaymentPages = exports.export_ = exports.customer = exports.cloud = exports.checkCapture = exports.chargeBacks = exports.boarding = exports.bill = void 0;
+exports.wallet = exports.vendor = exports.v2MoneyInTypes = exports.user = exports.tokenStorage = exports.templates = exports.subscription = exports.statistic = exports.queryTypes = exports.query = exports.paypoint = exports.payoutSubscription = exports.paymentMethodDomain = exports.paymentLink = exports.organization = exports.ocr = exports.notificationlogs = exports.notification = exports.moneyOutTypes = exports.moneyOut = exports.moneyIn = exports.lineItem = exports.invoice = exports.import_ = exports.hostedPaymentPages = exports.ghostCard = exports.export_ = exports.customer = exports.cloud = exports.checkCapture = exports.chargeBacks = exports.boarding = exports.bill = void 0;
 __exportStar(require("./bill/client/requests/index.js"), exports);
 exports.bill = __importStar(require("./bill/index.js"));
 __exportStar(require("./bill/types/index.js"), exports);
@@ -57,6 +57,9 @@ exports.customer = __importStar(require("./customer/index.js"));
 __exportStar(require("./export/client/requests/index.js"), exports);
 exports.export_ = __importStar(require("./export/index.js"));
 __exportStar(require("./export/types/index.js"), exports);
+__exportStar(require("./ghostCard/client/requests/index.js"), exports);
+exports.ghostCard = __importStar(require("./ghostCard/index.js"));
+__exportStar(require("./ghostCard/types/index.js"), exports);
 __exportStar(require("./hostedPaymentPages/client/requests/index.js"), exports);
 exports.hostedPaymentPages = __importStar(require("./hostedPaymentPages/index.js"));
 __exportStar(require("./import/client/requests/index.js"), exports);
@@ -91,6 +94,9 @@ __exportStar(require("./paymentLink/types/index.js"), exports);
 __exportStar(require("./paymentMethodDomain/client/requests/index.js"), exports);
 exports.paymentMethodDomain = __importStar(require("./paymentMethodDomain/index.js"));
 __exportStar(require("./paymentMethodDomain/types/index.js"), exports);
+__exportStar(require("./payoutSubscription/client/requests/index.js"), exports);
+exports.payoutSubscription = __importStar(require("./payoutSubscription/index.js"));
+__exportStar(require("./payoutSubscription/types/index.js"), exports);
 __exportStar(require("./paypoint/client/requests/index.js"), exports);
 exports.paypoint = __importStar(require("./paypoint/index.js"));
 __exportStar(require("./paypoint/types/index.js"), exports);

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

@@ -0,0 +1,156 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Payabli from "../../../index.js";
+export declare namespace PayoutSubscriptionClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PayoutSubscriptionClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PayoutSubscriptionClient.Options>;
+    constructor(options?: PayoutSubscriptionClient.Options);
+    /**
+     * Creates a payout subscription to automatically send payouts to a vendor on a recurring schedule. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for a step-by-step guide.
+     *
+     * @param {Payabli.RequestPayoutSchedule} request
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.createPayoutSubscription({
+     *         body: {
+     *             entryPoint: "d193cf9a46",
+     *             paymentMethod: {
+     *                 method: "ach",
+     *                 achHolder: "Herman Coatings",
+     *                 achRouting: "021000021",
+     *                 achAccount: "3453445666",
+     *                 achAccountType: "checking"
+     *             },
+     *             paymentDetails: {
+     *                 totalAmount: 500,
+     *                 serviceFee: 0,
+     *                 currency: "USD"
+     *             },
+     *             vendorData: {
+     *                 vendorId: 1501
+     *             },
+     *             billData: [{
+     *                     invoiceNumber: "INV-5001",
+     *                     netAmount: "500",
+     *                     invoiceDate: "2025-08-01",
+     *                     dueDate: "2025-08-15"
+     *                 }],
+     *             scheduleDetails: {
+     *                 startDate: "09/01/2025",
+     *                 endDate: "09/01/2026",
+     *                 frequency: "monthly"
+     *             }
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.payoutSubscription.createPayoutSubscription({
+     *         body: {
+     *             entryPoint: "d193cf9a46",
+     *             paymentMethod: {
+     *                 method: "vcard"
+     *             },
+     *             paymentDetails: {
+     *                 totalAmount: 250,
+     *                 serviceFee: 0
+     *             },
+     *             vendorData: {
+     *                 vendorId: 1501
+     *             },
+     *             billData: [{
+     *                     invoiceNumber: "INV-7820",
+     *                     netAmount: "250",
+     *                     invoiceDate: "2025-08-15",
+     *                     dueDate: "2025-09-01"
+     *                 }],
+     *             scheduleDetails: {
+     *                 startDate: "09/01/2025",
+     *                 frequency: "weekly",
+     *                 endDate: "untilcancelled"
+     *             }
+     *         }
+     *     })
+     */
+    createPayoutSubscription(request: Payabli.RequestPayoutSchedule, requestOptions?: PayoutSubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.AddPayoutSubscriptionResponse>;
+    private __createPayoutSubscription;
+    /**
+     * Retrieves a single payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} id - The payout subscription ID.
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.getPayoutSubscription(42)
+     */
+    getPayoutSubscription(id: number, requestOptions?: PayoutSubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.GetPayoutSubscriptionResponse>;
+    private __getPayoutSubscription;
+    /**
+     * Updates a payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} id - The payout subscription ID.
+     * @param {Payabli.UpdatePayoutSubscriptionBody} request
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.updatePayoutSubscription(42, {
+     *         setPause: true
+     *     })
+     *
+     * @example
+     *     await client.payoutSubscription.updatePayoutSubscription(42, {
+     *         setPause: false
+     *     })
+     *
+     * @example
+     *     await client.payoutSubscription.updatePayoutSubscription(42, {
+     *         paymentDetails: {
+     *             serviceFee: 0,
+     *             totalAmount: 750
+     *         },
+     *         scheduleDetails: {
+     *             endDate: "12/31/2026",
+     *             frequency: "monthly",
+     *             startDate: "01/01/2026"
+     *         }
+     *     })
+     */
+    updatePayoutSubscription(id: number, request: Payabli.UpdatePayoutSubscriptionBody, requestOptions?: PayoutSubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.UpdatePayoutSubscriptionResponse>;
+    private __updatePayoutSubscription;
+    /**
+     * Deletes a payout subscription and prevents future payouts. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} id - The payout subscription ID.
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.deletePayoutSubscription(42)
+     */
+    deletePayoutSubscription(id: number, requestOptions?: PayoutSubscriptionClient.RequestOptions): core.HttpResponsePromise<Payabli.DeletePayoutSubscriptionResponse>;
+    private __deletePayoutSubscription;
+}