@naturalpay/sdk 1.2.0 → 1.2.2

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

@@ -14,7 +14,7 @@ export declare class InvitationLinksClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<InvitationLinksClient.Options>;
     constructor(options?: InvitationLinksClient.Options);
     /**
-     * List the invitation links your party has created
+     * List the invitation links you have created, with masked tokens
      *
      * @param {Natural.ListInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -40,7 +40,7 @@ export declare class InvitationLinksClient {
     list(request?: Natural.ListInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.ListInvitationLinksResponse>;
     private __list;
     /**
-     * Create a shareable link that offers your agents to any customer who opens it
+     * Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
      *
      * @param {Natural.CreateInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -75,7 +75,7 @@ export declare class InvitationLinksClient {
     create(request: Natural.CreateInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.CreateInvitationLinksResponse>;
     private __create;
     /**
-     * Get an invitation link your party created
+     * Get an invitation link and its offered agents, with a masked token
      *
      * @param {Natural.GetInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -103,7 +103,7 @@ export declare class InvitationLinksClient {
     get(request: Natural.GetInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.GetInvitationLinksResponse>;
     private __get;
     /**
-     * Stop a link from accepting new approvals. Access already granted through it keeps working until the customer revokes it.
+     * Revoke an invitation link so it stops connecting new customers
      *
      * @param {Natural.RevokeInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -25,7 +25,7 @@ export class InvitationLinksClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * List the invitation links your party has created
+     * List the invitation links you have created, with masked tokens
      *
      * @param {Natural.ListInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -135,7 +135,7 @@ export class InvitationLinksClient {
         });
     }
     /**
-     * Create a shareable link that offers your agents to any customer who opens it
+     * Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
      *
      * @param {Natural.CreateInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -245,7 +245,7 @@ export class InvitationLinksClient {
         });
     }
     /**
-     * Get an invitation link your party created
+     * Get an invitation link and its offered agents, with a masked token
      *
      * @param {Natural.GetInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -343,7 +343,7 @@ export class InvitationLinksClient {
         });
     }
     /**
-     * Stop a link from accepting new approvals. Access already granted through it keeps working until the customer revokes it.
+     * Revoke an invitation link so it stops connecting new customers
      *
      * @param {Natural.RevokeInvitationLinksRequest} request
      * @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts

@@ -1,6 +1,10 @@
 export declare const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem: {
     readonly PaymentsRead: "payments.read";
     readonly PaymentsCreate: "payments.create";
+    readonly ExternalPartiesRead: "external_parties.read";
+    readonly ExternalPartiesCreate: "external_parties.create";
+    readonly DirectPaymentsRead: "direct_payments.read";
+    readonly DirectPaymentsCreate: "direct_payments.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
     readonly WalletsUpdate: "wallets.update";

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs

@@ -2,6 +2,10 @@
 export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = {
     PaymentsRead: "payments.read",
     PaymentsCreate: "payments.create",
+    ExternalPartiesRead: "external_parties.read",
+    ExternalPartiesCreate: "external_parties.create",
+    DirectPaymentsRead: "direct_payments.read",
+    DirectPaymentsCreate: "direct_payments.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
     WalletsUpdate: "wallets.update",

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -1,6 +1,10 @@
 export declare const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem: {
     readonly PaymentsRead: "payments.read";
     readonly PaymentsCreate: "payments.create";
+    readonly ExternalPartiesRead: "external_parties.read";
+    readonly ExternalPartiesCreate: "external_parties.create";
+    readonly DirectPaymentsRead: "direct_payments.read";
+    readonly DirectPaymentsCreate: "direct_payments.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
     readonly WalletsUpdate: "wallets.update";

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -2,6 +2,10 @@
 export const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem = {
     PaymentsRead: "payments.read",
     PaymentsCreate: "payments.create",
+    ExternalPartiesRead: "external_parties.read",
+    ExternalPartiesCreate: "external_parties.create",
+    DirectPaymentsRead: "direct_payments.read",
+    DirectPaymentsCreate: "direct_payments.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
     WalletsUpdate: "wallets.update",

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -1,6 +1,10 @@
 export declare const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem: {
     readonly PaymentsRead: "payments.read";
     readonly PaymentsCreate: "payments.create";
+    readonly ExternalPartiesRead: "external_parties.read";
+    readonly ExternalPartiesCreate: "external_parties.create";
+    readonly DirectPaymentsRead: "direct_payments.read";
+    readonly DirectPaymentsCreate: "direct_payments.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
     readonly WalletsUpdate: "wallets.update";

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -2,6 +2,10 @@
 export const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem = {
     PaymentsRead: "payments.read",
     PaymentsCreate: "payments.create",
+    ExternalPartiesRead: "external_parties.read",
+    ExternalPartiesCreate: "external_parties.create",
+    DirectPaymentsRead: "direct_payments.read",
+    DirectPaymentsCreate: "direct_payments.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
     WalletsUpdate: "wallets.update",

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -1,6 +1,10 @@
 export declare const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem: {
     readonly PaymentsRead: "payments.read";
     readonly PaymentsCreate: "payments.create";
+    readonly ExternalPartiesRead: "external_parties.read";
+    readonly ExternalPartiesCreate: "external_parties.create";
+    readonly DirectPaymentsRead: "direct_payments.read";
+    readonly DirectPaymentsCreate: "direct_payments.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
     readonly WalletsUpdate: "wallets.update";

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.mjs

@@ -2,6 +2,10 @@
 export const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem = {
     PaymentsRead: "payments.read",
     PaymentsCreate: "payments.create",
+    ExternalPartiesRead: "external_parties.read",
+    ExternalPartiesCreate: "external_parties.create",
+    DirectPaymentsRead: "direct_payments.read",
+    DirectPaymentsCreate: "direct_payments.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
     WalletsUpdate: "wallets.update",

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -1,6 +1,10 @@
 export declare const RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem: {
     readonly PaymentsRead: "payments.read";
     readonly PaymentsCreate: "payments.create";
+    readonly ExternalPartiesRead: "external_parties.read";
+    readonly ExternalPartiesCreate: "external_parties.create";
+    readonly DirectPaymentsRead: "direct_payments.read";
+    readonly DirectPaymentsCreate: "direct_payments.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
     readonly WalletsUpdate: "wallets.update";

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -2,6 +2,10 @@
 export const RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem = {
     PaymentsRead: "payments.read",
     PaymentsCreate: "payments.create",
+    ExternalPartiesRead: "external_parties.read",
+    ExternalPartiesCreate: "external_parties.create",
+    DirectPaymentsRead: "direct_payments.read",
+    DirectPaymentsCreate: "direct_payments.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
     WalletsUpdate: "wallets.update",

package/dist/esm/api/resources/paymentRequests/types/FulfillPaymentRequestsRequestPaymentSourceWallet.d.mts

@@ -1,4 +1,4 @@
 export interface FulfillPaymentRequestsRequestPaymentSourceWallet {
-    /** Wallet used to pay. */
-    walletId: string;
+    /** Wallet used to pay. Omit to resolve the caller's default or granted wallet. */
+    walletId?: string;
 }

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

