@naturalpay/sdk 1.6.32 → 1.6.34

package/reference.md

@@ -35,7 +35,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.agents.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -719,7 +719,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.customers.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -1470,7 +1470,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.payments.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -1753,7 +1753,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.externalParties.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -2047,7 +2047,7 @@ let page = await client.externalPartyAccounts.list({
     externalPartyId: "externalPartyId"
 });
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -2261,7 +2261,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.ach.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -3073,7 +3073,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.paymentIntents.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -3437,7 +3437,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.cardPayments.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -3578,7 +3578,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.voiceSessions.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -3854,7 +3854,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.refunds.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -4063,7 +4063,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.chargebacks.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -4605,7 +4605,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.transactions.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -4963,7 +4963,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.transfers.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -5104,7 +5104,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.paymentRequests.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -5255,7 +5255,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.paymentRequests.listIncoming();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -6188,7 +6188,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.parties.listMembers();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -7640,7 +7640,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.externalAccounts.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -7845,7 +7845,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.externalAccounts.listCards();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -7921,7 +7921,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.apiKeys.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response
@@ -8644,7 +8644,7 @@ await client.cardSessions.claim({
 </details>
 
 ## AgenticPayments
-<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">listMandates</a>({ ...params }) -> Natural.ListMandatesAgenticPaymentsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">card</a>({ ...params }) -> Natural.CardAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -8656,7 +8656,7 @@ await client.cardSessions.claim({
 <dl>
 <dd>
 
-List the party's usable mandates for the calling agent, or all of the owner's mandates
+Get enrollment and mandates for a saved card. An agent sees only the mandates it can spend under.
 </dd>
 </dl>
 </dd>
@@ -8671,7 +8671,9 @@ List the party's usable mandates for the calling agent, or all of the owner's ma
 <dd>
 
 ```typescript
-await client.agenticPayments.listMandates();
+await client.agenticPayments.card({
+    cardId: "cardId"
+});
 
 ```
 </dd>
@@ -8687,7 +8689,7 @@ await client.agenticPayments.listMandates();
 <dl>
 <dd>
 
-**request:** `Natural.ListMandatesAgenticPaymentsRequest` 
+**request:** `Natural.CardAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -8707,7 +8709,7 @@ await client.agenticPayments.listMandates();
 </dl>
 </details>
 
-<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">getMandate</a>({ ...params }) -> Natural.GetMandateAgenticPaymentsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">listMandates</a>({ ...params }) -> Natural.ListMandatesAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -8719,7 +8721,7 @@ await client.agenticPayments.listMandates();
 <dl>
 <dd>
 
-Get the current budget and approval status
+List the party's usable mandates for the calling agent, or all of the owner's mandates
 </dd>
 </dl>
 </dd>
@@ -8734,9 +8736,7 @@ Get the current budget and approval status
 <dd>
 
 ```typescript
-await client.agenticPayments.getMandate({
-    mandateId: "mandateId"
-});
+await client.agenticPayments.listMandates();
 
 ```
 </dd>
@@ -8752,7 +8752,7 @@ await client.agenticPayments.getMandate({
 <dl>
 <dd>
 
-**request:** `Natural.GetMandateAgenticPaymentsRequest` 
+**request:** `Natural.ListMandatesAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -8772,7 +8772,7 @@ await client.agenticPayments.getMandate({
 </dl>
 </details>
 
-<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">createPurchase</a>({ ...params }) -> Natural.CreatePurchaseAgenticPaymentsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">getMandate</a>({ ...params }) -> Natural.GetMandateAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -8784,7 +8784,7 @@ await client.agenticPayments.getMandate({
 <dl>
 <dd>
 
-Reserve budget for a purchase
+Get the current budget and approval status
 </dd>
 </dl>
 </dd>
@@ -8799,17 +8799,8 @@ Reserve budget for a purchase
 <dd>
 
 ```typescript
-await client.agenticPayments.createPurchase({
-    idempotencyKey: "Idempotency-Key",
-    mandateId: "amd_01a0e6466ba3713bba0f0d9d36803b92",
-    amount: 2450,
-    currency: "USD",
-    merchant: {
-        name: "Blue Bottle Coffee",
-        url: "https://bluebottlecoffee.com",
-        countryCode: "US"
-    },
-    ttlSeconds: 600
+await client.agenticPayments.getMandate({
+    mandateId: "mandateId"
 });
 
 ```
@@ -8826,7 +8817,7 @@ await client.agenticPayments.createPurchase({
 <dl>
 <dd>
 
-**request:** `Natural.CreatePurchaseAgenticPaymentsRequest` 
+**request:** `Natural.GetMandateAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -8846,7 +8837,7 @@ await client.agenticPayments.createPurchase({
 </dl>
 </details>
 
-<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">getPurchase</a>({ ...params }) -> Natural.GetPurchaseAgenticPaymentsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">createPurchase</a>({ ...params }) -> Natural.CreatePurchaseAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -8858,7 +8849,7 @@ await client.agenticPayments.createPurchase({
 <dl>
 <dd>
 
-Get credential issuance status without the credential
+Reserve budget for a purchase
 </dd>
 </dl>
 </dd>
@@ -8873,8 +8864,17 @@ Get credential issuance status without the credential
 <dd>
 
 ```typescript
-await client.agenticPayments.getPurchase({
-    purchaseId: "purchaseId"
+await client.agenticPayments.createPurchase({
+    idempotencyKey: "Idempotency-Key",
+    mandateId: "amd_01a0e6466ba3713bba0f0d9d36803b92",
+    amount: 2450,
+    currency: "USD",
+    merchant: {
+        name: "Blue Bottle Coffee",
+        url: "https://bluebottlecoffee.com",
+        countryCode: "US"
+    },
+    ttlSeconds: 600
 });
 
 ```
@@ -8891,7 +8891,7 @@ await client.agenticPayments.getPurchase({
 <dl>
 <dd>
 
-**request:** `Natural.GetPurchaseAgenticPaymentsRequest` 
+**request:** `Natural.CreatePurchaseAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -8911,7 +8911,7 @@ await client.agenticPayments.getPurchase({
 </dl>
 </details>
 
-<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">claimPurchase</a>({ ...params }) -> Natural.ClaimPurchaseAgenticPaymentsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">getPurchase</a>({ ...params }) -> Natural.GetPurchaseAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -8923,7 +8923,7 @@ await client.agenticPayments.getPurchase({
 <dl>
 <dd>
 
-Return the purchase credential exactly once
+Get credential issuance status without the credential
 </dd>
 </dl>
 </dd>
@@ -8938,7 +8938,7 @@ Return the purchase credential exactly once
 <dd>
 
 ```typescript
-await client.agenticPayments.claimPurchase({
+await client.agenticPayments.getPurchase({
     purchaseId: "purchaseId"
 });
 
@@ -8956,7 +8956,7 @@ await client.agenticPayments.claimPurchase({
 <dl>
 <dd>
 
-**request:** `Natural.ClaimPurchaseAgenticPaymentsRequest` 
+**request:** `Natural.GetPurchaseAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -8976,7 +8976,7 @@ await client.agenticPayments.claimPurchase({
 </dl>
 </details>
 
-<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">cancelPurchase</a>({ ...params }) -> Natural.CancelPurchaseAgenticPaymentsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">claimPurchase</a>({ ...params }) -> Natural.ClaimPurchaseAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -8988,7 +8988,7 @@ await client.agenticPayments.claimPurchase({
 <dl>
 <dd>
 
-Release budget reserved for a purchase that has not been claimed
+Return the purchase credential exactly once
 </dd>
 </dl>
 </dd>
@@ -9003,7 +9003,7 @@ Release budget reserved for a purchase that has not been claimed
 <dd>
 
 ```typescript
-await client.agenticPayments.cancelPurchase({
+await client.agenticPayments.claimPurchase({
     purchaseId: "purchaseId"
 });
 
@@ -9021,7 +9021,7 @@ await client.agenticPayments.cancelPurchase({
 <dl>
 <dd>
 
-**request:** `Natural.CancelPurchaseAgenticPaymentsRequest` 
+**request:** `Natural.ClaimPurchaseAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -9041,209 +9041,7 @@ await client.agenticPayments.cancelPurchase({
 </dl>
 </details>
 
-## Agent Cards
-<details><summary><code>client.agentCards.<a href="/src/api/resources/agentCards/client/Client.ts">create</a>({ ...params }) -> Natural.CreateAgentCardsResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Issue a card for one purchase at one merchant, up to a maximum. It approves one authorization, then closes.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agentCards.create({
-    idempotencyKey: "Idempotency-Key",
-    type: "single_use",
-    merchant: {
-        name: "Blue Bottle Coffee"
-    },
-    maximumAmount: 5000,
-    currency: "USD",
-    expiresInMinutes: 60
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Natural.CreateAgentCardsRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentCardsClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.agentCards.<a href="/src/api/resources/agentCards/client/Client.ts">get</a>({ ...params }) -> Natural.GetAgentCardsResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Get an agent card's status. It never includes the card number.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agentCards.get({
-    cardId: "cardId"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Natural.GetAgentCardsRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentCardsClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-## Card Transactions
-<details><summary><code>client.cardTransactions.<a href="/src/api/resources/cardTransactions/client/Client.ts">list</a>({ ...params }) -> Natural.ListCardTransactionsResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-List purchases and refunds on Natural-issued cards, newest first. An agent sees only its own card transactions.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.cardTransactions.list();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Natural.ListCardTransactionsRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `CardTransactionsClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.cardTransactions.<a href="/src/api/resources/cardTransactions/client/Client.ts">get</a>({ ...params }) -> Natural.GetCardTransactionsResponse</code></summary>
+<details><summary><code>client.agenticPayments.<a href="/src/api/resources/agenticPayments/client/Client.ts">cancelPurchase</a>({ ...params }) -> Natural.CancelPurchaseAgenticPaymentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -9255,7 +9053,7 @@ await client.cardTransactions.list();
 <dl>
 <dd>
 
-Get a purchase or refund on a Natural-issued card, with its timeline.
+Release budget reserved for a purchase that has not been claimed
 </dd>
 </dl>
 </dd>
@@ -9270,8 +9068,8 @@ Get a purchase or refund on a Natural-issued card, with its timeline.
 <dd>
 
 ```typescript
-await client.cardTransactions.get({
-    cardTransactionId: "cardTransactionId"
+await client.agenticPayments.cancelPurchase({
+    purchaseId: "purchaseId"
 });
 
 ```
@@ -9288,7 +9086,7 @@ await client.cardTransactions.get({
 <dl>
 <dd>
 
-**request:** `Natural.GetCardTransactionsRequest` 
+**request:** `Natural.CancelPurchaseAgenticPaymentsRequest` 
     
 </dd>
 </dl>
@@ -9296,7 +9094,7 @@ await client.cardTransactions.get({
 <dl>
 <dd>
 
-**requestOptions:** `CardTransactionsClient.RequestOptions` 
+**requestOptions:** `AgenticPaymentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -9344,7 +9142,7 @@ for await (const item of pageableResponse) {
 // Or you can manually iterate page-by-page
 let page = await client.webhooks.list();
 while (page.hasNextPage()) {
-    page = page.getNextPage();
+    page = await page.getNextPage();
 }
 
 // You can also access the underlying response