@naturalpay/sdk 1.6.19 → 1.6.21

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface GetRealtimeResponseDataAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.GetRealtimeResponseDataAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.GetRealtimeResponseDataAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.GetRealtimeResponseDataAttributesFeeApplied;
+}

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFee.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const GetRealtimeResponseDataAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type GetRealtimeResponseDataAttributesFeeApplied = (typeof GetRealtimeResponseDataAttributesFeeApplied)[keyof typeof GetRealtimeResponseDataAttributesFeeApplied];

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const GetRealtimeResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const GetRealtimeResponseDataAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type GetRealtimeResponseDataAttributesFeeCurrency = (typeof GetRealtimeResponseDataAttributesFeeCurrency)[keyof typeof GetRealtimeResponseDataAttributesFeeCurrency];

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const GetRealtimeResponseDataAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const GetRealtimeResponseDataAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type GetRealtimeResponseDataAttributesFeePayer = (typeof GetRealtimeResponseDataAttributesFeePayer)[keyof typeof GetRealtimeResponseDataAttributesFeePayer];

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const GetRealtimeResponseDataAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributes.d.mts

@@ -4,10 +4,14 @@ export interface ListRealtimeResponseDataItemAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.ListRealtimeResponseDataItemAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the payment failed, was denied, or was canceled, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.ListRealtimeResponseDataItemAttributesFee | null;
     /** Realtime payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, or CANCELED end it. */
     status: Natural.ListRealtimeResponseDataItemAttributesStatus;
     /** Payment description delivered to the recipient bank. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the payment failed, or null. */
     failure: Natural.ListRealtimeResponseDataItemAttributesFailure | null;
     /** RFC 3339 timestamp when the payment was submitted to the network, or null. */

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface ListRealtimeResponseDataItemAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.ListRealtimeResponseDataItemAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.ListRealtimeResponseDataItemAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.ListRealtimeResponseDataItemAttributesFeeApplied;
+}

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFee.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const ListRealtimeResponseDataItemAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type ListRealtimeResponseDataItemAttributesFeeApplied = (typeof ListRealtimeResponseDataItemAttributesFeeApplied)[keyof typeof ListRealtimeResponseDataItemAttributesFeeApplied];

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const ListRealtimeResponseDataItemAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const ListRealtimeResponseDataItemAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type ListRealtimeResponseDataItemAttributesFeeCurrency = (typeof ListRealtimeResponseDataItemAttributesFeeCurrency)[keyof typeof ListRealtimeResponseDataItemAttributesFeeCurrency];

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const ListRealtimeResponseDataItemAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const ListRealtimeResponseDataItemAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type ListRealtimeResponseDataItemAttributesFeePayer = (typeof ListRealtimeResponseDataItemAttributesFeePayer)[keyof typeof ListRealtimeResponseDataItemAttributesFeePayer];

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const ListRealtimeResponseDataItemAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/realtime/types/index.d.mts

@@ -3,6 +3,10 @@ export * from "./CancelRealtimeResponseData.mjs";
 export * from "./CancelRealtimeResponseDataAttributes.mjs";
 export * from "./CancelRealtimeResponseDataAttributesCurrency.mjs";
 export * from "./CancelRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFee.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFeeApplied.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFeeCurrency.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFeePayer.mjs";
 export * from "./CancelRealtimeResponseDataAttributesStatus.mjs";
 export * from "./CancelRealtimeResponseDataRelationships.mjs";
 export * from "./CancelRealtimeResponseDataRelationshipsCustomerParty.mjs";
@@ -24,6 +28,10 @@ export * from "./CreateRealtimeResponseData.mjs";
 export * from "./CreateRealtimeResponseDataAttributes.mjs";
 export * from "./CreateRealtimeResponseDataAttributesCurrency.mjs";
 export * from "./CreateRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFee.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFeeApplied.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFeeCurrency.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFeePayer.mjs";
 export * from "./CreateRealtimeResponseDataAttributesStatus.mjs";
 export * from "./CreateRealtimeResponseDataRelationships.mjs";
 export * from "./CreateRealtimeResponseDataRelationshipsCustomerParty.mjs";
@@ -44,6 +52,10 @@ export * from "./GetRealtimeResponseData.mjs";
 export * from "./GetRealtimeResponseDataAttributes.mjs";
 export * from "./GetRealtimeResponseDataAttributesCurrency.mjs";
 export * from "./GetRealtimeResponseDataAttributesFailure.mjs";
