npm - @naturalpay/sdk - Versions diffs - 1.6.32 → 1.6.34 - Mend

@naturalpay/sdk 1.6.32 → 1.6.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1197) hide show

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

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.mjs";
  *     {}
  */
 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/esm/api/resources/paymentIntents/client/requests/UpdatePaymentIntentsRequest.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/paymentRequests/client/requests/CancelPaymentRequestsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/paymentRequests/client/requests/DeclinePaymentRequestsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/paymentRequests/client/requests/GetPaymentRequestsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/paymentRequests/client/requests/ListIncomingPaymentRequestsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/paymentRequests/client/requests/ListPaymentRequestsRequest.d.mts CHANGED Viewed

@@ -4,12 +4,20 @@ import type * as Natural from "../../../../index.mjs";
  *     {}
  */
 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/esm/api/resources/paymentRequests/client/requests/NewFulfilledReqParams.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/payments/client/requests/CancelPaymentsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/payments/client/requests/GetPaymentsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/payments/client/requests/ListPaymentsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/realtime/client/requests/CancelRealtimeRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/realtime/client/requests/GetRealtimeRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/realtime/client/requests/ListRealtimeRequest.d.mts CHANGED Viewed

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.mjs";
  *     {}
  */
 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/esm/api/resources/refunds/client/requests/GetRefundsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/refunds/client/requests/ListRefundsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/AcceptCustomerInvitationSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/CompletePaymentClaimSimulationsRequest.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/simulations/client/requests/DeclineCustomerInvitationSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/DeclinePaymentRequestSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/DisconnectCustomerSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/FailRealtimeSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/FailWireSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/FulfillPaymentRequestSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/FundCustomerSimulationsRequest.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/simulations/client/requests/RevokeAgentConnectionSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/SettleCardPaymentSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/SettleRealtimeSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/simulations/client/requests/SettleWireSimulationsRequest.d.mts CHANGED Viewed

@@ -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/esm/api/resources/transactions/client/requests/GetTransactionsRequest.d.mts CHANGED Viewed

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetTransactionsRequest {
+    /** Transaction ID (txn_*). */
     transactionId: 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/esm/api/resources/transactions/client/requests/ListTransactionsRequest.d.mts CHANGED Viewed

@@ -4,11 +4,18 @@ import type * as Natural from "../../../../index.mjs";
  *     {}
  */
 export interface ListTransactionsRequest {
+    /** Filter by transaction type. Chargeback rows need `chargebacks.read`. Without it, `all` leaves them out and `chargeback` returns an empty page. */
     type?: Natural.ListTransactionsRequestType;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Restrict results to transactions whose payment counterparty is this party. */
     counterpartyPartyId?: string;
+    /** Restrict results to transactions visible through this wallet. */
     walletId?: string;
+    /** Restrict results to delegated activity performed for this customer, not activity involving it as a payment counterparty. */
     customerPartyId?: string;
+    /** When true, return only transactions an agent performed for a connected customer. */
     delegated?: boolean;
 }

package/dist/esm/api/resources/transfers/client/requests/GetTransfersRequest.d.mts CHANGED Viewed

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetTransfersRequest {
+    /** Transfer ID (trf_*). */
     transferId: 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/esm/api/resources/transfers/client/requests/ListTransfersRequest.d.mts CHANGED Viewed

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface ListTransfersRequest {
+    /** 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/esm/api/resources/voiceSessions/client/requests/GetTranscriptVoiceSessionsRequest.d.mts CHANGED Viewed

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetTranscriptVoiceSessionsRequest {
+    /** Voice session ID (vos_*). */
     voiceSessionId: string;
+    /** Customer party to act for (pty_*). Omit for your account's call log, including delegated activity. Requires authorization from that customer. */
     customerPartyId?: string;
 }

package/dist/esm/api/resources/voiceSessions/client/requests/GetVoiceSessionsRequest.d.mts CHANGED Viewed

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetVoiceSessionsRequest {
+    /** Voice session ID (vos_*). */
     voiceSessionId: string;
+    /** Customer party to act for (pty_*). Omit for your account's call log, including delegated activity. Requires authorization from that customer. */
     customerPartyId?: string;
 }

package/dist/esm/api/resources/voiceSessions/client/requests/ListVoiceSessionsRequest.d.mts CHANGED Viewed

@@ -4,11 +4,18 @@ import type * as Natural from "../../../../index.mjs";
  *     {}
  */
 export interface ListVoiceSessionsRequest {
+    /** Customer party to act for (pty_*). Omit for your account's call log, including delegated activity. Requires authorization from that customer. */
     customerPartyId?: string;
+    /** Only sessions associated with this payment intent. */
     paymentIntentId?: string;
+    /** Filter by call-session status. */
     status?: Natural.ListVoiceSessionsRequestStatus;
+    /** Only sessions created after this RFC 3339 timestamp (exclusive). */
     createdAfter?: string;
+    /** Only sessions created before this RFC 3339 timestamp (exclusive). */
     createdBefore?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page with the same customer and filters. */
     cursor?: string;
 }

package/dist/esm/api/resources/wallets/client/requests/AttachAgentWalletsRequest.d.mts CHANGED Viewed

@@ -7,6 +7,7 @@
  *     }
  */
 export interface AttachAgentWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/wallets/client/requests/DetachAgentWalletsRequest.d.mts CHANGED Viewed

@@ -7,7 +7,9 @@
  *     }
  */
 export interface DetachAgentWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
