@naturalpay/sdk 1.6.15 → 1.6.16

package/reference.md

@@ -450,7 +450,7 @@ await client.agents.createCustomer({
             type: "email",
             value: "value"
         }],
-    permissions: ["payments.read"]
+    permissions: ["disputes.read"]
 });
 
 ```
@@ -2333,7 +2333,8 @@ await client.ach.create({
     amount: 25000,
     currency: "USD",
     externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-    companyEntryDescription: "PAYOUT"
+    companyEntryDescription: "PAYOUT",
+    addenda: "Invoice 1042, July services"
 });
 
 ```
@@ -3028,6 +3029,485 @@ await client.wire.cancel({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Chargebacks
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Natural.ListChargebacksResponseDataItem, Natural.ListChargebacksResponse&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List chargebacks on card payments received by the customer
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const pageableResponse = await client.chargebacks.list();
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.chargebacks.list();
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.ListChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">get</a>({ ...params }) -> Natural.GetChargebacksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a chargeback with saved evidence and response guidance
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargebacks.get({
+    chargebackId: "chargebackId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.GetChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">update</a>({ ...params }) -> Natural.UpdateChargebacksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Save evidence changes without submitting the response
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargebacks.update({
+    idempotencyKey: "Idempotency-Key",
+    chargebackId: "chargebackId",
+    version: 1,
+    evidence: {
+        responseReason: "receivedProduct",
+        explanation: "The cardholder confirmed receiving the order."
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.UpdateChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">uploadFile</a>({ ...params }) -> Natural.UploadFileChargebacksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Upload and validate one evidence file for this chargeback
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargebacks.uploadFile({
+    file: fs.createReadStream("/path/to/your/file"),
+    idempotencyKey: "Idempotency-Key",
+    chargebackId: "chargebackId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.UploadFileChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">preview</a>({ ...params }) -> Natural.PreviewChargebacksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Render the saved response without submitting it
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargebacks.preview({
+    chargebackId: "chargebackId",
+    version: 2
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.PreviewChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">submit</a>({ ...params }) -> Natural.SubmitChargebacksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Validate and freeze the saved evidence for submission
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargebacks.submit({
+    idempotencyKey: "Idempotency-Key",
+    chargebackId: "chargebackId",
+    version: 2
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.SubmitChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chargebacks.<a href="/src/api/resources/chargebacks/client/Client.ts">accept</a>({ ...params }) -> Natural.AcceptChargebacksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Accept the chargeback without contesting it
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargebacks.accept({
+    idempotencyKey: "Idempotency-Key",
+    chargebackId: "chargebackId",
+    version: 2
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.AcceptChargebacksRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ChargebacksClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>