+export * from "./GetRealtimeResponseDataAttributesFee.mjs";
+export * from "./GetRealtimeResponseDataAttributesFeeApplied.mjs";
+export * from "./GetRealtimeResponseDataAttributesFeeCurrency.mjs";
+export * from "./GetRealtimeResponseDataAttributesFeePayer.mjs";
 export * from "./GetRealtimeResponseDataAttributesStatus.mjs";
 export * from "./GetRealtimeResponseDataRelationships.mjs";
 export * from "./GetRealtimeResponseDataRelationshipsCustomerParty.mjs";
@@ -65,6 +77,10 @@ export * from "./ListRealtimeResponseDataItem.mjs";
 export * from "./ListRealtimeResponseDataItemAttributes.mjs";
 export * from "./ListRealtimeResponseDataItemAttributesCurrency.mjs";
 export * from "./ListRealtimeResponseDataItemAttributesFailure.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFee.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListRealtimeResponseDataItemAttributesStatus.mjs";
 export * from "./ListRealtimeResponseDataItemRelationships.mjs";
 export * from "./ListRealtimeResponseDataItemRelationshipsCustomerParty.mjs";

package/dist/esm/api/resources/realtime/types/index.mjs

@@ -3,6 +3,10 @@ export * from "./CancelRealtimeResponseData.mjs";
 export * from "./CancelRealtimeResponseDataAttributes.mjs";
 export * from "./CancelRealtimeResponseDataAttributesCurrency.mjs";
 export * from "./CancelRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFee.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFeeApplied.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFeeCurrency.mjs";
+export * from "./CancelRealtimeResponseDataAttributesFeePayer.mjs";
 export * from "./CancelRealtimeResponseDataAttributesStatus.mjs";
 export * from "./CancelRealtimeResponseDataRelationships.mjs";
 export * from "./CancelRealtimeResponseDataRelationshipsCustomerParty.mjs";
@@ -24,6 +28,10 @@ export * from "./CreateRealtimeResponseData.mjs";
 export * from "./CreateRealtimeResponseDataAttributes.mjs";
 export * from "./CreateRealtimeResponseDataAttributesCurrency.mjs";
 export * from "./CreateRealtimeResponseDataAttributesFailure.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFee.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFeeApplied.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFeeCurrency.mjs";
+export * from "./CreateRealtimeResponseDataAttributesFeePayer.mjs";
 export * from "./CreateRealtimeResponseDataAttributesStatus.mjs";
 export * from "./CreateRealtimeResponseDataRelationships.mjs";
 export * from "./CreateRealtimeResponseDataRelationshipsCustomerParty.mjs";
@@ -44,6 +52,10 @@ export * from "./GetRealtimeResponseData.mjs";
 export * from "./GetRealtimeResponseDataAttributes.mjs";
 export * from "./GetRealtimeResponseDataAttributesCurrency.mjs";
 export * from "./GetRealtimeResponseDataAttributesFailure.mjs";
+export * from "./GetRealtimeResponseDataAttributesFee.mjs";
+export * from "./GetRealtimeResponseDataAttributesFeeApplied.mjs";
+export * from "./GetRealtimeResponseDataAttributesFeeCurrency.mjs";
+export * from "./GetRealtimeResponseDataAttributesFeePayer.mjs";
 export * from "./GetRealtimeResponseDataAttributesStatus.mjs";
 export * from "./GetRealtimeResponseDataRelationships.mjs";
 export * from "./GetRealtimeResponseDataRelationshipsCustomerParty.mjs";
@@ -65,6 +77,10 @@ export * from "./ListRealtimeResponseDataItem.mjs";
 export * from "./ListRealtimeResponseDataItemAttributes.mjs";
 export * from "./ListRealtimeResponseDataItemAttributesCurrency.mjs";
 export * from "./ListRealtimeResponseDataItemAttributesFailure.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFee.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListRealtimeResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListRealtimeResponseDataItemAttributesStatus.mjs";
 export * from "./ListRealtimeResponseDataItemRelationships.mjs";
 export * from "./ListRealtimeResponseDataItemRelationshipsCustomerParty.mjs";

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributes.d.mts

@@ -12,6 +12,16 @@ export interface CompletePaymentClaimSimulationsResponseDataAttributes {
     tags: Record<string, string>;
     /** Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
     fee: Natural.CompletePaymentClaimSimulationsResponseDataAttributesFee | null;
+    /** RFC 3339 timestamp when this payment was submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.CompletePaymentClaimSimulationsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.CompletePaymentClaimSimulationsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.CompletePaymentClaimSimulationsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesClaim.d.mts

@@ -0,0 +1,8 @@
+export interface CompletePaymentClaimSimulationsResponseDataAttributesClaim {
+    /** RFC 3339 timestamp when the recipient began claiming this payment, or null while unclaimed or unobserved. */
+    startedAt: string | null;
+    /** RFC 3339 timestamp when the recipient claimed this payment, or null while unclaimed. */
+    claimedAt: string | null;
+    /** RFC 3339 timestamp when a claimed payment detached from its recipient, or null. */
+    unboundAt: string | null;
+}

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesClaim.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesFailure.d.mts

