@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
@@ -1 +1 @@
1
- {"version":3,"file":"pagination.d.mts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"pagination.d.mts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,sCAAkC"}
package/pagination.d.ts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/pagination instead */
1
2
  export * from "./core/pagination.js";
2
3
  //# sourceMappingURL=pagination.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,qCAAkC"}
package/pagination.mjs CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/pagination instead */
1
2
  export * from "./core/pagination.mjs";
2
3
  //# sourceMappingURL=pagination.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"pagination.mjs","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"pagination.mjs","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,sCAAkC"}
package/resource.d.mts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/resource instead */
1
2
  export * from "./core/resource.mjs";
2
3
  //# sourceMappingURL=resource.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"resource.d.mts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"resource.d.mts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,oCAAgC"}
package/resource.d.ts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/resource instead */
1
2
  export * from "./core/resource.js";
2
3
  //# sourceMappingURL=resource.d.ts.map
package/resource.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,mCAAgC"}
package/resource.mjs CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/resource instead */
1
2
  export * from "./core/resource.mjs";
2
3
  //# sourceMappingURL=resource.mjs.map
package/resource.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,oCAAgC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,EAAE,EAAE"}
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,EAAE,EAAE,oBAAgB"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,EAAE,EAAE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,EAAE,EAAE,mBAAgB"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,EAAE,EAAE"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,EAAE,EAAE,oBAAgB"}
@@ -1,6 +1,6 @@
1
1
  import { APIResource } from "../../../core/resource.mjs";
2
2
  import * as EntitlementsAPI from "./entitlements.mjs";
3
- import { AddonPackageEntitlement, EntitlementCreateParams, EntitlementCreateResponse, EntitlementDeleteParams, EntitlementListResponse, EntitlementUpdateParams, Entitlements } from "./entitlements.mjs";
3
+ import { AddonPackageEntitlement, EntitlementCreateParams, EntitlementCreateResponse, EntitlementDeleteParams, EntitlementListParams, EntitlementListResponse, EntitlementUpdateParams, Entitlements } from "./entitlements.mjs";
4
4
  import { APIPromise } from "../../../core/api-promise.mjs";
5
5
  import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
6
6
  import { RequestOptions } from "../../../internal/request-options.mjs";
