@naturalpay/sdk 1.6.11 → 1.6.13

package/reference.md

@@ -104,12 +104,12 @@ Create an agent
 ```typescript
 await client.agents.create({
     idempotencyKey: "Idempotency-Key",
-    name: "Carrier Payment Agent v2.1",
-    description: "Autonomous agent that pays delivery carriers",
+    name: "Procurement Agent",
+    description: "Buys supplies",
     tags: {
-        "department": "logistics"
+        "department": "procurement"
     },
-    slug: "carrier_payments",
+    slug: "procurementagent",
     limits: {
         perTransaction: 100000
     }
@@ -292,7 +292,7 @@ await client.agents.remove({
 <dl>
 <dd>
 
-Update an agent's mutable fields; a slug renames the handle and can never be cleared
+Update an agent
 </dd>
 </dl>
 </dd>
@@ -310,10 +310,10 @@ Update an agent's mutable fields; a slug renames the handle and can never be cle
 await client.agents.update({
     idempotencyKey: "Idempotency-Key",
     agentId: "agentId",
-    name: "Carrier Payment Agent v3.0",
-    description: "Autonomous agent that pays delivery carriers with enhanced fraud detection",
+    name: "Procurement Agent v2.1",
+    description: "Autonomous agent that pays contractors",
     tags: {
-        "release": "v3"
+        "release": "v2.1"
     }
 });
 
@@ -983,11 +983,11 @@ Invite specific customers by email or phone to approve a set of your agents, eac
 await client.customers.createInvitations({
     recipients: [{
             type: "email",
-            value: "ops@acme.com"
+            value: "ops@bistroroma.com"
         }],
     agents: [{
-            agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
-            permissions: ["payments.read"],
+            agentId: "agt_019cd1798d637a4da75dce386343931d",
+            permissions: ["payments.read", "payments.create", "external_accounts.create", "wallets.balance", "wallets.update", "party.read", "party.update"],
             limits: {
                 perTransaction: 100000
             }
@@ -1045,7 +1045,7 @@ await client.customers.createInvitations({
 <dl>
 <dd>
 
-Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
+Revoke a pending customer invitation
 </dd>
 </dl>
 </dd>
@@ -1257,15 +1257,15 @@ Create a shareable link offering your agents, with the permissions and limits yo
 ```typescript
 await client.invitationLinks.create({
     proposedAgents: [{
-            agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
-            permissions: ["payments.create"],
+            agentId: "agt_019cd1798d637a4da75dce386343931d",
+            permissions: ["payments.read", "payments.create"],
             limits: {
-                perTransaction: 50000
+                perTransaction: 100000
             }
         }],
-    name: "Carrier Payment Integration",
+    name: "Q3 carrier onboarding",
     tags: {
-        "integration": "carrier_payments"
+        "campaign": "q3_carrier_onboarding"
     }
 });
 
