@stigg/typescript 0.1.0-alpha.2 → 0.1.0-alpha.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 (378) hide show
  1. package/CHANGELOG.md +270 -0
  2. package/README.md +9 -0
  3. package/client.d.mts +7 -9
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +7 -9
  6. package/client.d.ts.map +1 -1
  7. package/client.js +29 -26
  8. package/client.js.map +1 -1
  9. package/client.mjs +30 -27
  10. package/client.mjs.map +1 -1
  11. package/internal/parse.d.mts.map +1 -1
  12. package/internal/parse.d.ts.map +1 -1
  13. package/internal/parse.js +5 -0
  14. package/internal/parse.js.map +1 -1
  15. package/internal/parse.mjs +5 -0
  16. package/internal/parse.mjs.map +1 -1
  17. package/internal/qs/formats.d.mts +7 -0
  18. package/internal/qs/formats.d.mts.map +1 -0
  19. package/internal/qs/formats.d.ts +7 -0
  20. package/internal/qs/formats.d.ts.map +1 -0
  21. package/internal/qs/formats.js +13 -0
  22. package/internal/qs/formats.js.map +1 -0
  23. package/internal/qs/formats.mjs +9 -0
  24. package/internal/qs/formats.mjs.map +1 -0
  25. package/internal/qs/index.d.mts +10 -0
  26. package/internal/qs/index.d.mts.map +1 -0
  27. package/internal/qs/index.d.ts +10 -0
  28. package/internal/qs/index.d.ts.map +1 -0
  29. package/internal/qs/index.js +14 -0
  30. package/internal/qs/index.js.map +1 -0
  31. package/internal/qs/index.mjs +10 -0
  32. package/internal/qs/index.mjs.map +1 -0
  33. package/internal/qs/stringify.d.mts +3 -0
  34. package/internal/qs/stringify.d.mts.map +1 -0
  35. package/internal/qs/stringify.d.ts +3 -0
  36. package/internal/qs/stringify.d.ts.map +1 -0
  37. package/internal/qs/stringify.js +277 -0
  38. package/internal/qs/stringify.js.map +1 -0
  39. package/internal/qs/stringify.mjs +274 -0
  40. package/internal/qs/stringify.mjs.map +1 -0
  41. package/internal/qs/types.d.mts +57 -0
  42. package/internal/qs/types.d.mts.map +1 -0
  43. package/internal/qs/types.d.ts +57 -0
  44. package/internal/qs/types.d.ts.map +1 -0
  45. package/internal/qs/types.js +3 -0
  46. package/internal/qs/types.js.map +1 -0
  47. package/internal/qs/types.mjs +2 -0
  48. package/internal/qs/types.mjs.map +1 -0
  49. package/internal/qs/utils.d.mts +15 -0
  50. package/internal/qs/utils.d.mts.map +1 -0
  51. package/internal/qs/utils.d.ts +15 -0
  52. package/internal/qs/utils.d.ts.map +1 -0
  53. package/internal/qs/utils.js +230 -0
  54. package/internal/qs/utils.js.map +1 -0
  55. package/internal/qs/utils.mjs +217 -0
  56. package/internal/qs/utils.mjs.map +1 -0
  57. package/internal/tslib.js +17 -17
  58. package/internal/utils/query.d.mts +2 -0
  59. package/internal/utils/query.d.mts.map +1 -0
  60. package/internal/utils/query.d.ts +2 -0
  61. package/internal/utils/query.d.ts.map +1 -0
  62. package/internal/utils/query.js +10 -0
  63. package/internal/utils/query.js.map +1 -0
  64. package/internal/utils/query.mjs +6 -0
  65. package/internal/utils/query.mjs.map +1 -0
  66. package/internal/utils.d.mts +1 -0
  67. package/internal/utils.d.ts +1 -0
  68. package/internal/utils.js +1 -0
  69. package/internal/utils.js.map +1 -1
  70. package/internal/utils.mjs +1 -0
  71. package/package.json +12 -1
  72. package/resources/index.d.mts +1 -1
  73. package/resources/index.d.mts.map +1 -1
  74. package/resources/index.d.ts +1 -1
  75. package/resources/index.d.ts.map +1 -1
  76. package/resources/index.js.map +1 -1
  77. package/resources/index.mjs +1 -1
  78. package/resources/index.mjs.map +1 -1
  79. package/resources/v1/addons/addons.d.mts +1305 -0
  80. package/resources/v1/addons/addons.d.mts.map +1 -0
  81. package/resources/v1/addons/addons.d.ts +1305 -0
  82. package/resources/v1/addons/addons.d.ts.map +1 -0
  83. package/resources/v1/addons/addons.js +81 -0
  84. package/resources/v1/addons/addons.js.map +1 -0
  85. package/resources/v1/addons/addons.mjs +76 -0
  86. package/resources/v1/addons/addons.mjs.map +1 -0
  87. package/resources/v1/addons/entitlements.d.mts +860 -0
  88. package/resources/v1/addons/entitlements.d.mts.map +1 -0
  89. package/resources/v1/addons/entitlements.d.ts +860 -0
  90. package/resources/v1/addons/entitlements.d.ts.map +1 -0
  91. package/resources/v1/addons/entitlements.js +36 -0
  92. package/resources/v1/addons/entitlements.js.map +1 -0
  93. package/resources/v1/addons/entitlements.mjs +32 -0
  94. package/resources/v1/addons/entitlements.mjs.map +1 -0
  95. package/resources/v1/addons/index.d.mts +3 -0
  96. package/resources/v1/addons/index.d.mts.map +1 -0
  97. package/resources/v1/addons/index.d.ts +3 -0
  98. package/resources/v1/addons/index.d.ts.map +1 -0
  99. package/resources/v1/addons/index.js +9 -0
  100. package/resources/v1/addons/index.js.map +1 -0
  101. package/resources/v1/addons/index.mjs +4 -0
  102. package/resources/v1/addons/index.mjs.map +1 -0
  103. package/resources/v1/addons.d.mts +2 -0
  104. package/resources/v1/addons.d.mts.map +1 -0
  105. package/resources/v1/addons.d.ts +2 -0
  106. package/resources/v1/addons.d.ts.map +1 -0
  107. package/resources/v1/addons.js +6 -0
  108. package/resources/v1/addons.js.map +1 -0
  109. package/resources/v1/addons.mjs +3 -0
  110. package/resources/v1/addons.mjs.map +1 -0
  111. package/resources/v1/coupons.d.mts +113 -82
  112. package/resources/v1/coupons.d.mts.map +1 -1
  113. package/resources/v1/coupons.d.ts +113 -82
  114. package/resources/v1/coupons.d.ts.map +1 -1
  115. package/resources/v1/coupons.js +19 -3
  116. package/resources/v1/coupons.js.map +1 -1
  117. package/resources/v1/coupons.mjs +19 -3
  118. package/resources/v1/coupons.mjs.map +1 -1
  119. package/resources/v1/customers/customers.d.mts +221 -45
  120. package/resources/v1/customers/customers.d.mts.map +1 -1
  121. package/resources/v1/customers/customers.d.ts +221 -45
  122. package/resources/v1/customers/customers.d.ts.map +1 -1
  123. package/resources/v1/customers/customers.js +32 -15
  124. package/resources/v1/customers/customers.js.map +1 -1
  125. package/resources/v1/customers/customers.mjs +32 -15
  126. package/resources/v1/customers/customers.mjs.map +1 -1
  127. package/resources/v1/customers/index.d.mts +2 -2
  128. package/resources/v1/customers/index.d.mts.map +1 -1
  129. package/resources/v1/customers/index.d.ts +2 -2
  130. package/resources/v1/customers/index.d.ts.map +1 -1
  131. package/resources/v1/customers/index.js +3 -3
  132. package/resources/v1/customers/index.js.map +1 -1
  133. package/resources/v1/customers/index.mjs +1 -1
  134. package/resources/v1/customers/index.mjs.map +1 -1
  135. package/resources/v1/customers/payment-method.d.mts +10 -2
  136. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  137. package/resources/v1/customers/payment-method.d.ts +10 -2
  138. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  139. package/resources/v1/customers/payment-method.js +7 -2
  140. package/resources/v1/customers/payment-method.js.map +1 -1
  141. package/resources/v1/customers/payment-method.mjs +7 -2
  142. package/resources/v1/customers/payment-method.mjs.map +1 -1
  143. package/resources/v1/customers/promotional-entitlements.d.mts +501 -0
  144. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -0
  145. package/resources/v1/customers/promotional-entitlements.d.ts +501 -0
  146. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -0
  147. package/resources/v1/customers/promotional-entitlements.js +35 -0
  148. package/resources/v1/customers/promotional-entitlements.js.map +1 -0
  149. package/resources/v1/customers/promotional-entitlements.mjs +31 -0
  150. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -0
  151. package/resources/v1/events/credits/credits.d.mts +260 -0
  152. package/resources/v1/events/credits/credits.d.mts.map +1 -0
  153. package/resources/v1/events/credits/credits.d.ts +260 -0
  154. package/resources/v1/events/credits/credits.d.ts.map +1 -0
  155. package/resources/v1/events/credits/credits.js +41 -0
  156. package/resources/v1/events/credits/credits.js.map +1 -0
  157. package/resources/v1/events/credits/credits.mjs +36 -0
  158. package/resources/v1/events/credits/credits.mjs.map +1 -0
  159. package/resources/v1/events/credits/grants.d.mts +549 -0
  160. package/resources/v1/events/credits/grants.d.mts.map +1 -0
  161. package/resources/v1/events/credits/grants.d.ts +549 -0
  162. package/resources/v1/events/credits/grants.d.ts.map +1 -0
  163. package/resources/v1/events/credits/grants.js +37 -0
  164. package/resources/v1/events/credits/grants.js.map +1 -0
  165. package/resources/v1/events/credits/grants.mjs +33 -0
  166. package/resources/v1/events/credits/grants.mjs.map +1 -0
  167. package/resources/v1/events/credits/index.d.mts +3 -0
  168. package/resources/v1/events/credits/index.d.mts.map +1 -0
  169. package/resources/v1/events/credits/index.d.ts +3 -0
  170. package/resources/v1/events/credits/index.d.ts.map +1 -0
  171. package/resources/v1/events/credits/index.js +9 -0
  172. package/resources/v1/events/credits/index.js.map +1 -0
  173. package/resources/v1/events/credits/index.mjs +4 -0
  174. package/resources/v1/events/credits/index.mjs.map +1 -0
  175. package/resources/v1/events/credits.d.mts +2 -0
  176. package/resources/v1/events/credits.d.mts.map +1 -0
  177. package/resources/v1/events/credits.d.ts +2 -0
  178. package/resources/v1/events/credits.d.ts.map +1 -0
  179. package/resources/v1/events/credits.js +6 -0
  180. package/resources/v1/events/credits.js.map +1 -0
  181. package/resources/v1/events/credits.mjs +3 -0
  182. package/resources/v1/events/credits.mjs.map +1 -0
  183. package/resources/v1/events/events.d.mts +70 -0
  184. package/resources/v1/events/events.d.mts.map +1 -0
  185. package/resources/v1/events/events.d.ts +70 -0
  186. package/resources/v1/events/events.d.ts.map +1 -0
  187. package/resources/v1/events/events.js +27 -0
  188. package/resources/v1/events/events.js.map +1 -0
  189. package/resources/v1/events/events.mjs +22 -0
  190. package/resources/v1/events/events.mjs.map +1 -0
  191. package/resources/v1/events/index.d.mts +3 -0
  192. package/resources/v1/events/index.d.mts.map +1 -0
  193. package/resources/v1/events/index.d.ts +3 -0
  194. package/resources/v1/events/index.d.ts.map +1 -0
  195. package/resources/v1/events/index.js +9 -0
  196. package/resources/v1/events/index.js.map +1 -0
  197. package/resources/v1/events/index.mjs +4 -0
  198. package/resources/v1/events/index.mjs.map +1 -0
  199. package/resources/v1/events.d.mts +2 -0
  200. package/resources/v1/events.d.mts.map +1 -0
  201. package/resources/v1/events.d.ts +2 -0
  202. package/resources/v1/events.d.ts.map +1 -0
  203. package/resources/v1/events.js +6 -0
  204. package/resources/v1/events.js.map +1 -0
  205. package/resources/v1/events.mjs +3 -0
  206. package/resources/v1/events.mjs.map +1 -0
  207. package/resources/v1/features.d.mts +447 -0
  208. package/resources/v1/features.d.mts.map +1 -0
  209. package/resources/v1/features.d.ts +447 -0
  210. package/resources/v1/features.d.ts.map +1 -0
  211. package/resources/v1/features.js +54 -0
  212. package/resources/v1/features.js.map +1 -0
  213. package/resources/v1/features.mjs +50 -0
  214. package/resources/v1/features.mjs.map +1 -0
  215. package/resources/v1/index.d.mts +10 -4
  216. package/resources/v1/index.d.mts.map +1 -1
  217. package/resources/v1/index.d.ts +10 -4
  218. package/resources/v1/index.d.ts.map +1 -1
  219. package/resources/v1/index.js +17 -5
  220. package/resources/v1/index.js.map +1 -1
  221. package/resources/v1/index.mjs +7 -1
  222. package/resources/v1/index.mjs.map +1 -1
  223. package/resources/v1/plans/entitlements.d.mts +860 -0
  224. package/resources/v1/plans/entitlements.d.mts.map +1 -0
  225. package/resources/v1/plans/entitlements.d.ts +860 -0
  226. package/resources/v1/plans/entitlements.d.ts.map +1 -0
  227. package/resources/v1/plans/entitlements.js +36 -0
  228. package/resources/v1/plans/entitlements.js.map +1 -0
  229. package/resources/v1/plans/entitlements.mjs +32 -0
  230. package/resources/v1/plans/entitlements.mjs.map +1 -0
  231. package/resources/v1/plans/index.d.mts +3 -0
  232. package/resources/v1/plans/index.d.mts.map +1 -0
  233. package/resources/v1/plans/index.d.ts +3 -0
  234. package/resources/v1/plans/index.d.ts.map +1 -0
  235. package/resources/v1/plans/index.js +9 -0
  236. package/resources/v1/plans/index.js.map +1 -0
  237. package/resources/v1/plans/index.mjs +4 -0
  238. package/resources/v1/plans/index.mjs.map +1 -0
  239. package/resources/v1/plans/plans.d.mts +976 -0
  240. package/resources/v1/plans/plans.d.mts.map +1 -0
  241. package/resources/v1/plans/plans.d.ts +976 -0
  242. package/resources/v1/plans/plans.d.ts.map +1 -0
  243. package/resources/v1/plans/plans.js +79 -0
  244. package/resources/v1/plans/plans.js.map +1 -0
  245. package/resources/v1/plans/plans.mjs +74 -0
  246. package/resources/v1/plans/plans.mjs.map +1 -0
  247. package/resources/v1/plans.d.mts +2 -0
  248. package/resources/v1/plans.d.mts.map +1 -0
  249. package/resources/v1/plans.d.ts +2 -0
  250. package/resources/v1/plans.d.ts.map +1 -0
  251. package/resources/v1/plans.js +6 -0
  252. package/resources/v1/plans.js.map +1 -0
  253. package/resources/v1/plans.mjs +3 -0
  254. package/resources/v1/plans.mjs.map +1 -0
  255. package/resources/v1/products.d.mts +335 -0
  256. package/resources/v1/products.d.mts.map +1 -0
  257. package/resources/v1/products.d.ts +335 -0
  258. package/resources/v1/products.d.ts.map +1 -0
  259. package/resources/v1/products.js +55 -0
  260. package/resources/v1/products.js.map +1 -0
  261. package/resources/v1/products.mjs +51 -0
  262. package/resources/v1/products.mjs.map +1 -0
  263. package/resources/v1/subscriptions/future-update.d.mts +15 -19
  264. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  265. package/resources/v1/subscriptions/future-update.d.ts +15 -19
  266. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  267. package/resources/v1/subscriptions/future-update.js +6 -2
  268. package/resources/v1/subscriptions/future-update.js.map +1 -1
  269. package/resources/v1/subscriptions/future-update.mjs +6 -2
  270. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  271. package/resources/v1/subscriptions/index.d.mts +4 -2
  272. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  273. package/resources/v1/subscriptions/index.d.ts +4 -2
  274. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  275. package/resources/v1/subscriptions/index.js +5 -1
  276. package/resources/v1/subscriptions/index.js.map +1 -1
  277. package/resources/v1/subscriptions/index.mjs +3 -1
  278. package/resources/v1/subscriptions/index.mjs.map +1 -1
  279. package/resources/v1/subscriptions/invoice.d.mts +37 -0
  280. package/resources/v1/subscriptions/invoice.d.mts.map +1 -0
  281. package/resources/v1/subscriptions/invoice.d.ts +37 -0
  282. package/resources/v1/subscriptions/invoice.d.ts.map +1 -0
  283. package/resources/v1/subscriptions/invoice.js +20 -0
  284. package/resources/v1/subscriptions/invoice.js.map +1 -0
  285. package/resources/v1/subscriptions/invoice.mjs +16 -0
  286. package/resources/v1/subscriptions/invoice.mjs.map +1 -0
  287. package/resources/v1/subscriptions/subscriptions.d.mts +2547 -561
  288. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  289. package/resources/v1/subscriptions/subscriptions.d.ts +2547 -561
  290. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  291. package/resources/v1/subscriptions/subscriptions.js +47 -11
  292. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  293. package/resources/v1/subscriptions/subscriptions.mjs +49 -13
  294. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  295. package/resources/v1/subscriptions/usage.d.mts +101 -0
  296. package/resources/v1/subscriptions/usage.d.mts.map +1 -0
  297. package/resources/v1/subscriptions/usage.d.ts +101 -0
  298. package/resources/v1/subscriptions/usage.d.ts.map +1 -0
  299. package/resources/v1/subscriptions/usage.js +27 -0
  300. package/resources/v1/subscriptions/usage.js.map +1 -0
  301. package/resources/v1/subscriptions/usage.mjs +23 -0
  302. package/resources/v1/subscriptions/usage.mjs.map +1 -0
  303. package/resources/v1/usage.d.mts +238 -0
  304. package/resources/v1/usage.d.mts.map +1 -0
  305. package/resources/v1/usage.d.ts +238 -0
  306. package/resources/v1/usage.d.ts.map +1 -0
  307. package/resources/v1/usage.js +27 -0
  308. package/resources/v1/usage.js.map +1 -0
  309. package/resources/v1/usage.mjs +23 -0
  310. package/resources/v1/usage.mjs.map +1 -0
  311. package/resources/v1/v1.d.mts +30 -149
  312. package/resources/v1/v1.d.mts.map +1 -1
  313. package/resources/v1/v1.d.ts +30 -149
  314. package/resources/v1/v1.d.ts.map +1 -1
  315. package/resources/v1/v1.js +24 -12
  316. package/resources/v1/v1.js.map +1 -1
  317. package/resources/v1/v1.mjs +24 -12
  318. package/resources/v1/v1.mjs.map +1 -1
  319. package/src/client.ts +41 -47
  320. package/src/internal/parse.ts +6 -0
  321. package/src/internal/qs/LICENSE.md +13 -0
  322. package/src/internal/qs/README.md +3 -0
  323. package/src/internal/qs/formats.ts +10 -0
  324. package/src/internal/qs/index.ts +13 -0
  325. package/src/internal/qs/stringify.ts +385 -0
  326. package/src/internal/qs/types.ts +71 -0
  327. package/src/internal/qs/utils.ts +265 -0
  328. package/src/internal/utils/query.ts +7 -0
  329. package/src/internal/utils.ts +1 -0
  330. package/src/resources/index.ts +1 -7
  331. package/src/resources/v1/addons/addons.ts +3253 -0
  332. package/src/resources/v1/addons/entitlements.ts +1120 -0
  333. package/src/resources/v1/addons/index.ts +26 -0
  334. package/src/resources/v1/addons.ts +3 -0
  335. package/src/resources/v1/coupons.ts +126 -216
  336. package/src/resources/v1/customers/customers.ts +296 -61
  337. package/src/resources/v1/customers/index.ts +16 -2
  338. package/src/resources/v1/customers/payment-method.ts +10 -2
  339. package/src/resources/v1/customers/promotional-entitlements.ts +672 -0
  340. package/src/resources/v1/events/credits/credits.ts +356 -0
  341. package/src/resources/v1/events/credits/grants.ts +795 -0
  342. package/src/resources/v1/events/credits/index.ts +20 -0
  343. package/src/resources/v1/events/credits.ts +3 -0
  344. package/src/resources/v1/events/events.ts +103 -0
  345. package/src/resources/v1/events/index.ts +13 -0
  346. package/src/resources/v1/events.ts +3 -0
  347. package/src/resources/v1/features.ts +574 -0
  348. package/src/resources/v1/index.ts +70 -15
  349. package/src/resources/v1/plans/entitlements.ts +1112 -0
  350. package/src/resources/v1/plans/index.ts +24 -0
  351. package/src/resources/v1/plans/plans.ts +2035 -0
  352. package/src/resources/v1/plans.ts +3 -0
  353. package/src/resources/v1/products.ts +426 -0
  354. package/src/resources/v1/subscriptions/future-update.ts +15 -27
  355. package/src/resources/v1/subscriptions/index.ts +15 -11
  356. package/src/resources/v1/subscriptions/invoice.ts +45 -0
  357. package/src/resources/v1/subscriptions/subscriptions.ts +5836 -777
  358. package/src/resources/v1/subscriptions/usage.ts +129 -0
  359. package/src/resources/v1/usage.ts +293 -0
  360. package/src/resources/v1/v1.ts +168 -197
  361. package/src/version.ts +1 -1
  362. package/version.d.mts +1 -1
  363. package/version.d.mts.map +1 -1
  364. package/version.d.ts +1 -1
  365. package/version.d.ts.map +1 -1
  366. package/version.js +1 -1
  367. package/version.js.map +1 -1
  368. package/version.mjs +1 -1
  369. package/version.mjs.map +1 -1
  370. package/resources/v1/customers/usage.d.mts +0 -98
  371. package/resources/v1/customers/usage.d.mts.map +0 -1
  372. package/resources/v1/customers/usage.d.ts +0 -98
  373. package/resources/v1/customers/usage.d.ts.map +0 -1
  374. package/resources/v1/customers/usage.js +0 -20
  375. package/resources/v1/customers/usage.js.map +0 -1
  376. package/resources/v1/customers/usage.mjs +0 -16
  377. package/resources/v1/customers/usage.mjs.map +0 -1
  378. package/src/resources/v1/customers/usage.ts +0 -132