@@ -11,40 +11,104 @@ export declare class Addons extends APIResource {
11
11
  entitlements: EntitlementsAPI.Entitlements;
12
12
  /**
13
13
  * Creates a new addon in draft status, associated with a specific product.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const addon = await client.v1.addons.create({
18
+ * id: 'id',
19
+ * displayName: 'displayName',
20
+ * productId: 'productId',
21
+ * });
22
+ * ```
14
23
  */
15
- create(body: AddonCreateParams, options?: RequestOptions): APIPromise<Addon>;
24
+ create(params: AddonCreateParams, options?: RequestOptions): APIPromise<Addon>;
16
25
  /**
17
26
  * Retrieves an addon by its unique identifier, including entitlements and pricing
18
27
  * details.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const addon = await client.v1.addons.retrieve('x');
32
+ * ```
19
33
  */
20
- retrieve(id: string, options?: RequestOptions): APIPromise<Addon>;
34
+ retrieve(id: string, params?: AddonRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Addon>;
21
35
  /**
22
36
  * Updates an existing addon's properties such as display name, description, and
23
37
  * metadata.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const addon = await client.v1.addons.update('x');
42
+ * ```
24
43
  */
25
- update(id: string, body: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon>;
44
+ update(id: string, params: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon>;
26
45
  /**
27
46
  * Retrieves a paginated list of addons in the environment.
47
+ *
48
+ * @example
49
+ * ```ts
50
+ * // Automatically fetches more pages as needed.
51
+ * for await (const addonListResponse of client.v1.addons.list()) {
52
+ * // ...
53
+ * }
54
+ * ```
28
55
  */
29
- list(query?: AddonListParams | null | undefined, options?: RequestOptions): PagePromise<AddonListResponsesMyCursorIDPage, AddonListResponse>;
56
+ list(params?: AddonListParams | null | undefined, options?: RequestOptions): PagePromise<AddonListResponsesMyCursorIDPage, AddonListResponse>;
30
57
  /**
31
58
  * Archives an addon, preventing it from being used in new subscriptions.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const addon = await client.v1.addons.archive('x');
63
+ * ```
32
64
  */
33
- archive(id: string, options?: RequestOptions): APIPromise<Addon>;
65
+ archive(id: string, params?: AddonArchiveParams | null | undefined, options?: RequestOptions): APIPromise<Addon>;
34
66
  /**
35
67
  * Creates a draft version of an existing addon for modification before publishing.
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * const addon = await client.v1.addons.createDraft('x');
72
+ * ```
36
73
  */
37
- createDraft(id: string, options?: RequestOptions): APIPromise<Addon>;
74
+ createDraft(id: string, params?: AddonCreateDraftParams | null | undefined, options?: RequestOptions): APIPromise<Addon>;
75
+ /**
76
+ * Retrieves the list of charges configured on an addon.
77
+ *
78
+ * @example
79
+ * ```ts
80
+ * // Automatically fetches more pages as needed.
81
+ * for await (const addonListChargesResponse of client.v1.addons.listCharges(
82
+ * 'x',
83
+ * )) {
84
+ * // ...
85
+ * }
86
+ * ```
87
+ */
88
+ listCharges(id: string, params?: AddonListChargesParams | null | undefined, options?: RequestOptions): PagePromise<AddonListChargesResponsesMyCursorIDPage, AddonListChargesResponse>;
38
89
  /**
39
90
  * Publishes a draft addon, making it available for use in subscriptions.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * const response = await client.v1.addons.publish('x', {
95
+ * migrationType: 'NEW_CUSTOMERS',
96
+ * });
97
+ * ```
40
98
  */
41
- publish(id: string, body: AddonPublishParams, options?: RequestOptions): APIPromise<AddonPublishResponse>;
99
+ publish(id: string, params: AddonPublishParams, options?: RequestOptions): APIPromise<AddonPublishResponse>;
42
100
  /**
43
101
  * Removes a draft version of an addon.
102
+ *
103
+ * @example
104
+ * ```ts
105
+ * const response = await client.v1.addons.removeDraft('x');
106
+ * ```
44
107
  */
45
- removeDraft(id: string, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse>;
108
+ removeDraft(id: string, params?: AddonRemoveDraftParams | null | undefined, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse>;
46
109
  }
47
110
  export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
111
+ export type AddonListChargesResponsesMyCursorIDPage = MyCursorIDPage<AddonListChargesResponse>;
48
112
  /**
49
113
  * Response object
50
114
  */
@@ -214,6 +278,170 @@ export declare namespace AddonListResponse {
214
278
  type: 'FEATURE' | 'CREDIT';
215
279
  }
216
280
  }
281
+ /**
282
+ * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
283
+ * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
284
+ * own many of these — one per currency / billing period / feature.
285
+ */
286
+ export interface AddonListChargesResponse {
287
+ /**
288
+ * Unique identifier of the charge
289
+ */
290
+ id: string;
291
+ /**
292
+ * The billing cadence (RECURRING or ONE_OFF)
293
+ */
294
+ billingCadence: 'RECURRING' | 'ONE_OFF';
295
+ /**
296
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
297
+ */
298
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
299
+ /**
300
+ * The billing period (MONTHLY or ANNUALLY)
301
+ */
302
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
303
+ /**
304
+ * Timestamp when the charge was created
305
+ */
306
+ createdAt: string;
307
+ /**
308
+ * ISO country code for localized pricing, if any
309
+ */
310
+ billingCountryCode?: string | null;
311
+ /**
312
+ * Identifier in the external billing integration (e.g. Stripe price id), if any
313
+ */
314
+ billingId?: string | null;
315
+ /**
316
+ * Block size for usage-based pricing
317
+ */
318
+ blockSize?: number | null;
319
+ /**
320
+ * When credits are granted (for credit-based pricing)
321
+ */
322
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
323
+ /**
324
+ * Credit rate configuration for credit-based pricing
325
+ */
326
+ creditRate?: AddonListChargesResponse.CreditRate | null;
327
+ /**
328
+ * Identifier in the linked CRM, if any
329
+ */
330
+ crmId?: string | null;
331
+ /**
332
+ * Deep link to the charge in the linked CRM, if any
333
+ */
334
+ crmLinkUrl?: string | null;
335
+ /**
336
+ * The feature this charge meters, if metered
337
+ */
338
+ featureId?: string | null;
339
+ /**
340
+ * Maximum unit quantity that can be purchased
341
+ */
342
+ maxUnitQuantity?: number | null;
343
+ /**
344
+ * Minimum unit quantity that can be purchased
345
+ */
346
+ minUnitQuantity?: number | null;
347
+ /**
348
+ * The flat price amount and currency, when applicable
349
+ */
350
+ price?: AddonListChargesResponse.Price | null;
351
+ /**
352
+ * Tiered pricing rows when the charge is tiered
353
+ */
354
+ tiers?: Array<AddonListChargesResponse.Tier> | null;
355
+ /**
356
+ * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
357
+ */
358
+ tiersMode?: 'VOLUME' | 'GRADUATED' | null;
359
+ /**
360
+ * Custom currency identifier for top-up pricing, if any
361
+ */
362
+ topUpCustomCurrencyId?: string | null;
363
+ /**
364
+ * True if this charge is referenced by at least one subscription
365
+ */
366
+ usedInSubscriptions?: boolean | null;
367
+ }
368
+ export declare namespace AddonListChargesResponse {
369
+ /**
370
+ * Credit rate configuration for credit-based pricing
371
+ */
372
+ interface CreditRate {
373
+ /**
374
+ * Credit rate amount
375
+ */
376
+ amount: number;
377
+ /**
378
+ * Custom currency identifier
379
+ */
380
+ currencyId: string;
381
+ /**
382
+ * Optional cost formula expression
383
+ */
384
+ costFormula?: string | null;
385
+ }
386
+ /**
387
+ * The flat price amount and currency, when applicable
388
+ */
389
+ interface Price {
390
+ /**
391
+ * The price amount
392
+ */
393
+ amount: number;
394
+ /**
395
+ * ISO 4217 currency code
396
+ */
397
+ currency: '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';
398
+ }
399
+ /**
400
+ * A single tier within a tiered charge
401
+ */
402
+ interface Tier {
403
+ /**
404
+ * Flat price for this tier
405
+ */
406
+ flatPrice?: Tier.FlatPrice | null;
407
+ /**
408
+ * Per-unit price in this tier
409
+ */
410
+ unitPrice?: Tier.UnitPrice | null;
411
+ /**
412
+ * Upper bound of this tier (null for unlimited)
413
+ */
414
+ upTo?: number | null;
415
+ }
416
+ namespace Tier {
417
+ /**
418
+ * Flat price for this tier
419
+ */
420
+ interface FlatPrice {
421
+ /**
422
+ * The price amount
423
+ */
424
+ amount: number;
425
+ /**
426
+ * ISO 4217 currency code
427
+ */
428
+ currency: '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';
429
+ }
430
+ /**
431
+ * Per-unit price in this tier
432
+ */
433
+ interface UnitPrice {
434
+ /**
435
+ * The price amount
436
+ */
437
+ amount: number;
438
+ /**
439
+ * ISO 4217 currency code
440
+ */
441
+ currency: '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';
442
+ }
443
+ }
444
+ }
217
445
  /**
218
446
  * Response containing task ID for publish operation
219
447
  */
@@ -244,79 +472,116 @@ export declare namespace AddonRemoveDraftResponse {
244
472
  }
245
473
  export interface AddonCreateParams {
246
474
  /**
247
- * The unique identifier for the entity
475
+ * Body param: The unique identifier for the entity
248
476
  */
249
477
  id: string;
250
478
  /**
251
- * The display name of the package
479
+ * Body param: The display name of the package
252
480
  */
253
481
  displayName: string;
254
482
  /**
255
- * The product id of the package
483
+ * Body param: The product id of the package
256
484
  */
257
485
  productId: string;
258
486
  /**
259
- * The unique identifier for the entity in the billing provider
487
+ * Body param: The unique identifier for the entity in the billing provider
260
488
  */
261
489
  billingId?: string | null;
262
490
  /**
263
- * The description of the package
491
+ * Body param: The description of the package
264
492
  */
265
493
  description?: string | null;
266
494
  /**
267
- * The maximum quantity of this addon that can be added to a subscription
495
+ * Body param: The maximum quantity of this addon that can be added to a
496
+ * subscription
268
497
  */
269
498
  maxQuantity?: number | null;
270
499
  /**
271
- * Metadata associated with the entity
500
+ * Body param: Metadata associated with the entity
272
501
  */
273
502
  metadata?: {
274
503
  [key: string]: string;
275
504
  };
276
505
  /**
277
- * The pricing type of the package
506
+ * Body param: The pricing type of the package
278
507
  */
279
508
  pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
280
509
  /**
281
- * The status of the package
510
+ * Body param: The status of the package
282
511
  */
283
512
  status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
513
+ /**
514
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
515
+ * token); falls back to the user's first membership. Ignored for API-key auth.
516
+ */
517
+ 'X-ACCOUNT-ID'?: string;
518
+ /**
519
+ * Header param: Environment ID — required when authenticating with a user JWT
520
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
521
+ * intrinsic to the key).
522
+ */
523
+ 'X-ENVIRONMENT-ID'?: string;
524
+ }
525
+ export interface AddonRetrieveParams {
526
+ /**
527
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
528
+ * back to the user's first membership. Ignored for API-key auth.
529
+ */
530
+ 'X-ACCOUNT-ID'?: string;
531
+ /**
532
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
533
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
534
+ * key).
535
+ */
536
+ 'X-ENVIRONMENT-ID'?: string;
284
537
  }
285
538
  export interface AddonUpdateParams {
286
539
  /**
287
- * The unique identifier for the entity in the billing provider
540
+ * Body param: The unique identifier for the entity in the billing provider
288
541
  */
289
542
  billingId?: string | null;
290
543
  /**
291
- * Pricing configuration to set on the addon draft
544
+ * Body param: Pricing configuration to set on the addon draft
292
545
  */
293
546
  charges?: AddonUpdateParams.Charges;
294
547
  /**
295
- * List of addons the addon is dependant on
548
+ * Body param: List of addons the addon is dependant on
296
549
  */
297
550
  dependencies?: Array<string> | null;
298
551
  /**
299
- * The description of the package
552
+ * Body param: The description of the package
300
553
  */
301
554
  description?: string | null;
302
555
  /**
303
- * The display name of the package
556
+ * Body param: The display name of the package
304
557
  */
305
558
  displayName?: string;
306
559
  /**
307
- * The maximum quantity of this addon that can be added to a subscription
560
+ * Body param: The maximum quantity of this addon that can be added to a
561
+ * subscription
308
562
  */
309
563
  maxQuantity?: number | null;
310
564
  /**
311
- * Metadata associated with the entity
565
+ * Body param: Metadata associated with the entity
312
566
  */
313
567
  metadata?: {
314
568
  [key: string]: string;
315
569
  };
316
570
  /**
317
- * The status of the package
571
+ * Body param: The status of the package
318
572
  */
319
573
  status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
574
+ /**
575
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
576
+ * token); falls back to the user's first membership. Ignored for API-key auth.
577
+ */
578
+ 'X-ACCOUNT-ID'?: string;
579
+ /**
580
+ * Header param: Environment ID — required when authenticating with a user JWT
581
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
582
+ * intrinsic to the key).
583
+ */
584
+ 'X-ENVIRONMENT-ID'?: string;
320
585
  }
321
586
  export declare namespace AddonUpdateParams {
322
587
  /**
@@ -780,17 +1045,29 @@ export declare namespace AddonUpdateParams {
780
1045
  }
781
1046
  export interface AddonListParams extends MyCursorIDPageParams {
782
1047
  /**
783
- * Filter by creation date using range operators: gt, gte, lt, lte
1048
+ * Query param: Filter by creation date using range operators: gt, gte, lt, lte
784
1049
  */
785
1050
  createdAt?: AddonListParams.CreatedAt;
786
1051
  /**
787
- * Filter by product ID
1052
+ * Query param: Filter by product ID
788
1053
  */
789
1054
  productId?: string;
790
1055
  /**
791
- * Filter by status. Supports comma-separated values for multiple statuses
1056
+ * Query param: Filter by status. Supports comma-separated values for multiple
1057
+ * statuses
792
1058
  */
793
1059
  status?: Array<'DRAFT' | 'PUBLISHED' | 'ARCHIVED'>;
1060
+ /**
1061
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1062
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1063
+ */
1064
+ 'X-ACCOUNT-ID'?: string;
1065
+ /**
1066
+ * Header param: Environment ID — required when authenticating with a user JWT
1067
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1068
+ * intrinsic to the key).
1069
+ */
1070
+ 'X-ENVIRONMENT-ID'?: string;
794
1071
  }
795
1072
  export declare namespace AddonListParams {
796
1073
  /**
@@ -815,14 +1092,77 @@ export declare namespace AddonListParams {
815
1092
  lte?: string;
816
1093
  }
817
1094
  }
1095
+ export interface AddonArchiveParams {
1096
+ /**
1097
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
1098
+ * back to the user's first membership. Ignored for API-key auth.
1099
+ */
1100
+ 'X-ACCOUNT-ID'?: string;
1101
+ /**
1102
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
1103
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
1104
+ * key).
1105
+ */
1106
+ 'X-ENVIRONMENT-ID'?: string;
1107
+ }
1108
+ export interface AddonCreateDraftParams {
1109
+ /**
1110
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
1111
+ * back to the user's first membership. Ignored for API-key auth.
1112
+ */
1113
+ 'X-ACCOUNT-ID'?: string;
1114
+ /**
1115
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
1116
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
1117
+ * key).
1118
+ */
1119
+ 'X-ENVIRONMENT-ID'?: string;
1120
+ }
1121
+ export interface AddonListChargesParams extends MyCursorIDPageParams {
1122
+ /**
1123
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1124
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1125
+ */
1126
+ 'X-ACCOUNT-ID'?: string;
1127
+ /**
1128
+ * Header param: Environment ID — required when authenticating with a user JWT
1129
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1130
+ * intrinsic to the key).
1131
+ */
1132
+ 'X-ENVIRONMENT-ID'?: string;
1133
+ }
818
1134
  export interface AddonPublishParams {
819
1135
  /**
820
- * The migration type of the package
1136
+ * Body param: The migration type of the package
821
1137
  */
822
1138
  migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
1139
+ /**
1140
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
1141
+ * token); falls back to the user's first membership. Ignored for API-key auth.
1142
+ */
1143
+ 'X-ACCOUNT-ID'?: string;
1144
+ /**
1145
+ * Header param: Environment ID — required when authenticating with a user JWT
1146
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
1147
+ * intrinsic to the key).
1148
+ */
1149
+ 'X-ENVIRONMENT-ID'?: string;
1150
+ }
1151
+ export interface AddonRemoveDraftParams {
1152
+ /**
1153
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
1154
+ * back to the user's first membership. Ignored for API-key auth.
1155
+ */
1156
+ 'X-ACCOUNT-ID'?: string;
1157
+ /**
1158
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
1159
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
1160
+ * key).
1161
+ */
1162
+ 'X-ENVIRONMENT-ID'?: string;
823
1163
  }
824
1164
  export declare namespace Addons {
825
- export { type Addon as Addon, type AddonListResponse as AddonListResponse, type AddonPublishResponse as AddonPublishResponse, type AddonRemoveDraftResponse as AddonRemoveDraftResponse, type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage, type AddonCreateParams as AddonCreateParams, type AddonUpdateParams as AddonUpdateParams, type AddonListParams as AddonListParams, type AddonPublishParams as AddonPublishParams, };
826
- export { Entitlements as Entitlements, type AddonPackageEntitlement as AddonPackageEntitlement, type EntitlementCreateResponse as EntitlementCreateResponse, type EntitlementListResponse as EntitlementListResponse, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementDeleteParams as EntitlementDeleteParams, };
1165
+ export { type Addon as Addon, type AddonListResponse as AddonListResponse, type AddonListChargesResponse as AddonListChargesResponse, type AddonPublishResponse as AddonPublishResponse, type AddonRemoveDraftResponse as AddonRemoveDraftResponse, type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage, type AddonListChargesResponsesMyCursorIDPage as AddonListChargesResponsesMyCursorIDPage, type AddonCreateParams as AddonCreateParams, type AddonRetrieveParams as AddonRetrieveParams, type AddonUpdateParams as AddonUpdateParams, type AddonListParams as AddonListParams, type AddonArchiveParams as AddonArchiveParams, type AddonCreateDraftParams as AddonCreateDraftParams, type AddonListChargesParams as AddonListChargesParams, type AddonPublishParams as AddonPublishParams, type AddonRemoveDraftParams as AddonRemoveDraftParams, };
1166
+ export { Entitlements as Entitlements, type AddonPackageEntitlement as AddonPackageEntitlement, type EntitlementCreateResponse as EntitlementCreateResponse, type EntitlementListResponse as EntitlementListResponse, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementListParams as EntitlementListParams, type EntitlementDeleteParams as EntitlementDeleteParams, };
827
1167
  }
828
1168
  //# sourceMappingURL=addons.d.mts.map