@naturalpay/sdk 1.2.1 → 1.2.3

package/reference.md

@@ -106,6 +106,9 @@ await client.agents.create({
     idempotencyKey: "Idempotency-Key",
     name: "Carrier Payment Agent v2.1",
     description: "Autonomous agent that pays delivery carriers",
+    tags: {
+        "department": "logistics"
+    },
     slug: "carrier_payments",
     limits: {
         perTransaction: 100000
@@ -308,7 +311,10 @@ await client.agents.update({
     idempotencyKey: "Idempotency-Key",
     agentId: "agentId",
     name: "Carrier Payment Agent v3.0",
-    description: "Autonomous agent that pays delivery carriers with enhanced fraud detection"
+    description: "Autonomous agent that pays delivery carriers with enhanced fraud detection",
+    tags: {
+        "release": "v3"
+    }
 });
 
 ```
@@ -1190,7 +1196,10 @@ await client.invitationLinks.create({
                 perTransaction: 50000
             }
         }],
-    name: "Carrier Payment Integration"
+    name: "Carrier Payment Integration",
+    tags: {
+        "integration": "carrier_payments"
+    }
 });
 
 ```
@@ -1469,7 +1478,10 @@ await client.payments.create({
     },
     customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3",
     currency: "USD",
-    description: "Payment for Q4 2025 development work"
+    description: "Payment for Q4 2025 development work",
+    tags: {
+        "order_id": "ord_123"
+    }
 });
 
 ```
@@ -1811,7 +1823,10 @@ await client.transfers.initiateDeposit({
     amount: 50000,
     currency: "USD",
     externalAccountId: "eac_550e8400e29b41d4a716446655440000",
-    description: "Wallet top-up"
+    description: "Wallet top-up",
+    tags: {
+        "workflow": "treasury"
+    }
 });
 
 ```
@@ -1880,7 +1895,11 @@ await client.transfers.initiateWithdrawal({
     amount: 12500,
     currency: "USD",
     externalAccountId: "eac_550e8400e29b41d4a716446655440000",
-    description: "Payout transfer"
+    method: "standard",
+    description: "Payout transfer",
+    tags: {
+        "workflow": "treasury"
+    }
 });
 
 ```
@@ -1949,7 +1968,10 @@ await client.transfers.initiateInternal({
     amount: 5000,
     sourceWalletId: "wal_550e8400e29b41d4a716446655440000",
     destWalletId: "wal_7c9e6679e29b41d4a716446655440002",
-    description: "Sweep to vault"
+    description: "Sweep to vault",
+    tags: {
+        "workflow": "treasury"
+    }
 });
 
 ```
@@ -2234,6 +2256,9 @@ await client.paymentRequests.create({
     amount: 2500,
     currency: "USD",
     description: "Invoice 7",
+    tags: {
+        "invoice_id": "inv_7"
+    },
     payerName: "Ada Lovelace",
     payer: {
         type: "email",
@@ -2448,6 +2473,9 @@ await client.paymentRequests.fulfill({
     paymentSource: {
         type: "wallet",
         walletId: "wal_550e8400e29b41d4a716446655440000"
+    },
+    tags: {
+        "invoice_id": "inv_7"
     }
 });
 
@@ -2976,7 +3004,10 @@ await client.invitations.create({
         }, {
             email: "cfo@velocitylogistics.com",
             role: "ADMIN"
-        }]
+        }],
+    tags: {
+        "team": "operations"
+    }
 });
 
 ```
@@ -3742,7 +3773,10 @@ Create a standard wallet
 await client.wallets.create({
     idempotencyKey: "Idempotency-Key",
     displayName: "Payroll",
-    description: "Dedicated wallet for payroll runs"
+    description: "Dedicated wallet for payroll runs",
+    tags: {
+        "department": "payroll"
+    }
 });
 
 ```
@@ -3856,7 +3890,7 @@ await client.wallets.get({
 <dl>
 <dd>
 
-Update wallet metadata
+Update a wallet's display name, description, or tags
 </dd>
 </dl>
 </dd>
@@ -3875,7 +3909,11 @@ await client.wallets.update({
     idempotencyKey: "Idempotency-Key",
     walletId: "walletId",
     displayName: "Operating (US)",
-    description: "Primary USD operating wallet"
+    description: "Primary USD operating wallet",
+    tags: {
+        "region": "us",
+        "legacy_key": null
+    }
 });
 
 ```
@@ -4406,7 +4444,10 @@ await client.externalAccounts.createFromProcessorToken({
     idempotencyKey: "Idempotency-Key",
     partyId: "pty_7c9e6679e29b41d4a716446655440001",
     processorToken: "processor-sandbox-abc123",
-    institutionName: "Chase"
+    institutionName: "Chase",
+    tags: {
+        "environment": "production"
+    }
 });
 
 ```
@@ -4753,7 +4794,10 @@ Create an API key. The secret is returned only once.
 ```typescript
 await client.apiKeys.create({
     name: "Production Backend",
-    scopes: ["payments.read", "payments.create"]
+    scopes: ["payments.read", "payments.create"],
+    tags: {
+        "service": "checkout"
+    }
 });
 
 ```
@@ -5015,7 +5059,9 @@ Create an agent key for an agent. The secret is returned only once.
 await client.agentKeys.create({
     data: {
         attributes: {
-            "key": "value"
+            tags: {
+                "team": "payments"
+            }
         },
         relationships: {
             agent: {
@@ -5158,7 +5204,10 @@ Generate a replacement agent key.
 await client.agentKeys.rotate({
     idempotencyKey: "Idempotency-Key",
     keyId: "keyId",
-    expiresInSeconds: 86400
+    expiresInSeconds: 86400,
+    tags: {
+        "team": "payments"
+    }
 });
 
 ```
@@ -5739,6 +5788,73 @@ await client.events.get({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">redeliver</a>({ ...params }) -> Natural.RedeliverEventsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Send the stored event once to the same webhook using its current URL and signing secret. Automatic retries continue independently, and delegated events require the original delegation to remain active.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.events.redeliver({
+    idempotencyKey: "Idempotency-Key",
+    webhookId: "webhookId",
+    eventId: "eventId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.RedeliverEventsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EventsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>