@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.21

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 (517) hide show
  1. package/CHANGELOG.md +170 -0
  2. package/api-promise.d.mts +1 -0
  3. package/api-promise.d.mts.map +1 -1
  4. package/api-promise.d.ts +1 -0
  5. package/api-promise.d.ts.map +1 -1
  6. package/api-promise.mjs +1 -0
  7. package/api-promise.mjs.map +1 -1
  8. package/client.d.mts.map +1 -1
  9. package/client.d.ts.map +1 -1
  10. package/client.mjs.map +1 -1
  11. package/core/api-promise.d.mts.map +1 -1
  12. package/core/api-promise.d.ts.map +1 -1
  13. package/core/api-promise.mjs.map +1 -1
  14. package/core/error.mjs.map +1 -1
  15. package/core/pagination.d.mts.map +1 -1
  16. package/core/pagination.d.ts.map +1 -1
  17. package/core/pagination.mjs.map +1 -1
  18. package/core/resource.d.mts.map +1 -1
  19. package/core/resource.d.ts.map +1 -1
  20. package/core/uploads.d.mts.map +1 -1
  21. package/core/uploads.d.ts.map +1 -1
  22. package/core/uploads.mjs.map +1 -1
  23. package/error.d.mts +1 -0
  24. package/error.d.mts.map +1 -1
  25. package/error.d.ts +1 -0
  26. package/error.d.ts.map +1 -1
  27. package/error.mjs +1 -0
  28. package/error.mjs.map +1 -1
  29. package/index.d.mts.map +1 -1
  30. package/index.d.ts.map +1 -1
  31. package/index.mjs.map +1 -1
  32. package/internal/detect-platform.mjs.map +1 -1
  33. package/internal/headers.mjs.map +1 -1
  34. package/internal/parse.d.mts.map +1 -1
  35. package/internal/parse.d.ts.map +1 -1
  36. package/internal/parse.mjs.map +1 -1
  37. package/internal/qs/formats.d.mts.map +1 -1
  38. package/internal/qs/formats.d.ts.map +1 -1
  39. package/internal/qs/index.d.mts +2 -2
  40. package/internal/qs/index.d.mts.map +1 -1
  41. package/internal/qs/index.d.ts +2 -2
  42. package/internal/qs/index.d.ts.map +1 -1
  43. package/internal/qs/index.mjs.map +1 -1
  44. package/internal/qs/stringify.d.mts.map +1 -1
  45. package/internal/qs/stringify.d.ts.map +1 -1
  46. package/internal/qs/stringify.mjs.map +1 -1
  47. package/internal/qs/utils.d.mts.map +1 -1
  48. package/internal/qs/utils.d.ts.map +1 -1
  49. package/internal/qs/utils.mjs.map +1 -1
  50. package/internal/request-options.d.mts.map +1 -1
  51. package/internal/request-options.d.ts.map +1 -1
  52. package/internal/shims.d.mts +6 -0
  53. package/internal/shims.d.mts.map +1 -1
  54. package/internal/shims.d.ts +6 -0
  55. package/internal/shims.d.ts.map +1 -1
  56. package/internal/to-file.d.mts.map +1 -1
  57. package/internal/to-file.d.ts.map +1 -1
  58. package/internal/to-file.mjs.map +1 -1
  59. package/internal/types.d.mts +4 -4
  60. package/internal/types.d.mts.map +1 -1
  61. package/internal/types.d.ts +4 -4
  62. package/internal/types.d.ts.map +1 -1
  63. package/internal/uploads.d.mts.map +1 -1
  64. package/internal/uploads.d.ts.map +1 -1
  65. package/internal/uploads.mjs.map +1 -1
  66. package/internal/utils/base64.mjs.map +1 -1
  67. package/internal/utils/log.d.mts.map +1 -1
  68. package/internal/utils/log.d.ts.map +1 -1
  69. package/internal/utils/log.mjs.map +1 -1
  70. package/internal/utils/path.mjs.map +1 -1
  71. package/internal/utils/query.mjs.map +1 -1
  72. package/internal/utils/values.mjs.map +1 -1
  73. package/internal/utils.d.mts.map +1 -1
  74. package/internal/utils.d.ts.map +1 -1
  75. package/internal/utils.mjs.map +1 -1
  76. package/package.json +1 -1
  77. package/pagination.d.mts +1 -0
  78. package/pagination.d.mts.map +1 -1
  79. package/pagination.d.ts +1 -0
  80. package/pagination.d.ts.map +1 -1
  81. package/pagination.mjs +1 -0
  82. package/pagination.mjs.map +1 -1
  83. package/resource.d.mts +1 -0
  84. package/resource.d.mts.map +1 -1
  85. package/resource.d.ts +1 -0
  86. package/resource.d.ts.map +1 -1
  87. package/resource.mjs +1 -0
  88. package/resource.mjs.map +1 -1
  89. package/resources/index.d.mts.map +1 -1
  90. package/resources/index.d.ts.map +1 -1
  91. package/resources/index.mjs.map +1 -1
  92. package/resources/v1/addons/addons.d.mts +372 -32
  93. package/resources/v1/addons/addons.d.mts.map +1 -1
  94. package/resources/v1/addons/addons.d.ts +372 -32
  95. package/resources/v1/addons/addons.d.ts.map +1 -1
  96. package/resources/v1/addons/addons.js +173 -15
  97. package/resources/v1/addons/addons.js.map +1 -1
  98. package/resources/v1/addons/addons.mjs +173 -15
  99. package/resources/v1/addons/addons.mjs.map +1 -1
  100. package/resources/v1/addons/entitlements.d.mts +93 -5
  101. package/resources/v1/addons/entitlements.d.mts.map +1 -1
  102. package/resources/v1/addons/entitlements.d.ts +93 -5
  103. package/resources/v1/addons/entitlements.d.ts.map +1 -1
  104. package/resources/v1/addons/entitlements.js +80 -8
  105. package/resources/v1/addons/entitlements.js.map +1 -1
  106. package/resources/v1/addons/entitlements.mjs +80 -8
  107. package/resources/v1/addons/entitlements.mjs.map +1 -1
  108. package/resources/v1/addons/index.d.mts +2 -2
  109. package/resources/v1/addons/index.d.mts.map +1 -1
  110. package/resources/v1/addons/index.d.ts +2 -2
  111. package/resources/v1/addons/index.d.ts.map +1 -1
  112. package/resources/v1/addons/index.js.map +1 -1
  113. package/resources/v1/addons/index.mjs.map +1 -1
  114. package/resources/v1/addons.d.mts.map +1 -1
  115. package/resources/v1/addons.d.ts.map +1 -1
  116. package/resources/v1/addons.mjs.map +1 -1
  117. package/resources/v1/coupons.d.mts +117 -21
  118. package/resources/v1/coupons.d.mts.map +1 -1
  119. package/resources/v1/coupons.d.ts +117 -21
  120. package/resources/v1/coupons.d.ts.map +1 -1
  121. package/resources/v1/coupons.js +96 -9
  122. package/resources/v1/coupons.js.map +1 -1
  123. package/resources/v1/coupons.mjs +96 -9
  124. package/resources/v1/coupons.mjs.map +1 -1
  125. package/resources/v1/credits/credits.d.mts +212 -27
  126. package/resources/v1/credits/credits.d.mts.map +1 -1
  127. package/resources/v1/credits/credits.d.ts +212 -27
  128. package/resources/v1/credits/credits.d.ts.map +1 -1
  129. package/resources/v1/credits/credits.js +66 -7
  130. package/resources/v1/credits/credits.js.map +1 -1
  131. package/resources/v1/credits/credits.mjs +66 -7
  132. package/resources/v1/credits/credits.mjs.map +1 -1
  133. package/resources/v1/credits/custom-currencies.d.mts +150 -28
  134. package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
  135. package/resources/v1/credits/custom-currencies.d.ts +150 -28
  136. package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
  137. package/resources/v1/credits/custom-currencies.js +125 -12
  138. package/resources/v1/credits/custom-currencies.js.map +1 -1
  139. package/resources/v1/credits/custom-currencies.mjs +125 -12
  140. package/resources/v1/credits/custom-currencies.mjs.map +1 -1
  141. package/resources/v1/credits/grants.d.mts +91 -26
  142. package/resources/v1/credits/grants.d.mts.map +1 -1
  143. package/resources/v1/credits/grants.d.ts +91 -26
  144. package/resources/v1/credits/grants.d.ts.map +1 -1
  145. package/resources/v1/credits/grants.js +63 -5
  146. package/resources/v1/credits/grants.js.map +1 -1
  147. package/resources/v1/credits/grants.mjs +63 -5
  148. package/resources/v1/credits/grants.mjs.map +1 -1
  149. package/resources/v1/credits/index.d.mts +3 -4
  150. package/resources/v1/credits/index.d.mts.map +1 -1
  151. package/resources/v1/credits/index.d.ts +3 -4
  152. package/resources/v1/credits/index.d.ts.map +1 -1
  153. package/resources/v1/credits/index.js +1 -3
  154. package/resources/v1/credits/index.js.map +1 -1
  155. package/resources/v1/credits/index.mjs +0 -1
  156. package/resources/v1/credits/index.mjs.map +1 -1
  157. package/resources/v1/credits.d.mts.map +1 -1
  158. package/resources/v1/credits.d.ts.map +1 -1
  159. package/resources/v1/credits.mjs.map +1 -1
  160. package/resources/v1/customers/customers.d.mts +249 -55
  161. package/resources/v1/customers/customers.d.mts.map +1 -1
  162. package/resources/v1/customers/customers.d.ts +249 -55
  163. package/resources/v1/customers/customers.d.ts.map +1 -1
  164. package/resources/v1/customers/customers.js +201 -19
  165. package/resources/v1/customers/customers.js.map +1 -1
  166. package/resources/v1/customers/customers.mjs +201 -19
  167. package/resources/v1/customers/customers.mjs.map +1 -1
  168. package/resources/v1/customers/index.d.mts +2 -2
  169. package/resources/v1/customers/index.d.mts.map +1 -1
  170. package/resources/v1/customers/index.d.ts +2 -2
  171. package/resources/v1/customers/index.d.ts.map +1 -1
  172. package/resources/v1/customers/index.js.map +1 -1
  173. package/resources/v1/customers/index.mjs +1 -1
  174. package/resources/v1/customers/index.mjs.map +1 -1
  175. package/resources/v1/customers/integrations.d.mts +116 -14
  176. package/resources/v1/customers/integrations.d.mts.map +1 -1
  177. package/resources/v1/customers/integrations.d.ts +116 -14
  178. package/resources/v1/customers/integrations.d.ts.map +1 -1
  179. package/resources/v1/customers/integrations.js +104 -9
  180. package/resources/v1/customers/integrations.js.map +1 -1
  181. package/resources/v1/customers/integrations.mjs +104 -9
  182. package/resources/v1/customers/integrations.mjs.map +1 -1
  183. package/resources/v1/customers/payment-method.d.mts +48 -8
  184. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  185. package/resources/v1/customers/payment-method.d.ts +48 -8
  186. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  187. package/resources/v1/customers/payment-method.js +42 -4
  188. package/resources/v1/customers/payment-method.js.map +1 -1
  189. package/resources/v1/customers/payment-method.mjs +42 -4
  190. package/resources/v1/customers/payment-method.mjs.map +1 -1
  191. package/resources/v1/customers/promotional-entitlements.d.mts +93 -9
  192. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
  193. package/resources/v1/customers/promotional-entitlements.d.ts +93 -9
  194. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
  195. package/resources/v1/customers/promotional-entitlements.js +89 -6
  196. package/resources/v1/customers/promotional-entitlements.js.map +1 -1
  197. package/resources/v1/customers/promotional-entitlements.mjs +89 -6
  198. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
  199. package/resources/v1/customers.d.mts.map +1 -1
  200. package/resources/v1/customers.d.ts.map +1 -1
  201. package/resources/v1/customers.mjs.map +1 -1
  202. package/resources/v1/events/beta/beta.d.mts +14 -0
  203. package/resources/v1/events/beta/beta.d.mts.map +1 -0
  204. package/resources/v1/events/beta/beta.d.ts +14 -0
  205. package/resources/v1/events/beta/beta.d.ts.map +1 -0
  206. package/resources/v1/events/beta/beta.js +21 -0
  207. package/resources/v1/events/beta/beta.js.map +1 -0
  208. package/resources/v1/events/beta/beta.mjs +16 -0
  209. package/resources/v1/events/beta/beta.mjs.map +1 -0
  210. package/resources/v1/events/beta/customers/assignments.d.mts +200 -0
  211. package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -0
  212. package/resources/v1/events/beta/customers/assignments.d.ts +200 -0
  213. package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -0
  214. package/resources/v1/events/beta/customers/assignments.js +85 -0
  215. package/resources/v1/events/beta/customers/assignments.js.map +1 -0
  216. package/resources/v1/events/beta/customers/assignments.mjs +81 -0
  217. package/resources/v1/events/beta/customers/assignments.mjs.map +1 -0
  218. package/resources/v1/events/beta/customers/customers.d.mts +18 -0
  219. package/resources/v1/events/beta/customers/customers.d.mts.map +1 -0
  220. package/resources/v1/events/beta/customers/customers.d.ts +18 -0
  221. package/resources/v1/events/beta/customers/customers.d.ts.map +1 -0
  222. package/resources/v1/events/beta/customers/customers.js +25 -0
  223. package/resources/v1/events/beta/customers/customers.js.map +1 -0
  224. package/resources/v1/events/beta/customers/customers.mjs +20 -0
  225. package/resources/v1/events/beta/customers/customers.mjs.map +1 -0
  226. package/resources/v1/events/beta/customers/entities.d.mts +360 -0
  227. package/resources/v1/events/beta/customers/entities.d.mts.map +1 -0
  228. package/resources/v1/events/beta/customers/entities.d.ts +360 -0
  229. package/resources/v1/events/beta/customers/entities.d.ts.map +1 -0
  230. package/resources/v1/events/beta/customers/entities.js +159 -0
  231. package/resources/v1/events/beta/customers/entities.js.map +1 -0
  232. package/resources/v1/events/beta/customers/entities.mjs +155 -0
  233. package/resources/v1/events/beta/customers/entities.mjs.map +1 -0
  234. package/resources/v1/events/beta/customers/entitlements.d.mts +251 -0
  235. package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -0
  236. package/resources/v1/events/beta/customers/entitlements.d.ts +251 -0
  237. package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -0
  238. package/resources/v1/events/beta/customers/entitlements.js +38 -0
  239. package/resources/v1/events/beta/customers/entitlements.js.map +1 -0
  240. package/resources/v1/events/beta/customers/entitlements.mjs +34 -0
  241. package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -0
  242. package/resources/v1/events/beta/customers/index.d.mts +5 -0
  243. package/resources/v1/events/beta/customers/index.d.mts.map +1 -0
  244. package/resources/v1/events/beta/customers/index.d.ts +5 -0
  245. package/resources/v1/events/beta/customers/index.d.ts.map +1 -0
  246. package/resources/v1/events/beta/customers/index.js +13 -0
  247. package/resources/v1/events/beta/customers/index.js.map +1 -0
  248. package/resources/v1/events/beta/customers/index.mjs +6 -0
  249. package/resources/v1/events/beta/customers/index.mjs.map +1 -0
  250. package/resources/v1/events/beta/customers.d.mts +2 -0
  251. package/resources/v1/events/beta/customers.d.mts.map +1 -0
  252. package/resources/v1/events/beta/customers.d.ts +2 -0
  253. package/resources/v1/events/beta/customers.d.ts.map +1 -0
  254. package/resources/v1/events/beta/customers.js +6 -0
  255. package/resources/v1/events/beta/customers.js.map +1 -0
  256. package/resources/v1/events/beta/customers.mjs +3 -0
  257. package/resources/v1/events/beta/customers.mjs.map +1 -0
  258. package/resources/v1/events/beta/entity-types.d.mts +166 -0
  259. package/resources/v1/events/beta/entity-types.d.mts.map +1 -0
  260. package/resources/v1/events/beta/entity-types.d.ts +166 -0
  261. package/resources/v1/events/beta/entity-types.d.ts.map +1 -0
  262. package/resources/v1/events/beta/entity-types.js +76 -0
  263. package/resources/v1/events/beta/entity-types.js.map +1 -0
  264. package/resources/v1/events/beta/entity-types.mjs +72 -0
  265. package/resources/v1/events/beta/entity-types.mjs.map +1 -0
  266. package/resources/v1/events/beta/index.d.mts +4 -0
  267. package/resources/v1/events/beta/index.d.mts.map +1 -0
  268. package/resources/v1/events/beta/index.d.ts +4 -0
  269. package/resources/v1/events/beta/index.d.ts.map +1 -0
  270. package/resources/v1/events/beta/index.js +11 -0
  271. package/resources/v1/events/beta/index.js.map +1 -0
  272. package/resources/v1/events/beta/index.mjs +5 -0
  273. package/resources/v1/events/beta/index.mjs.map +1 -0
  274. package/resources/v1/events/beta.d.mts +2 -0
  275. package/resources/v1/events/beta.d.mts.map +1 -0
  276. package/resources/v1/events/beta.d.ts +2 -0
  277. package/resources/v1/events/beta.d.ts.map +1 -0
  278. package/resources/v1/events/beta.js +6 -0
  279. package/resources/v1/events/beta.js.map +1 -0
  280. package/resources/v1/events/beta.mjs +3 -0
  281. package/resources/v1/events/beta.mjs.map +1 -0
  282. package/resources/v1/events/data-export/data-export.d.mts +126 -0
  283. package/resources/v1/events/data-export/data-export.d.mts.map +1 -0
  284. package/resources/v1/events/data-export/data-export.d.ts +126 -0
  285. package/resources/v1/events/data-export/data-export.d.ts.map +1 -0
  286. package/resources/v1/events/data-export/data-export.js +45 -0
  287. package/resources/v1/events/data-export/data-export.js.map +1 -0
  288. package/resources/v1/events/data-export/data-export.mjs +40 -0
  289. package/resources/v1/events/data-export/data-export.mjs.map +1 -0
  290. package/resources/v1/events/data-export/destinations.d.mts +202 -0
  291. package/resources/v1/events/data-export/destinations.d.mts.map +1 -0
  292. package/resources/v1/events/data-export/destinations.d.ts +202 -0
  293. package/resources/v1/events/data-export/destinations.d.ts.map +1 -0
  294. package/resources/v1/events/data-export/destinations.js +41 -0
  295. package/resources/v1/events/data-export/destinations.js.map +1 -0
  296. package/resources/v1/events/data-export/destinations.mjs +37 -0
  297. package/resources/v1/events/data-export/destinations.mjs.map +1 -0
  298. package/resources/v1/events/data-export/index.d.mts +3 -0
  299. package/resources/v1/events/data-export/index.d.mts.map +1 -0
  300. package/resources/v1/events/data-export/index.d.ts +3 -0
  301. package/resources/v1/events/data-export/index.d.ts.map +1 -0
  302. package/resources/v1/events/data-export/index.js +9 -0
  303. package/resources/v1/events/data-export/index.js.map +1 -0
  304. package/resources/v1/events/data-export/index.mjs +4 -0
  305. package/resources/v1/events/data-export/index.mjs.map +1 -0
  306. package/resources/v1/events/data-export.d.mts +2 -0
  307. package/resources/v1/events/data-export.d.mts.map +1 -0
  308. package/resources/v1/events/data-export.d.ts +2 -0
  309. package/resources/v1/events/data-export.d.ts.map +1 -0
  310. package/resources/v1/events/data-export.js +6 -0
  311. package/resources/v1/events/data-export.js.map +1 -0
  312. package/resources/v1/events/data-export.mjs +3 -0
  313. package/resources/v1/events/data-export.mjs.map +1 -0
  314. package/resources/v1/events/events.d.mts +98 -0
  315. package/resources/v1/events/events.d.mts.map +1 -0
  316. package/resources/v1/events/events.d.ts +98 -0
  317. package/resources/v1/events/events.d.ts.map +1 -0
  318. package/resources/v1/events/events.js +56 -0
  319. package/resources/v1/events/events.js.map +1 -0
  320. package/resources/v1/events/events.mjs +51 -0
  321. package/resources/v1/events/events.mjs.map +1 -0
  322. package/resources/v1/events/index.d.mts +4 -0
  323. package/resources/v1/events/index.d.mts.map +1 -0
  324. package/resources/v1/events/index.d.ts +4 -0
  325. package/resources/v1/events/index.d.ts.map +1 -0
  326. package/resources/v1/events/index.js +11 -0
  327. package/resources/v1/events/index.js.map +1 -0
  328. package/resources/v1/events/index.mjs +5 -0
  329. package/resources/v1/events/index.mjs.map +1 -0
  330. package/resources/v1/events.d.mts +1 -65
  331. package/resources/v1/events.d.mts.map +1 -1
  332. package/resources/v1/events.d.ts +1 -65
  333. package/resources/v1/events.d.ts.map +1 -1
  334. package/resources/v1/events.js +2 -15
  335. package/resources/v1/events.js.map +1 -1
  336. package/resources/v1/events.mjs +1 -13
  337. package/resources/v1/events.mjs.map +1 -1
  338. package/resources/v1/features.d.mts +152 -31
  339. package/resources/v1/features.d.mts.map +1 -1
  340. package/resources/v1/features.d.ts +152 -31
  341. package/resources/v1/features.d.ts.map +1 -1
  342. package/resources/v1/features.js +115 -11
  343. package/resources/v1/features.js.map +1 -1
  344. package/resources/v1/features.mjs +115 -11
  345. package/resources/v1/features.mjs.map +1 -1
  346. package/resources/v1/index.d.mts +9 -9
  347. package/resources/v1/index.d.mts.map +1 -1
  348. package/resources/v1/index.d.ts +9 -9
  349. package/resources/v1/index.d.ts.map +1 -1
  350. package/resources/v1/index.js +6 -6
  351. package/resources/v1/index.js.map +1 -1
  352. package/resources/v1/index.mjs +1 -1
  353. package/resources/v1/index.mjs.map +1 -1
  354. package/resources/v1/plans/entitlements.d.mts +93 -5
  355. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  356. package/resources/v1/plans/entitlements.d.ts +93 -5
  357. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  358. package/resources/v1/plans/entitlements.js +80 -8
  359. package/resources/v1/plans/entitlements.js.map +1 -1
  360. package/resources/v1/plans/entitlements.mjs +80 -8
  361. package/resources/v1/plans/entitlements.mjs.map +1 -1
  362. package/resources/v1/plans/index.d.mts +2 -2
  363. package/resources/v1/plans/index.d.mts.map +1 -1
  364. package/resources/v1/plans/index.d.ts +2 -2
  365. package/resources/v1/plans/index.d.ts.map +1 -1
  366. package/resources/v1/plans/index.js.map +1 -1
  367. package/resources/v1/plans/index.mjs.map +1 -1
  368. package/resources/v1/plans/plans.d.mts +565 -32
  369. package/resources/v1/plans/plans.d.mts.map +1 -1
  370. package/resources/v1/plans/plans.d.ts +565 -32
  371. package/resources/v1/plans/plans.d.ts.map +1 -1
  372. package/resources/v1/plans/plans.js +204 -16
  373. package/resources/v1/plans/plans.js.map +1 -1
  374. package/resources/v1/plans/plans.mjs +204 -16
  375. package/resources/v1/plans/plans.mjs.map +1 -1
  376. package/resources/v1/plans.d.mts.map +1 -1
  377. package/resources/v1/plans.d.ts.map +1 -1
  378. package/resources/v1/plans.mjs.map +1 -1
  379. package/resources/v1/products.d.mts +140 -23
  380. package/resources/v1/products.d.mts.map +1 -1
  381. package/resources/v1/products.d.ts +140 -23
  382. package/resources/v1/products.d.ts.map +1 -1
  383. package/resources/v1/products.js +116 -11
  384. package/resources/v1/products.js.map +1 -1
  385. package/resources/v1/products.mjs +116 -11
  386. package/resources/v1/products.mjs.map +1 -1
  387. package/resources/v1/subscriptions/future-update.d.mts +45 -3
  388. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  389. package/resources/v1/subscriptions/future-update.d.ts +45 -3
  390. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  391. package/resources/v1/subscriptions/future-update.js +41 -4
  392. package/resources/v1/subscriptions/future-update.js.map +1 -1
  393. package/resources/v1/subscriptions/future-update.mjs +41 -4
  394. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  395. package/resources/v1/subscriptions/index.d.mts +4 -4
  396. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  397. package/resources/v1/subscriptions/index.d.ts +4 -4
  398. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  399. package/resources/v1/subscriptions/index.js.map +1 -1
  400. package/resources/v1/subscriptions/index.mjs +1 -1
  401. package/resources/v1/subscriptions/index.mjs.map +1 -1
  402. package/resources/v1/subscriptions/invoice.d.mts +21 -2
  403. package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
  404. package/resources/v1/subscriptions/invoice.d.ts +21 -2
  405. package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
  406. package/resources/v1/subscriptions/invoice.js +19 -2
  407. package/resources/v1/subscriptions/invoice.js.map +1 -1
  408. package/resources/v1/subscriptions/invoice.mjs +19 -2
  409. package/resources/v1/subscriptions/invoice.mjs.map +1 -1
  410. package/resources/v1/subscriptions/subscriptions.d.mts +341 -85
  411. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  412. package/resources/v1/subscriptions/subscriptions.d.ts +341 -85
  413. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  414. package/resources/v1/subscriptions/subscriptions.js +207 -19
  415. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  416. package/resources/v1/subscriptions/subscriptions.mjs +209 -21
  417. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  418. package/resources/v1/subscriptions/usage.d.mts +42 -4
  419. package/resources/v1/subscriptions/usage.d.mts.map +1 -1
  420. package/resources/v1/subscriptions/usage.d.ts +42 -4
  421. package/resources/v1/subscriptions/usage.d.ts.map +1 -1
  422. package/resources/v1/subscriptions/usage.js +39 -4
  423. package/resources/v1/subscriptions/usage.js.map +1 -1
  424. package/resources/v1/subscriptions/usage.mjs +39 -4
  425. package/resources/v1/subscriptions/usage.mjs.map +1 -1
  426. package/resources/v1/subscriptions.d.mts.map +1 -1
  427. package/resources/v1/subscriptions.d.ts.map +1 -1
  428. package/resources/v1/subscriptions.mjs.map +1 -1
  429. package/resources/v1/usage.d.mts +48 -2
  430. package/resources/v1/usage.d.mts.map +1 -1
  431. package/resources/v1/usage.d.ts +48 -2
  432. package/resources/v1/usage.d.ts.map +1 -1
  433. package/resources/v1/usage.js +50 -4
  434. package/resources/v1/usage.js.map +1 -1
  435. package/resources/v1/usage.mjs +50 -4
  436. package/resources/v1/usage.mjs.map +1 -1
  437. package/resources/v1/v1.d.mts +18 -18
  438. package/resources/v1/v1.d.mts.map +1 -1
  439. package/resources/v1/v1.d.ts +18 -18
  440. package/resources/v1/v1.d.ts.map +1 -1
  441. package/resources/v1/v1.js +2 -2
  442. package/resources/v1/v1.js.map +1 -1
  443. package/resources/v1/v1.mjs +2 -2
  444. package/resources/v1/v1.mjs.map +1 -1
  445. package/resources/v1.d.mts.map +1 -1
  446. package/resources/v1.d.ts.map +1 -1
  447. package/resources/v1.mjs.map +1 -1
  448. package/resources.d.mts.map +1 -1
  449. package/resources.d.ts.map +1 -1
  450. package/resources.mjs.map +1 -1
  451. package/src/resources/v1/addons/addons.ts +908 -36
  452. package/src/resources/v1/addons/entitlements.ts +154 -10
  453. package/src/resources/v1/addons/index.ts +8 -0
  454. package/src/resources/v1/coupons.ts +194 -27
  455. package/src/resources/v1/credits/credits.ts +287 -35
  456. package/src/resources/v1/credits/custom-currencies.ts +245 -38
  457. package/src/resources/v1/credits/grants.ts +132 -26
  458. package/src/resources/v1/credits/index.ts +7 -6
  459. package/src/resources/v1/customers/customers.ts +415 -67
  460. package/src/resources/v1/customers/index.ts +8 -1
  461. package/src/resources/v1/customers/integrations.ts +184 -18
  462. package/src/resources/v1/customers/payment-method.ts +85 -10
  463. package/src/resources/v1/customers/promotional-entitlements.ts +133 -11
  464. package/src/resources/v1/events/beta/beta.ts +35 -0
  465. package/src/resources/v1/events/beta/customers/assignments.ts +277 -0
  466. package/src/resources/v1/events/beta/customers/customers.ts +71 -0
  467. package/src/resources/v1/events/beta/customers/entities.ts +501 -0
  468. package/src/resources/v1/events/beta/customers/entitlements.ts +354 -0
  469. package/src/resources/v1/events/beta/customers/index.ts +26 -0
  470. package/src/resources/v1/events/beta/customers.ts +3 -0
  471. package/src/resources/v1/events/beta/entity-types.ts +226 -0
  472. package/src/resources/v1/events/beta/index.ts +12 -0
  473. package/src/resources/v1/events/beta.ts +3 -0
  474. package/src/resources/v1/events/data-export/data-export.ts +170 -0
  475. package/src/resources/v1/events/data-export/destinations.ts +243 -0
  476. package/src/resources/v1/events/data-export/index.ts +15 -0
  477. package/src/resources/v1/events/data-export.ts +3 -0
  478. package/src/resources/v1/events/events.ts +141 -0
  479. package/src/resources/v1/events/index.ts +11 -0
  480. package/src/resources/v1/events.ts +1 -75
  481. package/src/resources/v1/features.ts +252 -39
  482. package/src/resources/v1/index.ts +31 -1
  483. package/src/resources/v1/plans/entitlements.ts +154 -10
  484. package/src/resources/v1/plans/index.ts +11 -0
  485. package/src/resources/v1/plans/plans.ts +1509 -37
  486. package/src/resources/v1/products.ts +235 -30
  487. package/src/resources/v1/subscriptions/future-update.ts +84 -5
  488. package/src/resources/v1/subscriptions/index.ts +9 -2
  489. package/src/resources/v1/subscriptions/invoice.ts +42 -3
  490. package/src/resources/v1/subscriptions/subscriptions.ts +509 -90
  491. package/src/resources/v1/subscriptions/usage.ts +74 -5
  492. package/src/resources/v1/usage.ts +77 -5
  493. package/src/resources/v1/v1.ts +62 -2
  494. package/src/version.ts +1 -1
  495. package/uploads.d.mts +1 -0
  496. package/uploads.d.mts.map +1 -1
  497. package/uploads.d.ts +1 -0
  498. package/uploads.d.ts.map +1 -1
  499. package/uploads.mjs +1 -0
  500. package/uploads.mjs.map +1 -1
  501. package/version.d.mts +1 -1
  502. package/version.d.mts.map +1 -1
  503. package/version.d.ts +1 -1
  504. package/version.d.ts.map +1 -1
  505. package/version.js +1 -1
  506. package/version.js.map +1 -1
  507. package/version.mjs +1 -1
  508. package/version.mjs.map +1 -1
  509. package/resources/v1/credits/auto-recharge.d.mts +0 -84
  510. package/resources/v1/credits/auto-recharge.d.mts.map +0 -1
  511. package/resources/v1/credits/auto-recharge.d.ts +0 -84
  512. package/resources/v1/credits/auto-recharge.d.ts.map +0 -1
  513. package/resources/v1/credits/auto-recharge.js +0 -16
  514. package/resources/v1/credits/auto-recharge.js.map +0 -1
  515. package/resources/v1/credits/auto-recharge.mjs +0 -12
  516. package/resources/v1/credits/auto-recharge.mjs.map +0 -1
  517. package/src/resources/v1/credits/auto-recharge.ts +0 -109
