@naturalpay/sdk 1.6.40 → 1.6.41

package/reference.md

@@ -3033,6 +3033,286 @@ await client.wire.cancel({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Check
+<details><summary><code>client.check.<a href="/src/api/resources/check/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Natural.ListCheckResponseDataItem, Natural.ListCheckResponse&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List your check payments
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const pageableResponse = await client.check.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.check.list();
+while (page.hasNextPage()) {
+    page = await page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.ListCheckRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CheckClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.check.<a href="/src/api/resources/check/client/Client.ts">create</a>({ ...params }) -> Natural.CreateCheckResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a check payment mailed to an external party
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.check.create({
+    idempotencyKey: "Idempotency-Key",
+    amount: 25000,
+    currency: "USD",
+    externalPartyId: "epty_019cd1798d8d6873421613705e3c1415",
+    memo: "Invoice 1042",
+    message: "Thank you for your business",
+    internalDescription: "Q3 vendor true-up",
+    deliveryMethod: "USPS_FIRST_CLASS"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CreateCheckRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CheckClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.check.<a href="/src/api/resources/check/client/Client.ts">get</a>({ ...params }) -> Natural.GetCheckResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a check payment
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.check.get({
+    checkId: "checkId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.GetCheckRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CheckClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.check.<a href="/src/api/resources/check/client/Client.ts">cancel</a>({ ...params }) -> Natural.CancelCheckResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancel a check payment before submission
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.check.cancel({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    reason: "Duplicate payment"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CancelCheckRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CheckClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -10451,6 +10731,475 @@ await client.simulations.failWire({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.simulations.<a href="/src/api/resources/simulations/client/Client.ts">depositCheck</a>({ ...params }) -> Natural.DepositCheckSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check payment to settlement (deposit side)
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.depositCheck({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.DepositCheckSimulationsRequest` 
+    
+</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">failCheck</a>({ ...params }) -> Natural.FailCheckSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check payment to a terminal pre-settlement rejection
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.failCheck({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.FailCheckSimulationsRequest` 
+    
+</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">bounceCheck</a>({ ...params }) -> Natural.BounceCheckSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check payment through a non-terminal presentment return; the check stays outstanding and depositable
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.bounceCheck({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.BounceCheckSimulationsRequest` 
+    
+</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">voidCheck</a>({ ...params }) -> Natural.VoidCheckSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check payment to CANCELED through a second presentment return after a failed reclear
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.voidCheck({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.VoidCheckSimulationsRequest` 
+    
+</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">stopCheck</a>({ ...params }) -> Natural.StopCheckSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check payment to CANCELED through a confirmed stop payment
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.stopCheck({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.StopCheckSimulationsRequest` 
+    
+</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">deliverCheck</a>({ ...params }) -> Natural.DeliverCheckSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check mail delivery through to delivered (created → rendered_pdf → mailed → in_transit → delivered)
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.deliverCheck({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.DeliverCheckSimulationsRequest` 
+    
+</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">returnCheckToSender</a>({ ...params }) -> Natural.ReturnCheckToSenderSimulationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Drive a sandbox check mail delivery to returned-to-sender, firing the returned-to-sender webhook
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.simulations.returnCheckToSender({
+    idempotencyKey: "Idempotency-Key",
+    checkId: "checkId",
+    customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.ReturnCheckToSenderSimulationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SimulationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>