@naturalpay/sdk 0.13.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/resources/agents.d.mts +27 -54
  4. package/resources/agents.d.mts.map +1 -1
  5. package/resources/agents.d.ts +27 -54
  6. package/resources/agents.d.ts.map +1 -1
  7. package/resources/api-keys.d.mts +12 -24
  8. package/resources/api-keys.d.mts.map +1 -1
  9. package/resources/api-keys.d.ts +12 -24
  10. package/resources/api-keys.d.ts.map +1 -1
  11. package/resources/approvals.d.mts +12 -24
  12. package/resources/approvals.d.mts.map +1 -1
  13. package/resources/approvals.d.ts +12 -24
  14. package/resources/approvals.d.ts.map +1 -1
  15. package/resources/counterparties.d.mts +3 -6
  16. package/resources/counterparties.d.mts.map +1 -1
  17. package/resources/counterparties.d.ts +3 -6
  18. package/resources/counterparties.d.ts.map +1 -1
  19. package/resources/customers.d.mts +6 -12
  20. package/resources/customers.d.mts.map +1 -1
  21. package/resources/customers.d.ts +6 -12
  22. package/resources/customers.d.ts.map +1 -1
  23. package/resources/external-accounts.d.mts +6 -12
  24. package/resources/external-accounts.d.mts.map +1 -1
  25. package/resources/external-accounts.d.ts +6 -12
  26. package/resources/external-accounts.d.ts.map +1 -1
  27. package/resources/invitations.d.mts +9 -18
  28. package/resources/invitations.d.mts.map +1 -1
  29. package/resources/invitations.d.ts +9 -18
  30. package/resources/invitations.d.ts.map +1 -1
  31. package/resources/parties.d.mts +12 -24
  32. package/resources/parties.d.mts.map +1 -1
  33. package/resources/parties.d.ts +12 -24
  34. package/resources/parties.d.ts.map +1 -1
  35. package/resources/payment-requests.d.mts +18 -36
  36. package/resources/payment-requests.d.mts.map +1 -1
  37. package/resources/payment-requests.d.ts +18 -36
  38. package/resources/payment-requests.d.ts.map +1 -1
  39. package/resources/payments.d.mts +12 -24
  40. package/resources/payments.d.mts.map +1 -1
  41. package/resources/payments.d.ts +12 -24
  42. package/resources/payments.d.ts.map +1 -1
  43. package/resources/transactions.d.mts +6 -12
  44. package/resources/transactions.d.mts.map +1 -1
  45. package/resources/transactions.d.ts +6 -12
  46. package/resources/transactions.d.ts.map +1 -1
  47. package/resources/transfers.d.mts +12 -24
  48. package/resources/transfers.d.mts.map +1 -1
  49. package/resources/transfers.d.ts +12 -24
  50. package/resources/transfers.d.ts.map +1 -1
  51. package/resources/wallet.d.mts +6 -12
  52. package/resources/wallet.d.mts.map +1 -1
  53. package/resources/wallet.d.ts +6 -12
  54. package/resources/wallet.d.ts.map +1 -1
  55. package/resources/webhooks.d.mts +18 -36
  56. package/resources/webhooks.d.mts.map +1 -1
  57. package/resources/webhooks.d.ts +18 -36
  58. package/resources/webhooks.d.ts.map +1 -1
  59. package/src/resources/agents.ts +27 -54
  60. package/src/resources/api-keys.ts +12 -24
  61. package/src/resources/approvals.ts +12 -24
  62. package/src/resources/counterparties.ts +3 -6
  63. package/src/resources/customers.ts +6 -12
  64. package/src/resources/external-accounts.ts +6 -12
  65. package/src/resources/invitations.ts +9 -18
  66. package/src/resources/parties.ts +12 -24
  67. package/src/resources/payment-requests.ts +18 -36
  68. package/src/resources/payments.ts +12 -24
  69. package/src/resources/transactions.ts +6 -12
  70. package/src/resources/transfers.ts +12 -24
  71. package/src/resources/wallet.ts +6 -12
  72. package/src/resources/webhooks.ts +18 -36
  73. package/src/version.ts +1 -1
  74. package/version.d.mts +1 -1
  75. package/version.d.ts +1 -1
  76. package/version.js +1 -1
  77. package/version.mjs +1 -1
