@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,860 @@
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import { APIPromise } from "../../../core/api-promise.js";
3
+ import { RequestOptions } from "../../../internal/request-options.js";
4
+ export declare class Entitlements extends APIResource {
5
+ /**
6
+ * Creates one or more entitlements (feature or credit) on a draft addon.
7
+ */
8
+ create(addonID: string, body: EntitlementCreateParams, options?: RequestOptions): APIPromise<EntitlementCreateResponse>;
9
+ /**
10
+ * Updates an existing entitlement on a draft addon.
11
+ */
12
+ update(id: string, params: EntitlementUpdateParams, options?: RequestOptions): APIPromise<AddonPackageEntitlement>;
13
+ /**
14
+ * Retrieves a list of entitlements for an addon.
15
+ */
16
+ list(addonID: string, options?: RequestOptions): APIPromise<EntitlementListResponse>;
17
+ /**
18
+ * Deletes an entitlement from a draft addon.
19
+ */
20
+ delete(id: string, params: EntitlementDeleteParams, options?: RequestOptions): APIPromise<AddonPackageEntitlement>;
21
+ }
22
+ /**
23
+ * Response object
24
+ */
25
+ export interface AddonPackageEntitlement {
26
+ /**
27
+ * Feature entitlement response
28
+ */
29
+ data: AddonPackageEntitlement.Feature | AddonPackageEntitlement.Credit;
30
+ }
31
+ export declare namespace AddonPackageEntitlement {
32
+ /**
33
+ * Feature entitlement response
34
+ */
35
+ interface Feature {
36
+ /**
37
+ * Unique identifier of the entitlement
38
+ */
39
+ id: string;
40
+ /**
41
+ * Entitlement behavior (Increment or Override)
42
+ */
43
+ behavior: 'Increment' | 'Override';
44
+ /**
45
+ * Timestamp of when the record was created
46
+ */
47
+ createdAt: string;
48
+ /**
49
+ * Optional description of the entitlement
50
+ */
51
+ description: string | null;
52
+ /**
53
+ * Override display name for the entitlement
54
+ */
55
+ displayNameOverride: string | null;
56
+ /**
57
+ * Allowed enum values (for feature entitlements)
58
+ */
59
+ enumValues: Array<string> | null;
60
+ /**
61
+ * Whether the usage limit is a soft limit (for feature entitlements)
62
+ */
63
+ hasSoftLimit: boolean | null;
64
+ /**
65
+ * Whether usage is unlimited (for feature entitlements)
66
+ */
67
+ hasUnlimitedUsage: boolean | null;
68
+ /**
69
+ * Widget types where this entitlement is hidden
70
+ */
71
+ hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
72
+ /**
73
+ * Whether this is a custom entitlement
74
+ */
75
+ isCustom: boolean | null;
76
+ /**
77
+ * Whether the entitlement is granted
78
+ */
79
+ isGranted: boolean;
80
+ /**
81
+ * Display order of the entitlement
82
+ */
83
+ order: number | null;
84
+ /**
85
+ * Usage reset period (for feature entitlements)
86
+ */
87
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
88
+ /**
89
+ * Reset period configuration (for feature entitlements)
90
+ */
91
+ resetPeriodConfiguration: Feature.YearlyResetPeriodConfig | Feature.MonthlyResetPeriodConfig | Feature.WeeklyResetPeriodConfig | null;
92
+ /**
93
+ * Entitlement type (FEATURE or CREDIT)
94
+ */
95
+ type: 'FEATURE';
96
+ /**
97
+ * Timestamp of when the record was last updated
98
+ */
99
+ updatedAt: string;
100
+ /**
101
+ * Usage limit (for feature entitlements)
102
+ */
103
+ usageLimit: number | null;
104
+ }
105
+ namespace Feature {
106
+ /**
107
+ * Yearly reset configuration
108
+ */
109
+ interface YearlyResetPeriodConfig {
110
+ /**
111
+ * Reset anchor (SubscriptionStart)
112
+ */
113
+ accordingTo: 'SubscriptionStart';
114
+ }
115
+ /**
116
+ * Monthly reset configuration
117
+ */
118
+ interface MonthlyResetPeriodConfig {
119
+ /**
120
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
121
+ */
122
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
123
+ }
124
+ /**
125
+ * Weekly reset configuration
126
+ */
127
+ interface WeeklyResetPeriodConfig {
128
+ /**
129
+ * Reset anchor (SubscriptionStart or specific day)
130
+ */
131
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
132
+ }
133
+ }
134
+ /**
135
+ * Credit entitlement response
136
+ */
137
+ interface Credit {
138
+ /**
139
+ * Unique identifier of the entitlement
140
+ */
141
+ id: string;
142
+ /**
143
+ * Credit amount (for credit entitlements)
144
+ */
145
+ amount: number | null;
146
+ /**
147
+ * Entitlement behavior (Increment or Override)
148
+ */
149
+ behavior: 'Increment' | 'Override';
150
+ /**
151
+ * Credit grant cadence (for credit entitlements)
152
+ */
153
+ cadence: 'MONTH' | 'YEAR' | null;
154
+ /**
155
+ * Timestamp of when the record was created
156
+ */
157
+ createdAt: string;
158
+ /**
159
+ * Optional description of the entitlement
160
+ */
161
+ description: string | null;
162
+ /**
163
+ * Override display name for the entitlement
164
+ */
165
+ displayNameOverride: string | null;
166
+ /**
167
+ * Widget types where this entitlement is hidden
168
+ */
169
+ hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
170
+ /**
171
+ * Whether this is a custom entitlement
172
+ */
173
+ isCustom: boolean | null;
174
+ /**
175
+ * Whether the entitlement is granted
176
+ */
177
+ isGranted: boolean;
178
+ /**
179
+ * Display order of the entitlement
180
+ */
181
+ order: number | null;
182
+ /**
183
+ * Entitlement type (FEATURE or CREDIT)
184
+ */
185
+ type: 'CREDIT';
186
+ /**
187
+ * Timestamp of when the record was last updated
188
+ */
189
+ updatedAt: string;
190
+ }
191
+ }
192
+ /**
193
+ * Response object
194
+ */
195
+ export interface EntitlementCreateResponse {
196
+ data: Array<EntitlementCreateResponse.Feature | EntitlementCreateResponse.Credit>;
197
+ }
198
+ export declare namespace EntitlementCreateResponse {
199
+ /**
200
+ * Feature entitlement response
201
+ */
202
+ interface Feature {
203
+ /**
204
+ * Unique identifier of the entitlement
205
+ */
206
+ id: string;
207
+ /**
208
+ * Entitlement behavior (Increment or Override)
209
+ */
210
+ behavior: 'Increment' | 'Override';
211
+ /**
212
+ * Timestamp of when the record was created
213
+ */
214
+ createdAt: string;
215
+ /**
216
+ * Optional description of the entitlement
217
+ */
218
+ description: string | null;
219
+ /**
220
+ * Override display name for the entitlement
221
+ */
222
+ displayNameOverride: string | null;
223
+ /**
224
+ * Allowed enum values (for feature entitlements)
225
+ */
226
+ enumValues: Array<string> | null;
227
+ /**
228
+ * Whether the usage limit is a soft limit (for feature entitlements)
229
+ */
230
+ hasSoftLimit: boolean | null;
231
+ /**
232
+ * Whether usage is unlimited (for feature entitlements)
233
+ */
234
+ hasUnlimitedUsage: boolean | null;
235
+ /**
236
+ * Widget types where this entitlement is hidden
237
+ */
238
+ hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
239
+ /**
240
+ * Whether this is a custom entitlement
241
+ */
242
+ isCustom: boolean | null;
243
+ /**
244
+ * Whether the entitlement is granted
245
+ */
246
+ isGranted: boolean;
247
+ /**
248
+ * Display order of the entitlement
249
+ */
250
+ order: number | null;
251
+ /**
252
+ * Usage reset period (for feature entitlements)
253
+ */
254
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
255
+ /**
256
+ * Reset period configuration (for feature entitlements)
257
+ */
258
+ resetPeriodConfiguration: Feature.YearlyResetPeriodConfig | Feature.MonthlyResetPeriodConfig | Feature.WeeklyResetPeriodConfig | null;
259
+ /**
260
+ * Entitlement type (FEATURE or CREDIT)
261
+ */
262
+ type: 'FEATURE';
263
+ /**
264
+ * Timestamp of when the record was last updated
265
+ */
266
+ updatedAt: string;
267
+ /**
268
+ * Usage limit (for feature entitlements)
269
+ */
270
+ usageLimit: number | null;
271
+ }
272
+ namespace Feature {
273
+ /**
274
+ * Yearly reset configuration
275
+ */
276
+ interface YearlyResetPeriodConfig {
277
+ /**
278
+ * Reset anchor (SubscriptionStart)
279
+ */
280
+ accordingTo: 'SubscriptionStart';
281
+ }
282
+ /**
283
+ * Monthly reset configuration
284
+ */
285
+ interface MonthlyResetPeriodConfig {
286
+ /**
287
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
288
+ */
289
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
290
+ }
291
+ /**
292
+ * Weekly reset configuration
293
+ */
294
+ interface WeeklyResetPeriodConfig {
295
+ /**
296
+ * Reset anchor (SubscriptionStart or specific day)
297
+ */
298
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
299
+ }
300
+ }
301
+ /**
302
+ * Credit entitlement response
303
+ */
304
+ interface Credit {
305
+ /**
306
+ * Unique identifier of the entitlement
307
+ */
308
+ id: string;
309
+ /**
310
+ * Credit amount (for credit entitlements)
311
+ */
312
+ amount: number | null;
313
+ /**
314
+ * Entitlement behavior (Increment or Override)
315
+ */
316
+ behavior: 'Increment' | 'Override';
317
+ /**
318
+ * Credit grant cadence (for credit entitlements)
319
+ */
320
+ cadence: 'MONTH' | 'YEAR' | null;
321
+ /**
322
+ * Timestamp of when the record was created
323
+ */
324
+ createdAt: string;
325
+ /**
326
+ * Optional description of the entitlement
327
+ */
328
+ description: string | null;
329
+ /**
330
+ * Override display name for the entitlement
331
+ */
332
+ displayNameOverride: string | null;
333
+ /**
334
+ * Widget types where this entitlement is hidden
335
+ */
336
+ hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
337
+ /**
338
+ * Whether this is a custom entitlement
339
+ */
340
+ isCustom: boolean | null;
341
+ /**
342
+ * Whether the entitlement is granted
343
+ */
344
+ isGranted: boolean;
345
+ /**
346
+ * Display order of the entitlement
347
+ */
348
+ order: number | null;
349
+ /**
350
+ * Entitlement type (FEATURE or CREDIT)
351
+ */
352
+ type: 'CREDIT';
353
+ /**
354
+ * Timestamp of when the record was last updated
355
+ */
356
+ updatedAt: string;
357
+ }
358
+ }
359
+ /**
360
+ * Response list object
361
+ */
362
+ export interface EntitlementListResponse {
363
+ data: Array<EntitlementListResponse.Feature | EntitlementListResponse.Credit>;
364
+ /**
365
+ * Pagination metadata including cursors for navigating through results
366
+ */
367
+ pagination: EntitlementListResponse.Pagination;
368
+ }
369
+ export declare namespace EntitlementListResponse {
370
+ /**
371
+ * Feature entitlement response
372
+ */
373
+ interface Feature {
374
+ /**
375
+ * Unique identifier of the entitlement
376
+ */
377
+ id: string;
378
+ /**
379
+ * Entitlement behavior (Increment or Override)
380
+ */
381
+ behavior: 'Increment' | 'Override';
382
+ /**
383
+ * Timestamp of when the record was created
384
+ */
385
+ createdAt: string;
386
+ /**
387
+ * Optional description of the entitlement
388
+ */
389
+ description: string | null;
390
+ /**
391
+ * Override display name for the entitlement
392
+ */
393
+ displayNameOverride: string | null;
394
+ /**
395
+ * Allowed enum values (for feature entitlements)
396
+ */
397
+ enumValues: Array<string> | null;
398
+ /**
399
+ * Whether the usage limit is a soft limit (for feature entitlements)
400
+ */
401
+ hasSoftLimit: boolean | null;
402
+ /**
403
+ * Whether usage is unlimited (for feature entitlements)
404
+ */
405
+ hasUnlimitedUsage: boolean | null;
406
+ /**
407
+ * Widget types where this entitlement is hidden
408
+ */
409
+ hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
410
+ /**
411
+ * Whether this is a custom entitlement
412
+ */
413
+ isCustom: boolean | null;
414
+ /**
415
+ * Whether the entitlement is granted
416
+ */
417
+ isGranted: boolean;
418
+ /**
419
+ * Display order of the entitlement
420
+ */
421
+ order: number | null;
422
+ /**
423
+ * Usage reset period (for feature entitlements)
424
+ */
425
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
426
+ /**
427
+ * Reset period configuration (for feature entitlements)
428
+ */
429
+ resetPeriodConfiguration: Feature.YearlyResetPeriodConfig | Feature.MonthlyResetPeriodConfig | Feature.WeeklyResetPeriodConfig | null;
430
+ /**
431
+ * Entitlement type (FEATURE or CREDIT)
432
+ */
433
+ type: 'FEATURE';
434
+ /**
435
+ * Timestamp of when the record was last updated
436
+ */
437
+ updatedAt: string;
438
+ /**
439
+ * Usage limit (for feature entitlements)
440
+ */
441
+ usageLimit: number | null;
442
+ }
443
+ namespace Feature {
444
+ /**
445
+ * Yearly reset configuration
446
+ */
447
+ interface YearlyResetPeriodConfig {
448
+ /**
449
+ * Reset anchor (SubscriptionStart)
450
+ */
451
+ accordingTo: 'SubscriptionStart';
452
+ }
453
+ /**
454
+ * Monthly reset configuration
455
+ */
456
+ interface MonthlyResetPeriodConfig {
457
+ /**
458
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
459
+ */
460
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
461
+ }
462
+ /**
463
+ * Weekly reset configuration
464
+ */
465
+ interface WeeklyResetPeriodConfig {
466
+ /**
467
+ * Reset anchor (SubscriptionStart or specific day)
468
+ */
469
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
470
+ }
471
+ }
472
+ /**
473
+ * Credit entitlement response
474
+ */
475
+ interface Credit {
476
+ /**
477
+ * Unique identifier of the entitlement
478
+ */
479
+ id: string;
480
+ /**
481
+ * Credit amount (for credit entitlements)
482
+ */
483
+ amount: number | null;
484
+ /**
485
+ * Entitlement behavior (Increment or Override)
486
+ */
487
+ behavior: 'Increment' | 'Override';
488
+ /**
489
+ * Credit grant cadence (for credit entitlements)
490
+ */
491
+ cadence: 'MONTH' | 'YEAR' | null;
492
+ /**
493
+ * Timestamp of when the record was created
494
+ */
495
+ createdAt: string;
496
+ /**
497
+ * Optional description of the entitlement
498
+ */
499
+ description: string | null;
500
+ /**
501
+ * Override display name for the entitlement
502
+ */
503
+ displayNameOverride: string | null;
504
+ /**
505
+ * Widget types where this entitlement is hidden
506
+ */
507
+ hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
508
+ /**
509
+ * Whether this is a custom entitlement
510
+ */
511
+ isCustom: boolean | null;
512
+ /**
513
+ * Whether the entitlement is granted
514
+ */
515
+ isGranted: boolean;
516
+ /**
517
+ * Display order of the entitlement
518
+ */
519
+ order: number | null;
520
+ /**
521
+ * Entitlement type (FEATURE or CREDIT)
522
+ */
523
+ type: 'CREDIT';
524
+ /**
525
+ * Timestamp of when the record was last updated
526
+ */
527
+ updatedAt: string;
528
+ }
529
+ /**
530
+ * Pagination metadata including cursors for navigating through results
531
+ */
532
+ interface Pagination {
533
+ /**
534
+ * Cursor for fetching the next page of results, or null if no additional pages
535
+ * exist
536
+ */
537
+ next: string | null;
538
+ /**
539
+ * Cursor for fetching the previous page of results, or null if at the beginning
540
+ */
541
+ prev: string | null;
542
+ }
543
+ }
544
+ export interface EntitlementCreateParams {
545
+ /**
546
+ * Entitlements to create
547
+ */
548
+ entitlements: Array<EntitlementCreateParams.Feature | EntitlementCreateParams.Credit>;
549
+ }
550
+ export declare namespace EntitlementCreateParams {
551
+ /**
552
+ * Request to create a feature entitlement
553
+ */
554
+ interface Feature {
555
+ /**
556
+ * The feature ID to attach the entitlement to
557
+ */
558
+ id: string;
559
+ /**
560
+ * CreateFeatureEntitlementRequest
561
+ */
562
+ type: 'FEATURE';
563
+ /**
564
+ * Entitlement behavior (Increment or Override)
565
+ */
566
+ behavior?: 'Increment' | 'Override';
567
+ /**
568
+ * Description of the entitlement
569
+ */
570
+ description?: string;
571
+ /**
572
+ * Override display name for the entitlement
573
+ */
574
+ displayNameOverride?: string;
575
+ /**
576
+ * Allowed enum values for the feature entitlement
577
+ */
578
+ enumValues?: Array<string>;
579
+ /**
580
+ * Whether the usage limit is a soft limit
581
+ */
582
+ hasSoftLimit?: boolean;
583
+ /**
584
+ * Whether usage is unlimited
585
+ */
586
+ hasUnlimitedUsage?: boolean;
587
+ /**
588
+ * Widget types where this entitlement is hidden
589
+ */
590
+ hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
591
+ /**
592
+ * Whether this is a custom entitlement
593
+ */
594
+ isCustom?: boolean;
595
+ /**
596
+ * Whether the entitlement is granted
597
+ */
598
+ isGranted?: boolean;
599
+ /**
600
+ * Configuration for monthly reset period
601
+ */
602
+ monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
603
+ /**
604
+ * Display order of the entitlement
605
+ */
606
+ order?: number;
607
+ /**
608
+ * Period at which usage resets
609
+ */
610
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
611
+ /**
612
+ * Maximum allowed usage for the feature
613
+ */
614
+ usageLimit?: number | null;
615
+ /**
616
+ * Configuration for weekly reset period
617
+ */
618
+ weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
619
+ /**
620
+ * Configuration for yearly reset period
621
+ */
622
+ yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
623
+ }
624
+ namespace Feature {
625
+ /**
626
+ * Configuration for monthly reset period
627
+ */
628
+ interface MonthlyResetPeriodConfiguration {
629
+ /**
630
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
631
+ */
632
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
633
+ }
634
+ /**
635
+ * Configuration for weekly reset period
636
+ */
637
+ interface WeeklyResetPeriodConfiguration {
638
+ /**
639
+ * Reset anchor (SubscriptionStart or specific day)
640
+ */
641
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
642
+ }
643
+ /**
644
+ * Configuration for yearly reset period
645
+ */
646
+ interface YearlyResetPeriodConfiguration {
647
+ /**
648
+ * Reset anchor (SubscriptionStart)
649
+ */
650
+ accordingTo: 'SubscriptionStart';
651
+ }
652
+ }
653
+ /**
654
+ * Request to create a credit entitlement
655
+ */
656
+ interface Credit {
657
+ /**
658
+ * The custom currency ID for the credit entitlement
659
+ */
660
+ id: string;
661
+ /**
662
+ * Credit grant amount
663
+ */
664
+ amount: number | null;
665
+ /**
666
+ * Credit grant cadence (MONTH or YEAR)
667
+ */
668
+ cadence: 'MONTH' | 'YEAR';
669
+ /**
670
+ * CreateCreditEntitlementRequest
671
+ */
672
+ type: 'CREDIT';
673
+ /**
674
+ * Entitlement behavior (Increment or Override)
675
+ */
676
+ behavior?: 'Increment' | 'Override';
677
+ /**
678
+ * Description of the entitlement
679
+ */
680
+ description?: string;
681
+ /**
682
+ * Override display name for the entitlement
683
+ */
684
+ displayNameOverride?: string;
685
+ /**
686
+ * Widget types where this entitlement is hidden
687
+ */
688
+ hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
689
+ /**
690
+ * Whether this is a custom entitlement
691
+ */
692
+ isCustom?: boolean;
693
+ /**
694
+ * Whether the entitlement is granted
695
+ */
696
+ isGranted?: boolean;
697
+ /**
698
+ * Display order of the entitlement
699
+ */
700
+ order?: number;
701
+ }
702
+ }
703
+ export type EntitlementUpdateParams = EntitlementUpdateParams.UpdateFeatureEntitlementRequest | EntitlementUpdateParams.UpdateCreditEntitlementRequest;
704
+ export declare namespace EntitlementUpdateParams {
705
+ interface UpdateFeatureEntitlementRequest {
706
+ /**
707
+ * Path param: The addon ID
708
+ */
709
+ addonId: string;
710
+ /**
711
+ * Body param: UpdateFeatureEntitlementRequest
712
+ */
713
+ type: 'FEATURE';
714
+ /**
715
+ * Body param: Entitlement behavior (Increment or Override)
716
+ */
717
+ behavior?: 'Increment' | 'Override';
718
+ /**
719
+ * Body param: Description of the entitlement
720
+ */
721
+ description?: string;
722
+ /**
723
+ * Body param: Override display name for the entitlement
724
+ */
725
+ displayNameOverride?: string;
726
+ /**
727
+ * Body param: Allowed enum values for the feature entitlement
728
+ */
729
+ enumValues?: Array<string>;
730
+ /**
731
+ * Body param: Whether the usage limit is a soft limit
732
+ */
733
+ hasSoftLimit?: boolean;
734
+ /**
735
+ * Body param: Whether usage is unlimited
736
+ */
737
+ hasUnlimitedUsage?: boolean;
738
+ /**
739
+ * Body param: Widget types where this entitlement is hidden
740
+ */
741
+ hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
742
+ /**
743
+ * Body param: Whether this is a custom entitlement
744
+ */
745
+ isCustom?: boolean;
746
+ /**
747
+ * Body param: Whether the entitlement is granted
748
+ */
749
+ isGranted?: boolean;
750
+ /**
751
+ * Body param: Configuration for monthly reset period
752
+ */
753
+ monthlyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.MonthlyResetPeriodConfiguration | null;
754
+ /**
755
+ * Body param: Display order of the entitlement
756
+ */
757
+ order?: number;
758
+ /**
759
+ * Body param: Period at which usage resets
760
+ */
761
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
762
+ /**
763
+ * Body param: Maximum allowed usage for the feature
764
+ */
765
+ usageLimit?: number | null;
766
+ /**
767
+ * Body param: Configuration for weekly reset period
768
+ */
769
+ weeklyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.WeeklyResetPeriodConfiguration | null;
770
+ /**
771
+ * Body param: Configuration for yearly reset period
772
+ */
773
+ yearlyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.YearlyResetPeriodConfiguration | null;
774
+ }
775
+ namespace UpdateFeatureEntitlementRequest {
776
+ /**
777
+ * Configuration for monthly reset period
778
+ */
779
+ interface MonthlyResetPeriodConfiguration {
780
+ /**
781
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
782
+ */
783
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
784
+ }
785
+ /**
786
+ * Configuration for weekly reset period
787
+ */
788
+ interface WeeklyResetPeriodConfiguration {
789
+ /**
790
+ * Reset anchor (SubscriptionStart or specific day)
791
+ */
792
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
793
+ }
794
+ /**
795
+ * Configuration for yearly reset period
796
+ */
797
+ interface YearlyResetPeriodConfiguration {
798
+ /**
799
+ * Reset anchor (SubscriptionStart)
800
+ */
801
+ accordingTo: 'SubscriptionStart';
802
+ }
803
+ }
804
+ interface UpdateCreditEntitlementRequest {
805
+ /**
806
+ * Path param: The addon ID
807
+ */
808
+ addonId: string;
809
+ /**
810
+ * Body param: UpdateCreditEntitlementRequest
811
+ */
812
+ type: 'CREDIT';
813
+ /**
814
+ * Body param: Credit grant amount
815
+ */
816
+ amount?: number;
817
+ /**
818
+ * Body param: Entitlement behavior (Increment or Override)
819
+ */
820
+ behavior?: 'Increment' | 'Override';
821
+ /**
822
+ * Body param: Credit grant cadence (MONTH or YEAR)
823
+ */
824
+ cadence?: 'MONTH' | 'YEAR';
825
+ /**
826
+ * Body param: Description of the entitlement
827
+ */
828
+ description?: string;
829
+ /**
830
+ * Body param: Override display name for the entitlement
831
+ */
832
+ displayNameOverride?: string;
833
+ /**
834
+ * Body param: Widget types where this entitlement is hidden
835
+ */
836
+ hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
837
+ /**
838
+ * Body param: Whether this is a custom entitlement
839
+ */
840
+ isCustom?: boolean;
841
+ /**
842
+ * Body param: Whether the entitlement is granted
843
+ */
844
+ isGranted?: boolean;
845
+ /**
846
+ * Body param: Display order of the entitlement
847
+ */
848
+ order?: number;
849
+ }
850
+ }
851
+ export interface EntitlementDeleteParams {
852
+ /**
853
+ * The addon ID
854
+ */
855
+ addonId: string;
856
+ }
857
+ export declare namespace Entitlements {
858
+ export { type AddonPackageEntitlement as AddonPackageEntitlement, type EntitlementCreateResponse as EntitlementCreateResponse, type EntitlementListResponse as EntitlementListResponse, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementDeleteParams as EntitlementDeleteParams, };
859
+ }
860
+ //# sourceMappingURL=entitlements.d.ts.map