@onkernel/sdk 0.100.0 → 0.101.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 +16 -0
  2. package/client.d.mts +3 -0
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +3 -0
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -0
  9. package/client.mjs.map +1 -1
  10. package/lib/browser-routing.d.mts.map +1 -1
  11. package/lib/browser-routing.d.ts.map +1 -1
  12. package/lib/browser-routing.js +23 -6
  13. package/lib/browser-routing.js.map +1 -1
  14. package/lib/browser-routing.mjs +23 -6
  15. package/lib/browser-routing.mjs.map +1 -1
  16. package/package.json +1 -1
  17. package/resources/browsers/telemetry.d.mts +4 -3
  18. package/resources/browsers/telemetry.d.mts.map +1 -1
  19. package/resources/browsers/telemetry.d.ts +4 -3
  20. package/resources/browsers/telemetry.d.ts.map +1 -1
  21. package/resources/config-registry/config-registry.d.mts +14 -7
  22. package/resources/config-registry/config-registry.d.mts.map +1 -1
  23. package/resources/config-registry/config-registry.d.ts +14 -7
  24. package/resources/config-registry/config-registry.d.ts.map +1 -1
  25. package/resources/config-registry/config-registry.js.map +1 -1
  26. package/resources/config-registry/config-registry.mjs.map +1 -1
  27. package/resources/index.d.mts +1 -0
  28. package/resources/index.d.mts.map +1 -1
  29. package/resources/index.d.ts +1 -0
  30. package/resources/index.d.ts.map +1 -1
  31. package/resources/index.js +3 -1
  32. package/resources/index.js.map +1 -1
  33. package/resources/index.mjs +1 -0
  34. package/resources/index.mjs.map +1 -1
  35. package/resources/invocations.d.mts +44 -15
  36. package/resources/invocations.d.mts.map +1 -1
  37. package/resources/invocations.d.ts +44 -15
  38. package/resources/invocations.d.ts.map +1 -1
  39. package/resources/organization/entitlements.d.mts +20 -0
  40. package/resources/organization/entitlements.d.mts.map +1 -1
  41. package/resources/organization/entitlements.d.ts +20 -0
  42. package/resources/organization/entitlements.d.ts.map +1 -1
  43. package/resources/organization/limits.d.mts +10 -1
  44. package/resources/organization/limits.d.mts.map +1 -1
  45. package/resources/organization/limits.d.ts +10 -1
  46. package/resources/organization/limits.d.ts.map +1 -1
  47. package/resources/organization/limits.js +1 -1
  48. package/resources/organization/limits.mjs +1 -1
  49. package/resources/proxies.d.mts +36 -18
  50. package/resources/proxies.d.mts.map +1 -1
  51. package/resources/proxies.d.ts +36 -18
  52. package/resources/proxies.d.ts.map +1 -1
  53. package/resources/vault-provider-configs.d.mts +179 -0
  54. package/resources/vault-provider-configs.d.mts.map +1 -0
  55. package/resources/vault-provider-configs.d.ts +179 -0
  56. package/resources/vault-provider-configs.d.ts.map +1 -0
  57. package/resources/vault-provider-configs.js +99 -0
  58. package/resources/vault-provider-configs.js.map +1 -0
  59. package/resources/vault-provider-configs.mjs +95 -0
  60. package/resources/vault-provider-configs.mjs.map +1 -0
  61. package/resources/vaults/items.d.mts +285 -22
  62. package/resources/vaults/items.d.mts.map +1 -1
  63. package/resources/vaults/items.d.ts +285 -22
  64. package/resources/vaults/items.d.ts.map +1 -1
  65. package/resources/vaults/items.js +85 -5
  66. package/resources/vaults/items.js.map +1 -1
  67. package/resources/vaults/items.mjs +85 -5
  68. package/resources/vaults/items.mjs.map +1 -1
  69. package/resources/vaults/vaults.d.mts +31 -2
  70. package/resources/vaults/vaults.d.mts.map +1 -1
  71. package/resources/vaults/vaults.d.ts +31 -2
  72. package/resources/vaults/vaults.d.ts.map +1 -1
  73. package/resources/vaults/vaults.js +31 -2
  74. package/resources/vaults/vaults.js.map +1 -1
  75. package/resources/vaults/vaults.mjs +31 -2
  76. package/resources/vaults/vaults.mjs.map +1 -1
  77. package/src/client.ts +19 -0
  78. package/src/lib/browser-routing.ts +27 -6
  79. package/src/resources/browsers/telemetry.ts +5 -2
  80. package/src/resources/config-registry/config-registry.ts +15 -7
  81. package/src/resources/index.ts +8 -0
  82. package/src/resources/invocations.ts +44 -15
  83. package/src/resources/organization/entitlements.ts +23 -0
  84. package/src/resources/organization/limits.ts +12 -1
  85. package/src/resources/proxies.ts +36 -18
  86. package/src/resources/vault-provider-configs.ts +250 -0
  87. package/src/resources/vaults/items.ts +322 -22
  88. package/src/resources/vaults/vaults.ts +31 -2
  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