@@ -0,0 +1,1305 @@
1
+ import { APIResource } from "../../../core/resource.mjs";
2
+ import * as EntitlementsAPI from "./entitlements.mjs";
3
+ import { AddonPackageEntitlement, EntitlementCreateParams, EntitlementCreateResponse, EntitlementDeleteParams, EntitlementListResponse, EntitlementUpdateParams, Entitlements } from "./entitlements.mjs";
4
+ import { APIPromise } from "../../../core/api-promise.mjs";
5
+ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
6
+ import { RequestOptions } from "../../../internal/request-options.mjs";
7
+ /**
8
+ * Operations related to addons
9
+ */
10
+ export declare class Addons extends APIResource {
11
+ entitlements: EntitlementsAPI.Entitlements;
12
+ /**
13
+ * Creates a new addon in draft status, associated with a specific product.
14
+ */
15
+ create(body: AddonCreateParams, options?: RequestOptions): APIPromise<Addon>;
16
+ /**
17
+ * Retrieves an addon by its unique identifier, including entitlements and pricing
18
+ * details.
19
+ */
20
+ retrieve(id: string, options?: RequestOptions): APIPromise<Addon>;
21
+ /**
22
+ * Updates an existing addon's properties such as display name, description, and
23
+ * metadata.
24
+ */
25
+ update(id: string, body: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon>;
26
+ /**
27
+ * Retrieves a paginated list of addons in the environment.
28
+ */
29
+ list(query?: AddonListParams | null | undefined, options?: RequestOptions): PagePromise<AddonListResponsesMyCursorIDPage, AddonListResponse>;
30
+ /**
31
+ * Archives an addon, preventing it from being used in new subscriptions.
32
+ */
33
+ archive(id: string, options?: RequestOptions): APIPromise<Addon>;
34
+ /**
35
+ * Creates a draft version of an existing addon for modification before publishing.
36
+ */
37
+ createDraft(id: string, options?: RequestOptions): APIPromise<Addon>;
38
+ /**
39
+ * Publishes a draft addon, making it available for use in subscriptions.
40
+ */
41
+ publish(id: string, body: AddonPublishParams, options?: RequestOptions): APIPromise<AddonPublishResponse>;
42
+ /**
43
+ * Removes a draft version of an addon.
44
+ */
45
+ removeDraft(id: string, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse>;
46
+ /**
47
+ * Sets the pricing configuration for an addon.
48
+ */
49
+ setPricing(id: string, body: AddonSetPricingParams, options?: RequestOptions): APIPromise<SetPackagePricingResponse>;
50
+ }
51
+ export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
52
+ /**
53
+ * Response object
54
+ */
55
+ export interface Addon {
56
+ /**
57
+ * Addon configuration object
58
+ */
59
+ data: Addon.Data;
60
+ }
61
+ export declare namespace Addon {
62
+ /**
63
+ * Addon configuration object
64
+ */
65
+ interface Data {
66
+ /**
67
+ * The unique identifier for the entity
68
+ */
69
+ id: string;
70
+ /**
71
+ * The unique identifier for the entity in the billing provider
72
+ */
73
+ billingId: string | null;
74
+ /**
75
+ * Timestamp of when the record was created
76
+ */
77
+ createdAt: string;
78
+ /**
79
+ * List of addons the addon is dependant on
80
+ */
81
+ dependencies: Array<string> | null;
82
+ /**
83
+ * The description of the package
84
+ */
85
+ description: string | null;
86
+ /**
87
+ * The display name of the package
88
+ */
89
+ displayName: string;
90
+ /**
91
+ * List of entitlements of the package
92
+ */
93
+ entitlements: Array<Data.Entitlement>;
94
+ /**
95
+ * Indicates if the package is the latest version
96
+ */
97
+ isLatest: boolean | null;
98
+ /**
99
+ * The maximum quantity of this addon that can be added to a subscription
100
+ */
101
+ maxQuantity: number | null;
102
+ /**
103
+ * Metadata associated with the entity
104
+ */
105
+ metadata: {
106
+ [key: string]: string;
107
+ };
108
+ /**
109
+ * The pricing type of the package
110
+ */
111
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
112
+ /**
113
+ * The product id of the package
114
+ */
115
+ productId: string;
116
+ /**
117
+ * The status of the package
118
+ */
119
+ status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
120
+ /**
121
+ * Timestamp of when the record was last updated
122
+ */
123
+ updatedAt: string;
124
+ /**
125
+ * The version number of the package
126
+ */
127
+ versionNumber: number;
128
+ }
129
+ namespace Data {
130
+ /**
131
+ * Entitlement reference with type and identifier
132
+ */
133
+ interface Entitlement {
134
+ /**
135
+ * The unique identifier for the entity
136
+ */
137
+ id: string;
138
+ type: 'FEATURE' | 'CREDIT';
139
+ }
140
+ }
141
+ }
142
+ /**
143
+ * Request to set the pricing configuration for a plan or addon.
144
+ */
145
+ export interface SetPackagePricing {
146
+ /**
147
+ * The pricing type (FREE, PAID, or CUSTOM)
148
+ */
149
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
150
+ /**
151
+ * Deprecated: billing integration ID
152
+ */
153
+ billingId?: string;
154
+ /**
155
+ * Minimum spend configuration per billing period
156
+ */
157
+ minimumSpend?: Array<SetPackagePricing.MinimumSpend> | null;
158
+ /**
159
+ * When overage charges are billed
160
+ */
161
+ overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
162
+ /**
163
+ * Array of overage pricing model configurations
164
+ */
165
+ overagePricingModels?: Array<SetPackagePricing.OveragePricingModel>;
166
+ /**
167
+ * Array of pricing model configurations
168
+ */
169
+ pricingModels?: Array<SetPackagePricing.PricingModel>;
170
+ }
171
+ export declare namespace SetPackagePricing {
172
+ /**
173
+ * Minimum spend configuration for a billing period.
174
+ */
175
+ interface MinimumSpend {
176
+ /**
177
+ * The billing period
178
+ */
179
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
180
+ /**
181
+ * The minimum spend amount
182
+ */
183
+ minimum: MinimumSpend.Minimum;
184
+ }
185
+ namespace MinimumSpend {
186
+ /**
187
+ * The minimum spend amount
188
+ */
189
+ interface Minimum {
190
+ /**
191
+ * The price amount
192
+ */
193
+ amount: number;
194
+ /**
195
+ * The price currency
196
+ */
197
+ 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';
198
+ }
199
+ }
200
+ /**
201
+ * Overage pricing model configuration.
202
+ */
203
+ interface OveragePricingModel {
204
+ /**
205
+ * The billing model for overages
206
+ */
207
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
208
+ /**
209
+ * Price periods for overage pricing
210
+ */
211
+ pricePeriods: Array<OveragePricingModel.PricePeriod>;
212
+ /**
213
+ * The billing cadence for overages
214
+ */
215
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
216
+ /**
217
+ * Entitlement configuration for the overage feature
218
+ */
219
+ entitlement?: OveragePricingModel.Entitlement;
220
+ /**
221
+ * The feature ID for overage pricing
222
+ */
223
+ featureId?: string;
224
+ /**
225
+ * Custom currency ID for overage top-up
226
+ */
227
+ topUpCustomCurrencyId?: string;
228
+ }
229
+ namespace OveragePricingModel {
230
+ /**
231
+ * Price configuration for a specific billing period.
232
+ */
233
+ interface PricePeriod {
234
+ /**
235
+ * The billing period (MONTHLY or ANNUALLY)
236
+ */
237
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
238
+ /**
239
+ * ISO country code for localized pricing
240
+ */
241
+ billingCountryCode?: string;
242
+ /**
243
+ * Block size for usage-based pricing
244
+ */
245
+ blockSize?: number;
246
+ /**
247
+ * When credits are granted
248
+ */
249
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
250
+ /**
251
+ * Credit rate configuration for credit-based pricing
252
+ */
253
+ creditRate?: PricePeriod.CreditRate;
254
+ /**
255
+ * The price amount and currency
256
+ */
257
+ price?: PricePeriod.Price;
258
+ /**
259
+ * Tiered pricing configuration
260
+ */
261
+ tiers?: Array<PricePeriod.Tier>;
262
+ }
263
+ namespace PricePeriod {
264
+ /**
265
+ * Credit rate configuration for credit-based pricing
266
+ */
267
+ interface CreditRate {
268
+ /**
269
+ * The credit rate amount
270
+ */
271
+ amount: number;
272
+ /**
273
+ * The custom currency ID
274
+ */
275
+ currencyId: string;
276
+ /**
277
+ * Optional cost formula expression
278
+ */
279
+ costFormula?: string;
280
+ }
281
+ /**
282
+ * The price amount and currency
283
+ */
284
+ interface Price {
285
+ /**
286
+ * The price amount
287
+ */
288
+ amount: number;
289
+ /**
290
+ * The price currency
291
+ */
292
+ 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';
293
+ }
294
+ /**
295
+ * A tier in tiered pricing.
296
+ */
297
+ interface Tier {
298
+ /**
299
+ * Flat price for this tier
300
+ */
301
+ flatPrice?: Tier.FlatPrice;
302
+ /**
303
+ * Per-unit price in this tier
304
+ */
305
+ unitPrice?: Tier.UnitPrice;
306
+ /**
307
+ * Upper bound of this tier (null for unlimited)
308
+ */
309
+ upTo?: number;
310
+ }
311
+ namespace Tier {
312
+ /**
313
+ * Flat price for this tier
314
+ */
315
+ interface FlatPrice {
316
+ /**
317
+ * The price amount
318
+ */
319
+ amount: number;
320
+ /**
321
+ * The price currency
322
+ */
323
+ 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';
324
+ }
325
+ /**
326
+ * Per-unit price in this tier
327
+ */
328
+ interface UnitPrice {
329
+ /**
330
+ * The price amount
331
+ */
332
+ amount: number;
333
+ /**
334
+ * The price currency
335
+ */
336
+ 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';
337
+ }
338
+ }
339
+ }
340
+ /**
341
+ * Entitlement configuration for the overage feature
342
+ */
343
+ interface Entitlement {
344
+ /**
345
+ * The feature ID for the entitlement
346
+ */
347
+ featureId: string;
348
+ /**
349
+ * Whether the limit is soft (allows overage)
350
+ */
351
+ hasSoftLimit?: boolean;
352
+ /**
353
+ * Whether usage is unlimited
354
+ */
355
+ hasUnlimitedUsage?: boolean;
356
+ /**
357
+ * Monthly reset configuration
358
+ */
359
+ monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
360
+ /**
361
+ * The usage reset period
362
+ */
363
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
364
+ /**
365
+ * The usage limit before overage kicks in
366
+ */
367
+ usageLimit?: number;
368
+ /**
369
+ * Weekly reset configuration
370
+ */
371
+ weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
372
+ /**
373
+ * Yearly reset configuration
374
+ */
375
+ yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
376
+ }
377
+ namespace Entitlement {
378
+ /**
379
+ * Monthly reset configuration
380
+ */
381
+ interface MonthlyResetPeriodConfiguration {
382
+ /**
383
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
384
+ */
385
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
386
+ }
387
+ /**
388
+ * Weekly reset configuration
389
+ */
390
+ interface WeeklyResetPeriodConfiguration {
391
+ /**
392
+ * Reset anchor (SubscriptionStart or specific day)
393
+ */
394
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
395
+ }
396
+ /**
397
+ * Yearly reset configuration
398
+ */
399
+ interface YearlyResetPeriodConfiguration {
400
+ /**
401
+ * Reset anchor (SubscriptionStart)
402
+ */
403
+ accordingTo: 'SubscriptionStart';
404
+ }
405
+ }
406
+ }
407
+ /**
408
+ * A pricing model configuration with billing details and price periods.
409
+ */
410
+ interface PricingModel {
411
+ /**
412
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
413
+ */
414
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
415
+ /**
416
+ * Array of price period configurations (at least one required)
417
+ */
418
+ pricePeriods: Array<PricingModel.PricePeriod>;
419
+ /**
420
+ * The billing cadence (RECURRING or ONE_OFF)
421
+ */
422
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
423
+ /**
424
+ * The feature ID this pricing model is associated with
425
+ */
426
+ featureId?: string;
427
+ /**
428
+ * Maximum number of units (max 999999)
429
+ */
430
+ maxUnitQuantity?: number;
431
+ /**
432
+ * Minimum number of units
433
+ */
434
+ minUnitQuantity?: number;
435
+ /**
436
+ * Monthly reset period configuration
437
+ */
438
+ monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
439
+ /**
440
+ * The usage reset period
441
+ */
442
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
443
+ /**
444
+ * The tiered pricing mode (VOLUME or GRADUATED)
445
+ */
446
+ tiersMode?: 'VOLUME' | 'GRADUATED';
447
+ /**
448
+ * The custom currency ID for top-up pricing
449
+ */
450
+ topUpCustomCurrencyId?: string;
451
+ /**
452
+ * Weekly reset period configuration
453
+ */
454
+ weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
455
+ /**
456
+ * Yearly reset period configuration
457
+ */
458
+ yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
459
+ }
460
+ namespace PricingModel {
461
+ /**
462
+ * Price configuration for a specific billing period.
463
+ */
464
+ interface PricePeriod {
465
+ /**
466
+ * The billing period (MONTHLY or ANNUALLY)
467
+ */
468
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
469
+ /**
470
+ * ISO country code for localized pricing
471
+ */
472
+ billingCountryCode?: string;
473
+ /**
474
+ * Block size for usage-based pricing
475
+ */
476
+ blockSize?: number;
477
+ /**
478
+ * When credits are granted
479
+ */
480
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
481
+ /**
482
+ * Credit rate configuration for credit-based pricing
483
+ */
484
+ creditRate?: PricePeriod.CreditRate;
485
+ /**
486
+ * The price amount and currency
487
+ */
488
+ price?: PricePeriod.Price;
489
+ /**
490
+ * Tiered pricing configuration
491
+ */
492
+ tiers?: Array<PricePeriod.Tier>;
493
+ }
494
+ namespace PricePeriod {
495
+ /**
496
+ * Credit rate configuration for credit-based pricing
497
+ */
498
+ interface CreditRate {
499
+ /**
500
+ * The credit rate amount
501
+ */
502
+ amount: number;
503
+ /**
504
+ * The custom currency ID
505
+ */
506
+ currencyId: string;
507
+ /**
508
+ * Optional cost formula expression
509
+ */
510
+ costFormula?: string;
511
+ }
512
+ /**
513
+ * The price amount and currency
514
+ */
515
+ interface Price {
516
+ /**
517
+ * The price amount
518
+ */
519
+ amount: number;
520
+ /**
521
+ * The price currency
522
+ */
523
+ 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';
524
+ }
525
+ /**
526
+ * A tier in tiered pricing.
527
+ */
528
+ interface Tier {
529
+ /**
530
+ * Flat price for this tier
531
+ */
532
+ flatPrice?: Tier.FlatPrice;
533
+ /**
534
+ * Per-unit price in this tier
535
+ */
536
+ unitPrice?: Tier.UnitPrice;
537
+ /**
538
+ * Upper bound of this tier (null for unlimited)
539
+ */
540
+ upTo?: number;
541
+ }
542
+ namespace Tier {
543
+ /**
544
+ * Flat price for this tier
545
+ */
546
+ interface FlatPrice {
547
+ /**
548
+ * The price amount
549
+ */
550
+ amount: number;
551
+ /**
552
+ * The price currency
553
+ */
554
+ 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';
555
+ }
556
+ /**
557
+ * Per-unit price in this tier
558
+ */
559
+ interface UnitPrice {
560
+ /**
561
+ * The price amount
562
+ */
563
+ amount: number;
564
+ /**
565
+ * The price currency
566
+ */
567
+ 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';
568
+ }
569
+ }
570
+ }
571
+ /**
572
+ * Monthly reset period configuration
573
+ */
574
+ interface MonthlyResetPeriodConfiguration {
575
+ /**
576
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
577
+ */
578
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
579
+ }
580
+ /**
581
+ * Weekly reset period configuration
582
+ */
583
+ interface WeeklyResetPeriodConfiguration {
584
+ /**
585
+ * Reset anchor (SubscriptionStart or specific day)
586
+ */
587
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
588
+ }
589
+ /**
590
+ * Yearly reset period configuration
591
+ */
592
+ interface YearlyResetPeriodConfiguration {
593
+ /**
594
+ * Reset anchor (SubscriptionStart)
595
+ */
596
+ accordingTo: 'SubscriptionStart';
597
+ }
598
+ }
599
+ }
600
+ /**
601
+ * Response object
602
+ */
603
+ export interface SetPackagePricingResponse {
604
+ /**
605
+ * Result of setting package pricing.
606
+ */
607
+ data: SetPackagePricingResponse.Data;
608
+ }
609
+ export declare namespace SetPackagePricingResponse {
610
+ /**
611
+ * Result of setting package pricing.
612
+ */
613
+ interface Data {
614
+ /**
615
+ * The package identifier (refId)
616
+ */
617
+ id: string;
618
+ /**
619
+ * The pricing type that was set
620
+ */
621
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
622
+ }
623
+ }
624
+ /**
625
+ * Addon configuration object
626
+ */
627
+ export interface AddonListResponse {
628
+ /**
629
+ * The unique identifier for the entity
630
+ */
631
+ id: string;
632
+ /**
633
+ * The unique identifier for the entity in the billing provider
634
+ */
635
+ billingId: string | null;
636
+ /**
637
+ * Timestamp of when the record was created
638
+ */
639
+ createdAt: string;
640
+ /**
641
+ * List of addons the addon is dependant on
642
+ */
643
+ dependencies: Array<string> | null;
644
+ /**
645
+ * The description of the package
646
+ */
647
+ description: string | null;
648
+ /**
649
+ * The display name of the package
650
+ */
651
+ displayName: string;
652
+ /**
653
+ * List of entitlements of the package
654
+ */
655
+ entitlements: Array<AddonListResponse.Entitlement>;
656
+ /**
657
+ * Indicates if the package is the latest version
658
+ */
659
+ isLatest: boolean | null;
660
+ /**
661
+ * The maximum quantity of this addon that can be added to a subscription
662
+ */
663
+ maxQuantity: number | null;
664
+ /**
665
+ * Metadata associated with the entity
666
+ */
667
+ metadata: {
668
+ [key: string]: string;
669
+ };
670
+ /**
671
+ * The pricing type of the package
672
+ */
673
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
674
+ /**
675
+ * The product id of the package
676
+ */
677
+ productId: string;
678
+ /**
679
+ * The status of the package
680
+ */
681
+ status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
682
+ /**
683
+ * Timestamp of when the record was last updated
684
+ */
685
+ updatedAt: string;
686
+ /**
687
+ * The version number of the package
688
+ */
689
+ versionNumber: number;
690
+ }
691
+ export declare namespace AddonListResponse {
692
+ /**
693
+ * Entitlement reference with type and identifier
694
+ */
695
+ interface Entitlement {
696
+ /**
697
+ * The unique identifier for the entity
698
+ */
699
+ id: string;
700
+ type: 'FEATURE' | 'CREDIT';
701
+ }
702
+ }
703
+ /**
704
+ * Response containing task ID for publish operation
705
+ */
706
+ export interface AddonPublishResponse {
707
+ data: AddonPublishResponse.Data;
708
+ }
709
+ export declare namespace AddonPublishResponse {
710
+ interface Data {
711
+ /**
712
+ * Task ID for tracking the async publish operation
713
+ */
714
+ taskId: string | null;
715
+ }
716
+ }
717
+ /**
718
+ * Response confirming the addon draft was removed.
719
+ */
720
+ export interface AddonRemoveDraftResponse {
721
+ data: AddonRemoveDraftResponse.Data;
722
+ }
723
+ export declare namespace AddonRemoveDraftResponse {
724
+ interface Data {
725
+ /**
726
+ * The unique identifier for the entity
727
+ */
728
+ id: string;
729
+ }
730
+ }
731
+ export interface AddonCreateParams {
732
+ /**
733
+ * The unique identifier for the entity
734
+ */
735
+ id: string;
736
+ /**
737
+ * The display name of the package
738
+ */
739
+ displayName: string;
740
+ /**
741
+ * The product id of the package
742
+ */
743
+ productId: string;
744
+ /**
745
+ * The unique identifier for the entity in the billing provider
746
+ */
747
+ billingId?: string | null;
748
+ /**
749
+ * The description of the package
750
+ */
751
+ description?: string | null;
752
+ /**
753
+ * The maximum quantity of this addon that can be added to a subscription
754
+ */
755
+ maxQuantity?: number | null;
756
+ /**
757
+ * Metadata associated with the entity
758
+ */
759
+ metadata?: {
760
+ [key: string]: string;
761
+ };
762
+ /**
763
+ * The pricing type of the package
764
+ */
765
+ pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
766
+ /**
767
+ * The status of the package
768
+ */
769
+ status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
770
+ }
771
+ export interface AddonUpdateParams {
772
+ /**
773
+ * The unique identifier for the entity in the billing provider
774
+ */
775
+ billingId?: string | null;
776
+ /**
777
+ * List of addons the addon is dependant on
778
+ */
779
+ dependencies?: Array<string> | null;
780
+ /**
781
+ * The description of the package
782
+ */
783
+ description?: string | null;
784
+ /**
785
+ * The display name of the package
786
+ */
787
+ displayName?: string;
788
+ /**
789
+ * The maximum quantity of this addon that can be added to a subscription
790
+ */
791
+ maxQuantity?: number | null;
792
+ /**
793
+ * Metadata associated with the entity
794
+ */
795
+ metadata?: {
796
+ [key: string]: string;
797
+ };
798
+ /**
799
+ * The status of the package
800
+ */
801
+ status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
802
+ }
803
+ export interface AddonListParams extends MyCursorIDPageParams {
804
+ /**
805
+ * Filter by creation date using range operators: gt, gte, lt, lte
806
+ */
807
+ createdAt?: AddonListParams.CreatedAt;
808
+ /**
809
+ * Filter by product ID
810
+ */
811
+ productId?: string;
812
+ /**
813
+ * Filter by status. Supports comma-separated values for multiple statuses
814
+ */
815
+ status?: string;
816
+ }
817
+ export declare namespace AddonListParams {
818
+ /**
819
+ * Filter by creation date using range operators: gt, gte, lt, lte
820
+ */
821
+ interface CreatedAt {
822
+ /**
823
+ * Greater than the specified createdAt value
824
+ */
825
+ gt?: string;
826
+ /**
827
+ * Greater than or equal to the specified createdAt value
828
+ */
829
+ gte?: string;
830
+ /**
831
+ * Less than the specified createdAt value
832
+ */
833
+ lt?: string;
834
+ /**
835
+ * Less than or equal to the specified createdAt value
836
+ */
837
+ lte?: string;
838
+ }
839
+ }
840
+ export interface AddonPublishParams {
841
+ /**
842
+ * The migration type of the package
843
+ */
844
+ migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
845
+ }
846
+ export interface AddonSetPricingParams {
847
+ /**
848
+ * The pricing type (FREE, PAID, or CUSTOM)
849
+ */
850
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
851
+ /**
852
+ * Deprecated: billing integration ID
853
+ */
854
+ billingId?: string;
855
+ /**
856
+ * Minimum spend configuration per billing period
857
+ */
858
+ minimumSpend?: Array<AddonSetPricingParams.MinimumSpend> | null;
859
+ /**
860
+ * When overage charges are billed
861
+ */
862
+ overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
863
+ /**
864
+ * Array of overage pricing model configurations
865
+ */
866
+ overagePricingModels?: Array<AddonSetPricingParams.OveragePricingModel>;
867
+ /**
868
+ * Array of pricing model configurations
869
+ */
870
+ pricingModels?: Array<AddonSetPricingParams.PricingModel>;
871
+ }
872
+ export declare namespace AddonSetPricingParams {
873
+ /**
874
+ * Minimum spend configuration for a billing period.
875
+ */
876
+ interface MinimumSpend {
877
+ /**
878
+ * The billing period
879
+ */
880
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
881
+ /**
882
+ * The minimum spend amount
883
+ */
884
+ minimum: MinimumSpend.Minimum;
885
+ }
886
+ namespace MinimumSpend {
887
+ /**
888
+ * The minimum spend amount
889
+ */
890
+ interface Minimum {
891
+ /**
892
+ * The price amount
893
+ */
894
+ amount: number;
895
+ /**
896
+ * The price currency
897
+ */
898
+ 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';
899
+ }
900
+ }
901
+ /**
902
+ * Overage pricing model configuration.
903
+ */
904
+ interface OveragePricingModel {
905
+ /**
906
+ * The billing model for overages
907
+ */
908
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
909
+ /**
910
+ * Price periods for overage pricing
911
+ */
912
+ pricePeriods: Array<OveragePricingModel.PricePeriod>;
913
+ /**
914
+ * The billing cadence for overages
915
+ */
916
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
917
+ /**
918
+ * Entitlement configuration for the overage feature
919
+ */
920
+ entitlement?: OveragePricingModel.Entitlement;
921
+ /**
922
+ * The feature ID for overage pricing
923
+ */
924
+ featureId?: string;
925
+ /**
926
+ * Custom currency ID for overage top-up
927
+ */
928
+ topUpCustomCurrencyId?: string;
929
+ }
930
+ namespace OveragePricingModel {
931
+ /**
932
+ * Price configuration for a specific billing period.
933
+ */
934
+ interface PricePeriod {
935
+ /**
936
+ * The billing period (MONTHLY or ANNUALLY)
937
+ */
938
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
939
+ /**
940
+ * ISO country code for localized pricing
941
+ */
942
+ billingCountryCode?: string;
943
+ /**
944
+ * Block size for usage-based pricing
945
+ */
946
+ blockSize?: number;
947
+ /**
948
+ * When credits are granted
949
+ */
950
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
951
+ /**
952
+ * Credit rate configuration for credit-based pricing
953
+ */
954
+ creditRate?: PricePeriod.CreditRate;
955
+ /**
956
+ * The price amount and currency
957
+ */
958
+ price?: PricePeriod.Price;
959
+ /**
960
+ * Tiered pricing configuration
961
+ */
962
+ tiers?: Array<PricePeriod.Tier>;
963
+ }
964
+ namespace PricePeriod {
965
+ /**
966
+ * Credit rate configuration for credit-based pricing
967
+ */
968
+ interface CreditRate {
969
+ /**
970
+ * The credit rate amount
971
+ */
972
+ amount: number;
973
+ /**
974
+ * The custom currency ID
975
+ */
976
+ currencyId: string;
977
+ /**
978
+ * Optional cost formula expression
979
+ */
980
+ costFormula?: string;
981
+ }
982
+ /**
983
+ * The price amount and currency
984
+ */
985
+ interface Price {
986
+ /**
987
+ * The price amount
988
+ */
989
+ amount: number;
990
+ /**
991
+ * The price currency
992
+ */
993
+ 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';
994
+ }
995
+ /**
996
+ * A tier in tiered pricing.
997
+ */
998
+ interface Tier {
999
+ /**
1000
+ * Flat price for this tier
1001
+ */
1002
+ flatPrice?: Tier.FlatPrice;
1003
+ /**
1004
+ * Per-unit price in this tier
1005
+ */
1006
+ unitPrice?: Tier.UnitPrice;
1007
+ /**
1008
+ * Upper bound of this tier (null for unlimited)
1009
+ */
1010
+ upTo?: number;
1011
+ }
1012
+ namespace Tier {
1013
+ /**
1014
+ * Flat price for this tier
1015
+ */
1016
+ interface FlatPrice {
1017
+ /**
1018
+ * The price amount
1019
+ */
1020
+ amount: number;
1021
+ /**
1022
+ * The price currency
1023
+ */
1024
+ 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';
1025
+ }
1026
+ /**
1027
+ * Per-unit price in this tier
1028
+ */
1029
+ interface UnitPrice {
1030
+ /**
1031
+ * The price amount
1032
+ */
1033
+ amount: number;
1034
+ /**
1035
+ * The price currency
1036
+ */
1037
+ 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';
1038
+ }
1039
+ }
1040
+ }
1041
+ /**
1042
+ * Entitlement configuration for the overage feature
1043
+ */
1044
+ interface Entitlement {
1045
+ /**
1046
+ * The feature ID for the entitlement
1047
+ */
1048
+ featureId: string;
1049
+ /**
1050
+ * Whether the limit is soft (allows overage)
1051
+ */
1052
+ hasSoftLimit?: boolean;
1053
+ /**
1054
+ * Whether usage is unlimited
1055
+ */
1056
+ hasUnlimitedUsage?: boolean;
1057
+ /**
1058
+ * Monthly reset configuration
1059
+ */
1060
+ monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
1061
+ /**
1062
+ * The usage reset period
1063
+ */
1064
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1065
+ /**
1066
+ * The usage limit before overage kicks in
1067
+ */
1068
+ usageLimit?: number;
1069
+ /**
1070
+ * Weekly reset configuration
1071
+ */
1072
+ weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
1073
+ /**
1074
+ * Yearly reset configuration
1075
+ */
1076
+ yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
1077
+ }
1078
+ namespace Entitlement {
1079
+ /**
1080
+ * Monthly reset configuration
1081
+ */
1082
+ interface MonthlyResetPeriodConfiguration {
1083
+ /**
1084
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
1085
+ */
1086
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1087
+ }
1088
+ /**
1089
+ * Weekly reset configuration
1090
+ */
1091
+ interface WeeklyResetPeriodConfiguration {
1092
+ /**
1093
+ * Reset anchor (SubscriptionStart or specific day)
1094
+ */
1095
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
1096
+ }
1097
+ /**
1098
+ * Yearly reset configuration
1099
+ */
1100
+ interface YearlyResetPeriodConfiguration {
1101
+ /**
1102
+ * Reset anchor (SubscriptionStart)
1103
+ */
1104
+ accordingTo: 'SubscriptionStart';
1105
+ }
1106
+ }
1107
+ }
1108
+ /**
1109
+ * A pricing model configuration with billing details and price periods.
1110
+ */
1111
+ interface PricingModel {
1112
+ /**
1113
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
1114
+ */
1115
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1116
+ /**
1117
+ * Array of price period configurations (at least one required)
1118
+ */
1119
+ pricePeriods: Array<PricingModel.PricePeriod>;
1120
+ /**
1121
+ * The billing cadence (RECURRING or ONE_OFF)
1122
+ */
1123
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
1124
+ /**
1125
+ * The feature ID this pricing model is associated with
1126
+ */
1127
+ featureId?: string;
1128
+ /**
1129
+ * Maximum number of units (max 999999)
1130
+ */
1131
+ maxUnitQuantity?: number;
1132
+ /**
1133
+ * Minimum number of units
1134
+ */
1135
+ minUnitQuantity?: number;
1136
+ /**
1137
+ * Monthly reset period configuration
1138
+ */
1139
+ monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
1140
+ /**
1141
+ * The usage reset period
1142
+ */
1143
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1144
+ /**
1145
+ * The tiered pricing mode (VOLUME or GRADUATED)
1146
+ */
1147
+ tiersMode?: 'VOLUME' | 'GRADUATED';
1148
+ /**
1149
+ * The custom currency ID for top-up pricing
1150
+ */
1151
+ topUpCustomCurrencyId?: string;
1152
+ /**
1153
+ * Weekly reset period configuration
1154
+ */
1155
+ weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
1156
+ /**
1157
+ * Yearly reset period configuration
1158
+ */
1159
+ yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
1160
+ }
1161
+ namespace PricingModel {
1162
+ /**
1163
+ * Price configuration for a specific billing period.
1164
+ */
1165
+ interface PricePeriod {
1166
+ /**
1167
+ * The billing period (MONTHLY or ANNUALLY)
1168
+ */
1169
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
1170
+ /**
1171
+ * ISO country code for localized pricing
1172
+ */
1173
+ billingCountryCode?: string;
1174
+ /**
1175
+ * Block size for usage-based pricing
1176
+ */
1177
+ blockSize?: number;
1178
+ /**
1179
+ * When credits are granted
1180
+ */
1181
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1182
+ /**
1183
+ * Credit rate configuration for credit-based pricing
1184
+ */
1185
+ creditRate?: PricePeriod.CreditRate;
1186
+ /**
1187
+ * The price amount and currency
1188
+ */
1189
+ price?: PricePeriod.Price;
1190
+ /**
1191
+ * Tiered pricing configuration
1192
+ */
1193
+ tiers?: Array<PricePeriod.Tier>;
1194
+ }
1195
+ namespace PricePeriod {
1196
+ /**
1197
+ * Credit rate configuration for credit-based pricing
1198
+ */
1199
+ interface CreditRate {
1200
+ /**
1201
+ * The credit rate amount
1202
+ */
1203
+ amount: number;
1204
+ /**
1205
+ * The custom currency ID
1206
+ */
1207
+ currencyId: string;
1208
+ /**
1209
+ * Optional cost formula expression
1210
+ */
1211
+ costFormula?: string;
1212
+ }
1213
+ /**
1214
+ * The price amount and currency
1215
+ */
1216
+ interface Price {
1217
+ /**
1218
+ * The price amount
1219
+ */
1220
+ amount: number;
1221
+ /**
1222
+ * The price currency
1223
+ */
1224
+ 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';
1225
+ }
1226
+ /**
1227
+ * A tier in tiered pricing.
1228
+ */
1229
+ interface Tier {
1230
+ /**
1231
+ * Flat price for this tier
1232
+ */
1233
+ flatPrice?: Tier.FlatPrice;
1234
+ /**
1235
+ * Per-unit price in this tier
1236
+ */
1237
+ unitPrice?: Tier.UnitPrice;
1238
+ /**
1239
+ * Upper bound of this tier (null for unlimited)
1240
+ */
1241
+ upTo?: number;
1242
+ }
1243
+ namespace Tier {
1244
+ /**
1245
+ * Flat price for this tier
1246
+ */
1247
+ interface FlatPrice {
1248
+ /**
1249
+ * The price amount
1250
+ */
1251
+ amount: number;
1252
+ /**
1253
+ * The price currency
1254
+ */
1255
+ 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';
1256
+ }
1257
+ /**
1258
+ * Per-unit price in this tier
1259
+ */
1260
+ interface UnitPrice {
1261
+ /**
1262
+ * The price amount
1263
+ */
1264
+ amount: number;
1265
+ /**
1266
+ * The price currency
1267
+ */
1268
+ 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';
1269
+ }
1270
+ }
1271
+ }
1272
+ /**
1273
+ * Monthly reset period configuration
1274
+ */
1275
+ interface MonthlyResetPeriodConfiguration {
1276
+ /**
1277
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
1278
+ */
1279
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1280
+ }
1281
+ /**
1282
+ * Weekly reset period configuration
1283
+ */
1284
+ interface WeeklyResetPeriodConfiguration {
1285
+ /**
1286
+ * Reset anchor (SubscriptionStart or specific day)
1287
+ */
1288
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
1289
+ }
1290
+ /**
1291
+ * Yearly reset period configuration
1292
+ */
1293
+ interface YearlyResetPeriodConfiguration {
1294
+ /**
1295
+ * Reset anchor (SubscriptionStart)
1296
+ */
1297
+ accordingTo: 'SubscriptionStart';
1298
+ }
1299
+ }
1300
+ }
1301
+ export declare namespace Addons {
1302
+ export { type Addon as Addon, type SetPackagePricing as SetPackagePricing, type SetPackagePricingResponse as SetPackagePricingResponse, 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, type AddonSetPricingParams as AddonSetPricingParams, };
1303
+ 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, };
1304
+ }
1305
+ //# sourceMappingURL=addons.d.mts.map