@@ -0,0 +1,6 @@
+export interface CompletePaymentClaimSimulationsResponseDataAttributesFailure {
+    /** Reason code, when available. */
+    code: string | null;
+    /** Reason text, when available. */
+    reason: string | null;
+}

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesFailure.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesReturn.d.mts

@@ -0,0 +1,6 @@
+export interface CompletePaymentClaimSimulationsResponseDataAttributesReturn {
+    /** Reason code, when available. */
+    code: string | null;
+    /** Reason text, when available. */
+    reason: string | null;
+}

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesReturn.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributes.d.mts

@@ -12,6 +12,16 @@ export interface FulfillPaymentRequestSimulationsResponseDataAttributes {
     tags: Record<string, string>;
     /** Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
     fee: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesFee | null;
+    /** RFC 3339 timestamp when this payment was submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesClaim.d.mts

@@ -0,0 +1,8 @@
+export interface FulfillPaymentRequestSimulationsResponseDataAttributesClaim {
+    /** RFC 3339 timestamp when the recipient began claiming this payment, or null while unclaimed or unobserved. */
+    startedAt: string | null;
+    /** RFC 3339 timestamp when the recipient claimed this payment, or null while unclaimed. */
+    claimedAt: string | null;
+    /** RFC 3339 timestamp when a claimed payment detached from its recipient, or null. */
+    unboundAt: string | null;
+}

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesClaim.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesFailure.d.mts

@@ -0,0 +1,6 @@
+export interface FulfillPaymentRequestSimulationsResponseDataAttributesFailure {
+    /** Reason code, when available. */
+    code: string | null;
+    /** Reason text, when available. */
+    reason: string | null;
+}

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesFailure.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesReturn.d.mts

@@ -0,0 +1,6 @@
+export interface FulfillPaymentRequestSimulationsResponseDataAttributesReturn {
+    /** Reason code, when available. */
+    code: string | null;
+    /** Reason text, when available. */
+    reason: string | null;
+}

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesReturn.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/simulations/types/index.d.mts

@@ -16,10 +16,13 @@ export * from "./AcceptCustomerInvitationSimulationsResponseDataType.mjs";
 export * from "./CompletePaymentClaimSimulationsResponse.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseData.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributes.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesClaim.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFailure.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFee.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesReturn.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesStatus.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationships.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationshipsPaymentRequest.mjs";
@@ -106,10 +109,13 @@ export * from "./FailWireSimulationsResponseDataType.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponse.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseData.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributes.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesClaim.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFailure.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFee.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesReturn.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesStatus.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationships.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationshipsPaymentRequest.mjs";

package/dist/esm/api/resources/simulations/types/index.mjs

@@ -16,10 +16,13 @@ export * from "./AcceptCustomerInvitationSimulationsResponseDataType.mjs";
 export * from "./CompletePaymentClaimSimulationsResponse.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseData.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributes.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesClaim.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFailure.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFee.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesReturn.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesStatus.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationships.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationshipsPaymentRequest.mjs";
@@ -106,10 +109,13 @@ export * from "./FailWireSimulationsResponseDataType.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponse.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseData.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributes.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesClaim.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFailure.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFee.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesReturn.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesStatus.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationships.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationshipsPaymentRequest.mjs";

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

@@ -66,7 +66,8 @@ export declare class WireClient {
      *         amount: 25000,
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-     *         description: "Invoice 1042 settlement"
+     *         description: "Invoice 1042 settlement",
+     *         internalDescription: "Vendor settlement, ledger 1042"
      *     })
      */
     create(request: Natural.CreateWireRequest, requestOptions?: WireClient.RequestOptions): core.HttpResponsePromise<Natural.CreateWireResponse>;

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

