@naturalpay/sdk 1.6.11 → 1.6.12

package/reference.md

@@ -1929,6 +1929,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>
+
+Correct a beneficiary address and synchronize existing bank accounts. Retry the same address after an incomplete synchronization.
+</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>
@@ -2690,6 +2763,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_550e8400e29b41d4a716446655440000",
+    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>
@@ -7437,6 +7775,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>
+
+Drive a sandbox wire to completion
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.settleWire({
+    idempotencyKey: "Idempotency-Key",
+    wireId: "wireId",
+    customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+});
+
+```
+</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>
+
+Drive a sandbox wire to rejection
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.failWire({
+    idempotencyKey: "Idempotency-Key",
+    wireId: "wireId",
+    customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+});
+
+```
+</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>