@@ -14,7 +14,7 @@ export declare class SimulationsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<SimulationsClient.Options>;
     constructor(options?: SimulationsClient.Options);
     /**
-     * Create a synthetic customer and one pending invitation for each selected agent
+     * Create a test customer and a pending invitation for each agent you name
      *
      * @param {Natural.InviteCustomerSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -44,7 +44,7 @@ export declare class SimulationsClient {
     inviteCustomer(request: Natural.InviteCustomerSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.InviteCustomerSimulationsResponse>;
     private __inviteCustomer;
     /**
-     * Add test funds to a connected customer's wallet and return the completed deposit Transfer
+     * Add test funds to a connected customer's wallet
      *
      * @param {Natural.FundCustomerSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -76,7 +76,7 @@ export declare class SimulationsClient {
     fundCustomer(request: Natural.FundCustomerSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FundCustomerSimulationsResponse>;
     private __fundCustomer;
     /**
-     * Link a test bank account to your own party and return it in the linked-accounts list
+     * Link a test bank account to your own party
      *
      * @param {Natural.LinkExternalAccountSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -104,7 +104,7 @@ export declare class SimulationsClient {
     linkExternalAccount(request: Natural.LinkExternalAccountSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.LinkExternalAccountSimulationsResponse>;
     private __linkExternalAccount;
     /**
-     * Simulate the recipient of a held payment joining and receiving the funds, returning the payment
+     * Simulate the recipient of a held payment joining Natural and receiving the funds
      *
      * @param {Natural.CompletePaymentClaimSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -133,7 +133,7 @@ export declare class SimulationsClient {
     completePaymentClaim(request: Natural.CompletePaymentClaimSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.CompletePaymentClaimSimulationsResponse>;
     private __completePaymentClaim;
     /**
-     * Pay an eligible payment request using your funded test payer fixture and return the resulting payment
+     * Fulfill an open payment request addressed to your test payer
      *
      * @param {Natural.FulfillPaymentRequestSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -163,7 +163,7 @@ export declare class SimulationsClient {
     fulfillPaymentRequest(request: Natural.FulfillPaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FulfillPaymentRequestSimulationsResponse>;
     private __fulfillPaymentRequest;
     /**
-     * Decline an eligible payment request as your test payer fixture and return the declined request
+     * Decline an open payment request addressed to your test payer
      *
      * @param {Natural.DeclinePaymentRequestSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -192,7 +192,7 @@ export declare class SimulationsClient {
     declinePaymentRequest(request: Natural.DeclinePaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclinePaymentRequestSimulationsResponse>;
     private __declinePaymentRequest;
     /**
-     * Accept a pending customer invitation as one of your test customers and return the accepted invitation
+     * Accept a pending customer invitation as the test customer it is addressed to
      *
      * @param {Natural.AcceptCustomerInvitationSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -223,7 +223,7 @@ export declare class SimulationsClient {
     acceptCustomerInvitation(request: Natural.AcceptCustomerInvitationSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.AcceptCustomerInvitationSimulationsResponse>;
     private __acceptCustomerInvitation;
     /**
-     * Decline a pending customer invitation as one of your test customers and return the declined invitation
+     * Decline a pending customer invitation as the test customer it is addressed to
      *
      * @param {Natural.DeclineCustomerInvitationSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -254,7 +254,7 @@ export declare class SimulationsClient {
     declineCustomerInvitation(request: Natural.DeclineCustomerInvitationSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclineCustomerInvitationSimulationsResponse>;
     private __declineCustomerInvitation;
     /**
-     * Revoke an agent's access to one of your test customers, acting as the customer, and return the customer
+     * Remove an agent's access to a test customer, acting as the customer
      *
      * @param {Natural.RevokeAgentConnectionSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -36,7 +36,7 @@ export class SimulationsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Create a synthetic customer and one pending invitation for each selected agent
+     * Create a test customer and a pending invitation for each agent you name
      *
      * @param {Natural.InviteCustomerSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -143,7 +143,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Add test funds to a connected customer's wallet and return the completed deposit Transfer
+     * Add test funds to a connected customer's wallet
      *
      * @param {Natural.FundCustomerSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -254,7 +254,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Link a test bank account to your own party and return it in the linked-accounts list
+     * Link a test bank account to your own party
      *
      * @param {Natural.LinkExternalAccountSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -353,7 +353,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Simulate the recipient of a held payment joining and receiving the funds, returning the payment
+     * Simulate the recipient of a held payment joining Natural and receiving the funds
      *
      * @param {Natural.CompletePaymentClaimSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -454,7 +454,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Pay an eligible payment request using your funded test payer fixture and return the resulting payment
+     * Fulfill an open payment request addressed to your test payer
      *
      * @param {Natural.FulfillPaymentRequestSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -557,7 +557,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Decline an eligible payment request as your test payer fixture and return the declined request
+     * Decline an open payment request addressed to your test payer
      *
      * @param {Natural.DeclinePaymentRequestSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -657,7 +657,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Accept a pending customer invitation as one of your test customers and return the accepted invitation
+     * Accept a pending customer invitation as the test customer it is addressed to
      *
      * @param {Natural.AcceptCustomerInvitationSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -767,7 +767,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Decline a pending customer invitation as one of your test customers and return the declined invitation
+     * Decline a pending customer invitation as the test customer it is addressed to
      *
      * @param {Natural.DeclineCustomerInvitationSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -877,7 +877,7 @@ export class SimulationsClient {
         });
     }
     /**
-     * Revoke an agent's access to one of your test customers, acting as the customer, and return the customer
+     * Remove an agent's access to a test customer, acting as the customer
      *
      * @param {Natural.RevokeAgentConnectionSimulationsRequest} request
      * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/simulations/client/requests/AcceptCustomerInvitationSimulationsRequest.d.mts

@@ -10,6 +10,6 @@ export interface AcceptCustomerInvitationSimulationsRequest {
     invitationId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;
-    /** Sandbox customer fixture Party the invitation is addressed to. */
+    /** Party ID (pty_*) of the test customer the invitation is addressed to. */
     partyId: string;
 }

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