@@ -172,7 +172,8 @@ export class WireClient {
      *         amount: 25000,
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-     *         description: "Invoice 1042 settlement"
+     *         description: "Invoice 1042 settlement",
+     *         internalDescription: "Vendor settlement, ledger 1042"
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/wire/client/requests/CreateWireRequest.d.mts

@@ -6,7 +6,8 @@ import type * as Natural from "../../../../index.mjs";
  *         amount: 25000,
  *         currency: "USD",
  *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
- *         description: "Invoice 1042 settlement"
+ *         description: "Invoice 1042 settlement",
+ *         internalDescription: "Vendor settlement, ledger 1042"
  *     }
  */
 export interface CreateWireRequest {
@@ -22,8 +23,10 @@ export interface CreateWireRequest {
     walletId?: string;
     /** External party account (epa_*) to pay. */
     externalPartyAccountId: string;
-    /** Internal payment description. Maximum 1000 characters. */
+    /** Payment description stored for the sender's records. Not sent over Fedwire. Maximum 1000 characters. */
     description: string;
-    /** Remittance information for the beneficiary. Maximum 105 characters: letters, digits, spaces, and / - ? : ( ) . , ' +. */
+    /** Remittance information delivered to the beneficiary, combined with the originator name into the Fedwire OBI field. Maximum 105 characters: letters, digits, spaces, and / - ? : ( ) . , ' +. */
     remittanceInfo?: string;
+    /** Description for your internal reference. Never shared with the counterparty or the banking network. Maximum 255 characters. */
+    internalDescription?: string;
 }

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributes.d.mts

@@ -4,12 +4,16 @@ export interface CancelWireResponseDataAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.CancelWireResponseDataAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the wire ended before network submission, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CancelWireResponseDataAttributesFee | null;
     /** Wire status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, REJECTED, FAILED, or CANCELED end it. */
     status: Natural.CancelWireResponseDataAttributesStatus;
-    /** Remittance information sent to the beneficiary, or null. */
+    /** Remittance information delivered to the beneficiary, or null. */
     remittanceInfo: string | null;
-    /** Internal payment description. */
+    /** Payment description stored for the sender's records. Not sent over Fedwire. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the wire failed, or null. */
     failure: Natural.CancelWireResponseDataAttributesFailure | null;
     /** RFC 3339 timestamp when the wire was submitted, or null. */

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface CancelWireResponseDataAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.CancelWireResponseDataAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.CancelWireResponseDataAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.CancelWireResponseDataAttributesFeeApplied;
+}

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFee.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const CancelWireResponseDataAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type CancelWireResponseDataAttributesFeeApplied = (typeof CancelWireResponseDataAttributesFeeApplied)[keyof typeof CancelWireResponseDataAttributesFeeApplied];

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const CancelWireResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const CancelWireResponseDataAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type CancelWireResponseDataAttributesFeeCurrency = (typeof CancelWireResponseDataAttributesFeeCurrency)[keyof typeof CancelWireResponseDataAttributesFeeCurrency];

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const CancelWireResponseDataAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const CancelWireResponseDataAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type CancelWireResponseDataAttributesFeePayer = (typeof CancelWireResponseDataAttributesFeePayer)[keyof typeof CancelWireResponseDataAttributesFeePayer];

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const CancelWireResponseDataAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributes.d.mts

@@ -4,12 +4,16 @@ export interface CreateWireResponseDataAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.CreateWireResponseDataAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the wire ended before network submission, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CreateWireResponseDataAttributesFee | null;
     /** Wire status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, REJECTED, FAILED, or CANCELED end it. */
     status: Natural.CreateWireResponseDataAttributesStatus;
-    /** Remittance information sent to the beneficiary, or null. */
+    /** Remittance information delivered to the beneficiary, or null. */
     remittanceInfo: string | null;
-    /** Internal payment description. */
+    /** Payment description stored for the sender's records. Not sent over Fedwire. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the wire failed, or null. */
     failure: Natural.CreateWireResponseDataAttributesFailure | null;
     /** RFC 3339 timestamp when the wire was submitted, or null. */

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface CreateWireResponseDataAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.CreateWireResponseDataAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.CreateWireResponseDataAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.CreateWireResponseDataAttributesFeeApplied;
+}

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFee.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const CreateWireResponseDataAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type CreateWireResponseDataAttributesFeeApplied = (typeof CreateWireResponseDataAttributesFeeApplied)[keyof typeof CreateWireResponseDataAttributesFeeApplied];

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const CreateWireResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const CreateWireResponseDataAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type CreateWireResponseDataAttributesFeeCurrency = (typeof CreateWireResponseDataAttributesFeeCurrency)[keyof typeof CreateWireResponseDataAttributesFeeCurrency];

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const CreateWireResponseDataAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const CreateWireResponseDataAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type CreateWireResponseDataAttributesFeePayer = (typeof CreateWireResponseDataAttributesFeePayer)[keyof typeof CreateWireResponseDataAttributesFeePayer];

package/dist/esm/api/resources/wire/types/CreateWireResponseDataAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const CreateWireResponseDataAttributesFeePayer = {
+    Sender: "sender",
+};