@@ -1538,14 +1538,13 @@ Create a payment
 ```typescript
 await client.payments.create({
     idempotencyKey: "Idempotency-Key",
-    amount: 500000,
+    amount: 50000,
     counterparty: {
         type: "party_id",
-        value: "pty_019cd1798d627ad9bc302511c4f2c115"
+        value: "pty_019cd1798d681091fcf1dc98afb72d01"
     },
-    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3",
     currency: "USD",
-    description: "Payment for Q4 2025 development work",
+    description: "Q4 development work",
     tags: {
         "order_id": "ord_123"
     }
@@ -1880,7 +1879,7 @@ await client.externalParties.create({
 <dl>
 <dd>
 
-Get an external party by ID
+Get an external party
 </dd>
 </dl>
 </dd>
@@ -1929,6 +1928,79 @@ await client.externalParties.get({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.externalParties.<a href="/src/api/resources/externalParties/client/Client.ts">correctAddress</a>({ ...params }) -> Natural.CorrectAddressExternalPartiesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an external party's address and resynchronize its bank accounts
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.externalParties.correctAddress({
+    externalPartyId: "externalPartyId",
+    expectedAddressVersion: 0,
+    address: {
+        line1: "456 Market St",
+        city: "San Francisco",
+        state: "CA",
+        postalCode: "94105",
+        countryCode: "US"
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CorrectAddressExternalPartiesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExternalPartiesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2025,7 +2097,7 @@ const response = page.response;
 <dl>
 <dd>
 
-Store banking details for an external party
+Store an external party's bank account details
 </dd>
 </dl>
 </dd>
@@ -2042,7 +2114,7 @@ Store banking details for an external party
 ```typescript
 await client.externalPartyAccounts.create({
     idempotencyKey: "Idempotency-Key",
-    externalPartyId: "epty_550e8400e29b41d4a716446655440000",
+    externalPartyId: "epty_019cd1798d8d6873421613705e3c1415",
     accountDetails: {
         type: "us_bank_account",
         accountType: "checking",
@@ -2098,7 +2170,7 @@ await client.externalPartyAccounts.create({
 <dl>
 <dd>
 
-Get an external party account by ID
+Get an external party account
 </dd>
 </dl>
 </dd>
@@ -2259,7 +2331,7 @@ await client.ach.create({
     direction: "credit",
     amount: 25000,
     currency: "USD",
-    externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
+    externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
     companyEntryDescription: "PAYOUT"
 });
 
@@ -2524,7 +2596,7 @@ await client.realtime.create({
     idempotencyKey: "Idempotency-Key",
     amount: 25000,
     currency: "USD",
-    externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
+    externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
     description: "Invoice 1042 settlement"
 });
 
@@ -2690,6 +2762,271 @@ await client.realtime.cancel({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Wire
+<details><summary><code>client.wire.<a href="/src/api/resources/wire/client/Client.ts">list</a>({ ...params }) -> Natural.ListWireResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List your wire payments
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.wire.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.ListWireRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WireClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.wire.<a href="/src/api/resources/wire/client/Client.ts">create</a>({ ...params }) -> Natural.CreateWireResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a wire payment to an external party account
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.wire.create({
+    idempotencyKey: "Idempotency-Key",
+    amount: 25000,
+    currency: "USD",
+    externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
+    description: "Invoice 1042 settlement"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CreateWireRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WireClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.wire.<a href="/src/api/resources/wire/client/Client.ts">get</a>({ ...params }) -> Natural.GetWireResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a wire payment
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.wire.get({
+    wireId: "wireId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.GetWireRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WireClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.wire.<a href="/src/api/resources/wire/client/Client.ts">cancel</a>({ ...params }) -> Natural.CancelWireResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancel a wire payment before submission
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.wire.cancel({
+    idempotencyKey: "Idempotency-Key",
+    wireId: "wireId",
+    reason: "Duplicate payment"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CancelWireRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WireClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2867,7 +3204,7 @@ await client.transfers.initiateDeposit({
     idempotencyKey: "Idempotency-Key",
     amount: 50000,
     currency: "USD",
-    externalAccountId: "eac_550e8400e29b41d4a716446655440000",
+    externalAccountId: "eac_019cd1798d75c7ec27e4218aeac1d282",
     description: "Wallet top-up",
     tags: {
         "workflow": "treasury"
@@ -2939,7 +3276,7 @@ await client.transfers.initiateWithdrawal({
     idempotencyKey: "Idempotency-Key",
     amount: 12500,
     currency: "USD",
-    externalAccountId: "eac_550e8400e29b41d4a716446655440000",
+    externalAccountId: "eac_019cd1798d75c7ec27e4218aeac1d282",
     method: "standard",
     description: "Payout transfer",
     tags: {
@@ -3011,9 +3348,9 @@ Move funds between two wallets
 await client.transfers.initiateInternal({
     idempotencyKey: "Idempotency-Key",
     amount: 5000,
-    sourceWalletId: "wal_550e8400e29b41d4a716446655440000",
-    destWalletId: "wal_7c9e6679e29b41d4a716446655440002",
-    description: "Sweep to vault",
+    sourceWalletId: "wal_019cd1798d714ce765e0486a417c23dc",
+    destWalletId: "wal_019cd1798d72cf01303c7c04148c9b8d",
+    description: "Sweep to Vault",
     tags: {
         "workflow": "treasury"
     }
@@ -3517,7 +3854,7 @@ await client.paymentRequests.fulfill({
     paymentRequestId: "paymentRequestId",
     paymentSource: {
         type: "wallet",
-        walletId: "wal_550e8400e29b41d4a716446655440000"
+        walletId: "wal_019cd1798d714ce765e0486a417c23dc"
     },
     tags: {
         "invoice_id": "inv_7"
@@ -3831,7 +4168,7 @@ await client.approvals.get({
 <dl>
 <dd>
 
-Approve the payment or transfer under review
+Approve the operation under review
 </dd>
 </dl>
 </dd>
@@ -3897,7 +4234,7 @@ await client.approvals.approve({
 <dl>
 <dd>
 
-Deny the payment or transfer under review
+Deny the operation under review
 </dd>
 </dl>
 </dd>
@@ -4045,10 +4382,10 @@ Invite people to join the party. Available for business parties.
 ```typescript
 await client.invitations.create({
     invitations: [{
-            email: "engineer@velocitylogistics.com",
+            email: "engineer@acmepayments.com",
             role: "MEMBER"
         }, {
-            email: "cfo@velocitylogistics.com",
+            email: "cfo@acmepayments.com",
             role: "ADMIN"
         }],
     tags: {
@@ -4240,7 +4577,7 @@ Update the current party
 
 ```typescript
 await client.parties.update({
-    displayName: "Natural Inc."
+    displayName: "Acme Payments Inc."
 });
 
 ```
@@ -4429,7 +4766,7 @@ await client.parties.getCompliance({
 <dl>
 <dd>
 
-Set or rename your party's handle; it can never be cleared
+Set your party's handle
 </dd>
 </dl>
 </dd>
@@ -4445,7 +4782,7 @@ Set or rename your party's handle; it can never be cleared
 
 ```typescript
 await client.parties.setHandle({
-    handle: "natural"
+    handle: "acme"
 });
 
 ```
@@ -5287,7 +5624,7 @@ Grant an agent access to a wallet
 await client.wallets.attachAgent({
     idempotencyKey: "Idempotency-Key",
     walletId: "walletId",
-    agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
+    agentId: "agt_019cd1798d637a4da75dce386343931d"
 });
 
 ```
@@ -6166,7 +6503,7 @@ await client.agentKeys.create({
 <dl>
 <dd>
 
-Revoke an agent key immediately without issuing a replacement. Other active keys for the same agent keep working.
+Revoke an agent key
 </dd>
 </dl>
 </dd>
@@ -6232,7 +6569,7 @@ await client.agentKeys.revoke({
 <dl>
 <dd>
 
-Generate a replacement agent key.
+Rotate an agent key. The new secret is returned only once.
 </dd>
 </dl>
 </dd>
@@ -6656,7 +6993,7 @@ await client.webhooks.update({
 <dl>
 <dd>
 
-Generate a new signing secret.
+Rotate the webhook signing secret. The new secret is returned only once.
 </dd>
 </dl>
 </dd>
@@ -6852,7 +7189,7 @@ await client.events.get({
 <dl>
 <dd>
 
-Send the stored event once to the same webhook using its current URL and signing secret. Automatic retries continue independently, and delegated events require the original delegation to remain active.
+Send the stored event to the webhook again
 </dd>
 </dl>
 </dd>
@@ -6937,7 +7274,7 @@ Create a test customer and a pending invitation for each agent you name
 ```typescript
 await client.simulations.inviteCustomer({
     idempotencyKey: "Idempotency-Key",
-    agentIds: ["agt_550e8400e29b41d4a716446655440000"],
+    agentIds: ["agt_019cd1798d637a4da75dce386343931d"],
     permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
     type: "ORG",
     message: "Please review the agent access request."
@@ -7337,7 +7674,7 @@ Drive a sandbox realtime payment to settlement
 await client.simulations.settleRealtime({
     idempotencyKey: "Idempotency-Key",
     realtimeId: "realtimeId",
-    customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
 });
 
 ```
@@ -7404,7 +7741,7 @@ Drive a sandbox realtime payment to a terminal network rejection
 await client.simulations.failRealtime({
     idempotencyKey: "Idempotency-Key",
     realtimeId: "realtimeId",
-    customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
 });
 
 ```
@@ -7437,6 +7774,140 @@ await client.simulations.failRealtime({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">settleWire</a>({ ...params }) -> Natural.SettleWireSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Complete a test wire payment
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.settleWire({
+    idempotencyKey: "Idempotency-Key",
+    wireId: "wireId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.SettleWireSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">failWire</a>({ ...params }) -> Natural.FailWireSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Reject a test wire payment
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.failWire({
+    idempotencyKey: "Idempotency-Key",
+    wireId: "wireId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.FailWireSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -7471,7 +7942,7 @@ Accept a pending customer invitation as the test customer it is addressed to
 await client.simulations.acceptCustomerInvitation({
     idempotencyKey: "Idempotency-Key",
     invitationId: "invitationId",
-    partyId: "pty_7c9e6679e29b41d4a716446655440001"
+    partyId: "pty_019cd1798d6a0cf1a6076c62addacb4d"
 });
 
 ```
@@ -7538,7 +8009,7 @@ Decline a pending customer invitation as the test customer it is addressed to
 await client.simulations.declineCustomerInvitation({
     idempotencyKey: "Idempotency-Key",
     invitationId: "invitationId",
-    partyId: "pty_7c9e6679e29b41d4a716446655440001"
+    partyId: "pty_019cd1798d6a0cf1a6076c62addacb4d"
 });
 
 ```