@@ -10,6 +10,6 @@ export interface DeclineCustomerInvitationSimulationsRequest {
     invitationId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;
-    /** Sandbox customer fixture Party the invitation is addressed to. */
+    /** Party ID (pty_*) of the test customer the invitation is addressed to. */
     partyId: string;
 }

package/dist/esm/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts

@@ -10,8 +10,8 @@ import type * as Natural from "../../../../index.mjs";
 export interface InviteCustomerSimulationsRequest {
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;
-    /** Operator agents that the synthetic party will delegate to */
+    /** Agents to grant access to. The test customer receives a pending invitation for each agent listed. */
     agentIds: string[];
-    /** Synthetic party type (`PERSON` or `ORG`). Defaults to `PERSON`. */
+    /** Test customer party type. Defaults to PERSON. */
     type?: Natural.InviteCustomerSimulationsRequestType;
 }

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

@@ -8,6 +8,10 @@ export interface FundCustomerSimulationsResponseDataAttributes {
     currency: string;
     /** Transfer status. */
     status: Natural.FundCustomerSimulationsResponseDataAttributesStatus;
+    /** Requested delivery method, when available. */
+    method: string | null;
+    /** Executed transfer rail, when available. */
+    rail: string | null;
     /** Transfer description. */
     description: string | null;
     /** Masked external account number. */

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

@@ -1,4 +1,4 @@
-/** Synthetic party type (`PERSON` or `ORG`). Defaults to `PERSON`. */
+/** Test customer party type. Defaults to PERSON. */
 export declare const InviteCustomerSimulationsRequestType: {
     readonly Person: "PERSON";
     readonly Org: "ORG";

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

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** Synthetic party type (`PERSON` or `ORG`). Defaults to `PERSON`. */
+/** Test customer party type. Defaults to PERSON. */
 export const InviteCustomerSimulationsRequestType = {
     Person: "PERSON",
     Org: "ORG",

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

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 export interface InviteCustomerSimulationsResponse {
-    /** Pending invitations created for the selected agents. */
+    /** Pending invitations created, one for each agent listed. */
     data: Natural.InviteCustomerSimulationsResponseDataItem[];
     meta: Natural.InviteCustomerSimulationsResponseMeta;
 }

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

@@ -1,9 +1,9 @@
 import type * as Natural from "../../../index.mjs";
 export interface InviteCustomerSimulationsResponseMetaCustomer {
-    /** Synthetic customer party ID. */
+    /** Customer party ID (pty_*). */
     partyId: string;
-    /** Synthetic customer handle in "@name" form. */
+    /** The test customer's handle (@name), assigned automatically. */
     handle: string;
-    /** Synthetic customer party type. */
+    /** Test customer party type. */
     partyType: Natural.InviteCustomerSimulationsResponseMetaCustomerPartyType;
 }

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

@@ -1,4 +1,4 @@
-/** Synthetic customer party type. */
+/** Test customer party type. */
 export declare const InviteCustomerSimulationsResponseMetaCustomerPartyType: {
     readonly Person: "PERSON";
     readonly Org: "ORG";

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

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** Synthetic customer party type. */
+/** Test customer party type. */
 export const InviteCustomerSimulationsResponseMetaCustomerPartyType = {
     Person: "PERSON",
     Org: "ORG",

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

@@ -6,6 +6,8 @@ export interface LinkExternalAccountSimulationsResponseDataItemAttributes {
     status: Natural.LinkExternalAccountSimulationsResponseDataItemAttributesStatus;
     /** Provider connection health for this external account. */
     connectionStatus: Natural.LinkExternalAccountSimulationsResponseDataItemAttributesConnectionStatus;
+    /** Withdrawal delivery methods currently available for this external account. */
+    availableMethods: Natural.LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem[];
     /** Time when the external account was linked. */
     createdAt: Date;
     /** Bank institution name, when available. */

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

@@ -0,0 +1,5 @@
+export declare const LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem: {
+    readonly Standard: "standard";
+    readonly Instant: "instant";
+};
+export type LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem = (typeof LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem)[keyof typeof LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem];

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

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem = {
+    Standard: "standard",
+    Instant: "instant",
+};

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

@@ -148,6 +148,7 @@ export * from "./LinkExternalAccountSimulationsResponse.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItem.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributes.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesAccountType.mjs";
+export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesConnectionStatus.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesStatus.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemRelationships.mjs";

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

@@ -148,6 +148,7 @@ export * from "./LinkExternalAccountSimulationsResponse.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItem.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributes.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesAccountType.mjs";
+export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesAvailableMethodsItem.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesConnectionStatus.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemAttributesStatus.mjs";
 export * from "./LinkExternalAccountSimulationsResponseDataItemRelationships.mjs";

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

@@ -72,6 +72,7 @@ export declare class TransfersClient {
      *         amount: 12500,
      *         currency: "USD",
      *         externalAccountId: "eac_550e8400e29b41d4a716446655440000",
+     *         method: "standard",
      *         description: "Payout transfer"
      *     })
      */

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

@@ -171,6 +171,7 @@ export class TransfersClient {
      *         amount: 12500,
      *         currency: "USD",
      *         externalAccountId: "eac_550e8400e29b41d4a716446655440000",
+     *         method: "standard",
      *         description: "Payout transfer"
      *     })
      */

package/dist/esm/api/resources/transfers/client/requests/NewWithdrawalParams.d.mts

@@ -6,6 +6,7 @@ import type * as Natural from "../../../../index.mjs";
  *         amount: 12500,
  *         currency: "USD",
  *         externalAccountId: "eac_550e8400e29b41d4a716446655440000",
+ *         method: "standard",
  *         description: "Payout transfer"
  *     }
  */
@@ -18,6 +19,8 @@ export interface NewWithdrawalParams {
     currency?: Natural.InitiateWithdrawalTransfersRequestCurrency;
     /** External account ID (eac_*). */
     externalAccountId: string;
+    /** Delivery method. Defaults to standard. To request instant withdrawal access and pricing, contact hi@natural.com. */
+    method?: Natural.InitiateWithdrawalTransfersRequestMethod;
     /** Source wallet for the withdrawal. Defaults to your party's default wallet when omitted. */
     walletId?: string;
     /** Memo for the withdrawal. */

package/dist/esm/api/resources/transfers/types/DepositAttrs.d.mts

@@ -8,6 +8,10 @@ export interface DepositAttrs {
     currency: string;
     /** Transfer status. */
     status: Natural.DepositStatus;
+    /** Requested delivery method, when available. */
+    method: string | null;
+    /** Executed transfer rail, when available. */
+    rail: string | null;
     /** Transfer description. */
     description: string | null;
     /** Masked external account number. */

package/dist/esm/api/resources/transfers/types/InitiateInternalTransfersResponseDataAttributes.d.mts

@@ -8,6 +8,10 @@ export interface InitiateInternalTransfersResponseDataAttributes {
     currency: string;
     /** Transfer status. */
     status: Natural.InitiateInternalTransfersResponseDataAttributesStatus;
+    /** Requested delivery method, when available. */
+    method: string | null;
+    /** Executed transfer rail, when available. */
+    rail: string | null;
     /** Transfer description. */
     description: string | null;
     /** Masked external account number. */

package/dist/esm/api/resources/transfers/types/InitiateWithdrawalTransfersRequestMethod.d.mts

@@ -0,0 +1,6 @@
+/** Delivery method. Defaults to standard. To request instant withdrawal access and pricing, contact hi@natural.com. */
+export declare const InitiateWithdrawalTransfersRequestMethod: {
+    readonly Standard: "standard";
+    readonly Instant: "instant";
+};
+export type InitiateWithdrawalTransfersRequestMethod = (typeof InitiateWithdrawalTransfersRequestMethod)[keyof typeof InitiateWithdrawalTransfersRequestMethod];

package/dist/esm/api/resources/transfers/types/InitiateWithdrawalTransfersRequestMethod.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Delivery method. Defaults to standard. To request instant withdrawal access and pricing, contact hi@natural.com. */
+export const InitiateWithdrawalTransfersRequestMethod = {
+    Standard: "standard",
+    Instant: "instant",
+};

package/dist/esm/api/resources/transfers/types/TransferAttrs.d.mts

@@ -8,6 +8,10 @@ export interface TransferAttrs {
     currency: string;
     /** Transfer status. */
     status: Natural.TransferStatus;
+    /** Requested delivery method, when available. */
+    method: string | null;
+    /** Executed transfer rail, when available. */
+    rail: string | null;
     /** Transfer description. */
     description: string | null;
     /** Masked external account number. */

package/dist/esm/api/resources/transfers/types/TransferDetailAttrs.d.mts

@@ -8,6 +8,10 @@ export interface TransferDetailAttrs {
     currency: string;
     /** Transfer status. */
     status: Natural.TransferDetailStatus;
+    /** Requested delivery method, when available. */
+    method: string | null;
+    /** Executed transfer rail, when available. */
+    rail: string | null;
     /** Transfer description. */
     description: string | null;
     /** Masked external account number. */

package/dist/esm/api/resources/transfers/types/WithdrawalAttrs.d.mts

@@ -8,6 +8,10 @@ export interface WithdrawalAttrs {
     currency: string;
     /** Transfer status. */
     status: Natural.WithdrawalStatus;
+    /** Requested delivery method, when available. */
+    method: string | null;
+    /** Executed transfer rail, when available. */
+    rail: string | null;
     /** Transfer description. */
     description: string | null;
     /** Masked external account number. */