@@ -343,16 +343,13 @@ export interface InvitationCreateParams {
343
343
  invitations: Array<InvitationCreateParams.Invitation>;
344
344
 
345
345
  /**
346
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
347
- * payment-related API requests unless your party has exactly one active agent,
348
- * which Natural defaults automatically.
346
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
349
347
  */
350
348
  'X-Agent-ID'?: string;
351
349
 
352
350
  /**
353
- * Header param: Stable run, session, or conversation ID for agent observability.
354
- * If omitted on a payment-related API request, Natural generates one after
355
- * resolving the attribution agent.
351
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
352
+ * for agent observability.
356
353
  */
357
354
  'X-Instance-ID'?: string;
358
355
  }
@@ -391,16 +388,13 @@ export interface InvitationListParams {
391
388
  status?: 'PENDING' | 'ACCEPTED' | 'REVOKED';
392
389
 
393
390
  /**
394
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
395
- * payment-related API requests unless your party has exactly one active agent,
396
- * which Natural defaults automatically.
391
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
397
392
  */
398
393
  'X-Agent-ID'?: string;
399
394
 
400
395
  /**
401
- * Header param: Stable run, session, or conversation ID for agent observability.
402
- * If omitted on a payment-related API request, Natural generates one after
403
- * resolving the attribution agent.
396
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
397
+ * for agent observability.
404
398
  */
405
399
  'X-Instance-ID'?: string;
406
400
  }
@@ -413,16 +407,13 @@ export interface InvitationRevokeParams {
413
407
  'Idempotency-Key': string;
414
408
 
415
409
  /**
416
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
417
- * requests unless your party has exactly one active agent, which Natural defaults
418
- * automatically.
410
+ * Agent ID (agt_xxx) identifying which agent is making the request.
419
411
  */
420
412
  'X-Agent-ID'?: string;
421
413
 
422
414
  /**
423
- * Stable run, session, or conversation ID for agent observability. If omitted on a
424
- * payment-related API request, Natural generates one after resolving the
425
- * attribution agent.
415
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
416
+ * observability.
426
417
  */
427
418
  'X-Instance-ID'?: string;
428
419
  }
@@ -468,32 +468,26 @@ export interface PartyUpdateParams {
468
468
  displayName?: string | null;
469
469
 
470
470
  /**
471
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
472
- * payment-related API requests unless your party has exactly one active agent,
473
- * which Natural defaults automatically.
471
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
474
472
  */
475
473
  'X-Agent-ID'?: string;
476
474
 
477
475
  /**
478
- * Header param: Stable run, session, or conversation ID for agent observability.
479
- * If omitted on a payment-related API request, Natural generates one after
480
- * resolving the attribution agent.
476
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
477
+ * for agent observability.
481
478
  */
482
479
  'X-Instance-ID'?: string;
483
480
  }
484
481
 
485
482
  export interface PartyGetParams {
486
483
  /**
487
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
488
- * requests unless your party has exactly one active agent, which Natural defaults
489
- * automatically.
484
+ * Agent ID (agt_xxx) identifying which agent is making the request.
490
485
  */
491
486
  'X-Agent-ID'?: string;
492
487
 
493
488
  /**
494
- * Stable run, session, or conversation ID for agent observability. If omitted on a
495
- * payment-related API request, Natural generates one after resolving the
496
- * attribution agent.
489
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
490
+ * observability.
497
491
  */
498
492
  'X-Instance-ID'?: string;
499
493
  }
