@naturalpay/sdk 1.6.7 → 1.6.9

package/reference.md

@@ -5466,6 +5466,271 @@ await client.ach.cancel({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Realtime
+<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">list</a>({ ...params }) -> Natural.ListRealtimeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List your realtime payments
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.realtime.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.ListRealtimeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RealtimeClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">create</a>({ ...params }) -> Natural.CreateRealtimeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a realtime payment to an external party account
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.realtime.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.CreateRealtimeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RealtimeClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">get</a>({ ...params }) -> Natural.GetRealtimeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a realtime payment
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.realtime.get({
+    realtimeId: "realtimeId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.GetRealtimeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RealtimeClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">cancel</a>({ ...params }) -> Natural.CancelRealtimeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancel a realtime payment before submission
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.realtime.cancel({
+    idempotencyKey: "Idempotency-Key",
+    realtimeId: "realtimeId",
+    reason: "Duplicate payment"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CancelRealtimeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RealtimeClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -7038,6 +7303,140 @@ await client.simulations.declinePaymentRequest({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">settleRealtime</a>({ ...params }) -> Natural.SettleRealtimeSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox realtime payment to settlement
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.settleRealtime({
+    idempotencyKey: "Idempotency-Key",
+    realtimeId: "realtimeId",
+    customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.SettleRealtimeSimulationsRequest` 
+    
+</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">failRealtime</a>({ ...params }) -> Natural.FailRealtimeSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox realtime payment to a terminal network rejection
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.failRealtime({
+    idempotencyKey: "Idempotency-Key",
+    realtimeId: "realtimeId",
+    customerPartyId: "pty_7c9e6679e29b41d4a716446655440001"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.FailRealtimeSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>