@naturalpay/sdk 1.6.33 → 1.6.35

package/dist/cjs/api/resources/externalAccounts/client/requests/ListExternalAccountsRequest.d.ts

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface ListExternalAccountsRequest {
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Customer party to read for (pty_*). Requires a connected agent with wallets.read permission. Omit to read your own party's banking information. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/externalAccounts/client/requests/RemoveExternalAccountsRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface RemoveExternalAccountsRequest {
+    /** External account ID (eac_*). */
     externalAccountId: string;
 }

package/dist/cjs/api/resources/externalParties/client/requests/CorrectAddressExternalPartiesRequest.d.ts

@@ -14,6 +14,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface CorrectAddressExternalPartiesRequest {
+    /** External party ID (epty_*). */
     externalPartyId: 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;

package/dist/cjs/api/resources/externalParties/client/requests/GetExternalPartiesRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetExternalPartiesRequest {
+    /** External party ID (epty_*). */
     externalPartyId: 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;
 }

package/dist/cjs/api/resources/externalParties/client/requests/ListExternalPartiesRequest.d.ts

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface ListExternalPartiesRequest {
+    /** 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;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/externalPartyAccounts/client/requests/GetExternalPartyAccountsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetExternalPartyAccountsRequest {
+    /** External party account ID (epa_*). */
     externalPartyAccountId: 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;
 }

package/dist/cjs/api/resources/externalPartyAccounts/client/requests/ListExternalPartyAccountsRequest.d.ts

@@ -5,8 +5,12 @@
  *     }
  */
 export interface ListExternalPartyAccountsRequest {
+    /** External party ID (epty_*). */
     externalPartyId: 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;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

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

@@ -1,9 +1,6 @@
 export * from "./ach/client/requests/index.js";
 export * as ach from "./ach/index.js";
 export * from "./ach/types/index.js";
-export * from "./agentCards/client/requests/index.js";
-export * as agentCards from "./agentCards/index.js";
-export * from "./agentCards/types/index.js";
 export * from "./agenticPayments/client/requests/index.js";
 export * as agenticPayments from "./agenticPayments/index.js";
 export * from "./agenticPayments/types/index.js";
@@ -25,9 +22,6 @@ export * from "./cardPayments/types/index.js";
 export * from "./cardSessions/client/requests/index.js";
 export * as cardSessions from "./cardSessions/index.js";
 export * from "./cardSessions/types/index.js";
-export * from "./cardTransactions/client/requests/index.js";
-export * as cardTransactions from "./cardTransactions/index.js";
-export * from "./cardTransactions/types/index.js";
 export * from "./chargebacks/client/requests/index.js";
 export * as chargebacks from "./chargebacks/index.js";
 export * from "./chargebacks/types/index.js";

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

@@ -36,13 +36,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wire = exports.webhooks = exports.wallets = exports.voiceSessions = exports.transfers = exports.transactions = exports.simulations = exports.refunds = exports.realtime = exports.payments = exports.paymentRequests = exports.paymentIntents = exports.parties = exports.invitations = exports.invitationLinks = exports.externalPartyAccounts = exports.externalParties = exports.externalAccounts = exports.events = exports.customers = exports.chargebacks = exports.cardTransactions = exports.cardSessions = exports.cardPayments = exports.approvals = exports.apiKeys = exports.agents = exports.agentKeys = exports.agenticPayments = exports.agentCards = exports.ach = void 0;
+exports.wire = exports.webhooks = exports.wallets = exports.voiceSessions = exports.transfers = exports.transactions = exports.simulations = exports.refunds = exports.realtime = exports.payments = exports.paymentRequests = exports.paymentIntents = exports.parties = exports.invitations = exports.invitationLinks = exports.externalPartyAccounts = exports.externalParties = exports.externalAccounts = exports.events = exports.customers = exports.chargebacks = exports.cardSessions = exports.cardPayments = exports.approvals = exports.apiKeys = exports.agents = exports.agentKeys = exports.agenticPayments = exports.ach = void 0;
 __exportStar(require("./ach/client/requests/index.js"), exports);
 exports.ach = __importStar(require("./ach/index.js"));
 __exportStar(require("./ach/types/index.js"), exports);
-__exportStar(require("./agentCards/client/requests/index.js"), exports);
-exports.agentCards = __importStar(require("./agentCards/index.js"));
-__exportStar(require("./agentCards/types/index.js"), exports);
 __exportStar(require("./agenticPayments/client/requests/index.js"), exports);
 exports.agenticPayments = __importStar(require("./agenticPayments/index.js"));
 __exportStar(require("./agenticPayments/types/index.js"), exports);
@@ -64,9 +61,6 @@ __exportStar(require("./cardPayments/types/index.js"), exports);
 __exportStar(require("./cardSessions/client/requests/index.js"), exports);
 exports.cardSessions = __importStar(require("./cardSessions/index.js"));
 __exportStar(require("./cardSessions/types/index.js"), exports);
-__exportStar(require("./cardTransactions/client/requests/index.js"), exports);
-exports.cardTransactions = __importStar(require("./cardTransactions/index.js"));
-__exportStar(require("./cardTransactions/types/index.js"), exports);
 __exportStar(require("./chargebacks/client/requests/index.js"), exports);
 exports.chargebacks = __importStar(require("./chargebacks/index.js"));
 __exportStar(require("./chargebacks/types/index.js"), exports);

package/dist/cjs/api/resources/invitationLinks/client/requests/GetInvitationLinksRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetInvitationLinksRequest {
+    /** Invitation link ID (ivl_*). */
     linkId: string;
 }

package/dist/cjs/api/resources/invitationLinks/client/requests/ListInvitationLinksRequest.d.ts

@@ -4,7 +4,10 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListInvitationLinksRequest {
+    /** Filter by status. */
     statusFilter?: Natural.ListInvitationLinksRequestStatusFilter;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/invitationLinks/client/requests/RevokeInvitationLinksRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface RevokeInvitationLinksRequest {
+    /** Invitation link ID (ivl_*). */
     linkId: string;
 }

package/dist/cjs/api/resources/invitations/client/requests/ListInvitationsRequest.d.ts

@@ -4,9 +4,14 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListInvitationsRequest {
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Party to filter by; only your own party is accepted. */
     partyId?: string;
+    /** Filter by email. */
     email?: string;
+    /** Filter by status. */
     status?: Natural.ListInvitationsRequestStatus;
 }

package/dist/cjs/api/resources/invitations/client/requests/RevokeInvitationsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RevokeInvitationsRequest {
+    /** Invitation ID (inv_*). */
     invitationId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/parties/client/requests/CreateBrandingPhotoUploadPartiesRequest.d.ts

@@ -8,6 +8,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface CreateBrandingPhotoUploadPartiesRequest {
+    /** Party ID (pty_*). */
     partyId: string;
     /** Avatar image MIME type */
     contentType: Natural.CreateBrandingPhotoUploadPartiesRequestContentType;

package/dist/cjs/api/resources/parties/client/requests/GetBrandingForPartyPartiesRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetBrandingForPartyPartiesRequest {
+    /** Party ID (pty_*). */
     partyId: string;
 }

package/dist/cjs/api/resources/parties/client/requests/GetCompliancePartiesRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetCompliancePartiesRequest {
+    /** Party ID (pty_*). */
     partyId: string;
 }

package/dist/cjs/api/resources/parties/client/requests/ListMembersPartiesRequest.d.ts

@@ -3,6 +3,8 @@
  *     {}
  */
 export interface ListMembersPartiesRequest {
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
 }

package/dist/cjs/api/resources/parties/client/requests/RemoveMemberPartiesRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RemoveMemberPartiesRequest {
+    /** User ID (usr_*). */
     userId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/parties/client/requests/UpdateBrandingForPartyPartiesRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface UpdateBrandingForPartyPartiesRequest {
+    /** Party ID (pty_*). */
     partyId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/paymentIntents/client/requests/CancelPaymentIntentsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface CancelPaymentIntentsRequest {
+    /** Payment intent ID (pmi_*). */
     paymentIntentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/paymentIntents/client/requests/GetPaymentIntentsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetPaymentIntentsRequest {
+    /** Payment intent ID (pmi_*). */
     paymentIntentId: string;
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/paymentIntents/client/requests/ListPaymentIntentsRequest.d.ts

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListPaymentIntentsRequest {
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
     customerPartyId?: string;
+    /** Only intents with this status. */
     status?: Natural.ListPaymentIntentsRequestStatus;
+    /** Only intents created after this RFC 3339 timestamp (exclusive). */
     createdAfter?: string;
+    /** Only intents created before this RFC 3339 timestamp (exclusive). */
     createdBefore?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/paymentIntents/client/requests/UpdatePaymentIntentsRequest.d.ts

@@ -21,6 +21,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface UpdatePaymentIntentsRequest {
+    /** Payment intent ID (pmi_*). */
     paymentIntentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/paymentRequests/client/requests/CancelPaymentRequestsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface CancelPaymentRequestsRequest {
+    /** Payment request ID (prq_*). */
     paymentRequestId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/paymentRequests/client/requests/DeclinePaymentRequestsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface DeclinePaymentRequestsRequest {
+    /** Payment request ID (prq_*). */
     paymentRequestId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/paymentRequests/client/requests/GetPaymentRequestsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetPaymentRequestsRequest {
+    /** Payment request ID (prq_*). */
     paymentRequestId: 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;
 }

package/dist/cjs/api/resources/paymentRequests/client/requests/ListIncomingPaymentRequestsRequest.d.ts

@@ -3,8 +3,12 @@
  *     {}
  */
 export interface ListIncomingPaymentRequestsRequest {
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: 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;
+    /** Only payment requests addressed to this agent (agt_*) as payer. */
     addressedToAgent?: string;
 }

package/dist/cjs/api/resources/paymentRequests/client/requests/ListPaymentRequestsRequest.d.ts

@@ -4,12 +4,20 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListPaymentRequestsRequest {
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: 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;
+    /** Whether to include completed payment requests. */
     includeCompleted?: Natural.ListPaymentRequestsRequestIncludeCompleted;
+    /** Whether to include canceled payment requests. */
     includeCanceled?: Natural.ListPaymentRequestsRequestIncludeCanceled;
+    /** Limit the list to one outgoing group. Open is still waiting on the payer. Completed is in flight or settled and not returned. Closed is failed, declined, canceled, expired, and returned. When set, this replaces includeCompleted and includeCanceled. */
     group?: Natural.ListPaymentRequestsRequestGroup;
+    /** Only payment requests created by this agent (agt_*). */
     initiatedByAgent?: string;
+    /** Only payment requests addressed to this agent (agt_*) as payer. */
     addressedToAgent?: string;
 }

package/dist/cjs/api/resources/paymentRequests/client/requests/NewFulfilledReqParams.d.ts

@@ -14,6 +14,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface NewFulfilledReqParams {
+    /** Payment request ID (prq_*). */
     paymentRequestId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/paymentRequests/types/CancelPaymentRequestsResponseDataAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface CancelPaymentRequestsResponseDataAttributesInitiatorParty {
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }

package/dist/cjs/api/resources/paymentRequests/types/CreatePaymentRequestsResponseDataAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface CreatePaymentRequestsResponseDataAttributesInitiatorParty {
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }

package/dist/cjs/api/resources/paymentRequests/types/DeclinePaymentRequestsResponseDataAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface DeclinePaymentRequestsResponseDataAttributesInitiatorParty {
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }

package/dist/cjs/api/resources/paymentRequests/types/GetPaymentRequestsResponseDataAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface GetPaymentRequestsResponseDataAttributesInitiatorParty {
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }

package/dist/cjs/api/resources/paymentRequests/types/ListIncomingPaymentRequestsResponseDataItemAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface ListIncomingPaymentRequestsResponseDataItemAttributesInitiatorP
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }

package/dist/cjs/api/resources/paymentRequests/types/ListPaymentRequestsResponseDataItemAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface ListPaymentRequestsResponseDataItemAttributesInitiatorParty {
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }

package/dist/cjs/api/resources/payments/client/requests/CancelPaymentsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface CancelPaymentsRequest {
+    /** Payment ID (pay_*). */
     paymentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/payments/client/requests/GetPaymentsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetPaymentsRequest {
+    /** Payment ID (pay_*). */
     paymentId: string;
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/payments/client/requests/ListPaymentsRequest.d.ts

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface ListPaymentsRequest {
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/realtime/client/requests/CancelRealtimeRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface CancelRealtimeRequest {
+    /** Realtime payment ID (rt_*). */
     realtimeId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/realtime/client/requests/GetRealtimeRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetRealtimeRequest {
+    /** Realtime payment ID (rt_*). */
     realtimeId: 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;
 }

package/dist/cjs/api/resources/realtime/client/requests/ListRealtimeRequest.d.ts

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListRealtimeRequest {
+    /** 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;
+    /** Filter by status. */
     status?: Natural.ListRealtimeRequestStatus;
+    /** Only payments to this external party (epty_*). */
     externalPartyId?: string;
+    /** Only payments using this account (epa_*). */
     externalPartyAccountId?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/refunds/client/requests/GetRefundsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetRefundsRequest {
+    /** Refund ID (rfd_*). */
     refundId: string;
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/refunds/client/requests/ListRefundsRequest.d.ts

@@ -3,9 +3,14 @@
  *     {}
  */
 export interface ListRefundsRequest {
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
     customerPartyId?: string;
+    /** Only refunds of this payment intent. */
     paymentIntentId?: string;
+    /** Only refunds of this card payment. If paymentIntentId is also supplied, both filters must match. */
     cardPaymentId?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/simulations/client/requests/AcceptCustomerInvitationSimulationsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface AcceptCustomerInvitationSimulationsRequest {
+    /** Invitation ID (adi_*). */
     invitationId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/CompletePaymentClaimSimulationsRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface CompletePaymentClaimSimulationsRequest {
+    /** Payment ID (pay_*). */
     paymentId: string;
 }

package/dist/cjs/api/resources/simulations/client/requests/DeclineCustomerInvitationSimulationsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface DeclineCustomerInvitationSimulationsRequest {
+    /** Invitation ID (adi_*). */
     invitationId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/DeclinePaymentRequestSimulationsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface DeclinePaymentRequestSimulationsRequest {
+    /** Payment request ID (prq_*). */
     paymentRequestId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/DisconnectCustomerSimulationsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface DisconnectCustomerSimulationsRequest {
+    /** Customer party ID (pty_*). */
     customerId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/FailRealtimeSimulationsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface FailRealtimeSimulationsRequest {
+    /** Realtime payment ID (rt_*). */
     realtimeId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/FailWireSimulationsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface FailWireSimulationsRequest {
+    /** Wire ID (wire_*). */
     wireId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/FulfillPaymentRequestSimulationsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface FulfillPaymentRequestSimulationsRequest {
+    /** Payment request ID (prq_*). */
     paymentRequestId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/FundCustomerSimulationsRequest.d.ts

@@ -9,6 +9,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface FundCustomerSimulationsRequest {
+    /** Customer party ID (pty_*). */
     customerId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/RevokeAgentConnectionSimulationsRequest.d.ts

@@ -7,7 +7,9 @@
  *     }
  */
 export interface RevokeAgentConnectionSimulationsRequest {
+    /** Customer party ID (pty_*). */
     customerId: string;
+    /** Agent ID (agt_*). */
     agentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/SettleCardPaymentSimulationsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface SettleCardPaymentSimulationsRequest {
+    /** Card payment ID (cpy_*). The payment must have succeeded. */
     cardPaymentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/SettleRealtimeSimulationsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface SettleRealtimeSimulationsRequest {
+    /** Realtime payment ID (rt_*). */
     realtimeId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/client/requests/SettleWireSimulationsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface SettleWireSimulationsRequest {
+    /** Wire ID (wire_*). */
     wireId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/simulations/types/DeclinePaymentRequestSimulationsResponseDataAttributesInitiatorParty.d.ts

@@ -5,4 +5,6 @@ export interface DeclinePaymentRequestSimulationsResponseDataAttributesInitiator
     name: string;
     /** Party handle, such as @acme, or null when none is set. */
     handle: string | null;
+    /** Party avatar URL, or null when none is set. */
+    avatarUrl: string | null;
 }