@@ -9,13 +9,44 @@ export class Items extends APIResource {
9
9
  * description before using it. Expanded data is fetched from the provider and is
10
10
  * not persisted in the vault item. Requesting an unavailable expansion returns 409
11
11
  * instead of a partial item.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const vaultItem = await client.vaults.items.retrieve('x', {
16
+ * id_or_name: 'id_or_name',
17
+ * });
18
+ * ```
12
19
  */
13
20
  retrieve(key, params, options) {
14
21
  const { id_or_name, ...query } = params;
15
22
  return this._client.get(path `/vaults/${id_or_name}/items/${key}`, { query, ...options });
16
23
  }
17
24
  /**
18
- * Update a card specification before or between authorizations
25
+ * Requested cards accept a replacement specification. Pending issuance requests
26
+ * may update provider-supported fields on their existing request, subject to
27
+ * atomic provider approval checks; omitted optional fields remain unchanged and
28
+ * explicit empty lists clear them. Wallet/provider binding and unsupported fields
29
+ * cannot change after authorization starts. An uncertain update enters
30
+ * recovery_required and must not be retried. Checkout cards may be edited between
31
+ * authorizations.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const vaultItem = await client.vaults.items.update('x', {
36
+ * id_or_name: 'id_or_name',
37
+ * spec: {
38
+ * provider: 'link',
39
+ * wallet: 'link-wallet',
40
+ * payment_method_id: 'pm_example',
41
+ * amount: 3000,
42
+ * currency: 'usd',
43
+ * merchant_name: 'Example Store',
44
+ * merchant_url: 'https://store.example.com',
45
+ * context:
46
+ * 'The order total changed to USD 30.00 including shipping and taxes for one notebook. Update this unapproved request rather than creating a second payment.',
47
+ * },
48
+ * });
49
+ * ```
19
50
  */
20
51
  update(key, params, options) {
21
52
  const { id_or_name, ...body } = params;
@@ -23,12 +54,28 @@ export class Items extends APIResource {
23
54
  }
24
55
  /**
25
56
  * List vault items without secret values
57
+ *
58
+ * @example
59
+ * ```ts
60
+ * const vaultItems = await client.vaults.items.list(
61
+ * 'id_or_name',
62
+ * );
63
+ * ```
26
64
  */
27
65
  list(idOrName, options) {
28
66
  return this._client.get(path `/vaults/${idOrName}/items`, options);
29
67
  }
30
68
  /**
31
- * Delete a vault item and invalidate its secret value
69
+ * Unresolved payment operations block deletion, including operations on child
70
+ * cards of a wallet. Reconcile the original attempt with the provider or support
71
+ * first; deleting or recreating an item is not proof that a payment did not occur.
72
+ *
73
+ * @example
74
+ * ```ts
75
+ * await client.vaults.items.delete('x', {
76
+ * id_or_name: 'id_or_name',
77
+ * });
78
+ * ```
32
79
  */
33
80
  delete(key, params, options) {
34
81
  const { id_or_name } = params;
@@ -39,6 +86,14 @@ export class Items extends APIResource {
39
86
  }
40
87
  /**
41
88
  * List immutable audit events for a vault item
89
+ *
90
+ * @example
91
+ * ```ts
92
+ * const vaultItemEvents = await client.vaults.items.events(
93
+ * 'key',
94
+ * { id_or_name: 'id_or_name' },
95
+ * );
96
+ * ```
42
97
  */
43
98
  events(key, params, options) {
44
99
  const { id_or_name, ...query } = params;
@@ -47,16 +102,41 @@ export class Items extends APIResource {
47
102
  /**
48
103
  * Retrieve the item first and invoke only an operation listed in
49
104
  * `available_operations`, following its natural-language description. Operations
50
- * may call an external provider and can return the item's updated state. If the
51
- * provider rate limits spend-request creation, returns HTTP 429 with code
105
+ * may call an external provider and return updated state. Link cards advertise
106
+ * authorize. AgentCard cards are created with PUT and request approval when their
107
+ * aliases are used at checkout; they do not expose this operation. If
108
+ * spend-request creation is rate limited, returns HTTP 429 with code
52
109
  * `spend_request_rate_limited`; stop and back off before retrying.
110
+ *
111
+ * @example
112
+ * ```ts
113
+ * const vaultItem =
114
+ * await client.vaults.items.performOperation('key', {
115
+ * id_or_name: 'id_or_name',
116
+ * type: 'authorize',
117
+ * });
118
+ * ```
53
119
  */
54
120
  performOperation(key, params, options) {
55
121
  const { id_or_name, ...body } = params;
56
122
  return this._client.post(path `/vaults/${id_or_name}/items/${key}/operations`, { body, ...options });
57
123
  }
58
124
  /**
59
- * Create or retrieve an identical vault item by immutable key
125
+ * Create an item under a key unique within its vault, or retrieve the existing
126
+ * item when its specification matches. An identical card PUT returns the existing
127
+ * card in any lifecycle state without polling the provider, reauthorizing,
128
+ * replacing aliases, or resetting recovery. Conflicting specifications return 409.
129
+ * Provider-specific authorization requirements and retry behavior are described in
130
+ * the item's request schema.
131
+ *
132
+ * @example
133
+ * ```ts
134
+ * const vaultItem = await client.vaults.items.upsert('x', {
135
+ * id_or_name: 'id_or_name',
136
+ * spec: { provider: 'link' },
137
+ * type: 'card',
138
+ * });
139
+ * ```
60
140
  */
61
141
  upsert(key, params, options) {
62
142
  const { id_or_name, ...body } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../src/resources/vaults/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,GAAW,EAAE,MAA0B,EAAE,OAAwB;QACxE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,QAAgB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,QAAQ,QAAQ,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,GAAW,EACX,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}
1
+ {"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../src/resources/vaults/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,GAAW,EAAE,MAA0B,EAAE,OAAwB;QACxE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,QAAgB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,QAAQ,QAAQ,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACd,GAAW,EACX,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,GAAW,EAAE,MAAwB,EAAE,OAAwB;QACpE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,UAAU,UAAU,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}
@@ -8,18 +8,47 @@ export declare class Vaults extends APIResource {
8
8
  items: ItemsAPI.Items;
9
9
  /**
10
10
  * Get a vault
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const vault = await client.vaults.retrieve('id_or_name');
15
+ * ```
11
16
  */
12
17
  retrieve(idOrName: string, options?: RequestOptions): APIPromise<Vault>;
13
18
  /**
14
19
  * List vaults in the current project
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * // Automatically fetches more pages as needed.
24
+ * for await (const vault of client.vaults.list()) {
25
+ * // ...
26
+ * }
27
+ * ```
15
28
  */
16
29
  list(query?: VaultListParams | null | undefined, options?: RequestOptions): PagePromise<VaultsOffsetPagination, Vault>;
17
30
  /**
18
- * Delete a vault and invalidate its items
31
+ * Unresolved payment operations block deletion. Reconcile the original attempt
32
+ * with the provider or support first; deleting or recreating an item is not proof
33
+ * that a payment did not occur.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * await client.vaults.delete('id_or_name');
38
+ * ```
19
39
  */
20
40
  delete(idOrName: string, options?: RequestOptions): APIPromise<void>;
21
41
  /**
22
- * Create or retrieve a vault by immutable name
42
+ * Free organizations can store up to 3 non-deleted vaults across all projects.
43
+ * Paid plans and active trials have no vault cap. Retrieving an existing vault by
44
+ * name succeeds even at the limit.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * const vault = await client.vaults.upsert({
49
+ * name: 'checkout',
50
+ * });
51
+ * ```
23
52
  */
24
53
  upsert(body: VaultUpsertParams, options?: RequestOptions): APIPromise<Vault>;
25
54
  }
@@ -1 +1 @@
1
- {"version":3,"file":"vaults.d.mts","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EACL,8BAA8B,EAC9B,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACrB,oBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,kCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIvE;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC;IAI7C;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAG7E;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE7D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;CAAG;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"vaults.d.mts","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EACL,8BAA8B,EAC9B,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACrB,oBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,kCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIvE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC;IAI7C;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAG7E;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE7D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;CAAG;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -8,18 +8,47 @@ export declare class Vaults extends APIResource {
8
8
  items: ItemsAPI.Items;
9
9
  /**
10
10
  * Get a vault
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const vault = await client.vaults.retrieve('id_or_name');
15
+ * ```
11
16
  */
12
17
  retrieve(idOrName: string, options?: RequestOptions): APIPromise<Vault>;
13
18
  /**
14
19
  * List vaults in the current project
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * // Automatically fetches more pages as needed.
24
+ * for await (const vault of client.vaults.list()) {
25
+ * // ...
26
+ * }
27
+ * ```
15
28
  */
16
29
  list(query?: VaultListParams | null | undefined, options?: RequestOptions): PagePromise<VaultsOffsetPagination, Vault>;
17
30
  /**
18
- * Delete a vault and invalidate its items
31
+ * Unresolved payment operations block deletion. Reconcile the original attempt
32
+ * with the provider or support first; deleting or recreating an item is not proof
33
+ * that a payment did not occur.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * await client.vaults.delete('id_or_name');
38
+ * ```
19
39
  */
20
40
  delete(idOrName: string, options?: RequestOptions): APIPromise<void>;
21
41
  /**
22
- * Create or retrieve a vault by immutable name
42
+ * Free organizations can store up to 3 non-deleted vaults across all projects.
43
+ * Paid plans and active trials have no vault cap. Retrieving an existing vault by
44
+ * name succeeds even at the limit.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * const vault = await client.vaults.upsert({
49
+ * name: 'checkout',
50
+ * });
51
+ * ```
23
52
  */
24
53
  upsert(body: VaultUpsertParams, options?: RequestOptions): APIPromise<Vault>;
25
54
  }
@@ -1 +1 @@
1
- {"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,8BAA8B,EAC9B,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACrB,mBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,iCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIvE;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC;IAI7C;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAG7E;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE7D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;CAAG;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,8BAA8B,EAC9B,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACrB,mBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,iCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIvE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC;IAI7C;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAG7E;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE7D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;CAAG;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -16,18 +16,38 @@ class Vaults extends resource_1.APIResource {
16
16
  }
17
17
  /**
18
18
  * Get a vault
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const vault = await client.vaults.retrieve('id_or_name');
23
+ * ```
19
24
  */
20
25
  retrieve(idOrName, options) {
21
26
  return this._client.get((0, path_1.path) `/vaults/${idOrName}`, options);
22
27
  }
23
28
  /**
24
29
  * List vaults in the current project
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * // Automatically fetches more pages as needed.
34
+ * for await (const vault of client.vaults.list()) {
35
+ * // ...
36
+ * }
37
+ * ```
25
38
  */
26
39
  list(query = {}, options) {
27
40
  return this._client.getAPIList('/vaults', (pagination_1.OffsetPagination), { query, ...options });
28
41
  }
29
42
  /**
30
- * Delete a vault and invalidate its items
43
+ * Unresolved payment operations block deletion. Reconcile the original attempt
44
+ * with the provider or support first; deleting or recreating an item is not proof
45
+ * that a payment did not occur.
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * await client.vaults.delete('id_or_name');
50
+ * ```
31
51
  */
32
52
  delete(idOrName, options) {
33
53
  return this._client.delete((0, path_1.path) `/vaults/${idOrName}`, {
@@ -36,7 +56,16 @@ class Vaults extends resource_1.APIResource {
36
56
  });
37
57
  }
38
58
  /**
39
- * Create or retrieve a vault by immutable name
59
+ * Free organizations can store up to 3 non-deleted vaults across all projects.
60
+ * Paid plans and active trials have no vault cap. Retrieving an existing vault by
61
+ * name succeeds even at the limit.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const vault = await client.vaults.upsert({
66
+ * name: 'checkout',
67
+ * });
68
+ * ```
40
69
  */
41
70
  upsert(body, options) {
42
71
  return this._client.post('/vaults', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"vaults.js","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAoBiB;AAEjB,yDAAmG;AACnG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmC3D,CAAC;IAjCC;;OAEG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,6BAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,EAAE,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AApCD,wBAoCC;AA0BD,MAAM,CAAC,KAAK,GAAG,aAAK,CAAC"}
1
+ {"version":3,"file":"vaults.js","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAoBiB;AAEjB,yDAAmG;AACnG,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgE3D,CAAC;IA9DC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,6BAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,QAAQ,EAAE,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAjED,wBAiEC;AA0BD,MAAM,CAAC,KAAK,GAAG,aAAK,CAAC"}
@@ -12,18 +12,38 @@ export class Vaults extends APIResource {
12
12
  }
13
13
  /**
14
14
  * Get a vault
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const vault = await client.vaults.retrieve('id_or_name');
19
+ * ```
15
20
  */
16
21
  retrieve(idOrName, options) {
17
22
  return this._client.get(path `/vaults/${idOrName}`, options);
18
23
  }
19
24
  /**
20
25
  * List vaults in the current project
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * // Automatically fetches more pages as needed.
30
+ * for await (const vault of client.vaults.list()) {
31
+ * // ...
32
+ * }
33
+ * ```
21
34
  */
22
35
  list(query = {}, options) {
23
36
  return this._client.getAPIList('/vaults', (OffsetPagination), { query, ...options });
24
37
  }
25
38
  /**
26
- * Delete a vault and invalidate its items
39
+ * Unresolved payment operations block deletion. Reconcile the original attempt
40
+ * with the provider or support first; deleting or recreating an item is not proof
41
+ * that a payment did not occur.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * await client.vaults.delete('id_or_name');
46
+ * ```
27
47
  */
28
48
  delete(idOrName, options) {
29
49
  return this._client.delete(path `/vaults/${idOrName}`, {
@@ -32,7 +52,16 @@ export class Vaults extends APIResource {
32
52
  });
33
53
  }
34
54
  /**
35
- * Create or retrieve a vault by immutable name
55
+ * Free organizations can store up to 3 non-deleted vaults across all projects.
56
+ * Paid plans and active trials have no vault cap. Retrieving an existing vault by
57
+ * name succeeds even at the limit.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * const vault = await client.vaults.upsert({
62
+ * name: 'checkout',
63
+ * });
64
+ * ```
36
65
  */
37
66
  upsert(body, options) {
38
67
  return this._client.post('/vaults', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"vaults.mjs","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAYL,KAAK,GAQN,oBAAgB;AAEjB,OAAO,EAAE,gBAAgB,EAA4C,kCAA8B;AACnG,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmC3D,CAAC;IAjCC;;OAEG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,gBAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,QAAQ,EAAE,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AA0BD,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC"}
1
+ {"version":3,"file":"vaults.mjs","sourceRoot":"","sources":["../../src/resources/vaults/vaults.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAYL,KAAK,GAQN,oBAAgB;AAEjB,OAAO,EAAE,gBAAgB,EAA4C,kCAA8B;AACnG,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgE3D,CAAC;IA9DC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,gBAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,QAAQ,EAAE,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AA0BD,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC"}
package/src/client.ts CHANGED
@@ -136,6 +136,14 @@ import {
136
136
  ProxyUpdateParams,
137
137
  ProxyUpdateResponse,
138
138
  } from './resources/proxies';
139
+ import {
140
+ VaultProviderConfig,
141
+ VaultProviderConfigCreateParams,
142
+ VaultProviderConfigListParams,
143
+ VaultProviderConfigUpdateParams,
144
+ VaultProviderConfigs,
145
+ VaultProviderConfigsOffsetPagination,
146
+ } from './resources/vault-provider-configs';
139
147
  import {
140
148
  AuditLogEntriesPageTokenPagination,
141
149
  AuditLogEntry,
@@ -1067,6 +1075,7 @@ export class Kernel {
1067
1075
  * Create and manage browser pools for acquiring and releasing browsers.
1068
1076
  */
1069
1077
  browserPools: API.BrowserPools = new API.BrowserPools(this);
1078
+ vaultProviderConfigs: API.VaultProviderConfigs = new API.VaultProviderConfigs(this);
1070
1079
  vaults: API.Vaults = new API.Vaults(this);
1071
1080
  /**
1072
1081
  * Create and manage credentials for authentication.
@@ -1105,6 +1114,7 @@ Kernel.Telemetry = Telemetry;
1105
1114
  Kernel.Proxies = Proxies;
1106
1115
  Kernel.Extensions = Extensions;
1107
1116
  Kernel.BrowserPools = BrowserPools;
1117
+ Kernel.VaultProviderConfigs = VaultProviderConfigs;
1108
1118
  Kernel.Vaults = Vaults;
1109
1119
  Kernel.Credentials = Credentials;
1110
1120
  Kernel.Projects = Projects;
@@ -1263,6 +1273,15 @@ export declare namespace Kernel {
1263
1273
  type BrowserPoolReleaseParams as BrowserPoolReleaseParams,
1264
1274
  };
1265
1275
 
1276
+ export {
1277
+ VaultProviderConfigs as VaultProviderConfigs,
1278
+ type VaultProviderConfig as VaultProviderConfig,
1279
+ type VaultProviderConfigsOffsetPagination as VaultProviderConfigsOffsetPagination,
1280
+ type VaultProviderConfigCreateParams as VaultProviderConfigCreateParams,
1281
+ type VaultProviderConfigUpdateParams as VaultProviderConfigUpdateParams,
1282
+ type VaultProviderConfigListParams as VaultProviderConfigListParams,
1283
+ };
1284
+
1266
1285
  export {
1267
1286
  Vaults as Vaults,
1268
1287
  type Vault as Vault,
@@ -47,6 +47,8 @@ const DEFAULT_BROWSER_ROUTING_SUBRESOURCES = [
47
47
  'computer',
48
48
  'playwright',
49
49
  'process',
50
+ 'fs',
51
+ 'logs/stream',
50
52
  ];
51
53
  const BROWSER_ROUTE_CACHEABLE_PATH = /^\/(?:v\d+\/)?browsers(?:\/[^/]+)?\/?$/;
52
54
  const BROWSER_POOL_ACQUIRE_PATH = /^\/(?:v\d+\/)?browser_pools\/[^/]+\/acquire\/?$/;
@@ -278,9 +280,13 @@ async function routeRequest(
278
280
 
279
281
  const headers = new Headers(request.headers);
280
282
  headers.delete('authorization');
283
+ const body = requestBodyForFetch(request, init);
281
284
  const routed = await innerFetch(target.toString(), buildRoutedInit(input, request, init, headers));
282
285
  if ((routed.status === 401 || routed.status === 403) && target.searchParams.get('jwt')) {
283
286
  cache.deleteIfJwt(sessionId, target.searchParams.get('jwt') ?? '');
287
+ if (isStreamingBody(body)) {
288
+ return routed;
289
+ }
284
290
  await CancelReadableStream(routed.body);
285
291
  return innerFetch(input, init);
286
292
  }
@@ -294,6 +300,14 @@ function buildRoutedInit(
294
300
  headers: Headers,
295
301
  ): RequestInit {
296
302
  const method = request.method.toUpperCase();
303
+ const body = method === 'GET' || method === 'HEAD' ? undefined : requestBodyForFetch(request, originalInit);
304
+ if (derivesOwnContentType(body) && !new Headers(originalInit?.headers).get('content-type')) {
305
+ // `request` was constructed from the same body, so its content-type carries
306
+ // that construction's multipart boundary. The routed fetch re-encodes the
307
+ // body with a new boundary, so let it derive the header again.
308
+ headers.delete('content-type');
309
+ }
310
+
297
311
  const routedInit = {
298
312
  ...((originalInit ?? {}) as Record<string, unknown>),
299
313
  method,
@@ -305,14 +319,13 @@ function buildRoutedInit(
305
319
  delete routedInit['body'];
306
320
  delete routedInit['duplex'];
307
321
 
322
+ if (body !== undefined) {
323
+ routedInit.body = body;
324
+ }
308
325
  if (method !== 'GET' && method !== 'HEAD') {
309
- const body = requestBodyForFetch(request, originalInit);
310
- if (body !== undefined) {
311
- routedInit.body = body;
312
- }
313
326
  if (originalInit?.duplex !== undefined) {
314
327
  routedInit.duplex = originalInit.duplex;
315
- } else if (requiresHalfDuplex(body)) {
328
+ } else if (isStreamingBody(body)) {
316
329
  routedInit.duplex = 'half';
317
330
  }
318
331
  }
@@ -331,7 +344,15 @@ function requestBodyForFetch(
331
344
  return request.body ?? undefined;
332
345
  }
333
346
 
334
- function requiresHalfDuplex(body: RequestInit['body'] | undefined): boolean {
347
+ function derivesOwnContentType(body: RequestInit['body'] | undefined): boolean {
348
+ return (
349
+ ((globalThis as any).FormData && body instanceof (globalThis as any).FormData) ||
350
+ ((globalThis as any).URLSearchParams && body instanceof (globalThis as any).URLSearchParams) ||
351
+ ((globalThis as any).Blob && body instanceof (globalThis as any).Blob)
352
+ );
353
+ }
354
+
355
+ function isStreamingBody(body: RequestInit['body'] | undefined): boolean {
335
356
  return (
336
357
  ((globalThis as any).ReadableStream && body instanceof (globalThis as any).ReadableStream) ||
337
358
  (typeof body === 'object' && body !== null && Symbol.asyncIterator in body)
@@ -4338,13 +4338,16 @@ export namespace BrowserProxyErrorEvent {
4338
4338
  * Proxy-layer error code: the X-Kernel-Proxy-Error response header value from a
4339
4339
  * branded 5xx error page served by the metro egress host-proxy. Values mirror what
4340
4340
  * the proxy emits: destination_blocked, provider_blacklisted,
4341
- * provider_unreachable, proxy_unavailable, upstream_timeout, upstream_dns_failure,
4342
- * upstream_connect_failed. Unknown header values are dropped.
4341
+ * provider_unreachable, provider_rejected, origin_tls_timeout, proxy_unavailable,
4342
+ * upstream_timeout, upstream_dns_failure, upstream_connect_failed. Unknown header
4343
+ * values are dropped.
4343
4344
  */
4344
4345
  code:
4345
4346
  | 'destination_blocked'
4346
4347
  | 'provider_blacklisted'
4347
4348
  | 'provider_unreachable'
4349
+ | 'provider_rejected'
4350
+ | 'origin_tls_timeout'
4348
4351
  | 'proxy_unavailable'
4349
4352
  | 'upstream_timeout'
4350
4353
  | 'upstream_dns_failure'
@@ -85,8 +85,13 @@ export interface Analysis {
85
85
  created_at: string;
86
86
 
87
87
  /**
88
- * Present for failed or canceled analyses. Messages contain safe retry guidance
89
- * rather than internal workflow errors.
88
+ * Deadline after which a still-running analysis becomes expired.
89
+ */
90
+ expires_at: string;
91
+
92
+ /**
93
+ * Present for failed, canceled, or expired analyses. Messages contain safe retry
94
+ * guidance rather than internal workflow errors.
90
95
  */
91
96
  failure: Shared.ErrorModel | null;
92
97
 
@@ -98,7 +103,7 @@ export interface Analysis {
98
103
  /**
99
104
  * Lifecycle status of a background analysis.
100
105
  */
101
- status: 'running' | 'completed' | 'failed' | 'canceled';
106
+ status: 'running' | 'completed' | 'failed' | 'canceled' | 'expired';
102
107
  }
103
108
 
104
109
  export interface AnalysisSummary {
@@ -295,7 +300,8 @@ export namespace Proxy {
295
300
  */
296
301
  export interface IspProxyConfig {
297
302
  /**
298
- * ISO 3166 country code. Defaults to US if not provided.
303
+ * ISO 3166 country code. Supported countries are US, GB, FR, DE, and SG. Defaults
304
+ * to US if not provided.
299
305
  */
300
306
  country?: string;
301
307
  }
@@ -316,7 +322,8 @@ export namespace Proxy {
316
322
  city?: string;
317
323
 
318
324
  /**
319
- * ISO 3166 country code.
325
+ * ISO 3166 country code. If omitted, the proxy uses the global pool without
326
+ * country targeting.
320
327
  */
321
328
  country?: string;
322
329
 
@@ -346,7 +353,8 @@ export namespace Proxy {
346
353
  city?: string;
347
354
 
348
355
  /**
349
- * ISO 3166 country code
356
+ * ISO 3166 country code. If omitted, the proxy uses the global pool without
357
+ * country targeting.
350
358
  */
351
359
  country?: string;
352
360
 
@@ -438,7 +446,7 @@ export interface RecommendationSummary {
438
446
  /**
439
447
  * Lifecycle status of the most recently requested analysis for this exact target.
440
448
  */
441
- analysis_status: 'running' | 'completed' | 'failed' | 'canceled';
449
+ analysis_status: 'running' | 'completed' | 'failed' | 'canceled' | 'expired';
442
450
 
443
451
  /**
444
452
  * Most recent time the selected project requested an analysis for this exact
@@ -180,6 +180,14 @@ export {
180
180
  type ProxyListResponsesOffsetPagination,
181
181
  } from './proxies';
182
182
  export { Telemetry } from './telemetry/telemetry';
183
+ export {
184
+ VaultProviderConfigs,
185
+ type VaultProviderConfig,
186
+ type VaultProviderConfigCreateParams,
187
+ type VaultProviderConfigUpdateParams,
188
+ type VaultProviderConfigListParams,
189
+ type VaultProviderConfigsOffsetPagination,
190
+ } from './vault-provider-configs';
183
191
  export {
184
192
  Vaults,
185
193
  type Vault,