@naturalpay/sdk 1.2.6 → 1.3.0

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@naturalpay/sdk",
-        "X-Fern-SDK-Version": "1.2.6",
-        "User-Agent": "@naturalpay/sdk/1.2.6",
+        "X-Fern-SDK-Version": "1.3.0",
+        "User-Agent": "@naturalpay/sdk/1.3.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Agent-ID": options === null || options === void 0 ? void 0 : options.agentId,

package/dist/cjs/api/resources/customers/client/Client.d.ts

@@ -117,7 +117,56 @@ export declare class CustomersClient {
      *     await client.customers.createInvitations({
      *         recipients: [{
      *                 type: "email",
-     *                 value: "ops@acme.com"
+     *                 value: "ops@acme.com",
+     *                 accountType: "business",
+     *                 firstName: "Morgan",
+     *                 lastName: "Lee",
+     *                 phone: "+14155550176",
+     *                 business: {
+     *                     legalName: "Acme Logistics LLC",
+     *                     displayName: "Acme Logistics",
+     *                     website: "https://acmelogistics.com",
+     *                     hasTradeName: true,
+     *                     tradeName: "Acme Freight",
+     *                     businessType: "llc",
+     *                     industry: "513210",
+     *                     stateOfIncorporation: "DE",
+     *                     incorporationDate: "2018-03-12",
+     *                     registeredAddress: {
+     *                         streetLine1: "251 Little Falls Dr",
+     *                         city: "Wilmington",
+     *                         subdivision: "DE",
+     *                         postalCode: "19808",
+     *                         country: "US"
+     *                     },
+     *                     physicalAddress: {
+     *                         streetLine1: "900 Harrison St",
+     *                         city: "San Francisco",
+     *                         subdivision: "CA",
+     *                         postalCode: "94107",
+     *                         country: "US"
+     *                     },
+     *                     sourceOfFunds: ["business_revenue"],
+     *                     countriesOfOperations: ["US", "CA"],
+     *                     beneficialOwners: [{
+     *                             firstName: "Morgan",
+     *                             lastName: "Lee",
+     *                             email: "morgan.lee@acme.com",
+     *                             phone: "+14155550176",
+     *                             dateOfBirth: "1985-09-02",
+     *                             address: {
+     *                                 streetLine1: "128 Alamo Square",
+     *                                 city: "San Francisco",
+     *                                 subdivision: "CA",
+     *                                 postalCode: "94117",
+     *                                 country: "US"
+     *                             },
+     *                             ownershipPercentage: 60,
+     *                             title: "ceo",
+     *                             countryOfCitizenship: "US",
+     *                             employmentStatus: "employed"
+     *                         }]
+     *                 }
      *             }],
      *         agents: [{
      *                 agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",

package/dist/cjs/api/resources/customers/client/Client.js

@@ -408,7 +408,56 @@ class CustomersClient {
      *     await client.customers.createInvitations({
      *         recipients: [{
      *                 type: "email",
-     *                 value: "ops@acme.com"
+     *                 value: "ops@acme.com",
+     *                 accountType: "business",
+     *                 firstName: "Morgan",
+     *                 lastName: "Lee",
+     *                 phone: "+14155550176",
+     *                 business: {
+     *                     legalName: "Acme Logistics LLC",
+     *                     displayName: "Acme Logistics",
+     *                     website: "https://acmelogistics.com",
+     *                     hasTradeName: true,
+     *                     tradeName: "Acme Freight",
+     *                     businessType: "llc",
+     *                     industry: "513210",
+     *                     stateOfIncorporation: "DE",
+     *                     incorporationDate: "2018-03-12",
+     *                     registeredAddress: {
+     *                         streetLine1: "251 Little Falls Dr",
+     *                         city: "Wilmington",
+     *                         subdivision: "DE",
+     *                         postalCode: "19808",
+     *                         country: "US"
+     *                     },
+     *                     physicalAddress: {
+     *                         streetLine1: "900 Harrison St",
+     *                         city: "San Francisco",
+     *                         subdivision: "CA",
+     *                         postalCode: "94107",
+     *                         country: "US"
+     *                     },
+     *                     sourceOfFunds: ["business_revenue"],
+     *                     countriesOfOperations: ["US", "CA"],
+     *                     beneficialOwners: [{
+     *                             firstName: "Morgan",
+     *                             lastName: "Lee",
+     *                             email: "morgan.lee@acme.com",
+     *                             phone: "+14155550176",
+     *                             dateOfBirth: "1985-09-02",
+     *                             address: {
+     *                                 streetLine1: "128 Alamo Square",
+     *                                 city: "San Francisco",
+     *                                 subdivision: "CA",
+     *                                 postalCode: "94117",
+     *                                 country: "US"
+     *                             },
+     *                             ownershipPercentage: 60,
+     *                             title: "ceo",
+     *                             countryOfCitizenship: "US",
+     *                             employmentStatus: "employed"
+     *                         }]
+     *                 }
      *             }],
      *         agents: [{
      *                 agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",

package/dist/cjs/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.ts

@@ -4,7 +4,56 @@ import type * as Natural from "../../../../index.js";
  *     {
  *         recipients: [{
  *                 type: "email",
- *                 value: "ops@acme.com"
+ *                 value: "ops@acme.com",
+ *                 accountType: "business",
+ *                 firstName: "Morgan",
+ *                 lastName: "Lee",
+ *                 phone: "+14155550176",
+ *                 business: {
+ *                     legalName: "Acme Logistics LLC",
+ *                     displayName: "Acme Logistics",
+ *                     website: "https://acmelogistics.com",
+ *                     hasTradeName: true,
+ *                     tradeName: "Acme Freight",
+ *                     businessType: "llc",
+ *                     industry: "513210",
+ *                     stateOfIncorporation: "DE",
+ *                     incorporationDate: "2018-03-12",
+ *                     registeredAddress: {
+ *                         streetLine1: "251 Little Falls Dr",
+ *                         city: "Wilmington",
+ *                         subdivision: "DE",
+ *                         postalCode: "19808",
+ *                         country: "US"
+ *                     },
+ *                     physicalAddress: {
+ *                         streetLine1: "900 Harrison St",
+ *                         city: "San Francisco",
+ *                         subdivision: "CA",
+ *                         postalCode: "94107",
+ *                         country: "US"
+ *                     },
+ *                     sourceOfFunds: ["business_revenue"],
+ *                     countriesOfOperations: ["US", "CA"],
+ *                     beneficialOwners: [{
+ *                             firstName: "Morgan",
+ *                             lastName: "Lee",
+ *                             email: "morgan.lee@acme.com",
+ *                             phone: "+14155550176",
+ *                             dateOfBirth: "1985-09-02",
+ *                             address: {
+ *                                 streetLine1: "128 Alamo Square",
+ *                                 city: "San Francisco",
+ *                                 subdivision: "CA",
+ *                                 postalCode: "94117",
+ *                                 country: "US"
+ *                             },
+ *                             ownershipPercentage: 60,
+ *                             title: "ceo",
+ *                             countryOfCitizenship: "US",
+ *                             employmentStatus: "employed"
+ *                         }]
+ *                 }
  *             }],
  *         agents: [{
  *                 agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
@@ -31,6 +80,6 @@ export interface CreateInvitationsCustomersRequest {
     message?: string;
     /** Tags applied to each invitation. */
     tags?: Record<string, string>;
-    /** Natural notifications to disable for this request. "recipient" silences our message to the counterparty so you can deliver the returned link yourself; the person who initiated the request is always notified. Requires a delegated caller on payments and payment requests, which return 403 otherwise. Omit it, or send an empty array, to have Natural notify as usual. */
+    /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
     disableNotifications?: Natural.CreateInvitationsCustomersRequestDisableNotificationsItem[];
 }

package/dist/cjs/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmail.d.ts

@@ -2,18 +2,16 @@ import type * as Natural from "../../../index.js";
 export interface CreateInvitationsCustomersRequestRecipientsItemEmail {
     /** Email address. */
     value: string;
-    /** Optional onboarding suggestion (account type). The customer reviews and confirms every value. */
+    /** Account type */
     accountType?: Natural.CustomerInvitationAccountType;
     /** Legal first name of the person signing up. */
     firstName?: string;
     /** Legal last name of the person signing up. */
     lastName?: string;
-    /** Phone number of the person signing up (E.164). Pre-fills the personal details step. */
+    /** Phone number of the person signing up (E.164) */
     phone?: string;
     /** Identity-verification details for individual accounts. */
     individual?: Natural.CustomerInvitationIndividual;
     /** Optional onboarding suggestion (business). The customer reviews and confirms every value. */
     business?: Natural.CustomerInvitationBusiness;
-    /** Optional onboarding suggestion (beneficial owners). The customer reviews and confirms every value. */
-    beneficialOwners?: Natural.CustomerInvitationBeneficialOwner[];
 }

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry.d.ts → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry.d.ts}

@@ -1,5 +1,5 @@
 /** Country (ISO-3166-1 alpha-2). */
-export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry: {
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry: {
     readonly Us: "US";
     readonly Af: "AF";
     readonly Al: "AL";
@@ -197,4 +197,4 @@ export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBenefic
     readonly Zm: "ZM";
     readonly Zw: "ZW";
 };
-export type CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry];
+export type CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry];

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry.js → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry.js}

@@ -1,9 +1,9 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry = void 0;
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry = void 0;
 /** Country (ISO-3166-1 alpha-2). */
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry = {
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry = {
     Us: "US",
     Af: "AF",
     Al: "AL",

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome.d.ts → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome.d.ts}

@@ -1,5 +1,5 @@
 /** Annual income bucket. */
-export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome: {
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome: {
     readonly Zero25000: "0-25000";
     readonly Undefined50000: "25001-50000";
     readonly Undefined100000: "50001-100000";
@@ -7,4 +7,4 @@ export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBenefic
     readonly Undefined500000: "200001-500000";
     readonly Undefined: "500001+";
 };
-export type CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome];
+export type CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome];

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome.js → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome.js}

@@ -1,9 +1,9 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome = void 0;
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome = void 0;
 /** Annual income bucket. */
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome = {
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome = {
     Zero25000: "0-25000",
     Undefined50000: "25001-50000",
     Undefined100000: "50001-100000",

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship.d.ts → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship.d.ts}

@@ -1,5 +1,5 @@
 /** Country of citizenship (ISO-3166-1 alpha-2). */
-export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship: {
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship: {
     readonly Us: "US";
     readonly Af: "AF";
     readonly Al: "AL";
@@ -197,4 +197,4 @@ export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBenefic
     readonly Zm: "ZM";
     readonly Zw: "ZW";
 };
-export type CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship];
+export type CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship];

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship.js → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship.js}

@@ -1,9 +1,9 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship = void 0;
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship = void 0;
 /** Country of citizenship (ISO-3166-1 alpha-2). */
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship = {
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship = {
     Us: "US",
     Af: "AF",
     Al: "AL",

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus.d.ts → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus.d.ts}

@@ -1,5 +1,5 @@
 /** Employment status. */
-export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus: {
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus: {
     readonly Employed: "employed";
     readonly SelfEmployed: "self_employed";
     readonly Unemployed: "unemployed";
@@ -7,4 +7,4 @@ export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBenefic
     readonly Student: "student";
     readonly Other: "other";
 };
-export type CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus];
+export type CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus];

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus.js → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus.js}

@@ -1,9 +1,9 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus = void 0;
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus = void 0;
 /** Employment status. */
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus = {
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus = {
     Employed: "employed",
     SelfEmployed: "self_employed",
     Unemployed: "unemployed",

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle.d.ts → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle.d.ts}

@@ -1,5 +1,5 @@
 /** Job title. */
-export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle: {
+export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle: {
     readonly Ceo: "ceo";
     readonly Cfo: "cfo";
     readonly Coo: "coo";
@@ -12,4 +12,4 @@ export declare const CreateInvitationsCustomersRequestRecipientsItemEmailBenefic
     readonly Partner: "partner";
     readonly Other: "other";
 };
-export type CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle];
+export type CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle = (typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle)[keyof typeof CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle];

package/dist/cjs/api/resources/customers/types/{CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle.js → CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle.js}

@@ -1,9 +1,9 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle = void 0;
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle = void 0;
 /** Job title. */
-exports.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle = {
+exports.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle = {
     Ceo: "ceo",
     Cfo: "cfo",
     Coo: "coo",

package/dist/cjs/api/resources/customers/types/CustomerInvitationAccountType.d.ts

@@ -1,4 +1,4 @@
-/** Optional onboarding suggestion (account type). The customer reviews and confirms every value. */
+/** Account type */
 export declare const CustomerInvitationAccountType: {
     readonly Individual: "individual";
     readonly Business: "business";

package/dist/cjs/api/resources/customers/types/CustomerInvitationAccountType.js

@@ -2,7 +2,7 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerInvitationAccountType = void 0;
-/** Optional onboarding suggestion (account type). The customer reviews and confirms every value. */
+/** Account type */
 exports.CustomerInvitationAccountType = {
     Individual: "individual",
     Business: "business",

package/dist/cjs/api/resources/customers/types/CustomerInvitationAddress.d.ts

@@ -14,5 +14,5 @@ export interface CustomerInvitationAddress {
     /** Postal or ZIP code. */
     postalCode?: string;
     /** Country (ISO-3166-1 alpha-2). */
-    country?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry;
+    country?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry;
 }

package/dist/cjs/api/resources/customers/types/CustomerInvitationBeneficialOwner.d.ts

@@ -15,11 +15,11 @@ export interface CustomerInvitationBeneficialOwner {
     /** Ownership percentage, 0-100. Total across owners cannot exceed 100. */
     ownershipPercentage?: number;
     /** Job title. */
-    title?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle;
+    title?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle;
     /** Country of citizenship (ISO-3166-1 alpha-2). */
-    countryOfCitizenship?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship;
+    countryOfCitizenship?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship;
     /** Employment status. */
-    employmentStatus?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus;
+    employmentStatus?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus;
     /** Annual income bucket. */
-    annualIncome?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome;
+    annualIncome?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome;
 }

package/dist/cjs/api/resources/customers/types/CustomerInvitationBusiness.d.ts

@@ -29,4 +29,6 @@ export interface CustomerInvitationBusiness {
     sourceOfFunds?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessSourceOfFundsItem[];
     /** Countries where the business operates (ISO-3166-1 alpha-2). */
     countriesOfOperations?: Natural.CreateInvitationsCustomersRequestRecipientsItemEmailBusinessCountriesOfOperationsItem[];
+    /** Beneficial owners of the business. */
+    beneficialOwners?: Natural.CustomerInvitationBeneficialOwner[];
 }

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

@@ -4,11 +4,11 @@ export * from "./CreateInvitationsCustomersRequestAgentsItemPermissionsItem.js";
 export * from "./CreateInvitationsCustomersRequestDisableNotificationsItem.js";
 export * from "./CreateInvitationsCustomersRequestRecipientsItem.js";
 export * from "./CreateInvitationsCustomersRequestRecipientsItemEmail.js";
-export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry.js";
-export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome.js";
-export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship.js";
-export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus.js";
-export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle.js";
+export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry.js";
+export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome.js";
+export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship.js";
+export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus.js";
+export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle.js";
 export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBusinessType.js";
 export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessCountriesOfOperationsItem.js";
 export * from "./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessPhysicalAddressCountry.js";

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

@@ -20,11 +20,11 @@ __exportStar(require("./CreateInvitationsCustomersRequestAgentsItemPermissionsIt
 __exportStar(require("./CreateInvitationsCustomersRequestDisableNotificationsItem.js"), exports);
 __exportStar(require("./CreateInvitationsCustomersRequestRecipientsItem.js"), exports);
 __exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmail.js"), exports);
-__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAddressCountry.js"), exports);
-__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemAnnualIncome.js"), exports);
-__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemCountryOfCitizenship.js"), exports);
-__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemEmploymentStatus.js"), exports);
-__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBeneficialOwnersItemTitle.js"), exports);
+__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAddressCountry.js"), exports);
+__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemAnnualIncome.js"), exports);
+__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemCountryOfCitizenship.js"), exports);
+__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemEmploymentStatus.js"), exports);
+__exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBeneficialOwnersItemTitle.js"), exports);
 __exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessBusinessType.js"), exports);
 __exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessCountriesOfOperationsItem.js"), exports);
 __exportStar(require("./CreateInvitationsCustomersRequestRecipientsItemEmailBusinessPhysicalAddressCountry.js"), exports);

package/dist/cjs/api/resources/events/types/GetEventsResponseDataAttributesEventType.d.ts

@@ -36,7 +36,7 @@ export declare const GetEventsResponseDataAttributesEventType: {
     readonly PaymentApprovalDenied: "payment.approval_denied";
     readonly AchCreated: "ach.created";
     readonly AchProcessing: "ach.processing";
-    readonly AchCompleted: "ach.completed";
+    readonly AchSettled: "ach.settled";
     readonly AchFailed: "ach.failed";
     readonly AchReturned: "ach.returned";
     readonly MandateCreated: "mandate.created";

package/dist/cjs/api/resources/events/types/GetEventsResponseDataAttributesEventType.js

@@ -40,7 +40,7 @@ exports.GetEventsResponseDataAttributesEventType = {
     PaymentApprovalDenied: "payment.approval_denied",
     AchCreated: "ach.created",
     AchProcessing: "ach.processing",
-    AchCompleted: "ach.completed",
+    AchSettled: "ach.settled",
     AchFailed: "ach.failed",
     AchReturned: "ach.returned",
     MandateCreated: "mandate.created",

package/dist/cjs/api/resources/events/types/ListEventsRequestEventType.d.ts

@@ -36,7 +36,7 @@ export declare const ListEventsRequestEventType: {
     readonly PaymentApprovalDenied: "payment.approval_denied";
     readonly AchCreated: "ach.created";
     readonly AchProcessing: "ach.processing";
-    readonly AchCompleted: "ach.completed";
+    readonly AchSettled: "ach.settled";
     readonly AchFailed: "ach.failed";
     readonly AchReturned: "ach.returned";
     readonly MandateCreated: "mandate.created";

package/dist/cjs/api/resources/events/types/ListEventsRequestEventType.js

@@ -40,7 +40,7 @@ exports.ListEventsRequestEventType = {
     PaymentApprovalDenied: "payment.approval_denied",
     AchCreated: "ach.created",
     AchProcessing: "ach.processing",
-    AchCompleted: "ach.completed",
+    AchSettled: "ach.settled",
     AchFailed: "ach.failed",
     AchReturned: "ach.returned",
     MandateCreated: "mandate.created",

package/dist/cjs/api/resources/events/types/ListEventsResponseDataItemAttributesEventType.d.ts

@@ -36,7 +36,7 @@ export declare const ListEventsResponseDataItemAttributesEventType: {
     readonly PaymentApprovalDenied: "payment.approval_denied";
     readonly AchCreated: "ach.created";
     readonly AchProcessing: "ach.processing";
-    readonly AchCompleted: "ach.completed";
+    readonly AchSettled: "ach.settled";
     readonly AchFailed: "ach.failed";
     readonly AchReturned: "ach.returned";
     readonly MandateCreated: "mandate.created";

package/dist/cjs/api/resources/events/types/ListEventsResponseDataItemAttributesEventType.js

@@ -40,7 +40,7 @@ exports.ListEventsResponseDataItemAttributesEventType = {
     PaymentApprovalDenied: "payment.approval_denied",
     AchCreated: "ach.created",
     AchProcessing: "ach.processing",
-    AchCompleted: "ach.completed",
+    AchSettled: "ach.settled",
     AchFailed: "ach.failed",
     AchReturned: "ach.returned",
     MandateCreated: "mandate.created",

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

@@ -34,6 +34,6 @@ export interface NewPayReqParams {
     payerName?: string;
     /** Who pays: exactly one typed email, phone, party ID, agent ID, or handle value. */
     payer: Natural.CreatePaymentRequestsRequestPayer;
-    /** Natural notifications to disable for this request. "recipient" silences our message to the counterparty so you can deliver the returned link yourself; the person who initiated the request is always notified. Requires a delegated caller on payments and payment requests, which return 403 otherwise. Omit it, or send an empty array, to have Natural notify as usual. */
+    /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
     disableNotifications?: Natural.CreatePaymentRequestsRequestDisableNotificationsItem[];
 }

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

@@ -32,6 +32,6 @@ export interface NewPaymentParams {
     tags?: Record<string, string>;
     /** Source wallet ID (wal_*). Omit to pay from the sender party's default wallet. */
     walletId?: string;
-    /** Natural notifications to disable for this request. "recipient" silences our message to the counterparty so you can deliver the returned link yourself; the person who initiated the request is always notified. Requires a delegated caller on payments and payment requests, which return 403 otherwise. Omit it, or send an empty array, to have Natural notify as usual. */
+    /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
     disableNotifications?: Natural.CreatePaymentsRequestDisableNotificationsItem[];
 }

package/dist/cjs/api/resources/simulations/client/Client.d.ts

@@ -38,6 +38,7 @@ export declare class SimulationsClient {
      *     await client.simulations.inviteCustomer({
      *         idempotencyKey: "Idempotency-Key",
      *         agentIds: ["agt_550e8400e29b41d4a716446655440000"],
+     *         permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
      *         type: "ORG"
      *     })
      */

package/dist/cjs/api/resources/simulations/client/Client.js

@@ -96,6 +96,7 @@ class SimulationsClient {
      *     await client.simulations.inviteCustomer({
      *         idempotencyKey: "Idempotency-Key",
      *         agentIds: ["agt_550e8400e29b41d4a716446655440000"],
+     *         permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
      *         type: "ORG"
      *     })
      */

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

@@ -4,6 +4,7 @@ import type * as Natural from "../../../../index.js";
  *     {
  *         idempotencyKey: "Idempotency-Key",
  *         agentIds: ["agt_550e8400e29b41d4a716446655440000"],
+ *         permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
  *         type: "ORG"
  *     }
  */
@@ -12,6 +13,8 @@ export interface InviteCustomerSimulationsRequest {
     idempotencyKey: string;
     /** Agents to grant access to. The test customer receives a pending invitation for each agent listed. */
     agentIds: string[];
+    /** Permissions to request for each agent. Defaults to send and view payments, and view wallets. */
+    permissions?: Natural.InviteCustomerSimulationsRequestPermissionsItem[];
     /** Test customer party type. Defaults to PERSON. */
     type?: Natural.InviteCustomerSimulationsRequestType;
 }

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

@@ -0,0 +1,19 @@
+export declare const InviteCustomerSimulationsRequestPermissionsItem: {
+    readonly PaymentsRead: "payments.read";
+    readonly PaymentsCreate: "payments.create";
+    readonly ExternalPartiesRead: "external_parties.read";
+    readonly ExternalPartiesCreate: "external_parties.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";
+};
+export type InviteCustomerSimulationsRequestPermissionsItem = (typeof InviteCustomerSimulationsRequestPermissionsItem)[keyof typeof InviteCustomerSimulationsRequestPermissionsItem];

package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.js

@@ -0,0 +1,22 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InviteCustomerSimulationsRequestPermissionsItem = void 0;
+exports.InviteCustomerSimulationsRequestPermissionsItem = {
+    PaymentsRead: "payments.read",
+    PaymentsCreate: "payments.create",
+    ExternalPartiesRead: "external_parties.read",
+    ExternalPartiesCreate: "external_parties.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",
+};