@naturalpay/sdk 0.13.0 → 0.14.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 (93) hide show
  1. package/CHANGELOG.md +8 -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 +59 -66
  36. package/resources/payment-requests.d.mts.map +1 -1
  37. package/resources/payment-requests.d.ts +59 -66
  38. package/resources/payment-requests.d.ts.map +1 -1
  39. package/resources/payment-requests.js +33 -46
  40. package/resources/payment-requests.js.map +1 -1
  41. package/resources/payment-requests.mjs +33 -46
  42. package/resources/payment-requests.mjs.map +1 -1
  43. package/resources/payments.d.mts +43 -46
  44. package/resources/payments.d.mts.map +1 -1
  45. package/resources/payments.d.ts +43 -46
  46. package/resources/payments.d.ts.map +1 -1
  47. package/resources/payments.js +23 -30
  48. package/resources/payments.js.map +1 -1
  49. package/resources/payments.mjs +23 -30
  50. package/resources/payments.mjs.map +1 -1
  51. package/resources/transactions.d.mts +15 -23
  52. package/resources/transactions.d.mts.map +1 -1
  53. package/resources/transactions.d.ts +15 -23
  54. package/resources/transactions.d.ts.map +1 -1
  55. package/resources/transactions.js +6 -18
  56. package/resources/transactions.js.map +1 -1
  57. package/resources/transactions.mjs +6 -18
  58. package/resources/transactions.mjs.map +1 -1
  59. package/resources/transfers.d.mts +43 -48
  60. package/resources/transfers.d.mts.map +1 -1
  61. package/resources/transfers.d.ts +43 -48
  62. package/resources/transfers.d.ts.map +1 -1
  63. package/resources/transfers.js +20 -29
  64. package/resources/transfers.js.map +1 -1
  65. package/resources/transfers.mjs +20 -29
  66. package/resources/transfers.mjs.map +1 -1
  67. package/resources/wallet.d.mts +6 -12
  68. package/resources/wallet.d.mts.map +1 -1
  69. package/resources/wallet.d.ts +6 -12
  70. package/resources/wallet.d.ts.map +1 -1
  71. package/resources/webhooks.d.mts +18 -36
  72. package/resources/webhooks.d.mts.map +1 -1
  73. package/resources/webhooks.d.ts +18 -36
  74. package/resources/webhooks.d.ts.map +1 -1
  75. package/src/resources/agents.ts +27 -54
  76. package/src/resources/api-keys.ts +12 -24
  77. package/src/resources/approvals.ts +12 -24
  78. package/src/resources/counterparties.ts +3 -6
  79. package/src/resources/customers.ts +6 -12
  80. package/src/resources/external-accounts.ts +6 -12
  81. package/src/resources/invitations.ts +9 -18
  82. package/src/resources/parties.ts +12 -24
  83. package/src/resources/payment-requests.ts +70 -110
  84. package/src/resources/payments.ts +53 -83
  85. package/src/resources/transactions.ts +21 -44
  86. package/src/resources/transfers.ts +51 -79
  87. package/src/resources/wallet.ts +6 -12
  88. package/src/resources/webhooks.ts +18 -36
  89. package/src/version.ts +1 -1
  90. package/version.d.mts +1 -1
  91. package/version.d.ts +1 -1
  92. package/version.js +1 -1
  93. package/version.mjs +1 -1