+    /** Agent ID (agt_*). */
     agentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/wallets/client/requests/FreezeWalletsRequest.d.mts CHANGED Viewed

@@ -5,5 +5,6 @@
  *     }
  */
 export interface FreezeWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
 }

package/dist/esm/api/resources/wallets/client/requests/GetWalletsRequest.d.mts CHANGED Viewed

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: 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/esm/api/resources/wallets/client/requests/ListAgentsWalletsRequest.d.mts CHANGED Viewed

@@ -5,7 +5,10 @@
  *     }
  */
 export interface ListAgentsWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/esm/api/resources/wallets/client/requests/ListWalletsRequest.d.mts CHANGED Viewed

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface ListWalletsRequest {
+    /** 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/esm/api/resources/wallets/client/requests/SetAgentDefaultWalletWalletsRequest.d.mts CHANGED Viewed

@@ -7,7 +7,9 @@
  *     }
  */
 export interface SetAgentDefaultWalletWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
+    /** Agent ID (agt_*). */
     agentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/wallets/client/requests/SetDefaultWalletsRequest.d.mts CHANGED Viewed

@@ -6,6 +6,7 @@
  *     }
  */
 export interface SetDefaultWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/wallets/client/requests/UnfreezeWalletsRequest.d.mts CHANGED Viewed

@@ -5,5 +5,6 @@
  *     }
  */
 export interface UnfreezeWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
 }

package/dist/esm/api/resources/wallets/client/requests/UpdateWalletsRequest.d.mts CHANGED Viewed

@@ -12,6 +12,7 @@
  *     }
  */
 export interface UpdateWalletsRequest {
+    /** Wallet ID (wal_*). */
     walletId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/webhooks/client/requests/GetWebhooksRequest.d.mts CHANGED Viewed

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetWebhooksRequest {
+    /** Webhook ID (whk_*). */
     webhookId: string;
 }

package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/webhooks/client/requests/NewRotatedWebhookParams.d.mts CHANGED Viewed

@@ -7,6 +7,7 @@
  *     }
  */
 export interface NewRotatedWebhookParams {
+    /** Webhook ID (whk_*). */
     webhookId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhooksRequest.d.mts CHANGED Viewed

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RemoveWebhooksRequest {
+    /** Webhook ID (whk_*). */
     webhookId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/webhooks/client/requests/UpdWebhookParams.d.mts CHANGED Viewed

@@ -15,6 +15,7 @@ import type * as Natural from "../../../../index.mjs";
  *     }
  */
 export interface UpdWebhookParams {
+    /** Webhook ID (whk_*). */
     webhookId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/esm/api/resources/wire/client/requests/CancelWireRequest.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/wire/client/requests/GetWireRequest.d.mts CHANGED Viewed

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetWireRequest {
+    /** Wire ID (wire_*). */
     wireId: 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/esm/api/resources/wire/client/requests/ListWireRequest.d.mts CHANGED Viewed

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.mjs";
  *     {}
  */
 export interface ListWireRequest {
+    /** 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.ListWireRequestStatus;
+    /** 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/esm/serialization/resources/agenticPayments/types/CardAgenticPaymentsRequestProvider.d.mts ADDED Viewed

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const CardAgenticPaymentsRequestProvider: core.serialization.Schema<serializers.CardAgenticPaymentsRequestProvider.Raw, Natural.CardAgenticPaymentsRequestProvider>;
+export declare namespace CardAgenticPaymentsRequestProvider {
+    type Raw = "basis_theory" | "simulation";
+}

package/dist/esm/serialization/resources/{agentCards/types/CreateAgentCardsRequestType.mjs → agenticPayments/types/CardAgenticPaymentsRequestProvider.mjs} RENAMED Viewed

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

package/dist/esm/serialization/resources/agenticPayments/types/CardAgenticPaymentsResponse.d.mts ADDED Viewed

@@ -0,0 +1,10 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+import { CardAgenticPaymentsResponseData } from "./CardAgenticPaymentsResponseData.mjs";
+export declare const CardAgenticPaymentsResponse: core.serialization.ObjectSchema<serializers.CardAgenticPaymentsResponse.Raw, Natural.CardAgenticPaymentsResponse>;
+export declare namespace CardAgenticPaymentsResponse {
+    interface Raw {
+        data: CardAgenticPaymentsResponseData.Raw;
+    }
+}

package/dist/esm/serialization/resources/agenticPayments/types/CardAgenticPaymentsResponse.mjs ADDED Viewed

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+import { CardAgenticPaymentsResponseData } from "./CardAgenticPaymentsResponseData.mjs";
+export const CardAgenticPaymentsResponse = core.serialization.object({
+    data: CardAgenticPaymentsResponseData,
+});