@naturalpay/sdk 1.2.2 → 1.2.4

package/dist/esm/api/resources/agents/types/DelAgentAttrs.d.mts

@@ -4,6 +4,8 @@ export interface DelAgentAttrs {
     name: string;
     /** Agent description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Agent handle, such as @acme-support, or null if none is configured. */
     handle: string | null;
     /** Agent status. */

package/dist/esm/api/resources/agents/types/NewAgentAttrs.d.mts

@@ -4,6 +4,8 @@ export interface NewAgentAttrs {
     name: string;
     /** Agent description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Agent handle, such as @acme-support, or null if none is configured. */
     handle: string | null;
     /** Agent status. */

package/dist/esm/api/resources/agents/types/UpdAgentAttrs.d.mts

@@ -4,6 +4,8 @@ export interface UpdAgentAttrs {
     name: string;
     /** Agent description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Agent handle, such as @acme-support, or null if none is configured. */
     handle: string | null;
     /** Agent status. */

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

@@ -62,7 +62,10 @@ export declare class ApiKeysClient {
      * @example
      *     await client.apiKeys.create({
      *         name: "Production Backend",
-     *         scopes: ["payments.read", "payments.create"]
+     *         scopes: ["payments.read", "payments.create"],
+     *         tags: {
+     *             "service": "checkout"
+     *         }
      *     })
      */
     create(request: Natural.NewApiKeyParams, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<Natural.NewApiKey>;

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

@@ -169,7 +169,10 @@ export class ApiKeysClient {
      * @example
      *     await client.apiKeys.create({
      *         name: "Production Backend",
-     *         scopes: ["payments.read", "payments.create"]
+     *         scopes: ["payments.read", "payments.create"],
+     *         tags: {
+     *             "service": "checkout"
+     *         }
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/apiKeys/client/requests/NewApiKeyParams.d.mts

@@ -3,7 +3,10 @@ import type * as Natural from "../../../../index.mjs";
  * @example
  *     {
  *         name: "Production Backend",
- *         scopes: ["payments.read", "payments.create"]
+ *         scopes: ["payments.read", "payments.create"],
+ *         tags: {
+ *             "service": "checkout"
+ *         }
  *     }
  */
 export interface NewApiKeyParams {
@@ -11,4 +14,6 @@ export interface NewApiKeyParams {
     name: string;
     /** Permission scopes for the API key. */
     scopes?: Natural.CreateApiKeysRequestScopesItem[];
+    /** Tags applied to this API key. */
+    tags?: Record<string, string>;
 }

package/dist/esm/api/resources/apiKeys/types/ApiKeyAttrs.d.mts

@@ -20,4 +20,6 @@ export interface ApiKeyAttrs {
     createdBy: string | null;
     /** User who revoked this key (usr_*). */
     revokedBy: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
 }

package/dist/esm/api/resources/apiKeys/types/ApiKeyDetailAttrs.d.mts

@@ -20,4 +20,6 @@ export interface ApiKeyDetailAttrs {
     createdBy: string | null;
     /** User who revoked this key (usr_*). */
     revokedBy: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
 }

package/dist/esm/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.d.mts

@@ -13,14 +13,16 @@ export declare const CreateApiKeysRequestScopesItem: {
     readonly PaymentsRead: "payments.read";
     readonly ExternalPartiesCreate: "external_parties.create";
     readonly ExternalPartiesRead: "external_parties.read";
-    readonly DirectPaymentsCreate: "direct_payments.create";
-    readonly DirectPaymentsRead: "direct_payments.read";
+    readonly DirectCreate: "direct.create";
+    readonly DirectRead: "direct.read";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
     readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
     readonly WalletsDelete: "wallets.delete";
     readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly DelegationsRead: "delegations.read";
     readonly DelegationsCreate: "delegations.create";

package/dist/esm/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.mjs

@@ -14,14 +14,16 @@ export const CreateApiKeysRequestScopesItem = {
     PaymentsRead: "payments.read",
     ExternalPartiesCreate: "external_parties.create",
     ExternalPartiesRead: "external_parties.read",
-    DirectPaymentsCreate: "direct_payments.create",
-    DirectPaymentsRead: "direct_payments.read",
+    DirectCreate: "direct.create",
+    DirectRead: "direct.read",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
     WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
     WalletsDelete: "wallets.delete",
     WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
     WalletsWithdraw: "wallets.withdraw",
     DelegationsRead: "delegations.read",
     DelegationsCreate: "delegations.create",

package/dist/esm/api/resources/apiKeys/types/DelApiKeyAttrs.d.mts

@@ -20,4 +20,6 @@ export interface DelApiKeyAttrs {
     createdBy: string | null;
     /** User who revoked this key (usr_*). */
     revokedBy: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
 }

package/dist/esm/api/resources/apiKeys/types/NewApiKeyAttrs.d.mts

@@ -20,6 +20,8 @@ export interface NewApiKeyAttrs {
     createdBy: string | null;
     /** User who revoked this key (usr_*). */
     revokedBy: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Full API key secret. Returned only once. */
     apiKey: string;
 }

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesTargetType.d.mts

@@ -3,6 +3,6 @@ export declare const ApproveApprovalsResponseDataAttributesTargetType: {
     readonly Payment: "payment";
     readonly Deposit: "deposit";
     readonly Withdrawal: "withdrawal";
-    readonly DirectPayment: "direct_payment";
+    readonly Ach: "ach";
 };
 export type ApproveApprovalsResponseDataAttributesTargetType = (typeof ApproveApprovalsResponseDataAttributesTargetType)[keyof typeof ApproveApprovalsResponseDataAttributesTargetType];

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesTargetType.mjs

@@ -4,5 +4,5 @@ export const ApproveApprovalsResponseDataAttributesTargetType = {
     Payment: "payment",
     Deposit: "deposit",
     Withdrawal: "withdrawal",
-    DirectPayment: "direct_payment",
+    Ach: "ach",
 };

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesTargetType.d.mts

@@ -3,6 +3,6 @@ export declare const DenyApprovalsResponseDataAttributesTargetType: {
     readonly Payment: "payment";
     readonly Deposit: "deposit";
     readonly Withdrawal: "withdrawal";
-    readonly DirectPayment: "direct_payment";
+    readonly Ach: "ach";
 };
 export type DenyApprovalsResponseDataAttributesTargetType = (typeof DenyApprovalsResponseDataAttributesTargetType)[keyof typeof DenyApprovalsResponseDataAttributesTargetType];

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesTargetType.mjs

@@ -4,5 +4,5 @@ export const DenyApprovalsResponseDataAttributesTargetType = {
     Payment: "payment",
     Deposit: "deposit",
     Withdrawal: "withdrawal",
-    DirectPayment: "direct_payment",
+    Ach: "ach",
 };

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesTargetType.d.mts

@@ -3,6 +3,6 @@ export declare const GetApprovalsResponseDataAttributesTargetType: {
     readonly Payment: "payment";
     readonly Deposit: "deposit";
     readonly Withdrawal: "withdrawal";
-    readonly DirectPayment: "direct_payment";
+    readonly Ach: "ach";
 };
 export type GetApprovalsResponseDataAttributesTargetType = (typeof GetApprovalsResponseDataAttributesTargetType)[keyof typeof GetApprovalsResponseDataAttributesTargetType];

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesTargetType.mjs

@@ -4,5 +4,5 @@ export const GetApprovalsResponseDataAttributesTargetType = {
     Payment: "payment",
     Deposit: "deposit",
     Withdrawal: "withdrawal",
-    DirectPayment: "direct_payment",
+    Ach: "ach",
 };

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesTargetType.d.mts

@@ -3,6 +3,6 @@ export declare const ListApprovalsResponseDataItemAttributesTargetType: {
     readonly Payment: "payment";
     readonly Deposit: "deposit";
     readonly Withdrawal: "withdrawal";
-    readonly DirectPayment: "direct_payment";
+    readonly Ach: "ach";
 };
 export type ListApprovalsResponseDataItemAttributesTargetType = (typeof ListApprovalsResponseDataItemAttributesTargetType)[keyof typeof ListApprovalsResponseDataItemAttributesTargetType];

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesTargetType.mjs

@@ -4,5 +4,5 @@ export const ListApprovalsResponseDataItemAttributesTargetType = {
     Payment: "payment",
     Deposit: "deposit",
     Withdrawal: "withdrawal",
-    DirectPayment: "direct_payment",
+    Ach: "ach",
 };

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.d.mts

@@ -3,11 +3,16 @@ export declare const CreateInvitationsCustomersRequestAgentsItemPermissionsItem:
     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 DirectRead: "direct.read";
+    readonly DirectCreate: "direct.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
+    readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
+    readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
+    readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
 };

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.mjs

@@ -4,11 +4,16 @@ export const CreateInvitationsCustomersRequestAgentsItemPermissionsItem = {
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
     ExternalPartiesCreate: "external_parties.create",
-    DirectPaymentsRead: "direct_payments.read",
-    DirectPaymentsCreate: "direct_payments.create",
+    DirectRead: "direct.read",
+    DirectCreate: "direct.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
+    WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
+    WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
+    WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
 };

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmail.d.mts

@@ -1,4 +1,7 @@
+import type * as Natural from "../../../index.mjs";
 export interface CreateInvitationsCustomersRequestRecipientsItemEmail {
     /** Email address. */
     value: string;
+    /** Optional onboarding suggestions for this customer. The customer reviews and confirms every value. */
+    prefill?: Natural.CustomerInvitationPrefill;
 }

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome.d.mts

@@ -0,0 +1,10 @@
+/** annual income bucket */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome: {
+    readonly Zero25000: "0-25000";
+    readonly Undefined50000: "25001-50000";
+    readonly Undefined100000: "50001-100000";
+    readonly Undefined200000: "100001-200000";
+    readonly Undefined500000: "200001-500000";
+    readonly Undefined: "500001+";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** annual income bucket */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemAnnualIncome = {
+    Zero25000: "0-25000",
+    Undefined50000: "25001-50000",
+    Undefined100000: "50001-100000",
+    Undefined200000: "100001-200000",
+    Undefined500000: "200001-500000",
+    Undefined: "500001+",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus.d.mts

@@ -0,0 +1,10 @@
+/** employment status */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus: {
+    readonly Employed: "employed";
+    readonly SelfEmployed: "self_employed";
+    readonly Unemployed: "unemployed";
+    readonly Retired: "retired";
+    readonly Student: "student";
+    readonly Other: "other";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** employment status */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemEmploymentStatus = {
+    Employed: "employed",
+    SelfEmployed: "self_employed",
+    Unemployed: "unemployed",
+    Retired: "retired",
+    Student: "student",
+    Other: "other",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle.d.mts

@@ -0,0 +1,15 @@
+/** job title */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle: {
+    readonly Ceo: "ceo";
+    readonly Cfo: "cfo";
+    readonly Coo: "coo";
+    readonly Cto: "cto";
+    readonly President: "president";
+    readonly Vp: "vp";
+    readonly Director: "director";
+    readonly Manager: "manager";
+    readonly Owner: "owner";
+    readonly Partner: "partner";
+    readonly Other: "other";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle.mjs

@@ -0,0 +1,15 @@
+// This file was auto-generated by Fern from our API Definition.
+/** job title */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBeneficialOwnersItemTitle = {
+    Ceo: "ceo",
+    Cfo: "cfo",
+    Coo: "coo",
+    Cto: "cto",
+    President: "president",
+    Vp: "vp",
+    Director: "director",
+    Manager: "manager",
+    Owner: "owner",
+    Partner: "partner",
+    Other: "other",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType.d.mts

@@ -0,0 +1,8 @@
+/** business entity type */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType: {
+    readonly Llc: "llc";
+    readonly Corporation: "corporation";
+    readonly Partnership: "partnership";
+    readonly SoleProprietorship: "sole_proprietorship";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** business entity type */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessBusinessType = {
+    Llc: "llc",
+    Corporation: "corporation",
+    Partnership: "partnership",
+    SoleProprietorship: "sole_proprietorship",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem.d.mts

@@ -0,0 +1,12 @@
+/** source of funds */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem: {
+    readonly BusinessRevenue: "business_revenue";
+    readonly IntercompanyTransfers: "intercompany_transfers";
+    readonly RentalLeaseIncome: "rental_lease_income";
+    readonly AssetSales: "asset_sales";
+    readonly LoanProceeds: "loan_proceeds";
+    readonly InvestmentCapital: "investment_capital";
+    readonly OwnerShareholderCapital: "owner_shareholder_capital";
+    readonly GovernmentGrantsDonations: "government_grants_donations";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem.mjs

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+/** source of funds */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessSourceOfFundsItem = {
+    BusinessRevenue: "business_revenue",
+    IntercompanyTransfers: "intercompany_transfers",
+    RentalLeaseIncome: "rental_lease_income",
+    AssetSales: "asset_sales",
+    LoanProceeds: "loan_proceeds",
+    InvestmentCapital: "investment_capital",
+    OwnerShareholderCapital: "owner_shareholder_capital",
+    GovernmentGrantsDonations: "government_grants_donations",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation.d.mts

@@ -0,0 +1,55 @@
+/** US state code */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation: {
+    readonly Al: "AL";
+    readonly Ak: "AK";
+    readonly Az: "AZ";
+    readonly Ar: "AR";
+    readonly Ca: "CA";
+    readonly Co: "CO";
+    readonly Ct: "CT";
+    readonly De: "DE";
+    readonly Fl: "FL";
+    readonly Ga: "GA";
+    readonly Hi: "HI";
+    readonly Id: "ID";
+    readonly Il: "IL";
+    readonly In: "IN";
+    readonly Ia: "IA";
+    readonly Ks: "KS";
+    readonly Ky: "KY";
+    readonly La: "LA";
+    readonly Me: "ME";
+    readonly Md: "MD";
+    readonly Ma: "MA";
+    readonly Mi: "MI";
+    readonly Mn: "MN";
+    readonly Ms: "MS";
+    readonly Mo: "MO";
+    readonly Mt: "MT";
+    readonly Ne: "NE";
+    readonly Nv: "NV";
+    readonly Nh: "NH";
+    readonly Nj: "NJ";
+    readonly Nm: "NM";
+    readonly Ny: "NY";
+    readonly Nc: "NC";
+    readonly Nd: "ND";
+    readonly Oh: "OH";
+    readonly Ok: "OK";
+    readonly Or: "OR";
+    readonly Pa: "PA";
+    readonly Ri: "RI";
+    readonly Sc: "SC";
+    readonly Sd: "SD";
+    readonly Tn: "TN";
+    readonly Tx: "TX";
+    readonly Ut: "UT";
+    readonly Vt: "VT";
+    readonly Va: "VA";
+    readonly Wa: "WA";
+    readonly Wv: "WV";
+    readonly Wi: "WI";
+    readonly Wy: "WY";
+    readonly Dc: "DC";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation.mjs

@@ -0,0 +1,55 @@
+// This file was auto-generated by Fern from our API Definition.
+/** US state code */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillBusinessStateOfIncorporation = {
+    Al: "AL",
+    Ak: "AK",
+    Az: "AZ",
+    Ar: "AR",
+    Ca: "CA",
+    Co: "CO",
+    Ct: "CT",
+    De: "DE",
+    Fl: "FL",
+    Ga: "GA",
+    Hi: "HI",
+    Id: "ID",
+    Il: "IL",
+    In: "IN",
+    Ia: "IA",
+    Ks: "KS",
+    Ky: "KY",
+    La: "LA",
+    Me: "ME",
+    Md: "MD",
+    Ma: "MA",
+    Mi: "MI",
+    Mn: "MN",
+    Ms: "MS",
+    Mo: "MO",
+    Mt: "MT",
+    Ne: "NE",
+    Nv: "NV",
+    Nh: "NH",
+    Nj: "NJ",
+    Nm: "NM",
+    Ny: "NY",
+    Nc: "NC",
+    Nd: "ND",
+    Oh: "OH",
+    Ok: "OK",
+    Or: "OR",
+    Pa: "PA",
+    Ri: "RI",
+    Sc: "SC",
+    Sd: "SD",
+    Tn: "TN",
+    Tx: "TX",
+    Ut: "UT",
+    Vt: "VT",
+    Va: "VA",
+    Wa: "WA",
+    Wv: "WV",
+    Wi: "WI",
+    Wy: "WY",
+    Dc: "DC",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome.d.mts

@@ -0,0 +1,10 @@
+/** annual income bucket */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome: {
+    readonly Zero25000: "0-25000";
+    readonly Undefined50000: "25001-50000";
+    readonly Undefined100000: "50001-100000";
+    readonly Undefined200000: "100001-200000";
+    readonly Undefined500000: "200001-500000";
+    readonly Undefined: "500001+";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** annual income bucket */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualAnnualIncome = {
+    Zero25000: "0-25000",
+    Undefined50000: "25001-50000",
+    Undefined100000: "50001-100000",
+    Undefined200000: "100001-200000",
+    Undefined500000: "200001-500000",
+    Undefined: "500001+",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus.d.mts

@@ -0,0 +1,10 @@
+/** employment status */
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus: {
+    readonly Employed: "employed";
+    readonly SelfEmployed: "self_employed";
+    readonly Unemployed: "unemployed";
+    readonly Retired: "retired";
+    readonly Student: "student";
+    readonly Other: "other";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** employment status */
+export const CreateInvitationsCustomersRequestRecipientsItemEmailPrefillIndividualEmploymentStatus = {
+    Employed: "employed",
+    SelfEmployed: "self_employed",
+    Unemployed: "unemployed",
+    Retired: "retired",
+    Student: "student",
+    Other: "other",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemPhone.d.mts

@@ -1,4 +1,7 @@
+import type * as Natural from "../../../index.mjs";
 export interface CreateInvitationsCustomersRequestRecipientsItemPhone {
     /** Phone number. */
     value: string;
+    /** Optional onboarding suggestions for this customer. The customer reviews and confirms every value. */
+    prefill?: Natural.CustomerInvitationPrefill;
 }

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome.d.mts

@@ -0,0 +1,10 @@
+/** annual income bucket */
+export declare const CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome: {
+    readonly Zero25000: "0-25000";
+    readonly Undefined50000: "25001-50000";
+    readonly Undefined100000: "50001-100000";
+    readonly Undefined200000: "100001-200000";
+    readonly Undefined500000: "200001-500000";
+    readonly Undefined: "500001+";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome = (typeof CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** annual income bucket */
+export const CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemAnnualIncome = {
+    Zero25000: "0-25000",
+    Undefined50000: "25001-50000",
+    Undefined100000: "50001-100000",
+    Undefined200000: "100001-200000",
+    Undefined500000: "200001-500000",
+    Undefined: "500001+",
+};

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus.d.mts

@@ -0,0 +1,10 @@
+/** employment status */
+export declare const CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus: {
+    readonly Employed: "employed";
+    readonly SelfEmployed: "self_employed";
+    readonly Unemployed: "unemployed";
+    readonly Retired: "retired";
+    readonly Student: "student";
+    readonly Other: "other";
+};
+export type CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus = (typeof CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus];

package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** employment status */
+export const CreateInvitationsCustomersRequestRecipientsItemPhonePrefillBeneficialOwnersItemEmploymentStatus = {
+    Employed: "employed",
+    SelfEmployed: "self_employed",
+    Unemployed: "unemployed",
+    Retired: "retired",
+    Student: "student",
+    Other: "other",
+};