@@ -13,21 +13,12 @@ export class Transactions extends APIResource {
13
13
  /**
14
14
  * List transactions visible to your party.
15
15
  */
16
- list(
17
- params: TransactionListParams | null | undefined = {},
18
- options?: RequestOptions,
19
- ): APIPromise<TransactionListResponse> {
20
- const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
16
+ list(params: TransactionListParams, options?: RequestOptions): APIPromise<TransactionListResponse> {
17
+ const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
21
18
  return this._client.get('/transactions', {
22
19
  query,
23
20
  ...options,
24
- headers: buildHeaders([
25
- {
26
- ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
27
- ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
28
- },
29
- options?.headers,
30
- ]),
21
+ headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
31
22
  });
32
23
  }
33
24
 
@@ -36,20 +27,14 @@ export class Transactions extends APIResource {
36
27
  */
37
28
  get(
38
29
  transactionID: string,
39
- params: TransactionGetParams | null | undefined = {},
30
+ params: TransactionGetParams,
40
31
  options?: RequestOptions,
41
32
  ): APIPromise<TransactionGetResponse> {
42
- const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
33
+ const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
43
34
  return this._client.get(path`/transactions/${transactionID}`, {
44
35
  query,
45
36
  ...options,
46
- headers: buildHeaders([
47
- {
48
- ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
49
- ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
50
- },
51
- options?.headers,
52
- ]),
37
+ headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
53
38
  });
54
39
  }
55
40
  }
@@ -479,6 +464,16 @@ export namespace TransactionGetResponse {
479
464
  }
480
465
 
481
466
  export interface TransactionListParams {
467
+ /**
468
+ * Header param: Agent ID (agt_xxx) used for attribution and audit.
469
+ */
470
+ 'X-Agent-ID': string;
471
+
472
+ /**
473
+ * Header param: Stable run, session, or conversation ID for agent observability.
474
+ */
475
+ 'X-Instance-ID': string;
476
+
482
477
  /**
483
478
  * Query param: Pagination cursor from previous response
484
479
  */
@@ -493,41 +488,23 @@ export interface TransactionListParams {
493
488
  * Query param
494
489
  */
495
490
  type?: 'payment' | 'transfer' | 'all';
491
+ }
496
492
 
493
+ export interface TransactionGetParams {
497
494
  /**
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.
495
+ * Header param: Agent ID (agt_xxx) used for attribution and audit.
501
496
  */
502
- 'X-Agent-ID'?: string;
497
+ 'X-Agent-ID': string;
503
498
 
504
499
  /**
505
500
  * 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.
508
501
  */
509
- 'X-Instance-ID'?: string;
510
- }
502
+ 'X-Instance-ID': string;
511
503
 
512
- export interface TransactionGetParams {
513
504
  /**
514
505
  * Query param: Party ID for delegated transaction lookup
515
506
  */
516
507
  partyId?: string;
517
-
518
- /**
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.
522
- */
523
- 'X-Agent-ID'?: string;
524
-
525
- /**
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.
529
- */
530
- 'X-Instance-ID'?: string;
531
508
  }
532
509
 
533
510
  export declare namespace Transactions {
@@ -15,24 +15,18 @@ export class Transfers extends APIResource {
15
15
  *
16
16
  * @example
17
17
  * ```ts
18
- * const transfers = await client.transfers.list();
18
+ * const transfers = await client.transfers.list({
19
+ * 'X-Agent-ID': 'X-Agent-ID',
20
+ * 'X-Instance-ID': 'X-Instance-ID',
21
+ * });
19
22
  * ```
20
23
  */
21
- list(
22
- params: TransferListParams | null | undefined = {},
23
- options?: RequestOptions,
24
- ): APIPromise<TransferListResponse> {
25
- const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
24
+ list(params: TransferListParams, options?: RequestOptions): APIPromise<TransferListResponse> {
25
+ const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
26
26
  return this._client.get('/transfers', {
27
27
  query,
28
28
  ...options,
29
- headers: buildHeaders([
30
- {
31
- ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
32
- ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
33
- },
34
- options?.headers,
35
- ]),
29
+ headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
36
30
  });
37
31
  }
38
32
 
@@ -43,25 +37,23 @@ export class Transfers extends APIResource {
43
37
  * ```ts
44
38
  * const transfer = await client.transfers.get(
45
39
  * 'trf_ecc2efdd09bd231a9ad9bd2aada37aa7',
40
+ * {
41
+ * 'X-Agent-ID': 'X-Agent-ID',
42
+ * 'X-Instance-ID': 'X-Instance-ID',
43
+ * },
46
44
  * );
47
45
  * ```
48
46
  */
49
47
  get(
50
48
  transferID: string,
51
- params: TransferGetParams | null | undefined = {},
49
+ params: TransferGetParams,
52
50
  options?: RequestOptions,
53
51
  ): APIPromise<TransferGetResponse> {
54
- const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
52
+ const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
55
53
  return this._client.get(path`/transfers/${transferID}`, {
56
54
  query,
57
55
  ...options,
58
- headers: buildHeaders([
59
- {
60
- ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
61
- ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
62
- },
63
- options?.headers,
64
- ]),
56
+ headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
65
57
  });
66
58
  }
67
59
 
@@ -74,6 +66,8 @@ export class Transfers extends APIResource {
74
66
  * amount: 100,
75
67
  * externalAccountId: 'eac_ecc2efdd09bd231a9ad9bd2aada37aa7',
76
68
  * 'Idempotency-Key': 'Idempotency-Key',
69
+ * 'X-Agent-ID': 'X-Agent-ID',
70
+ * 'X-Instance-ID': 'X-Instance-ID',
77
71
  * });
78
72
  * ```
79
73
  */
@@ -91,11 +85,7 @@ export class Transfers extends APIResource {
91
85
  body,
92
86
  ...options,
93
87
  headers: buildHeaders([
94
- {
95
- 'Idempotency-Key': idempotencyKey,
96
- ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
97
- ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
98
- },
88
+ { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
99
89
  options?.headers,
100
90
  ]),
101
91
  });
@@ -110,6 +100,8 @@ export class Transfers extends APIResource {
110
100
  * amount: 1,
111
101
  * externalAccountId: 'eac_ecc2efdd09bd231a9ad9bd2aada37aa7',
112
102
  * 'Idempotency-Key': 'Idempotency-Key',
103
+ * 'X-Agent-ID': 'X-Agent-ID',
104
+ * 'X-Instance-ID': 'X-Instance-ID',
113
105
  * });
114
106
  * ```
115
107
  */
@@ -127,11 +119,7 @@ export class Transfers extends APIResource {
127
119
  body,
128
120
  ...options,
129
121
  headers: buildHeaders([
130
- {
131
- 'Idempotency-Key': idempotencyKey,
132
- ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
133
- ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
134
- },
122
+ { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
135
123
  options?.headers,
136
124
  ]),
137
125
  });
@@ -1201,6 +1189,16 @@ export namespace TransferInitiateWithdrawalResponse {
1201
1189
  }
1202
1190
 
1203
1191
  export interface TransferListParams {
1192
+ /**
1193
+ * Header param: Agent ID (agt_xxx) used for attribution and audit.
1194
+ */
1195
+ 'X-Agent-ID': string;
1196
+
1197
+ /**
1198
+ * Header param: Stable run, session, or conversation ID for agent observability.
1199
+ */
1200
+ 'X-Instance-ID': string;
1201
+
1204
1202
  /**
1205
1203
  * Query param: Pagination cursor from previous response
1206
1204
  */
@@ -1215,41 +1213,23 @@ export interface TransferListParams {
1215
1213
  * Query param: Party ID for delegated transfer lookup
1216
1214
  */
1217
1215
  partyId?: string;
1216
+ }
1218
1217
 
1218
+ export interface TransferGetParams {
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) used for attribution and audit.
1223
1221
  */
1224
- 'X-Agent-ID'?: string;
1222
+ 'X-Agent-ID': string;
1225
1223
 
1226
1224
  /**
1227
1225
  * 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.
1230
1226
  */
1231
- 'X-Instance-ID'?: string;
1232
- }
1227
+ 'X-Instance-ID': string;
1233
1228
 
1234
- export interface TransferGetParams {
1235
1229
  /**
1236
1230
  * Query param: Party ID for delegated transfer lookup
1237
1231
  */
1238
1232
  partyId?: string;
1239
-
1240
- /**
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.
1244
- */
1245
- 'X-Agent-ID'?: string;
1246
-
1247
- /**
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.
1251
- */
1252
- 'X-Instance-ID'?: string;
1253
1233
  }
1254
1234
 
1255
1235
  export interface TransferInitiateDepositParams {
@@ -1270,28 +1250,24 @@ export interface TransferInitiateDepositParams {
1270
1250
  'Idempotency-Key': string;
1271
1251
 
1272
1252
  /**
1273
- * Body param: Currency code
1253
+ * Header param: Agent ID (agt_xxx) used for attribution and audit.
1274
1254
  */
1275
- currency?: string;
1255
+ 'X-Agent-ID': string;
1276
1256
 
1277
1257
  /**
1278
- * Body param: Deposit description
1258
+ * Header param: Stable run, session, or conversation ID for agent observability.
1279
1259
  */
1280
- description?: string;
1260
+ 'X-Instance-ID': string;
1281
1261
 
1282
1262
  /**
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.
1263
+ * Body param: Currency code
1286
1264
  */
1287
- 'X-Agent-ID'?: string;
1265
+ currency?: string;
1288
1266
 
1289
1267
  /**
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.
1268
+ * Body param: Deposit description
1293
1269
  */
1294
- 'X-Instance-ID'?: string;
1270
+ description?: string;
1295
1271
  }
1296
1272
 
1297
1273
  export interface TransferInitiateWithdrawalParams {
@@ -1312,28 +1288,24 @@ export interface TransferInitiateWithdrawalParams {
1312
1288
  'Idempotency-Key': string;
1313
1289
 
1314
1290
  /**
1315
- * Body param: Currency code
1291
+ * Header param: Agent ID (agt_xxx) used for attribution and audit.
1316
1292
  */
1317
- currency?: string;
1293
+ 'X-Agent-ID': string;
1318
1294
 
1319
1295
  /**
1320
- * Body param: Withdrawal description
1296
+ * Header param: Stable run, session, or conversation ID for agent observability.
1321
1297
  */
1322
- description?: string;
1298
+ 'X-Instance-ID': string;
1323
1299
 
1324
1300
  /**
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.
1301
+ * Body param: Currency code
1328
1302
  */
1329
- 'X-Agent-ID'?: string;
1303
+ currency?: string;
1330
1304
 
1331
1305
  /**
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.
1306
+ * Body param: Withdrawal description
1335
1307
  */
1336
- 'X-Instance-ID'?: string;
1308
+ description?: string;
1337
1309
  }
1338
1310
 
1339
1311
  export declare namespace Transfers {
@@ -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.14.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.14.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.14.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.14.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.14.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map