@naturalpay/sdk 1.2.2 → 1.2.3

package/dist/esm/serialization/resources/wallets/client/requests/UpdateWalletsRequest.mjs

@@ -3,4 +3,5 @@ import * as core from "../../../../../core/index.mjs";
 export const UpdateWalletsRequest = core.serialization.object({
     displayName: core.serialization.string().optional(),
     description: core.serialization.string().optionalNullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string().nullable()).optional(),
 });

package/dist/esm/serialization/resources/wallets/types/AttachAgentWalletsResponseDataAttributes.d.mts

@@ -8,6 +8,7 @@ export declare namespace AttachAgentWalletsResponseDataAttributes {
     interface Raw {
         name: string;
         description?: string | null;
+        tags: Record<string, string>;
         handle?: string | null;
         status: AttachAgentWalletsResponseDataAttributesStatus.Raw;
         limits?: AttachAgentWalletsResponseDataAttributesLimits.Raw | null;

package/dist/esm/serialization/resources/wallets/types/AttachAgentWalletsResponseDataAttributes.mjs

@@ -5,6 +5,7 @@ import { AttachAgentWalletsResponseDataAttributesStatus } from "./AttachAgentWal
 export const AttachAgentWalletsResponseDataAttributes = core.serialization.object({
     name: core.serialization.string(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     handle: core.serialization.string().nullable(),
     status: AttachAgentWalletsResponseDataAttributesStatus,
     limits: AttachAgentWalletsResponseDataAttributesLimits.nullable(),

package/dist/esm/serialization/resources/wallets/types/CreateWalletsResponseDataAttributes.d.mts

@@ -15,6 +15,7 @@ export declare namespace CreateWalletsResponseDataAttributes {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: CreateWalletsResponseDataAttributesBalance.Raw | null;
         claims: CreateWalletsResponseDataAttributesClaims.Raw;
         depositInstructions?: CreateWalletsResponseDataAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/CreateWalletsResponseDataAttributes.mjs

@@ -12,6 +12,7 @@ export const CreateWalletsResponseDataAttributes = core.serialization.object({
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: CreateWalletsResponseDataAttributesBalance.nullable(),
     claims: CreateWalletsResponseDataAttributesClaims,
     depositInstructions: CreateWalletsResponseDataAttributesDepositInstructions.nullable(),

package/dist/esm/serialization/resources/wallets/types/FreezeWalletsResponseDataAttributes.d.mts

@@ -15,6 +15,7 @@ export declare namespace FreezeWalletsResponseDataAttributes {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: FreezeWalletsResponseDataAttributesBalance.Raw | null;
         claims: FreezeWalletsResponseDataAttributesClaims.Raw;
         depositInstructions?: FreezeWalletsResponseDataAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/FreezeWalletsResponseDataAttributes.mjs

@@ -12,6 +12,7 @@ export const FreezeWalletsResponseDataAttributes = core.serialization.object({
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: FreezeWalletsResponseDataAttributesBalance.nullable(),
     claims: FreezeWalletsResponseDataAttributesClaims,
     depositInstructions: FreezeWalletsResponseDataAttributesDepositInstructions.nullable(),

package/dist/esm/serialization/resources/wallets/types/ListAgentsWalletsResponseDataItemAttributes.d.mts

@@ -8,6 +8,7 @@ export declare namespace ListAgentsWalletsResponseDataItemAttributes {
     interface Raw {
         name: string;
         description?: string | null;
+        tags: Record<string, string>;
         handle?: string | null;
         status: ListAgentsWalletsResponseDataItemAttributesStatus.Raw;
         limits?: ListAgentsWalletsResponseDataItemAttributesLimits.Raw | null;

package/dist/esm/serialization/resources/wallets/types/ListAgentsWalletsResponseDataItemAttributes.mjs

@@ -5,6 +5,7 @@ import { ListAgentsWalletsResponseDataItemAttributesStatus } from "./ListAgentsW
 export const ListAgentsWalletsResponseDataItemAttributes = core.serialization.object({
     name: core.serialization.string(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     handle: core.serialization.string().nullable(),
     status: ListAgentsWalletsResponseDataItemAttributesStatus,
     limits: ListAgentsWalletsResponseDataItemAttributesLimits.nullable(),

package/dist/esm/serialization/resources/wallets/types/SetAgentDefaultWalletWalletsResponseDataAttributes.d.mts

@@ -8,6 +8,7 @@ export declare namespace SetAgentDefaultWalletWalletsResponseDataAttributes {
     interface Raw {
         name: string;
         description?: string | null;
+        tags: Record<string, string>;
         handle?: string | null;
         status: SetAgentDefaultWalletWalletsResponseDataAttributesStatus.Raw;
         limits?: SetAgentDefaultWalletWalletsResponseDataAttributesLimits.Raw | null;

package/dist/esm/serialization/resources/wallets/types/SetAgentDefaultWalletWalletsResponseDataAttributes.mjs

@@ -5,6 +5,7 @@ import { SetAgentDefaultWalletWalletsResponseDataAttributesStatus } from "./SetA
 export const SetAgentDefaultWalletWalletsResponseDataAttributes = core.serialization.object({
     name: core.serialization.string(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     handle: core.serialization.string().nullable(),
     status: SetAgentDefaultWalletWalletsResponseDataAttributesStatus,
     limits: SetAgentDefaultWalletWalletsResponseDataAttributesLimits.nullable(),

package/dist/esm/serialization/resources/wallets/types/SetDefaultWalletsResponseDataAttributes.d.mts

@@ -15,6 +15,7 @@ export declare namespace SetDefaultWalletsResponseDataAttributes {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: SetDefaultWalletsResponseDataAttributesBalance.Raw | null;
         claims: SetDefaultWalletsResponseDataAttributesClaims.Raw;
         depositInstructions?: SetDefaultWalletsResponseDataAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/SetDefaultWalletsResponseDataAttributes.mjs

@@ -12,6 +12,7 @@ export const SetDefaultWalletsResponseDataAttributes = core.serialization.object
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: SetDefaultWalletsResponseDataAttributesBalance.nullable(),
     claims: SetDefaultWalletsResponseDataAttributesClaims,
     depositInstructions: SetDefaultWalletsResponseDataAttributesDepositInstructions.nullable(),

package/dist/esm/serialization/resources/wallets/types/UnfreezeWalletsResponseDataAttributes.d.mts

@@ -15,6 +15,7 @@ export declare namespace UnfreezeWalletsResponseDataAttributes {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: UnfreezeWalletsResponseDataAttributesBalance.Raw | null;
         claims: UnfreezeWalletsResponseDataAttributesClaims.Raw;
         depositInstructions?: UnfreezeWalletsResponseDataAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/UnfreezeWalletsResponseDataAttributes.mjs

@@ -12,6 +12,7 @@ export const UnfreezeWalletsResponseDataAttributes = core.serialization.object({
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: UnfreezeWalletsResponseDataAttributesBalance.nullable(),
     claims: UnfreezeWalletsResponseDataAttributesClaims,
     depositInstructions: UnfreezeWalletsResponseDataAttributesDepositInstructions.nullable(),

package/dist/esm/serialization/resources/wallets/types/UpdateWalletsResponseDataAttributes.d.mts

@@ -15,6 +15,7 @@ export declare namespace UpdateWalletsResponseDataAttributes {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: UpdateWalletsResponseDataAttributesBalance.Raw | null;
         claims: UpdateWalletsResponseDataAttributesClaims.Raw;
         depositInstructions?: UpdateWalletsResponseDataAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/UpdateWalletsResponseDataAttributes.mjs

@@ -12,6 +12,7 @@ export const UpdateWalletsResponseDataAttributes = core.serialization.object({
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: UpdateWalletsResponseDataAttributesBalance.nullable(),
     claims: UpdateWalletsResponseDataAttributesClaims,
     depositInstructions: UpdateWalletsResponseDataAttributesDepositInstructions.nullable(),

package/dist/esm/serialization/resources/wallets/types/WalletAttrs.d.mts

@@ -15,6 +15,7 @@ export declare namespace WalletAttrs {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: ListWalletsResponseDataItemAttributesBalance.Raw | null;
         claims: WalletClaims.Raw;
         depositInstructions?: ListWalletsResponseDataItemAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/WalletAttrs.mjs

@@ -12,6 +12,7 @@ export const WalletAttrs = core.serialization.object({
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: ListWalletsResponseDataItemAttributesBalance.nullable(),
     claims: WalletClaims,
     depositInstructions: ListWalletsResponseDataItemAttributesDepositInstructions.nullable(),

package/dist/esm/serialization/resources/wallets/types/WalletDetailAttrs.d.mts

@@ -15,6 +15,7 @@ export declare namespace WalletDetailAttrs {
         createdAt?: string | null;
         displayName?: string | null;
         description?: string | null;
+        tags: Record<string, string>;
         balance?: GetWalletsResponseDataAttributesBalance.Raw | null;
         claims: WalletDetailClaims.Raw;
         depositInstructions?: GetWalletsResponseDataAttributesDepositInstructions.Raw | null;

package/dist/esm/serialization/resources/wallets/types/WalletDetailAttrs.mjs

@@ -12,6 +12,7 @@ export const WalletDetailAttrs = core.serialization.object({
     createdAt: core.serialization.date().nullable(),
     displayName: core.serialization.string().nullable(),
     description: core.serialization.string().nullable(),
+    tags: core.serialization.record(core.serialization.string(), core.serialization.string()),
     balance: GetWalletsResponseDataAttributesBalance.nullable(),
     claims: WalletDetailClaims,
     depositInstructions: GetWalletsResponseDataAttributesDepositInstructions.nullable(),

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.2";
+export declare const SDK_VERSION = "1.2.3";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.2.2";
+export const SDK_VERSION = "1.2.3";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@naturalpay/sdk",
-    "version": "1.2.2",
+    "version": "1.2.3",
     "private": false,
     "repository": {
         "type": "git",

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"
+    }
 });
 
 ```
@@ -1881,7 +1896,10 @@ await client.transfers.initiateWithdrawal({
     currency: "USD",
     externalAccountId: "eac_550e8400e29b41d4a716446655440000",
     method: "standard",
-    description: "Payout transfer"
+    description: "Payout transfer",
+    tags: {
+        "workflow": "treasury"
+    }
 });
 
 ```
@@ -1950,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"
+    }
 });
 
 ```
@@ -2235,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",
@@ -2449,6 +2473,9 @@ await client.paymentRequests.fulfill({
     paymentSource: {
         type: "wallet",
         walletId: "wal_550e8400e29b41d4a716446655440000"
+    },
+    tags: {
+        "invoice_id": "inv_7"
     }
 });
 
@@ -2977,7 +3004,10 @@ await client.invitations.create({
         }, {
             email: "cfo@velocitylogistics.com",
             role: "ADMIN"
-        }]
+        }],
+    tags: {
+        "team": "operations"
+    }
 });
 
 ```
@@ -3743,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"
+    }
 });
 
 ```
@@ -3857,7 +3890,7 @@ await client.wallets.get({
 <dl>
 <dd>
 
-Update wallet metadata
+Update a wallet's display name, description, or tags
 </dd>
 </dl>
 </dd>
@@ -3876,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
+    }
 });
 
 ```
@@ -4407,7 +4444,10 @@ await client.externalAccounts.createFromProcessorToken({
     idempotencyKey: "Idempotency-Key",
     partyId: "pty_7c9e6679e29b41d4a716446655440001",
     processorToken: "processor-sandbox-abc123",
-    institutionName: "Chase"
+    institutionName: "Chase",
+    tags: {
+        "environment": "production"
+    }
 });
 
 ```
@@ -4754,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"
+    }
 });
 
 ```
@@ -5016,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: {
@@ -5159,7 +5204,10 @@ Generate a replacement agent key.
 await client.agentKeys.rotate({
     idempotencyKey: "Idempotency-Key",
     keyId: "keyId",
-    expiresInSeconds: 86400
+    expiresInSeconds: 86400,
+    tags: {
+        "team": "payments"
+    }
 });
 
 ```