@naturalpay/sdk 1.6.52 → 1.6.54

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": "@naturalpay/sdk",
-        "X-Fern-SDK-Version": "1.6.52",
-        "User-Agent": "@naturalpay/sdk/1.6.52",
+        "X-Fern-SDK-Version": "1.6.54",
+        "User-Agent": "@naturalpay/sdk/1.6.54",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Instance-ID": options === null || options === void 0 ? void 0 : options.instanceId,

package/dist/cjs/api/resources/ach/client/requests/NewAchParams.d.ts

@@ -17,18 +17,16 @@ export interface NewAchParams {
     idempotencyKey: string;
     /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
-    /** Direction of the payment. */
+    /** Direction of the payment. Direct ACH only sends money, so this is always credit. */
     direction: Natural.NewAchParamsDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. Defaults to USD. */
     currency?: Natural.NewAchParamsCurrency;
-    /** Wallet (wal_*) that funds an ACH credit or receives an ACH debit. Omit to use the party default for user or party API calls, or the agent default for the current customer connection when acting through a connected agent. Owned agents use their own agent default. */
+    /** Wallet (wal_*) that funds the ACH credit. Omit to use the party default for user or party API calls, or the agent default for the current customer connection when acting through a connected agent. Owned agents use their own agent default. */
     walletId?: string;
     /** External party account (epa_*) to pay. */
     externalPartyAccountId: string;
-    /** Mandate (mdt_*) authorizing the debit. Required for debits; not allowed for credits. */
-    mandateId?: string;
     /** ACH company entry description. Delivered to the receiving bank on the entry. Maximum 10 characters. */
     companyEntryDescription: string;
     /** Description for your internal reference. Never shared with the counterparty or the banking network. Maximum 255 characters. */

package/dist/cjs/api/resources/ach/types/NewAchParamsDirection.d.ts

@@ -1,6 +1,5 @@
-/** Direction of the payment. */
+/** Direction of the payment. Direct ACH only sends money, so this is always credit. */
 export declare const NewAchParamsDirection: {
-    readonly Debit: "debit";
     readonly Credit: "credit";
 };
 export type NewAchParamsDirection = (typeof NewAchParamsDirection)[keyof typeof NewAchParamsDirection];

package/dist/cjs/api/resources/ach/types/NewAchParamsDirection.js

@@ -2,8 +2,7 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NewAchParamsDirection = void 0;
-/** Direction of the payment. */
+/** Direction of the payment. Direct ACH only sends money, so this is always credit. */
 exports.NewAchParamsDirection = {
-    Debit: "debit",
     Credit: "credit",
 };

package/dist/cjs/api/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.d.ts

@@ -4,6 +4,8 @@ export interface ListCardsExternalAccountsResponseDataItemAttributes {
     brand: Natural.ListCardsExternalAccountsResponseDataItemAttributesBrand;
     /** Last four digits of the card number. */
     lastFour: string;
+    /** Name the customer gave the card, e.g. "Work Amex". Defaults to "<Brand> card ending <last4>". */
+    nickname: string;
     /** The card's billing address on file, for filling a merchant's checkout (the ZIP drives the bank's AVS check). */
     billingAddress: Natural.ListCardsExternalAccountsResponseDataItemAttributesBillingAddress | null;
     /** Lifecycle status of the external account. */

package/dist/cjs/api/resources/externalAccounts/types/RemoveCardExternalAccountsResponseDataAttributes.d.ts

@@ -4,6 +4,8 @@ export interface RemoveCardExternalAccountsResponseDataAttributes {
     brand: Natural.RemoveCardExternalAccountsResponseDataAttributesBrand;
     /** Last four digits of the card number. */
     lastFour: string;
+    /** Name the customer gave the card, e.g. "Work Amex". Defaults to "<Brand> card ending <last4>". */
+    nickname: string;
     /** The card's billing address on file, for filling a merchant's checkout (the ZIP drives the bank's AVS check). */
     billingAddress: Natural.RemoveCardExternalAccountsResponseDataAttributesBillingAddress | null;
     /** Lifecycle status of the external account. */

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

@@ -8,7 +8,7 @@ export declare namespace PaymentIntentsClient {
     }
 }
 /**
- * Accept card payments by link or voice
+ * Accept card payments by link or voice, or charge a saved card
  */
 export declare class PaymentIntentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PaymentIntentsClient.Options>;
@@ -39,7 +39,7 @@ export declare class PaymentIntentsClient {
      */
     list(request?: Natural.ListPaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): Promise<core.Page<Natural.PaymentIntent, Natural.ListPaymentIntentsResponse>>;
     /**
-     * Create a payment intent with a hosted checkout link
+     * Create a payment intent to collect a payment
      *
      * @param {Natural.CreatePaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -150,7 +150,7 @@ export declare class PaymentIntentsClient {
     update(request: Natural.UpdatePaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): core.HttpResponsePromise<Natural.UpdatePaymentIntentsResponse>;
     private __update;
     /**
-     * Cancel an open payment intent
+     * Cancel a payment intent that isn't paid yet
      *
      * @param {Natural.CancelPaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -65,7 +65,7 @@ const errors = __importStar(require("../../../../errors/index.js"));
 const serializers = __importStar(require("../../../../serialization/index.js"));
 const Natural = __importStar(require("../../../index.js"));
 /**
- * Accept card payments by link or voice
+ * Accept card payments by link or voice, or charge a saved card
  */
 class PaymentIntentsClient {
     constructor(options = {}) {
@@ -195,7 +195,7 @@ class PaymentIntentsClient {
         });
     }
     /**
-     * Create a payment intent with a hosted checkout link
+     * Create a payment intent to collect a payment
      *
      * @param {Natural.CreatePaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -532,7 +532,7 @@ class PaymentIntentsClient {
         });
     }
     /**
-     * Cancel an open payment intent
+     * Cancel a payment intent that isn't paid yet
      *
      * @param {Natural.CancelPaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/voiceSessions/client/requests/CreateVoiceSessionsRequest.d.ts

@@ -23,6 +23,6 @@ export interface CreateVoiceSessionsRequest {
     callerPhone: string;
     /** Your reference for this voice session. */
     referenceId?: string;
-    /** SIP URI to request a return transfer to when the payment call finishes. */
+    /** SIP URI with a public host to request a return transfer to when the payment call finishes. */
     returnTarget?: string;
 }

package/dist/cjs/api/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.d.ts

@@ -3,7 +3,6 @@ export declare const ListVoiceSessionsRequestStatus: {
     readonly AwaitingCall: "awaitingCall";
     readonly InProgress: "inProgress";
     readonly Ended: "ended";
-    readonly Failed: "failed";
     readonly Canceled: "canceled";
     readonly Expired: "expired";
 };

package/dist/cjs/api/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.js

@@ -7,7 +7,6 @@ exports.ListVoiceSessionsRequestStatus = {
     AwaitingCall: "awaitingCall",
     InProgress: "inProgress",
     Ended: "ended",
-    Failed: "failed",
     Canceled: "canceled",
     Expired: "expired",
 };

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

@@ -221,7 +221,7 @@ export declare class WalletsClient {
     unfreeze(request: Natural.UnfreezeWalletsRequest, requestOptions?: WalletsClient.RequestOptions): core.HttpResponsePromise<Natural.UnfreezeWalletsResponse>;
     private __unfreeze;
     /**
-     * List owned and customer-connected agents granted access to a wallet. Connected agents include customer connection limits and omit private metadata from the agent owner.
+     * List owned and customer-connected agents granted access to one of your wallets. Connected agents include customer connection limits and omit private metadata from the agent owner.
      *
      * @param {Natural.ListAgentsWalletsRequest} request
      * @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -785,7 +785,7 @@ class WalletsClient {
         });
     }
     /**
-     * List owned and customer-connected agents granted access to a wallet. Connected agents include customer connection limits and omit private metadata from the agent owner.
+     * List owned and customer-connected agents granted access to one of your wallets. Connected agents include customer connection limits and omit private metadata from the agent owner.
      *
      * @param {Natural.ListAgentsWalletsRequest} request
      * @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/wallets/client/requests/ListAgentsWalletsRequest.d.ts

@@ -5,7 +5,7 @@
  *     }
  */
 export interface ListAgentsWalletsRequest {
-    /** Wallet ID (wal_*). */
+    /** Wallet ID (wal_*) of a wallet your party owns. Any other wallet, including a connected customer's, returns 404. */
     walletId: string;
     /** Maximum results per page. */
     limit?: number;

package/dist/cjs/api/types/PaymentIntentRelationships.d.ts

@@ -2,7 +2,7 @@ import type * as Natural from "../index.js";
 export interface PaymentIntentRelationships {
     /** The party being paid. */
     customerParty: Natural.PaymentIntentRelationshipsCustomerParty;
-    /** Successful card payment. Null until a payment succeeds. */
+    /** The card payment the issuer approved. Null until one is approved. */
     cardPayment: Natural.PaymentIntentRelationshipsCardPayment;
     /** Latest voice session for this intent. Null when no session has been created. */
     voiceSession: Natural.PaymentIntentRelationshipsVoiceSession;

package/dist/cjs/api/types/PaymentIntentRelationshipsCardPayment.d.ts

@@ -1,6 +1,6 @@
 import type * as Natural from "../index.js";
 /**
- * Successful card payment. Null until a payment succeeds.
+ * The card payment the issuer approved. Null until one is approved.
  */
 export interface PaymentIntentRelationshipsCardPayment {
     /** Related resource identifier. */

package/dist/cjs/api/types/VoiceSessionAttributes.d.ts

@@ -8,14 +8,14 @@ export interface VoiceSessionAttributes {
     referenceId: string | null;
     /** Supplied caller phone number, or null for a session without one. */
     callerPhone: string | null;
-    /** Dial destination while the session accepts a call and you have permission to create payment voice sessions. Otherwise null. */
+    /** Dial destination while the session accepts a call and you have permission to create payment voice sessions. Otherwise null. Treat it as opaque: store it from the create response and never build it from the session ID. */
     dialUri: string | null;
     /** RFC 3339 deadline for starting the session's one permitted call. */
     dialExpiresAt: string;
     /** Requested return destination, or null. This does not confirm the destination answered. */
     returnTarget: string | null;
     call: Natural.VoiceSessionAttributesCall;
-    /** RFC 3339 time the session completed, or null. Set once the call has ended and the kind's block holds its result. `voiceSession.completed` fires then. */
+    /** RFC 3339 time the session closed, or null. Set once the call has ended and its result is known, or the session expired or was canceled. `voiceSession.completed` fires once then. */
     completedAt: string | null;
     /** RFC 3339 time the session was created. */
     createdAt: string;

package/dist/cjs/api/types/VoiceSessionAttributesStatus.d.ts

@@ -3,7 +3,6 @@ export declare const VoiceSessionAttributesStatus: {
     readonly AwaitingCall: "awaitingCall";
     readonly InProgress: "inProgress";
     readonly Ended: "ended";
-    readonly Failed: "failed";
     readonly Canceled: "canceled";
     readonly Expired: "expired";
 };

package/dist/cjs/api/types/VoiceSessionAttributesStatus.js

@@ -7,7 +7,6 @@ exports.VoiceSessionAttributesStatus = {
     AwaitingCall: "awaitingCall",
     InProgress: "inProgress",
     Ended: "ended",
-    Failed: "failed",
     Canceled: "canceled",
     Expired: "expired",
 };

package/dist/cjs/serialization/resources/ach/client/requests/NewAchParams.d.ts

@@ -12,7 +12,6 @@ export declare namespace NewAchParams {
         currency?: NewAchParamsCurrency.Raw | null;
         walletId?: string | null;
         externalPartyAccountId: string;
-        mandateId?: string | null;
         companyEntryDescription: string;
         internalDescription?: string | null;
         addenda?: string | null;

package/dist/cjs/serialization/resources/ach/client/requests/NewAchParams.js

@@ -45,7 +45,6 @@ exports.NewAchParams = core.serialization.object({
     currency: NewAchParamsCurrency_js_1.NewAchParamsCurrency.optional(),
     walletId: core.serialization.string().optional(),
     externalPartyAccountId: core.serialization.string(),
-    mandateId: core.serialization.string().optional(),
     companyEntryDescription: core.serialization.string(),
     internalDescription: core.serialization.string().optional(),
     addenda: core.serialization.string().optional(),

package/dist/cjs/serialization/resources/ach/types/NewAchParamsDirection.d.ts

@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.js";
 import type * as serializers from "../../../index.js";
 export declare const NewAchParamsDirection: core.serialization.Schema<serializers.NewAchParamsDirection.Raw, Natural.NewAchParamsDirection>;
 export declare namespace NewAchParamsDirection {
-    type Raw = "debit" | "credit";
+    type Raw = "credit";
 }

package/dist/cjs/serialization/resources/ach/types/NewAchParamsDirection.js

@@ -36,4 +36,4 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NewAchParamsDirection = void 0;
 const core = __importStar(require("../../../../core/index.js"));
-exports.NewAchParamsDirection = core.serialization.enum_(["debit", "credit"]);
+exports.NewAchParamsDirection = core.serialization.enum_(["credit"]);

package/dist/cjs/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.d.ts

@@ -9,6 +9,7 @@ export declare namespace ListCardsExternalAccountsResponseDataItemAttributes {
     interface Raw {
         brand: ListCardsExternalAccountsResponseDataItemAttributesBrand.Raw;
         lastFour: string;
+        nickname: string;
         billingAddress?: ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.Raw | null;
         status: ListCardsExternalAccountsResponseDataItemAttributesStatus.Raw;
         createdAt: string;

package/dist/cjs/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.js

@@ -42,6 +42,7 @@ const ListCardsExternalAccountsResponseDataItemAttributesStatus_js_1 = require("
 exports.ListCardsExternalAccountsResponseDataItemAttributes = core.serialization.object({
     brand: ListCardsExternalAccountsResponseDataItemAttributesBrand_js_1.ListCardsExternalAccountsResponseDataItemAttributesBrand,
     lastFour: core.serialization.string(),
+    nickname: core.serialization.string(),
     billingAddress: ListCardsExternalAccountsResponseDataItemAttributesBillingAddress_js_1.ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.nullable(),
     status: ListCardsExternalAccountsResponseDataItemAttributesStatus_js_1.ListCardsExternalAccountsResponseDataItemAttributesStatus,
     createdAt: core.serialization.date(),

package/dist/cjs/serialization/resources/externalAccounts/types/RemoveCardExternalAccountsResponseDataAttributes.d.ts

@@ -9,6 +9,7 @@ export declare namespace RemoveCardExternalAccountsResponseDataAttributes {
     interface Raw {
         brand: RemoveCardExternalAccountsResponseDataAttributesBrand.Raw;
         lastFour: string;
+        nickname: string;
         billingAddress?: RemoveCardExternalAccountsResponseDataAttributesBillingAddress.Raw | null;
         status: RemoveCardExternalAccountsResponseDataAttributesStatus.Raw;
         createdAt: string;

package/dist/cjs/serialization/resources/externalAccounts/types/RemoveCardExternalAccountsResponseDataAttributes.js

@@ -42,6 +42,7 @@ const RemoveCardExternalAccountsResponseDataAttributesStatus_js_1 = require("./R
 exports.RemoveCardExternalAccountsResponseDataAttributes = core.serialization.object({
     brand: RemoveCardExternalAccountsResponseDataAttributesBrand_js_1.RemoveCardExternalAccountsResponseDataAttributesBrand,
     lastFour: core.serialization.string(),
+    nickname: core.serialization.string(),
     billingAddress: RemoveCardExternalAccountsResponseDataAttributesBillingAddress_js_1.RemoveCardExternalAccountsResponseDataAttributesBillingAddress.nullable(),
     status: RemoveCardExternalAccountsResponseDataAttributesStatus_js_1.RemoveCardExternalAccountsResponseDataAttributesStatus,
     createdAt: core.serialization.date(),

package/dist/cjs/serialization/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.d.ts

@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.js";
 import type * as serializers from "../../../index.js";
 export declare const ListVoiceSessionsRequestStatus: core.serialization.Schema<serializers.ListVoiceSessionsRequestStatus.Raw, Natural.ListVoiceSessionsRequestStatus>;
 export declare namespace ListVoiceSessionsRequestStatus {
-    type Raw = "awaitingCall" | "inProgress" | "ended" | "failed" | "canceled" | "expired";
+    type Raw = "awaitingCall" | "inProgress" | "ended" | "canceled" | "expired";
 }

package/dist/cjs/serialization/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.js

@@ -36,4 +36,4 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListVoiceSessionsRequestStatus = void 0;
 const core = __importStar(require("../../../../core/index.js"));
-exports.ListVoiceSessionsRequestStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "failed", "canceled", "expired"]);
+exports.ListVoiceSessionsRequestStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "canceled", "expired"]);

package/dist/cjs/serialization/types/VoiceSessionAttributesStatus.d.ts

@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
 import type * as serializers from "../index.js";
 export declare const VoiceSessionAttributesStatus: core.serialization.Schema<serializers.VoiceSessionAttributesStatus.Raw, Natural.VoiceSessionAttributesStatus>;
 export declare namespace VoiceSessionAttributesStatus {
-    type Raw = "awaitingCall" | "inProgress" | "ended" | "failed" | "canceled" | "expired";
+    type Raw = "awaitingCall" | "inProgress" | "ended" | "canceled" | "expired";
 }

package/dist/cjs/serialization/types/VoiceSessionAttributesStatus.js

@@ -36,4 +36,4 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VoiceSessionAttributesStatus = void 0;
 const core = __importStar(require("../../core/index.js"));
-exports.VoiceSessionAttributesStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "failed", "canceled", "expired"]);
+exports.VoiceSessionAttributesStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "canceled", "expired"]);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.6.52";
+export declare const SDK_VERSION = "1.6.54";

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 = "1.6.52";
+exports.SDK_VERSION = "1.6.54";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@naturalpay/sdk",
-        "X-Fern-SDK-Version": "1.6.52",
-        "User-Agent": "@naturalpay/sdk/1.6.52",
+        "X-Fern-SDK-Version": "1.6.54",
+        "User-Agent": "@naturalpay/sdk/1.6.54",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Instance-ID": options === null || options === void 0 ? void 0 : options.instanceId,

package/dist/esm/api/resources/ach/client/requests/NewAchParams.d.mts

@@ -17,18 +17,16 @@ export interface NewAchParams {
     idempotencyKey: string;
     /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
-    /** Direction of the payment. */
+    /** Direction of the payment. Direct ACH only sends money, so this is always credit. */
     direction: Natural.NewAchParamsDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. Defaults to USD. */
     currency?: Natural.NewAchParamsCurrency;
-    /** Wallet (wal_*) that funds an ACH credit or receives an ACH debit. Omit to use the party default for user or party API calls, or the agent default for the current customer connection when acting through a connected agent. Owned agents use their own agent default. */
+    /** Wallet (wal_*) that funds the ACH credit. Omit to use the party default for user or party API calls, or the agent default for the current customer connection when acting through a connected agent. Owned agents use their own agent default. */
     walletId?: string;
     /** External party account (epa_*) to pay. */
     externalPartyAccountId: string;
-    /** Mandate (mdt_*) authorizing the debit. Required for debits; not allowed for credits. */
-    mandateId?: string;
     /** ACH company entry description. Delivered to the receiving bank on the entry. Maximum 10 characters. */
     companyEntryDescription: string;
     /** Description for your internal reference. Never shared with the counterparty or the banking network. Maximum 255 characters. */

package/dist/esm/api/resources/ach/types/NewAchParamsDirection.d.mts

@@ -1,6 +1,5 @@
-/** Direction of the payment. */
+/** Direction of the payment. Direct ACH only sends money, so this is always credit. */
 export declare const NewAchParamsDirection: {
-    readonly Debit: "debit";
     readonly Credit: "credit";
 };
 export type NewAchParamsDirection = (typeof NewAchParamsDirection)[keyof typeof NewAchParamsDirection];

package/dist/esm/api/resources/ach/types/NewAchParamsDirection.mjs

@@ -1,6 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** Direction of the payment. */
+/** Direction of the payment. Direct ACH only sends money, so this is always credit. */
 export const NewAchParamsDirection = {
-    Debit: "debit",
     Credit: "credit",
 };

package/dist/esm/api/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.d.mts

@@ -4,6 +4,8 @@ export interface ListCardsExternalAccountsResponseDataItemAttributes {
     brand: Natural.ListCardsExternalAccountsResponseDataItemAttributesBrand;
     /** Last four digits of the card number. */
     lastFour: string;
+    /** Name the customer gave the card, e.g. "Work Amex". Defaults to "<Brand> card ending <last4>". */
+    nickname: string;
     /** The card's billing address on file, for filling a merchant's checkout (the ZIP drives the bank's AVS check). */
     billingAddress: Natural.ListCardsExternalAccountsResponseDataItemAttributesBillingAddress | null;
     /** Lifecycle status of the external account. */

package/dist/esm/api/resources/externalAccounts/types/RemoveCardExternalAccountsResponseDataAttributes.d.mts

@@ -4,6 +4,8 @@ export interface RemoveCardExternalAccountsResponseDataAttributes {
     brand: Natural.RemoveCardExternalAccountsResponseDataAttributesBrand;
     /** Last four digits of the card number. */
     lastFour: string;
+    /** Name the customer gave the card, e.g. "Work Amex". Defaults to "<Brand> card ending <last4>". */
+    nickname: string;
     /** The card's billing address on file, for filling a merchant's checkout (the ZIP drives the bank's AVS check). */
     billingAddress: Natural.RemoveCardExternalAccountsResponseDataAttributesBillingAddress | null;
     /** Lifecycle status of the external account. */

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

@@ -8,7 +8,7 @@ export declare namespace PaymentIntentsClient {
     }
 }
 /**
- * Accept card payments by link or voice
+ * Accept card payments by link or voice, or charge a saved card
  */
 export declare class PaymentIntentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PaymentIntentsClient.Options>;
@@ -39,7 +39,7 @@ export declare class PaymentIntentsClient {
      */
     list(request?: Natural.ListPaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): Promise<core.Page<Natural.PaymentIntent, Natural.ListPaymentIntentsResponse>>;
     /**
-     * Create a payment intent with a hosted checkout link
+     * Create a payment intent to collect a payment
      *
      * @param {Natural.CreatePaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -150,7 +150,7 @@ export declare class PaymentIntentsClient {
     update(request: Natural.UpdatePaymentIntentsRequest, requestOptions?: PaymentIntentsClient.RequestOptions): core.HttpResponsePromise<Natural.UpdatePaymentIntentsResponse>;
     private __update;
     /**
-     * Cancel an open payment intent
+     * Cancel a payment intent that isn't paid yet
      *
      * @param {Natural.CancelPaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -29,7 +29,7 @@ import * as errors from "../../../../errors/index.mjs";
 import * as serializers from "../../../../serialization/index.mjs";
 import * as Natural from "../../../index.mjs";
 /**
- * Accept card payments by link or voice
+ * Accept card payments by link or voice, or charge a saved card
  */
 export class PaymentIntentsClient {
     constructor(options = {}) {
@@ -159,7 +159,7 @@ export class PaymentIntentsClient {
         });
     }
     /**
-     * Create a payment intent with a hosted checkout link
+     * Create a payment intent to collect a payment
      *
      * @param {Natural.CreatePaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -496,7 +496,7 @@ export class PaymentIntentsClient {
         });
     }
     /**
-     * Cancel an open payment intent
+     * Cancel a payment intent that isn't paid yet
      *
      * @param {Natural.CancelPaymentIntentsRequest} request
      * @param {PaymentIntentsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/voiceSessions/client/requests/CreateVoiceSessionsRequest.d.mts

@@ -23,6 +23,6 @@ export interface CreateVoiceSessionsRequest {
     callerPhone: string;
     /** Your reference for this voice session. */
     referenceId?: string;
-    /** SIP URI to request a return transfer to when the payment call finishes. */
+    /** SIP URI with a public host to request a return transfer to when the payment call finishes. */
     returnTarget?: string;
 }

package/dist/esm/api/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.d.mts

@@ -3,7 +3,6 @@ export declare const ListVoiceSessionsRequestStatus: {
     readonly AwaitingCall: "awaitingCall";
     readonly InProgress: "inProgress";
     readonly Ended: "ended";
-    readonly Failed: "failed";
     readonly Canceled: "canceled";
     readonly Expired: "expired";
 };

package/dist/esm/api/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.mjs

@@ -4,7 +4,6 @@ export const ListVoiceSessionsRequestStatus = {
     AwaitingCall: "awaitingCall",
     InProgress: "inProgress",
     Ended: "ended",
-    Failed: "failed",
     Canceled: "canceled",
     Expired: "expired",
 };

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

@@ -221,7 +221,7 @@ export declare class WalletsClient {
     unfreeze(request: Natural.UnfreezeWalletsRequest, requestOptions?: WalletsClient.RequestOptions): core.HttpResponsePromise<Natural.UnfreezeWalletsResponse>;
     private __unfreeze;
     /**
-     * List owned and customer-connected agents granted access to a wallet. Connected agents include customer connection limits and omit private metadata from the agent owner.
+     * List owned and customer-connected agents granted access to one of your wallets. Connected agents include customer connection limits and omit private metadata from the agent owner.
      *
      * @param {Natural.ListAgentsWalletsRequest} request
      * @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -749,7 +749,7 @@ export class WalletsClient {
         });
     }
     /**
-     * List owned and customer-connected agents granted access to a wallet. Connected agents include customer connection limits and omit private metadata from the agent owner.
+     * List owned and customer-connected agents granted access to one of your wallets. Connected agents include customer connection limits and omit private metadata from the agent owner.
      *
      * @param {Natural.ListAgentsWalletsRequest} request
      * @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/wallets/client/requests/ListAgentsWalletsRequest.d.mts

@@ -5,7 +5,7 @@
  *     }
  */
 export interface ListAgentsWalletsRequest {
-    /** Wallet ID (wal_*). */
+    /** Wallet ID (wal_*) of a wallet your party owns. Any other wallet, including a connected customer's, returns 404. */
     walletId: string;
     /** Maximum results per page. */
     limit?: number;

package/dist/esm/api/types/PaymentIntentRelationships.d.mts

@@ -2,7 +2,7 @@ import type * as Natural from "../index.mjs";
 export interface PaymentIntentRelationships {
     /** The party being paid. */
     customerParty: Natural.PaymentIntentRelationshipsCustomerParty;
-    /** Successful card payment. Null until a payment succeeds. */
+    /** The card payment the issuer approved. Null until one is approved. */
     cardPayment: Natural.PaymentIntentRelationshipsCardPayment;
     /** Latest voice session for this intent. Null when no session has been created. */
     voiceSession: Natural.PaymentIntentRelationshipsVoiceSession;

package/dist/esm/api/types/PaymentIntentRelationshipsCardPayment.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../index.mjs";
 /**
- * Successful card payment. Null until a payment succeeds.
+ * The card payment the issuer approved. Null until one is approved.
  */
 export interface PaymentIntentRelationshipsCardPayment {
     /** Related resource identifier. */

package/dist/esm/api/types/VoiceSessionAttributes.d.mts

@@ -8,14 +8,14 @@ export interface VoiceSessionAttributes {
     referenceId: string | null;
     /** Supplied caller phone number, or null for a session without one. */
     callerPhone: string | null;
-    /** Dial destination while the session accepts a call and you have permission to create payment voice sessions. Otherwise null. */
+    /** Dial destination while the session accepts a call and you have permission to create payment voice sessions. Otherwise null. Treat it as opaque: store it from the create response and never build it from the session ID. */
     dialUri: string | null;
     /** RFC 3339 deadline for starting the session's one permitted call. */
     dialExpiresAt: string;
     /** Requested return destination, or null. This does not confirm the destination answered. */
     returnTarget: string | null;
     call: Natural.VoiceSessionAttributesCall;
-    /** RFC 3339 time the session completed, or null. Set once the call has ended and the kind's block holds its result. `voiceSession.completed` fires then. */
+    /** RFC 3339 time the session closed, or null. Set once the call has ended and its result is known, or the session expired or was canceled. `voiceSession.completed` fires once then. */
     completedAt: string | null;
     /** RFC 3339 time the session was created. */
     createdAt: string;

package/dist/esm/api/types/VoiceSessionAttributesStatus.d.mts

@@ -3,7 +3,6 @@ export declare const VoiceSessionAttributesStatus: {
     readonly AwaitingCall: "awaitingCall";
     readonly InProgress: "inProgress";
     readonly Ended: "ended";
-    readonly Failed: "failed";
     readonly Canceled: "canceled";
     readonly Expired: "expired";
 };

package/dist/esm/api/types/VoiceSessionAttributesStatus.mjs

@@ -4,7 +4,6 @@ export const VoiceSessionAttributesStatus = {
     AwaitingCall: "awaitingCall",
     InProgress: "inProgress",
     Ended: "ended",
-    Failed: "failed",
     Canceled: "canceled",
     Expired: "expired",
 };

package/dist/esm/serialization/resources/ach/client/requests/NewAchParams.d.mts

@@ -12,7 +12,6 @@ export declare namespace NewAchParams {
         currency?: NewAchParamsCurrency.Raw | null;
         walletId?: string | null;
         externalPartyAccountId: string;
-        mandateId?: string | null;
         companyEntryDescription: string;
         internalDescription?: string | null;
         addenda?: string | null;

package/dist/esm/serialization/resources/ach/client/requests/NewAchParams.mjs

@@ -9,7 +9,6 @@ export const NewAchParams = core.serialization.object({
     currency: NewAchParamsCurrency.optional(),
     walletId: core.serialization.string().optional(),
     externalPartyAccountId: core.serialization.string(),
-    mandateId: core.serialization.string().optional(),
     companyEntryDescription: core.serialization.string(),
     internalDescription: core.serialization.string().optional(),
     addenda: core.serialization.string().optional(),

package/dist/esm/serialization/resources/ach/types/NewAchParamsDirection.d.mts

@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
 export declare const NewAchParamsDirection: core.serialization.Schema<serializers.NewAchParamsDirection.Raw, Natural.NewAchParamsDirection>;
 export declare namespace NewAchParamsDirection {
-    type Raw = "debit" | "credit";
+    type Raw = "credit";
 }

package/dist/esm/serialization/resources/ach/types/NewAchParamsDirection.mjs

@@ -1,3 +1,3 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
-export const NewAchParamsDirection = core.serialization.enum_(["debit", "credit"]);
+export const NewAchParamsDirection = core.serialization.enum_(["credit"]);

package/dist/esm/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.d.mts

@@ -9,6 +9,7 @@ export declare namespace ListCardsExternalAccountsResponseDataItemAttributes {
     interface Raw {
         brand: ListCardsExternalAccountsResponseDataItemAttributesBrand.Raw;
         lastFour: string;
+        nickname: string;
         billingAddress?: ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.Raw | null;
         status: ListCardsExternalAccountsResponseDataItemAttributesStatus.Raw;
         createdAt: string;

package/dist/esm/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.mjs

@@ -6,6 +6,7 @@ import { ListCardsExternalAccountsResponseDataItemAttributesStatus } from "./Lis
 export const ListCardsExternalAccountsResponseDataItemAttributes = core.serialization.object({
     brand: ListCardsExternalAccountsResponseDataItemAttributesBrand,
     lastFour: core.serialization.string(),
+    nickname: core.serialization.string(),
     billingAddress: ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.nullable(),
     status: ListCardsExternalAccountsResponseDataItemAttributesStatus,
     createdAt: core.serialization.date(),

package/dist/esm/serialization/resources/externalAccounts/types/RemoveCardExternalAccountsResponseDataAttributes.d.mts

@@ -9,6 +9,7 @@ export declare namespace RemoveCardExternalAccountsResponseDataAttributes {
     interface Raw {
         brand: RemoveCardExternalAccountsResponseDataAttributesBrand.Raw;
         lastFour: string;
+        nickname: string;
         billingAddress?: RemoveCardExternalAccountsResponseDataAttributesBillingAddress.Raw | null;
         status: RemoveCardExternalAccountsResponseDataAttributesStatus.Raw;
         createdAt: string;

package/dist/esm/serialization/resources/externalAccounts/types/RemoveCardExternalAccountsResponseDataAttributes.mjs

@@ -6,6 +6,7 @@ import { RemoveCardExternalAccountsResponseDataAttributesStatus } from "./Remove
 export const RemoveCardExternalAccountsResponseDataAttributes = core.serialization.object({
     brand: RemoveCardExternalAccountsResponseDataAttributesBrand,
     lastFour: core.serialization.string(),
+    nickname: core.serialization.string(),
     billingAddress: RemoveCardExternalAccountsResponseDataAttributesBillingAddress.nullable(),
     status: RemoveCardExternalAccountsResponseDataAttributesStatus,
     createdAt: core.serialization.date(),

package/dist/esm/serialization/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.d.mts

@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
 export declare const ListVoiceSessionsRequestStatus: core.serialization.Schema<serializers.ListVoiceSessionsRequestStatus.Raw, Natural.ListVoiceSessionsRequestStatus>;
 export declare namespace ListVoiceSessionsRequestStatus {
-    type Raw = "awaitingCall" | "inProgress" | "ended" | "failed" | "canceled" | "expired";
+    type Raw = "awaitingCall" | "inProgress" | "ended" | "canceled" | "expired";
 }

package/dist/esm/serialization/resources/voiceSessions/types/ListVoiceSessionsRequestStatus.mjs

@@ -1,3 +1,3 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
-export const ListVoiceSessionsRequestStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "failed", "canceled", "expired"]);
+export const ListVoiceSessionsRequestStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "canceled", "expired"]);

package/dist/esm/serialization/types/VoiceSessionAttributesStatus.d.mts

@@ -3,5 +3,5 @@ import * as core from "../../core/index.mjs";
 import type * as serializers from "../index.mjs";
 export declare const VoiceSessionAttributesStatus: core.serialization.Schema<serializers.VoiceSessionAttributesStatus.Raw, Natural.VoiceSessionAttributesStatus>;
 export declare namespace VoiceSessionAttributesStatus {
-    type Raw = "awaitingCall" | "inProgress" | "ended" | "failed" | "canceled" | "expired";
+    type Raw = "awaitingCall" | "inProgress" | "ended" | "canceled" | "expired";
 }

package/dist/esm/serialization/types/VoiceSessionAttributesStatus.mjs

@@ -1,3 +1,3 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../core/index.mjs";
-export const VoiceSessionAttributesStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "failed", "canceled", "expired"]);
+export const VoiceSessionAttributesStatus = core.serialization.enum_(["awaitingCall", "inProgress", "ended", "canceled", "expired"]);

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.6.52";
+export declare const SDK_VERSION = "1.6.54";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.6.52";
+export const SDK_VERSION = "1.6.54";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@naturalpay/sdk",
-    "version": "1.6.52",
+    "version": "1.6.54",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -3405,7 +3405,7 @@ const response = page.response;
 <dl>
 <dd>
 
-Create a payment intent with a hosted checkout link
+Create a payment intent to collect a payment
 </dd>
 </dl>
 </dd>
@@ -3627,7 +3627,7 @@ await client.paymentIntents.update({
 <dl>
 <dd>
 
-Cancel an open payment intent
+Cancel a payment intent that isn't paid yet
 </dd>
 </dl>
 </dd>
@@ -7559,7 +7559,7 @@ await client.wallets.unfreeze({
 <dl>
 <dd>
 
-List owned and customer-connected agents granted access to a wallet. Connected agents include customer connection limits and omit private metadata from the agent owner.
+List owned and customer-connected agents granted access to one of your wallets. Connected agents include customer connection limits and omit private metadata from the agent owner.
 </dd>
 </dl>
 </dd>