@@ -510,16 +504,13 @@ export interface PartyListMembersParams {
510
504
  limit?: number;
511
505
 
512
506
  /**
513
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
514
- * payment-related API requests unless your party has exactly one active agent,
515
- * which Natural defaults automatically.
507
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
516
508
  */
517
509
  'X-Agent-ID'?: string;
518
510
 
519
511
  /**
520
- * Header param: Stable run, session, or conversation ID for agent observability.
521
- * If omitted on a payment-related API request, Natural generates one after
522
- * resolving the attribution agent.
512
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
513
+ * for agent observability.
523
514
  */
524
515
  'X-Instance-ID'?: string;
525
516
  }
@@ -532,16 +523,13 @@ export interface PartyRemoveMemberParams {
532
523
  'Idempotency-Key': string;
533
524
 
534
525
  /**
535
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
536
- * requests unless your party has exactly one active agent, which Natural defaults
537
- * automatically.
526
+ * Agent ID (agt_xxx) identifying which agent is making the request.
538
527
  */
539
528
  'X-Agent-ID'?: string;
540
529
 
541
530
  /**
542
- * Stable run, session, or conversation ID for agent observability. If omitted on a
543
- * payment-related API request, Natural generates one after resolving the
544
- * attribution agent.
531
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
532
+ * observability.
545
533
  */
546
534
  'X-Instance-ID'?: string;
547
535
  }
@@ -1684,16 +1684,13 @@ export interface PaymentRequestCreateParams {
1684
1684
  walletId?: string;
1685
1685
 
1686
1686
  /**
1687
- * Header param: Conditionally required for payment-related API requests. Pass an
1688
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1689
- * one active agent, which Natural defaults automatically.
1687
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1690
1688
  */
1691
1689
  'X-Agent-ID'?: string;
1692
1690
 
1693
1691
  /**
1694
- * Header param: Stable run, session, or conversation ID for agent observability.
1695
- * If omitted on a payment-related API request, Natural generates one after
1696
- * resolving the attribution agent.
1692
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1693
+ * for agent observability.
1697
1694
  */
1698
1695
  'X-Instance-ID'?: string;
1699
1696
  }
@@ -1748,16 +1745,13 @@ export interface PaymentRequestListParams {
1748
1745
  limit?: number;
1749
1746
 
1750
1747
  /**
1751
- * Header param: Conditionally required for payment-related API requests. Pass an
1752
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1753
- * one active agent, which Natural defaults automatically.
1748
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1754
1749
  */
1755
1750
  'X-Agent-ID'?: string;
1756
1751
 
1757
1752
  /**
1758
- * Header param: Stable run, session, or conversation ID for agent observability.
1759
- * If omitted on a payment-related API request, Natural generates one after
1760
- * resolving the attribution agent.
1753
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1754
+ * for agent observability.
1761
1755
  */
1762
1756
  'X-Instance-ID'?: string;
1763
1757
  }
@@ -1770,16 +1764,13 @@ export interface PaymentRequestDeclineParams {
1770
1764
  'Idempotency-Key': string;
1771
1765
 
1772
1766
  /**
1773
- * Conditionally required for payment-related API requests. Pass an agent ID
1774
- * (agt_xxx) for attribution, or omit it only when your party has exactly one
1775
- * active agent, which Natural defaults automatically.
1767
+ * Agent ID (agt_xxx) identifying which agent is making the request.
1776
1768
  */
1777
1769
  'X-Agent-ID'?: string;
1778
1770
 
1779
1771
  /**
1780
- * Stable run, session, or conversation ID for agent observability. If omitted on a
1781
- * payment-related API request, Natural generates one after resolving the
1782
- * attribution agent.
1772
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
1773
+ * observability.
1783
1774
  */
1784
1775
  'X-Instance-ID'?: string;
1785
1776
  }
@@ -1797,16 +1788,13 @@ export interface PaymentRequestFulfillParams {
1797
1788
  'Idempotency-Key': string;
1798
1789
 
1799
1790
  /**
1800
- * Header param: Conditionally required for payment-related API requests. Pass an
1801
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1802
- * one active agent, which Natural defaults automatically.
1791
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1803
1792
  */
1804
1793
  'X-Agent-ID'?: string;
1805
1794
 
1806
1795
  /**
1807
- * Header param: Stable run, session, or conversation ID for agent observability.
1808
- * If omitted on a payment-related API request, Natural generates one after
1809
- * resolving the attribution agent.
1796
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1797
+ * for agent observability.
1810
1798
  */
1811
1799
  'X-Instance-ID'?: string;
1812
1800
  }