@@ -2,7 +2,7 @@ import { APIResource } from "../../../core/resource.mjs";
2
2
  import * as IntegrationsAPI from "./integrations.mjs";
3
3
  import { IntegrationLinkParams, IntegrationListParams, IntegrationListResponse, IntegrationListResponsesMyCursorIDPage, IntegrationRetrieveParams, IntegrationUnlinkParams, IntegrationUpdateParams, Integrations } from "./integrations.mjs";
4
4
  import * as PaymentMethodAPI from "./payment-method.mjs";
5
- import { PaymentMethod, PaymentMethodAttachParams } from "./payment-method.mjs";
5
+ import { PaymentMethod, PaymentMethodAttachParams, PaymentMethodDetachParams } from "./payment-method.mjs";
6
6
  import * as PromotionalEntitlementsAPI from "./promotional-entitlements.mjs";
7
7
  import { PromotionalEntitlementCreateParams, PromotionalEntitlementCreateResponse, PromotionalEntitlementListParams, PromotionalEntitlementListResponse, PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementRevokeParams, PromotionalEntitlementRevokeResponse, PromotionalEntitlements } from "./promotional-entitlements.mjs";
8
8
  import { APIPromise } from "../../../core/api-promise.mjs";
@@ -15,22 +15,51 @@ export declare class Customers extends APIResource {
15
15
  /**
16
16
  * Retrieves a customer by their unique identifier, including billing information
17
17
  * and subscription status.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const customerResponse = await client.v1.customers.retrieve(
22
+ * 'x',
23
+ * );
24
+ * ```
18
25
  */
19
- retrieve(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
26
+ retrieve(id: string, params?: CustomerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomerResponse>;
20
27
  /**
21
28
  * Updates an existing customer's properties such as name, email, and billing
22
29
  * information.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const customerResponse = await client.v1.customers.update(
34
+ * 'x',
35
+ * );
36
+ * ```
23
37
  */
24
- update(id: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse>;
38
+ update(id: string, params: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse>;
25
39
  /**
26
40
  * Retrieves a paginated list of customers in the environment.
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * // Automatically fetches more pages as needed.
45
+ * for await (const customerListResponse of client.v1.customers.list()) {
46
+ * // ...
47
+ * }
48
+ * ```
27
49
  */
28
- list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResponsesMyCursorIDPage, CustomerListResponse>;
50
+ list(params?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResponsesMyCursorIDPage, CustomerListResponse>;
29
51
  /**
30
52
  * Archives a customer, preventing new subscriptions. Optionally cancels existing
31
53
  * subscriptions.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const customerResponse = await client.v1.customers.archive(
58
+ * 'x',
59
+ * );
60
+ * ```
32
61
  */
33
- archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
62
+ archive(id: string, params?: CustomerArchiveParams | null | undefined, options?: RequestOptions): APIPromise<CustomerResponse>;
34
63
  /**
35
64
  * Checks a single entitlement (feature or credit) for a customer or resource.
36
65
  * Supports `requestedUsage` and `requestedValues` to evaluate against limits or
@@ -40,22 +69,58 @@ export declare class Customers extends APIResource {
40
69
  * mechanisms, and low-latency guarantees. It is not recommended for hot-path
41
70
  * entitlement checks. For production use, consider using the Stigg Node Server SDK
42
71
  * with caching or the Sidecar for low-latency cached responses.
72
+ *
73
+ * @example
74
+ * ```ts
75
+ * const response = await client.v1.customers.checkEntitlement(
76
+ * 'x',
77
+ * );
78
+ * ```
43
79
  */
44
- checkEntitlement(id: string, query?: CustomerCheckEntitlementParams | null | undefined, options?: RequestOptions): APIPromise<CustomerCheckEntitlementResponse>;
80
+ checkEntitlement(id: string, params?: CustomerCheckEntitlementParams | null | undefined, options?: RequestOptions): APIPromise<CustomerCheckEntitlementResponse>;
45
81
  /**
46
82
  * Imports multiple customers in bulk. Used for migrating customer data from
47
83
  * external systems.
48
- */
49
- import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse>;
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * const response = await client.v1.customers.import({
88
+ * customers: [
89
+ * {
90
+ * id: 'id',
91
+ * email: 'dev@stainless.com',
92
+ * name: 'name',
93
+ * },
94
+ * ],
95
+ * });
96
+ * ```
97
+ */
98
+ import(params: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse>;
50
99
  /**
51
100
  * Retrieves a paginated list of resources within the same customer.
52
- */
53
- listResources(id: string, query?: CustomerListResourcesParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResourcesResponsesMyCursorIDPage, CustomerListResourcesResponse>;
101
+ *
102
+ * @example
103
+ * ```ts
104
+ * // Automatically fetches more pages as needed.
105
+ * for await (const customerListResourcesResponse of client.v1.customers.listResources(
106
+ * 'x',
107
+ * )) {
108
+ * // ...
109
+ * }
110
+ * ```
111
+ */
112
+ listResources(id: string, params?: CustomerListResourcesParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResourcesResponsesMyCursorIDPage, CustomerListResourcesResponse>;
54
113
  /**
55
114
  * Creates a new customer and optionally provisions an initial subscription in a
56
115
  * single operation.
116
+ *
117
+ * @example
118
+ * ```ts
119
+ * const customerResponse =
120
+ * await client.v1.customers.provision({ id: 'id' });
121
+ * ```
57
122
  */
58
- provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse>;
123
+ provision(params: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse>;
59
124
  /**
60
125
  * Retrieves the effective entitlements for a customer or resource, including
61
126
  * feature and credit entitlements.
@@ -64,12 +129,24 @@ export declare class Customers extends APIResource {
64
129
  * mechanisms, and low-latency guarantees. It is not recommended for hot-path
65
130
  * entitlement checks. For production use, consider using the Stigg Node Server SDK
66
131
  * with caching or the Sidecar for low-latency cached responses.
132
+ *
133
+ * @example
134
+ * ```ts
135
+ * const response =
136
+ * await client.v1.customers.retrieveEntitlements('x');
137
+ * ```
67
138
  */
68
- retrieveEntitlements(id: string, query?: CustomerRetrieveEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<CustomerRetrieveEntitlementsResponse>;
139
+ retrieveEntitlements(id: string, params?: CustomerRetrieveEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<CustomerRetrieveEntitlementsResponse>;
69
140
  /**
70
141
  * Restores an archived customer, allowing them to create new subscriptions again.
142
+ *
143
+ * @example
144
+ * ```ts
145
+ * const customerResponse =
146
+ * await client.v1.customers.unarchive('x');
147
+ * ```
71
148
  */
72
- unarchive(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
149
+ unarchive(id: string, params?: CustomerUnarchiveParams | null | undefined, options?: RequestOptions): APIPromise<CustomerResponse>;
73
150
  }
74
151
  export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResponse>;
75
152
  export type CustomerListResourcesResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResourcesResponse>;
@@ -98,7 +175,7 @@ export declare namespace CustomerIntegrationResponse {
98
175
  /**
99
176
  * The vendor identifier of integration
100
177
  */
101
- vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
178
+ vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
102
179
  /**
103
180
  * Price billing sync revision data containing billing ID, link URL, and price
104
181
  * group package billing ID
@@ -266,7 +343,7 @@ export declare namespace CustomerResponse {
266
343
  /**
267
344
  * The vendor identifier of integration
268
345
  */
269
- vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
346
+ vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
270
347
  }
271
348
  /**
272
349
  * Vendor-specific billing passthrough fields.
@@ -557,7 +634,7 @@ export declare namespace CustomerListResponse {
557
634
  /**
558
635
  * The vendor identifier of integration
559
636
  */
560
- vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
637
+ vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
561
638
  }
562
639
  /**
563
640
  * Vendor-specific billing passthrough fields.
@@ -1036,49 +1113,73 @@ export declare namespace CustomerRetrieveEntitlementsResponse {
1036
1113
  }
1037
1114
  }
1038
1115
  }
1116
+ export interface CustomerRetrieveParams {
1117
+ /**
1118
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
1119
+ * back to the user's first membership. Ignored for API-key auth.
1120
+ */
1121
+ 'X-ACCOUNT-ID'?: string;
1122
+ /**
1123
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
1124
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
1125
+ * key).
1126
+ */
1127
+ 'X-ENVIRONMENT-ID'?: string;
1128
+ }
1039
1129
  export interface CustomerUpdateParams {
1040
1130
  /**
1041
- * The billing currency of the customer
1131
+ * Body param: The billing currency of the customer
1042
1132
  */
1043
1133
  billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
1044
1134
  /**
1045
- * The unique identifier for the entity in the billing provider
1135
+ * Body param: The unique identifier for the entity in the billing provider
1046
1136
  */
1047
1137
  billingId?: string | null;
1048
1138
  /**
1049
- * Customer level coupon
1139
+ * Body param: Customer level coupon
1050
1140
  */
1051
1141
  couponId?: (string & {}) | '' | null;
1052
1142
  /**
1053
- * The email of the customer
1143
+ * Body param: The email of the customer
1054
1144
  */
1055
1145
  email?: string | null;
1056
1146
  /**
1057
- * List of integrations
1147
+ * Body param: List of integrations
1058
1148
  */
1059
1149
  integrations?: Array<CustomerUpdateParams.Integration>;
1060
1150
  /**
1061
- * Language to use for this customer
1151
+ * Body param: Language to use for this customer
1062
1152
  */
1063
1153
  language?: string | null;
1064
1154
  /**
1065
- * Additional metadata
1155
+ * Body param: Additional metadata
1066
1156
  */
1067
1157
  metadata?: {
1068
1158
  [key: string]: string;
1069
1159
  };
1070
1160
  /**
1071
- * The name of the customer
1161
+ * Body param: The name of the customer
1072
1162
  */
1073
1163
  name?: string | null;
1074
1164
  /**
1075
- * Vendor-specific billing passthrough fields.
1165
+ * Body param: Vendor-specific billing passthrough fields.
1076
1166
  */
1077
1167
  passthrough?: CustomerUpdateParams.Passthrough;
1078
1168
  /**
1079
- * Timezone to use for this customer
1169
+ * Body param: Timezone to use for this customer
1080
1170
  */
1081
1171
  timezone?: string | null;
1172
+ /**
1173
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1174
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1175
+ */
1176
+ 'X-ACCOUNT-ID'?: string;
1177
+ /**
1178
+ * Header param: Environment ID — required when authenticating with a user JWT
1179
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1180
+ * intrinsic to the key).
1181
+ */
1182
+ 'X-ENVIRONMENT-ID'?: string;
1082
1183
  }
1083
1184
  export declare namespace CustomerUpdateParams {
1084
1185
  /**
@@ -1096,7 +1197,7 @@ export declare namespace CustomerUpdateParams {
1096
1197
  /**
1097
1198
  * The vendor identifier of integration
1098
1199
  */
1099
- vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
1200
+ vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
1100
1201
  }
1101
1202
  /**
1102
1203
  * Vendor-specific billing passthrough fields.
@@ -1280,17 +1381,28 @@ export declare namespace CustomerUpdateParams {
1280
1381
  }
1281
1382
  export interface CustomerListParams extends MyCursorIDPageParams {
1282
1383
  /**
1283
- * Filter by creation date using range operators: gt, gte, lt, lte
1384
+ * Query param: Filter by creation date using range operators: gt, gte, lt, lte
1284
1385
  */
1285
1386
  createdAt?: CustomerListParams.CreatedAt;
1286
1387
  /**
1287
- * Filter by exact customer email address
1388
+ * Query param: Filter by exact customer email address
1288
1389
  */
1289
1390
  email?: string;
1290
1391
  /**
1291
- * Filter by exact customer name
1392
+ * Query param: Filter by exact customer name
1292
1393
  */
1293
1394
  name?: string;
1395
+ /**
1396
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1397
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1398
+ */
1399
+ 'X-ACCOUNT-ID'?: string;
1400
+ /**
1401
+ * Header param: Environment ID — required when authenticating with a user JWT
1402
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1403
+ * intrinsic to the key).
1404
+ */
1405
+ 'X-ENVIRONMENT-ID'?: string;
1294
1406
  }
1295
1407
  export declare namespace CustomerListParams {
1296
1408
  /**
@@ -1315,39 +1427,75 @@ export declare namespace CustomerListParams {
1315
1427
  lte?: string;
1316
1428
  }
1317
1429
  }
1430
+ export interface CustomerArchiveParams {
1431
+ /**
1432
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
1433
+ * back to the user's first membership. Ignored for API-key auth.
1434
+ */
1435
+ 'X-ACCOUNT-ID'?: string;
1436
+ /**
1437
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
1438
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
1439
+ * key).
1440
+ */
1441
+ 'X-ENVIRONMENT-ID'?: string;
1442
+ }
1318
1443
  export interface CustomerCheckEntitlementParams {
1319
1444
  /**
1320
- * Currency ID (refId) to check for credit entitlements. Mutually exclusive with
1321
- * `featureId`.
1445
+ * Query param: Currency ID (refId) to check for credit entitlements. Mutually
1446
+ * exclusive with `featureId`.
1322
1447
  */
1323
1448
  currencyId?: string;
1324
1449
  /**
1325
- * Feature ID (refId) to check. Mutually exclusive with `currencyId`.
1450
+ * Query param: Feature ID (refId) to check. Mutually exclusive with `currencyId`.
1326
1451
  */
1327
1452
  featureId?: string;
1328
1453
  /**
1329
- * Requested usage amount to evaluate against the entitlement limit (numeric
1330
- * features only)
1454
+ * Query param: Requested usage amount to evaluate against the entitlement limit
1455
+ * (numeric features only)
1331
1456
  */
1332
1457
  requestedUsage?: number;
1333
1458
  /**
1334
- * Requested values to evaluate against allowed values (enum features only)
1459
+ * Query param: Requested values to evaluate against allowed values (enum features
1460
+ * only)
1335
1461
  */
1336
1462
  requestedValues?: Array<string>;
1337
1463
  /**
1338
- * Resource ID to scope the entitlement check to a specific resource
1464
+ * Query param: Resource ID to scope the entitlement check to a specific resource
1339
1465
  */
1340
1466
  resourceId?: string;
1467
+ /**
1468
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1469
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1470
+ */
1471
+ 'X-ACCOUNT-ID'?: string;
1472
+ /**
1473
+ * Header param: Environment ID — required when authenticating with a user JWT
1474
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1475
+ * intrinsic to the key).
1476
+ */
1477
+ 'X-ENVIRONMENT-ID'?: string;
1341
1478
  }
1342
1479
  export interface CustomerImportParams {
1343
1480
  /**
1344
- * List of customer objects to import
1481
+ * Body param: List of customer objects to import
1345
1482
  */
1346
1483
  customers: Array<CustomerImportParams.Customer>;
1347
1484
  /**
1348
- * Integration details
1485
+ * Body param: Integration details
1349
1486
  */
1350
1487
  integrationId?: string;
1488
+ /**
1489
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1490
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1491
+ */
1492
+ 'X-ACCOUNT-ID'?: string;
1493
+ /**
1494
+ * Header param: Environment ID — required when authenticating with a user JWT
1495
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1496
+ * intrinsic to the key).
1497
+ */
1498
+ 'X-ENVIRONMENT-ID'?: string;
1351
1499
  }
1352
1500
  export declare namespace CustomerImportParams {
1353
1501
  interface Customer {
@@ -1388,58 +1536,80 @@ export declare namespace CustomerImportParams {
1388
1536
  }
1389
1537
  }
1390
1538
  export interface CustomerListResourcesParams extends MyCursorIDPageParams {
1539
+ /**
1540
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1541
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1542
+ */
1543
+ 'X-ACCOUNT-ID'?: string;
1544
+ /**
1545
+ * Header param: Environment ID — required when authenticating with a user JWT
1546
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1547
+ * intrinsic to the key).
1548
+ */
1549
+ 'X-ENVIRONMENT-ID'?: string;
1391
1550
  }
1392
1551
  export interface CustomerProvisionParams {
1393
1552
  /**
1394
- * Customer slug
1553
+ * Body param: Customer slug
1395
1554
  */
1396
1555
  id: string;
1397
1556
  /**
1398
- * The billing currency of the customer
1557
+ * Body param: The billing currency of the customer
1399
1558
  */
1400
1559
  billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
1401
1560
  /**
1402
- * The unique identifier for the entity in the billing provider
1561
+ * Body param: The unique identifier for the entity in the billing provider
1403
1562
  */
1404
1563
  billingId?: string | null;
1405
1564
  /**
1406
- * Customer level coupon
1565
+ * Body param: Customer level coupon
1407
1566
  */
1408
1567
  couponId?: (string & {}) | '' | null;
1409
1568
  /**
1410
- * The default payment method details
1569
+ * Body param: The default payment method details
1411
1570
  */
1412
1571
  defaultPaymentMethod?: CustomerProvisionParams.DefaultPaymentMethod | null;
1413
1572
  /**
1414
- * The email of the customer
1573
+ * Body param: The email of the customer
1415
1574
  */
1416
1575
  email?: string | null;
1417
1576
  /**
1418
- * List of integrations
1577
+ * Body param: List of integrations
1419
1578
  */
1420
1579
  integrations?: Array<CustomerProvisionParams.Integration>;
1421
1580
  /**
1422
- * Language to use for this customer
1581
+ * Body param: Language to use for this customer
1423
1582
  */
1424
1583
  language?: string | null;
1425
1584
  /**
1426
- * Additional metadata
1585
+ * Body param: Additional metadata
1427
1586
  */
1428
1587
  metadata?: {
1429
1588
  [key: string]: string;
1430
1589
  };
1431
1590
  /**
1432
- * The name of the customer
1591
+ * Body param: The name of the customer
1433
1592
  */
1434
1593
  name?: string | null;
1435
1594
  /**
1436
- * Vendor-specific billing passthrough fields.
1595
+ * Body param: Vendor-specific billing passthrough fields.
1437
1596
  */
1438
1597
  passthrough?: CustomerProvisionParams.Passthrough;
1439
1598
  /**
1440
- * Timezone to use for this customer
1599
+ * Body param: Timezone to use for this customer
1441
1600
  */
1442
1601
  timezone?: string | null;
1602
+ /**
1603
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1604
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1605
+ */
1606
+ 'X-ACCOUNT-ID'?: string;
1607
+ /**
1608
+ * Header param: Environment ID — required when authenticating with a user JWT
1609
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1610
+ * intrinsic to the key).
1611
+ */
1612
+ 'X-ENVIRONMENT-ID'?: string;
1443
1613
  }
1444
1614
  export declare namespace CustomerProvisionParams {
1445
1615
  /**
@@ -1482,7 +1652,7 @@ export declare namespace CustomerProvisionParams {
1482
1652
  /**
1483
1653
  * The vendor identifier of integration
1484
1654
  */
1485
- vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
1655
+ vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
1486
1656
  }
1487
1657
  /**
1488
1658
  * Vendor-specific billing passthrough fields.
@@ -1666,13 +1836,37 @@ export declare namespace CustomerProvisionParams {
1666
1836
  }
1667
1837
  export interface CustomerRetrieveEntitlementsParams {
1668
1838
  /**
1669
- * Resource ID to scope entitlements to a specific resource
1839
+ * Query param: Resource ID to scope entitlements to a specific resource
1670
1840
  */
1671
1841
  resourceId?: string;
1842
+ /**
1843
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1844
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1845
+ */
1846
+ 'X-ACCOUNT-ID'?: string;
1847
+ /**
1848
+ * Header param: Environment ID — required when authenticating with a user JWT
1849
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1850
+ * intrinsic to the key).
1851
+ */
1852
+ 'X-ENVIRONMENT-ID'?: string;
1853
+ }
1854
+ export interface CustomerUnarchiveParams {
1855
+ /**
1856
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
1857
+ * back to the user's first membership. Ignored for API-key auth.
1858
+ */
1859
+ 'X-ACCOUNT-ID'?: string;
1860
+ /**
1861
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
1862
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
1863
+ * key).
1864
+ */
1865
+ 'X-ENVIRONMENT-ID'?: string;
1672
1866
  }
1673
1867
  export declare namespace Customers {
1674
- export { type CustomerIntegrationResponse as CustomerIntegrationResponse, type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerCheckEntitlementResponse as CustomerCheckEntitlementResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerCheckEntitlementParams as CustomerCheckEntitlementParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams, };
1675
- export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
1868
+ export { type CustomerIntegrationResponse as CustomerIntegrationResponse, type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerCheckEntitlementResponse as CustomerCheckEntitlementResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerArchiveParams as CustomerArchiveParams, type CustomerCheckEntitlementParams as CustomerCheckEntitlementParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams, type CustomerUnarchiveParams as CustomerUnarchiveParams, };
1869
+ export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams, type PaymentMethodDetachParams as PaymentMethodDetachParams, };
1676
1870
  export { PromotionalEntitlements as PromotionalEntitlements, type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse, type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse, type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse, type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage, type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams, type PromotionalEntitlementListParams as PromotionalEntitlementListParams, type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams, };
1677
1871
  export { Integrations as Integrations, type IntegrationListResponse as IntegrationListResponse, type IntegrationListResponsesMyCursorIDPage as IntegrationListResponsesMyCursorIDPage, type IntegrationRetrieveParams as IntegrationRetrieveParams, type IntegrationUpdateParams as IntegrationUpdateParams, type IntegrationListParams as IntegrationListParams, type IntegrationLinkParams as IntegrationLinkParams, type IntegrationUnlinkParams as IntegrationUnlinkParams, };
1678
1872
  }