@payabli/sdk-node 0.0.136 → 0.0.138

package/LICENSE.md

@@ -1,8 +1,7 @@
-Copyright (c) 2026 Payabli, Inc.
+Copyright (c) 2026 Payabli Inc.
 
-All Rights Reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-This source code is the proprietary property of Payabli, Inc. 
-The source code contained herein is made available for inspection 
-and reference purposes only. No license is granted to use, modify, 
-distribute, or create derivative works from this source code.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -10,6 +10,8 @@ The Payabli TypeScript library provides convenient access to the Payabli APIs fr
 - [Documentation](#documentation)
 - [Installation](#installation)
 - [Reference](#reference)
+- [Changelog](#changelog)
+- [Getting Started](#getting-started)
 - [Usage](#usage)
 - [Environments](#environments)
 - [Request and Response Types](#request-and-response-types)
@@ -42,6 +44,16 @@ npm i -s @payabli/sdk-node
 
 A full reference for this library is available [here](https://github.com/payabli/sdk-node/blob/HEAD/./reference.md).
 
+## Changelog
+
+The changelog for the official Payabli TypeScript SDK is available on the Payabli Docs site. See [TypeScript SDK Changelog](https://docs.payabli.com/changelog/typescript-sdk) for more information.
+
+
+## Getting Started
+
+Visit the Payabli Docs site to get started with the official Payabli TypeScript SDK. See [Use the TypeScript SDK](https://docs.payabli.com/developers/platform-sdk-typescript-guide) for more information.
+
+
 ## Usage
 
 Instantiate and use the client with the following:

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@payabli/sdk-node",
-        "X-Fern-SDK-Version": "0.0.136",
-        "User-Agent": "@payabli/sdk-node/0.0.136",
+        "X-Fern-SDK-Version": "0.0.138",
+        "User-Agent": "@payabli/sdk-node/0.0.138",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -15,6 +15,8 @@ export declare class GhostCardClient {
      *
      * Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
      *
+     * Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
+     *
      * @param {Payabli.Entry} entry
      * @param {Payabli.CreateGhostCardRequestBody} request
      * @param {GhostCardClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -28,6 +30,7 @@ export declare class GhostCardClient {
      *     await client.ghostCard.createGhostCard("8cfec2e0fa", {
      *         vendorId: 42,
      *         expenseLimit: 500,
+     *         amount: 500,
      *         maxNumberOfUses: 3,
      *         exactAmount: false,
      *         expenseLimitPeriod: "monthly",

package/dist/cjs/api/resources/ghostCard/client/Client.js

@@ -60,6 +60,8 @@ class GhostCardClient {
      *
      * Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
      *
+     * Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
+     *
      * @param {Payabli.Entry} entry
      * @param {Payabli.CreateGhostCardRequestBody} request
      * @param {GhostCardClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -73,6 +75,7 @@ class GhostCardClient {
      *     await client.ghostCard.createGhostCard("8cfec2e0fa", {
      *         vendorId: 42,
      *         expenseLimit: 500,
+     *         amount: 500,
      *         maxNumberOfUses: 3,
      *         exactAmount: false,
      *         expenseLimitPeriod: "monthly",

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

@@ -3,6 +3,7 @@
  *     {
  *         vendorId: 42,
  *         expenseLimit: 500,
+ *         amount: 500,
  *         maxNumberOfUses: 3,
  *         exactAmount: false,
  *         expenseLimitPeriod: "monthly",
@@ -24,24 +25,24 @@ export interface CreateGhostCardRequestBody {
     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. Defaults to `0`. */
-    amount?: number;
-    /** Maximum number of times the card can be used. If `0` or negative, defaults to `9999`. Ignored and set to `1` when `exactAmount` is `true`. */
-    maxNumberOfUses?: number;
+    /** 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`). No server-side enforcement. */
-    expenseLimitPeriod?: string;
+    exactAmount: boolean;
+    /** Time period over which `expenseLimit` applies (for example, `monthly` or `weekly`). */
+    expenseLimitPeriod: string;
     /** Billing cycle identifier. */
-    billingCycle?: string;
+    billingCycle: string;
     /** Day within the billing cycle. */
-    billingCycleDay?: string;
-    /** Maximum number of transactions allowed per day. Defaults to `0` (unlimited). */
-    dailyTransactionCount?: number;
-    /** Maximum total spend allowed per day. Defaults to `0` (unlimited). */
-    dailyAmountLimit?: number;
-    /** Maximum spend allowed per single transaction. Defaults to `0` (unlimited). */
-    transactionAmountLimit?: number;
+    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. */

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.136";
+export declare const SDK_VERSION = "0.0.138";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.136";
+exports.SDK_VERSION = "0.0.138";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@payabli/sdk-node",
-        "X-Fern-SDK-Version": "0.0.136",
-        "User-Agent": "@payabli/sdk-node/0.0.136",
+        "X-Fern-SDK-Version": "0.0.138",
+        "User-Agent": "@payabli/sdk-node/0.0.138",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -15,6 +15,8 @@ export declare class GhostCardClient {
      *
      * Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
      *
+     * Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
+     *
      * @param {Payabli.Entry} entry
      * @param {Payabli.CreateGhostCardRequestBody} request
      * @param {GhostCardClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -28,6 +30,7 @@ export declare class GhostCardClient {
      *     await client.ghostCard.createGhostCard("8cfec2e0fa", {
      *         vendorId: 42,
      *         expenseLimit: 500,
+     *         amount: 500,
      *         maxNumberOfUses: 3,
      *         exactAmount: false,
      *         expenseLimitPeriod: "monthly",

package/dist/esm/api/resources/ghostCard/client/Client.mjs

@@ -24,6 +24,8 @@ export class GhostCardClient {
      *
      * Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
      *
+     * Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
+     *
      * @param {Payabli.Entry} entry
      * @param {Payabli.CreateGhostCardRequestBody} request
      * @param {GhostCardClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,6 +39,7 @@ export class GhostCardClient {
      *     await client.ghostCard.createGhostCard("8cfec2e0fa", {
      *         vendorId: 42,
      *         expenseLimit: 500,
+     *         amount: 500,
      *         maxNumberOfUses: 3,
      *         exactAmount: false,
      *         expenseLimitPeriod: "monthly",

package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.mts

@@ -3,6 +3,7 @@
  *     {
  *         vendorId: 42,
  *         expenseLimit: 500,
+ *         amount: 500,
  *         maxNumberOfUses: 3,
  *         exactAmount: false,
  *         expenseLimitPeriod: "monthly",
@@ -24,24 +25,24 @@ export interface CreateGhostCardRequestBody {
     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. Defaults to `0`. */
-    amount?: number;
-    /** Maximum number of times the card can be used. If `0` or negative, defaults to `9999`. Ignored and set to `1` when `exactAmount` is `true`. */
-    maxNumberOfUses?: number;
+    /** 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`). No server-side enforcement. */
-    expenseLimitPeriod?: string;
+    exactAmount: boolean;
+    /** Time period over which `expenseLimit` applies (for example, `monthly` or `weekly`). */
+    expenseLimitPeriod: string;
     /** Billing cycle identifier. */
-    billingCycle?: string;
+    billingCycle: string;
     /** Day within the billing cycle. */
-    billingCycleDay?: string;
-    /** Maximum number of transactions allowed per day. Defaults to `0` (unlimited). */
-    dailyTransactionCount?: number;
-    /** Maximum total spend allowed per day. Defaults to `0` (unlimited). */
-    dailyAmountLimit?: number;
-    /** Maximum spend allowed per single transaction. Defaults to `0` (unlimited). */
-    transactionAmountLimit?: number;
+    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. */

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.136";
+export declare const SDK_VERSION = "0.0.138";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.136";
+export const SDK_VERSION = "0.0.138";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@payabli/sdk-node",
-    "version": "0.0.136",
+    "version": "0.0.138",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -5161,6 +5161,8 @@ await client.export.exportVendorsOrg("csv", 123, {
 Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.
 
 Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
+
+Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
 </dd>
 </dl>
 </dd>
@@ -5178,6 +5180,7 @@ Unlike single-use virtual cards issued as part of a payout transaction, ghost ca
 await client.ghostCard.createGhostCard("8cfec2e0fa", {
     vendorId: 42,
     expenseLimit: 500,
+    amount: 500,
     maxNumberOfUses: 3,
     exactAmount: false,
     expenseLimitPeriod: "monthly",