@@ -1827,16 +1815,13 @@ export namespace PaymentRequestFulfillParams {
1827
1815
 
1828
1816
  export interface PaymentRequestGetParams {
1829
1817
  /**
1830
- * Conditionally required for payment-related API requests. Pass an agent ID
1831
- * (agt_xxx) for attribution, or omit it only when your party has exactly one
1832
- * active agent, which Natural defaults automatically.
1818
+ * Agent ID (agt_xxx) identifying which agent is making the request.
1833
1819
  */
1834
1820
  'X-Agent-ID'?: string;
1835
1821
 
1836
1822
  /**
1837
- * Stable run, session, or conversation ID for agent observability. If omitted on a
1838
- * payment-related API request, Natural generates one after resolving the
1839
- * attribution agent.
1823
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
1824
+ * observability.
1840
1825
  */
1841
1826
  'X-Instance-ID'?: string;
1842
1827
  }
@@ -1853,16 +1838,13 @@ export interface PaymentRequestListIncomingParams {
1853
1838
  limit?: number;
1854
1839
 
1855
1840
  /**
1856
- * Header param: Conditionally required for payment-related API requests. Pass an
1857
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1858
- * one active agent, which Natural defaults automatically.
1841
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1859
1842
  */
1860
1843
  'X-Agent-ID'?: string;
1861
1844
 
1862
1845
  /**
1863
- * Header param: Stable run, session, or conversation ID for agent observability.
1864
- * If omitted on a payment-related API request, Natural generates one after
1865
- * resolving the attribution agent.
1846
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1847
+ * for agent observability.
1866
1848
  */
1867
1849
  'X-Instance-ID'?: string;
1868
1850
  }
@@ -1077,16 +1077,13 @@ export interface PaymentCreateParams {
1077
1077
  description?: string;
1078
1078
 
1079
1079
  /**
1080
- * Header param: Conditionally required for payment-related API requests. Pass an
1081
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1082
- * one active agent, which Natural defaults automatically.
1080
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1083
1081
  */
1084
1082
  'X-Agent-ID'?: string;
1085
1083
 
1086
1084
  /**
1087
- * Header param: Stable run, session, or conversation ID for agent observability.
1088
- * If omitted on a payment-related API request, Natural generates one after
1089
- * resolving the attribution agent.
1085
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1086
+ * for agent observability.
1090
1087
  */
1091
1088
  'X-Instance-ID'?: string;
1092
1089
  }
@@ -1146,16 +1143,13 @@ export interface PaymentListParams {
1146
1143
  partyId?: string;
1147
1144
 
1148
1145
  /**
1149
- * Header param: Conditionally required for payment-related API requests. Pass an
1150
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1151
- * one active agent, which Natural defaults automatically.
1146
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1152
1147
  */
1153
1148
  'X-Agent-ID'?: string;
1154
1149
 
1155
1150
  /**
1156
- * Header param: Stable run, session, or conversation ID for agent observability.
1157
- * If omitted on a payment-related API request, Natural generates one after
1158
- * resolving the attribution agent.
1151
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1152
+ * for agent observability.
1159
1153
  */
1160
1154
  'X-Instance-ID'?: string;
1161
1155
  }
@@ -1168,16 +1162,13 @@ export interface PaymentCancelParams {
1168
1162
  'Idempotency-Key': string;
1169
1163
 
1170
1164
  /**
1171
- * Conditionally required for payment-related API requests. Pass an agent ID
1172
- * (agt_xxx) for attribution, or omit it only when your party has exactly one
1173
- * active agent, which Natural defaults automatically.
1165
+ * Agent ID (agt_xxx) identifying which agent is making the request.
1174
1166
  */
1175
1167
  'X-Agent-ID'?: string;
1176
1168
 
1177
1169
  /**
1178
- * Stable run, session, or conversation ID for agent observability. If omitted on a
1179
- * payment-related API request, Natural generates one after resolving the
1180
- * attribution agent.
1170
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
1171
+ * observability.
1181
1172
  */
1182
1173
  'X-Instance-ID'?: string;
1183
1174
  }
@@ -1189,16 +1180,13 @@ export interface PaymentGetParams {
1189
1180
  partyId?: string;
1190
1181
 
1191
1182
  /**
1192
- * Header param: Conditionally required for payment-related API requests. Pass an
1193
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1194
- * one active agent, which Natural defaults automatically.
1183
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1195
1184
  */
1196
1185
  'X-Agent-ID'?: string;
1197
1186
 
1198
1187
  /**
1199
- * Header param: Stable run, session, or conversation ID for agent observability.
1200
- * If omitted on a payment-related API request, Natural generates one after
1201
- * resolving the attribution agent.
1188
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1189
+ * for agent observability.
1202
1190
  */
1203
1191
  'X-Instance-ID'?: string;
1204
1192
  }
@@ -495,16 +495,13 @@ export interface TransactionListParams {
495
495
  type?: 'payment' | 'transfer' | 'all';
496
496
 
497
497
  /**
498
- * Header param: Conditionally required for payment-related API requests. Pass an
499
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
500
- * one active agent, which Natural defaults automatically.
498
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
501
499
  */
502
500
  'X-Agent-ID'?: string;
503
501
 
504
502
  /**
505
- * Header param: Stable run, session, or conversation ID for agent observability.
506
- * If omitted on a payment-related API request, Natural generates one after
507
- * resolving the attribution agent.
503
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
504
+ * for agent observability.
508
505
  */
509
506
  'X-Instance-ID'?: string;
510
507
  }
@@ -516,16 +513,13 @@ export interface TransactionGetParams {
516
513
  partyId?: string;
517
514
 
518
515
  /**
519
- * Header param: Conditionally required for payment-related API requests. Pass an
520
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
521
- * one active agent, which Natural defaults automatically.
516
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
522
517
  */
523
518
  'X-Agent-ID'?: string;
524
519
 
525
520
  /**
526
- * Header param: Stable run, session, or conversation ID for agent observability.
527
- * If omitted on a payment-related API request, Natural generates one after
528
- * resolving the attribution agent.
521
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
522
+ * for agent observability.
529
523
  */
530
524
  'X-Instance-ID'?: string;
531
525
  }
@@ -1217,16 +1217,13 @@ export interface TransferListParams {
1217
1217
  partyId?: string;
1218
1218
 
1219
1219
  /**
1220
- * Header param: Conditionally required for payment-related API requests. Pass an
1221
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1222
- * one active agent, which Natural defaults automatically.
1220
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1223
1221
  */
1224
1222
  'X-Agent-ID'?: string;
1225
1223
 
1226
1224
  /**
1227
- * Header param: Stable run, session, or conversation ID for agent observability.
1228
- * If omitted on a payment-related API request, Natural generates one after
1229
- * resolving the attribution agent.
1225
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1226
+ * for agent observability.
1230
1227
  */
1231
1228
  'X-Instance-ID'?: string;
1232
1229
  }
@@ -1238,16 +1235,13 @@ export interface TransferGetParams {
1238
1235
  partyId?: string;
1239
1236
 
1240
1237
  /**
1241
- * Header param: Conditionally required for payment-related API requests. Pass an
1242
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1243
- * one active agent, which Natural defaults automatically.
1238
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1244
1239
  */
1245
1240
  'X-Agent-ID'?: string;
1246
1241
 
1247
1242
  /**
1248
- * Header param: Stable run, session, or conversation ID for agent observability.
1249
- * If omitted on a payment-related API request, Natural generates one after
1250
- * resolving the attribution agent.
1243
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1244
+ * for agent observability.
1251
1245
  */
1252
1246
  'X-Instance-ID'?: string;
1253
1247
  }
@@ -1280,16 +1274,13 @@ export interface TransferInitiateDepositParams {
1280
1274
  description?: string;
1281
1275
 
1282
1276
  /**
1283
- * Header param: Conditionally required for payment-related API requests. Pass an
1284
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1285
- * one active agent, which Natural defaults automatically.
1277
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1286
1278
  */
1287
1279
  'X-Agent-ID'?: string;
1288
1280
 
1289
1281
  /**
1290
- * Header param: Stable run, session, or conversation ID for agent observability.
1291
- * If omitted on a payment-related API request, Natural generates one after
1292
- * resolving the attribution agent.
1282
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1283
+ * for agent observability.
1293
1284
  */
1294
1285
  'X-Instance-ID'?: string;
1295
1286
  }
@@ -1322,16 +1313,13 @@ export interface TransferInitiateWithdrawalParams {
1322
1313
  description?: string;
1323
1314
 
1324
1315
  /**
1325
- * Header param: Conditionally required for payment-related API requests. Pass an
1326
- * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
1327
- * one active agent, which Natural defaults automatically.
1316
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1328
1317
  */
1329
1318
  'X-Agent-ID'?: string;
1330
1319
 
1331
1320
  /**
1332
- * Header param: Stable run, session, or conversation ID for agent observability.
1333
- * If omitted on a payment-related API request, Natural generates one after
1334
- * resolving the attribution agent.
1321
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1322
+ * for agent observability.
1335
1323
  */
1336
1324
  'X-Instance-ID'?: string;
1337
1325
  }
@@ -346,32 +346,26 @@ export namespace WalletGetResponse {
346
346
 
347
347
  export interface WalletListParams {
348
348
  /**
349
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
350
- * requests unless your party has exactly one active agent, which Natural defaults
351
- * automatically.
349
+ * Agent ID (agt_xxx) identifying which agent is making the request.
352
350
  */
353
351
  'X-Agent-ID'?: string;
354
352
 
355
353
  /**
356
- * Stable run, session, or conversation ID for agent observability. If omitted on a
357
- * payment-related API request, Natural generates one after resolving the
358
- * attribution agent.
354
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
355
+ * observability.
359
356
  */
360
357
  'X-Instance-ID'?: string;
361
358
  }
362
359
 
363
360
  export interface WalletGetParams {
364
361
  /**
365
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
366
- * requests unless your party has exactly one active agent, which Natural defaults
367
- * automatically.
362
+ * Agent ID (agt_xxx) identifying which agent is making the request.
368
363
  */
369
364
  'X-Agent-ID'?: string;
370
365
 
371
366
  /**
372
- * Stable run, session, or conversation ID for agent observability. If omitted on a
373
- * payment-related API request, Natural generates one after resolving the
374
- * attribution agent.
367
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
368
+ * observability.
375
369
  */
376
370
  'X-Instance-ID'?: string;
377
371
  }
@@ -1045,16 +1045,13 @@ export interface WebhookCreateParams {
1045
1045
  tags?: { [key: string]: string };
1046
1046
 
1047
1047
  /**
1048
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
1049
- * payment-related API requests unless your party has exactly one active agent,
1050
- * which Natural defaults automatically.
1048
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1051
1049
  */
1052
1050
  'X-Agent-ID'?: string;
1053
1051
 
1054
1052
  /**
1055
- * Header param: Stable run, session, or conversation ID for agent observability.
1056
- * If omitted on a payment-related API request, Natural generates one after
1057
- * resolving the attribution agent.
1053
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1054
+ * for agent observability.
1058
1055
  */
1059
1056
  'X-Instance-ID'?: string;
1060
1057
  }
@@ -1121,16 +1118,13 @@ export interface WebhookUpdateParams {
1121
1118
  url?: string;
1122
1119
 
1123
1120
  /**
1124
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
1125
- * payment-related API requests unless your party has exactly one active agent,
1126
- * which Natural defaults automatically.
1121
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1127
1122
  */
1128
1123
  'X-Agent-ID'?: string;
1129
1124
 
1130
1125
  /**
1131
- * Header param: Stable run, session, or conversation ID for agent observability.
1132
- * If omitted on a payment-related API request, Natural generates one after
1133
- * resolving the attribution agent.
1126
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1127
+ * for agent observability.
1134
1128
  */
1135
1129
  'X-Instance-ID'?: string;
1136
1130
  }
@@ -1152,32 +1146,26 @@ export interface WebhookListParams {
1152
1146
  status?: 'ENABLED' | 'DISABLED';
1153
1147
 
1154
1148
  /**
1155
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
1156
- * payment-related API requests unless your party has exactly one active agent,
1157
- * which Natural defaults automatically.
1149
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1158
1150
  */
1159
1151
  'X-Agent-ID'?: string;
1160
1152
 
1161
1153
  /**
1162
- * Header param: Stable run, session, or conversation ID for agent observability.
1163
- * If omitted on a payment-related API request, Natural generates one after
1164
- * resolving the attribution agent.
1154
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1155
+ * for agent observability.
1165
1156
  */
1166
1157
  'X-Instance-ID'?: string;
1167
1158
  }
1168
1159
 
1169
1160
  export interface WebhookGetParams {
1170
1161
  /**
1171
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
1172
- * requests unless your party has exactly one active agent, which Natural defaults
1173
- * automatically.
1162
+ * Agent ID (agt_xxx) identifying which agent is making the request.
1174
1163
  */
1175
1164
  'X-Agent-ID'?: string;
1176
1165
 
1177
1166
  /**
1178
- * Stable run, session, or conversation ID for agent observability. If omitted on a
1179
- * payment-related API request, Natural generates one after resolving the
1180
- * attribution agent.
1167
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
1168
+ * observability.
1181
1169
  */
1182
1170
  'X-Instance-ID'?: string;
1183
1171
  }
@@ -1190,16 +1178,13 @@ export interface WebhookRemoveParams {
1190
1178
  'Idempotency-Key': string;
1191
1179
 
1192
1180
  /**
1193
- * Agent ID (agt_xxx) used for attribution. Required for payment-related API
1194
- * requests unless your party has exactly one active agent, which Natural defaults
1195
- * automatically.
1181
+ * Agent ID (agt_xxx) identifying which agent is making the request.
1196
1182
  */
1197
1183
  'X-Agent-ID'?: string;
1198
1184
 
1199
1185
  /**
1200
- * Stable run, session, or conversation ID for agent observability. If omitted on a
1201
- * payment-related API request, Natural generates one after resolving the
1202
- * attribution agent.
1186
+ * Required when X-Agent-ID is present. Session or conversation ID for agent
1187
+ * observability.
1203
1188
  */
1204
1189
  'X-Instance-ID'?: string;
1205
1190
  }
@@ -1218,16 +1203,13 @@ export interface WebhookRotateSecretParams {
1218
1203
  'Idempotency-Key': string;
1219
1204
 
1220
1205
  /**
1221
- * Header param: Agent ID (agt_xxx) used for attribution. Required for
1222
- * payment-related API requests unless your party has exactly one active agent,
1223
- * which Natural defaults automatically.
1206
+ * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
1224
1207
  */
1225
1208
  'X-Agent-ID'?: string;
1226
1209
 
1227
1210
  /**
1228
- * Header param: Stable run, session, or conversation ID for agent observability.
1229
- * If omitted on a payment-related API request, Natural generates one after
1230
- * resolving the attribution agent.
1211
+ * Header param: Required when X-Agent-ID is present. Session or conversation ID
1212
+ * for agent observability.
1231
1213
  */
1232
1214
  'X-Instance-ID'?: string;
1233
1215
  }
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.13.0'; // x-release-please-version
1
+ export const VERSION = '0.15.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.13.0";
1
+ export declare const VERSION = "0.15.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.13.0";
1
+ export declare const VERSION = "0.15.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.13.0'; // x-release-please-version
4
+ exports.VERSION = '0.15.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.13.0'; // x-release-please-version
1
+ export const VERSION = '0.15.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map