@stigg/typescript 0.1.0-alpha.9 → 0.1.0-beta.10

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 (564) hide show
  1. package/CHANGELOG.md +499 -0
  2. package/api-promise.d.mts +1 -0
  3. package/api-promise.d.mts.map +1 -1
  4. package/api-promise.d.ts +1 -0
  5. package/api-promise.d.ts.map +1 -1
  6. package/api-promise.mjs +1 -0
  7. package/api-promise.mjs.map +1 -1
  8. package/client.d.mts +4 -1
  9. package/client.d.mts.map +1 -1
  10. package/client.d.ts +4 -1
  11. package/client.d.ts.map +1 -1
  12. package/client.js +22 -7
  13. package/client.js.map +1 -1
  14. package/client.mjs +22 -7
  15. package/client.mjs.map +1 -1
  16. package/core/api-promise.d.mts.map +1 -1
  17. package/core/api-promise.d.ts.map +1 -1
  18. package/core/api-promise.mjs.map +1 -1
  19. package/core/error.mjs.map +1 -1
  20. package/core/pagination.d.mts.map +1 -1
  21. package/core/pagination.d.ts.map +1 -1
  22. package/core/pagination.mjs.map +1 -1
  23. package/core/resource.d.mts.map +1 -1
  24. package/core/resource.d.ts.map +1 -1
  25. package/core/uploads.d.mts.map +1 -1
  26. package/core/uploads.d.ts.map +1 -1
  27. package/core/uploads.mjs.map +1 -1
  28. package/error.d.mts +1 -0
  29. package/error.d.mts.map +1 -1
  30. package/error.d.ts +1 -0
  31. package/error.d.ts.map +1 -1
  32. package/error.mjs +1 -0
  33. package/error.mjs.map +1 -1
  34. package/index.d.mts.map +1 -1
  35. package/index.d.ts.map +1 -1
  36. package/index.mjs.map +1 -1
  37. package/internal/detect-platform.mjs.map +1 -1
  38. package/internal/headers.mjs.map +1 -1
  39. package/internal/parse.d.mts.map +1 -1
  40. package/internal/parse.d.ts.map +1 -1
  41. package/internal/parse.mjs.map +1 -1
  42. package/internal/qs/formats.d.mts.map +1 -1
  43. package/internal/qs/formats.d.ts.map +1 -1
  44. package/internal/qs/index.d.mts +2 -2
  45. package/internal/qs/index.d.mts.map +1 -1
  46. package/internal/qs/index.d.ts +2 -2
  47. package/internal/qs/index.d.ts.map +1 -1
  48. package/internal/qs/index.mjs.map +1 -1
  49. package/internal/qs/stringify.d.mts.map +1 -1
  50. package/internal/qs/stringify.d.ts.map +1 -1
  51. package/internal/qs/stringify.mjs.map +1 -1
  52. package/internal/qs/utils.d.mts.map +1 -1
  53. package/internal/qs/utils.d.ts.map +1 -1
  54. package/internal/qs/utils.mjs.map +1 -1
  55. package/internal/request-options.d.mts.map +1 -1
  56. package/internal/request-options.d.ts.map +1 -1
  57. package/internal/shims.d.mts +6 -0
  58. package/internal/shims.d.mts.map +1 -1
  59. package/internal/shims.d.ts +6 -0
  60. package/internal/shims.d.ts.map +1 -1
  61. package/internal/to-file.d.mts.map +1 -1
  62. package/internal/to-file.d.ts.map +1 -1
  63. package/internal/to-file.mjs.map +1 -1
  64. package/internal/tslib.js +17 -17
  65. package/internal/types.d.mts +10 -10
  66. package/internal/types.d.mts.map +1 -1
  67. package/internal/types.d.ts +10 -10
  68. package/internal/types.d.ts.map +1 -1
  69. package/internal/uploads.d.mts.map +1 -1
  70. package/internal/uploads.d.ts.map +1 -1
  71. package/internal/uploads.mjs.map +1 -1
  72. package/internal/utils/base64.mjs.map +1 -1
  73. package/internal/utils/env.js +2 -2
  74. package/internal/utils/env.js.map +1 -1
  75. package/internal/utils/env.mjs +2 -2
  76. package/internal/utils/env.mjs.map +1 -1
  77. package/internal/utils/log.d.mts.map +1 -1
  78. package/internal/utils/log.d.ts.map +1 -1
  79. package/internal/utils/log.js +3 -2
  80. package/internal/utils/log.js.map +1 -1
  81. package/internal/utils/log.mjs +3 -2
  82. package/internal/utils/log.mjs.map +1 -1
  83. package/internal/utils/path.mjs.map +1 -1
  84. package/internal/utils/query.d.mts +2 -0
  85. package/internal/utils/query.d.mts.map +1 -0
  86. package/internal/utils/query.d.ts +2 -0
  87. package/internal/utils/query.d.ts.map +1 -0
  88. package/internal/utils/query.js +10 -0
  89. package/internal/utils/query.js.map +1 -0
  90. package/internal/utils/query.mjs +6 -0
  91. package/internal/utils/query.mjs.map +1 -0
  92. package/internal/utils/values.mjs.map +1 -1
  93. package/internal/utils.d.mts +1 -0
  94. package/internal/utils.d.mts.map +1 -1
  95. package/internal/utils.d.ts +1 -0
  96. package/internal/utils.d.ts.map +1 -1
  97. package/internal/utils.js +1 -0
  98. package/internal/utils.js.map +1 -1
  99. package/internal/utils.mjs +1 -0
  100. package/internal/utils.mjs.map +1 -1
  101. package/package.json +12 -1
  102. package/pagination.d.mts +1 -0
  103. package/pagination.d.mts.map +1 -1
  104. package/pagination.d.ts +1 -0
  105. package/pagination.d.ts.map +1 -1
  106. package/pagination.mjs +1 -0
  107. package/pagination.mjs.map +1 -1
  108. package/resource.d.mts +1 -0
  109. package/resource.d.mts.map +1 -1
  110. package/resource.d.ts +1 -0
  111. package/resource.d.ts.map +1 -1
  112. package/resource.mjs +1 -0
  113. package/resource.mjs.map +1 -1
  114. package/resources/index.d.mts +1 -0
  115. package/resources/index.d.mts.map +1 -1
  116. package/resources/index.d.ts +1 -0
  117. package/resources/index.d.ts.map +1 -1
  118. package/resources/index.js +3 -1
  119. package/resources/index.js.map +1 -1
  120. package/resources/index.mjs +1 -0
  121. package/resources/index.mjs.map +1 -1
  122. package/resources/v1/addons/addons.d.mts +1025 -0
  123. package/resources/v1/addons/addons.d.mts.map +1 -0
  124. package/resources/v1/addons/addons.d.ts +1025 -0
  125. package/resources/v1/addons/addons.d.ts.map +1 -0
  126. package/resources/v1/{events/addons → addons}/addons.js +50 -26
  127. package/resources/v1/addons/addons.js.map +1 -0
  128. package/resources/v1/{events/addons → addons}/addons.mjs +49 -25
  129. package/resources/v1/addons/addons.mjs.map +1 -0
  130. package/resources/v1/addons/entitlements.d.mts +888 -0
  131. package/resources/v1/addons/entitlements.d.mts.map +1 -0
  132. package/resources/v1/addons/entitlements.d.ts +888 -0
  133. package/resources/v1/addons/entitlements.d.ts.map +1 -0
  134. package/resources/v1/addons/entitlements.js +36 -0
  135. package/resources/v1/addons/entitlements.js.map +1 -0
  136. package/resources/v1/addons/entitlements.mjs +32 -0
  137. package/resources/v1/addons/entitlements.mjs.map +1 -0
  138. package/resources/v1/addons/index.d.mts +3 -0
  139. package/resources/v1/addons/index.d.mts.map +1 -0
  140. package/resources/v1/addons/index.d.ts +3 -0
  141. package/resources/v1/addons/index.d.ts.map +1 -0
  142. package/resources/v1/{events/addons → addons}/index.js +3 -3
  143. package/resources/v1/addons/index.js.map +1 -0
  144. package/resources/v1/{events/addons → addons}/index.mjs +1 -1
  145. package/resources/v1/addons/index.mjs.map +1 -0
  146. package/resources/v1/addons.d.mts.map +1 -0
  147. package/resources/v1/addons.d.ts.map +1 -0
  148. package/resources/v1/{events/addons.js → addons.js} +1 -1
  149. package/resources/v1/addons.js.map +1 -0
  150. package/resources/v1/addons.mjs.map +1 -0
  151. package/resources/v1/coupons.d.mts +19 -4
  152. package/resources/v1/coupons.d.mts.map +1 -1
  153. package/resources/v1/coupons.d.ts +19 -4
  154. package/resources/v1/coupons.d.ts.map +1 -1
  155. package/resources/v1/coupons.js +3 -0
  156. package/resources/v1/coupons.js.map +1 -1
  157. package/resources/v1/coupons.mjs +3 -0
  158. package/resources/v1/coupons.mjs.map +1 -1
  159. package/resources/v1/credits/credits.d.mts +296 -0
  160. package/resources/v1/credits/credits.d.mts.map +1 -0
  161. package/resources/v1/credits/credits.d.ts +296 -0
  162. package/resources/v1/credits/credits.d.ts.map +1 -0
  163. package/resources/v1/credits/credits.js +45 -0
  164. package/resources/v1/credits/credits.js.map +1 -0
  165. package/resources/v1/credits/credits.mjs +40 -0
  166. package/resources/v1/credits/credits.mjs.map +1 -0
  167. package/resources/v1/credits/custom-currencies.d.mts +290 -0
  168. package/resources/v1/credits/custom-currencies.d.mts.map +1 -0
  169. package/resources/v1/credits/custom-currencies.d.ts +290 -0
  170. package/resources/v1/credits/custom-currencies.d.ts.map +1 -0
  171. package/resources/v1/credits/custom-currencies.js +56 -0
  172. package/resources/v1/credits/custom-currencies.js.map +1 -0
  173. package/resources/v1/credits/custom-currencies.mjs +52 -0
  174. package/resources/v1/credits/custom-currencies.mjs.map +1 -0
  175. package/resources/v1/credits/grants.d.mts +549 -0
  176. package/resources/v1/credits/grants.d.mts.map +1 -0
  177. package/resources/v1/credits/grants.d.ts +549 -0
  178. package/resources/v1/credits/grants.d.ts.map +1 -0
  179. package/resources/v1/credits/grants.js +37 -0
  180. package/resources/v1/credits/grants.js.map +1 -0
  181. package/resources/v1/credits/grants.mjs +33 -0
  182. package/resources/v1/credits/grants.mjs.map +1 -0
  183. package/resources/v1/credits/index.d.mts +4 -0
  184. package/resources/v1/credits/index.d.mts.map +1 -0
  185. package/resources/v1/credits/index.d.ts +4 -0
  186. package/resources/v1/credits/index.d.ts.map +1 -0
  187. package/resources/v1/credits/index.js +11 -0
  188. package/resources/v1/credits/index.js.map +1 -0
  189. package/resources/v1/credits/index.mjs +5 -0
  190. package/resources/v1/credits/index.mjs.map +1 -0
  191. package/resources/v1/credits.d.mts +2 -0
  192. package/resources/v1/credits.d.mts.map +1 -0
  193. package/resources/v1/credits.d.ts +2 -0
  194. package/resources/v1/credits.d.ts.map +1 -0
  195. package/resources/v1/credits.js +6 -0
  196. package/resources/v1/credits.js.map +1 -0
  197. package/resources/v1/credits.mjs +3 -0
  198. package/resources/v1/credits.mjs.map +1 -0
  199. package/resources/v1/customers/customers.d.mts +1204 -6
  200. package/resources/v1/customers/customers.d.mts.map +1 -1
  201. package/resources/v1/customers/customers.d.ts +1204 -6
  202. package/resources/v1/customers/customers.d.ts.map +1 -1
  203. package/resources/v1/customers/customers.js +30 -1
  204. package/resources/v1/customers/customers.js.map +1 -1
  205. package/resources/v1/customers/customers.mjs +30 -1
  206. package/resources/v1/customers/customers.mjs.map +1 -1
  207. package/resources/v1/customers/index.d.mts +2 -1
  208. package/resources/v1/customers/index.d.mts.map +1 -1
  209. package/resources/v1/customers/index.d.ts +2 -1
  210. package/resources/v1/customers/index.d.ts.map +1 -1
  211. package/resources/v1/customers/index.js +3 -1
  212. package/resources/v1/customers/index.js.map +1 -1
  213. package/resources/v1/customers/index.mjs +1 -0
  214. package/resources/v1/customers/index.mjs.map +1 -1
  215. package/resources/v1/customers/integrations.d.mts +142 -0
  216. package/resources/v1/customers/integrations.d.mts.map +1 -0
  217. package/resources/v1/customers/integrations.d.ts +142 -0
  218. package/resources/v1/customers/integrations.d.ts.map +1 -0
  219. package/resources/v1/customers/integrations.js +50 -0
  220. package/resources/v1/customers/integrations.js.map +1 -0
  221. package/resources/v1/customers/integrations.mjs +46 -0
  222. package/resources/v1/customers/integrations.mjs.map +1 -0
  223. package/resources/v1/customers/payment-method.d.mts +3 -0
  224. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  225. package/resources/v1/customers/payment-method.d.ts +3 -0
  226. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  227. package/resources/v1/customers/payment-method.js +3 -0
  228. package/resources/v1/customers/payment-method.js.map +1 -1
  229. package/resources/v1/customers/payment-method.mjs +3 -0
  230. package/resources/v1/customers/payment-method.mjs.map +1 -1
  231. package/resources/v1/customers/promotional-entitlements.d.mts +4 -1
  232. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
  233. package/resources/v1/customers/promotional-entitlements.d.ts +4 -1
  234. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
  235. package/resources/v1/customers/promotional-entitlements.js +3 -0
  236. package/resources/v1/customers/promotional-entitlements.js.map +1 -1
  237. package/resources/v1/customers/promotional-entitlements.mjs +3 -0
  238. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
  239. package/resources/v1/customers.d.mts.map +1 -1
  240. package/resources/v1/customers.d.ts.map +1 -1
  241. package/resources/v1/customers.mjs.map +1 -1
  242. package/resources/v1/events.d.mts +65 -1
  243. package/resources/v1/events.d.mts.map +1 -1
  244. package/resources/v1/events.d.ts +65 -1
  245. package/resources/v1/events.d.ts.map +1 -1
  246. package/resources/v1/events.js +15 -2
  247. package/resources/v1/events.js.map +1 -1
  248. package/resources/v1/events.mjs +13 -1
  249. package/resources/v1/events.mjs.map +1 -1
  250. package/resources/v1/features.d.mts +456 -0
  251. package/resources/v1/features.d.mts.map +1 -0
  252. package/resources/v1/features.d.ts +456 -0
  253. package/resources/v1/features.d.ts.map +1 -0
  254. package/resources/v1/{events/features.js → features.js} +6 -3
  255. package/resources/v1/features.js.map +1 -0
  256. package/resources/v1/{events/features.mjs → features.mjs} +6 -3
  257. package/resources/v1/features.mjs.map +1 -0
  258. package/resources/v1/index.d.mts +7 -3
  259. package/resources/v1/index.d.mts.map +1 -1
  260. package/resources/v1/index.d.ts +7 -3
  261. package/resources/v1/index.d.ts.map +1 -1
  262. package/resources/v1/index.js +15 -7
  263. package/resources/v1/index.js.map +1 -1
  264. package/resources/v1/index.mjs +5 -1
  265. package/resources/v1/index.mjs.map +1 -1
  266. package/resources/v1/plans/entitlements.d.mts +888 -0
  267. package/resources/v1/plans/entitlements.d.mts.map +1 -0
  268. package/resources/v1/plans/entitlements.d.ts +888 -0
  269. package/resources/v1/plans/entitlements.d.ts.map +1 -0
  270. package/resources/v1/plans/entitlements.js +36 -0
  271. package/resources/v1/plans/entitlements.js.map +1 -0
  272. package/resources/v1/plans/entitlements.mjs +32 -0
  273. package/resources/v1/plans/entitlements.mjs.map +1 -0
  274. package/resources/v1/plans/index.d.mts +3 -0
  275. package/resources/v1/plans/index.d.mts.map +1 -0
  276. package/resources/v1/plans/index.d.ts +3 -0
  277. package/resources/v1/plans/index.d.ts.map +1 -0
  278. package/resources/v1/plans/index.js +9 -0
  279. package/resources/v1/plans/index.js.map +1 -0
  280. package/resources/v1/plans/index.mjs +4 -0
  281. package/resources/v1/plans/index.mjs.map +1 -0
  282. package/resources/v1/plans/plans.d.mts +992 -0
  283. package/resources/v1/plans/plans.d.mts.map +1 -0
  284. package/resources/v1/plans/plans.d.ts +992 -0
  285. package/resources/v1/plans/plans.d.ts.map +1 -0
  286. package/resources/v1/plans/plans.js +84 -0
  287. package/resources/v1/plans/plans.js.map +1 -0
  288. package/resources/v1/plans/plans.mjs +79 -0
  289. package/resources/v1/plans/plans.mjs.map +1 -0
  290. package/resources/v1/plans.d.mts +2 -0
  291. package/resources/v1/plans.d.mts.map +1 -0
  292. package/resources/v1/plans.d.ts +2 -0
  293. package/resources/v1/plans.d.ts.map +1 -0
  294. package/resources/v1/plans.js +6 -0
  295. package/resources/v1/plans.js.map +1 -0
  296. package/resources/v1/plans.mjs +3 -0
  297. package/resources/v1/plans.mjs.map +1 -0
  298. package/resources/v1/products.d.mts +22 -359
  299. package/resources/v1/products.d.mts.map +1 -1
  300. package/resources/v1/products.d.ts +22 -359
  301. package/resources/v1/products.d.ts.map +1 -1
  302. package/resources/v1/products.js +5 -2
  303. package/resources/v1/products.js.map +1 -1
  304. package/resources/v1/products.mjs +5 -2
  305. package/resources/v1/products.mjs.map +1 -1
  306. package/resources/v1/subscriptions/future-update.d.mts +3 -0
  307. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  308. package/resources/v1/subscriptions/future-update.d.ts +3 -0
  309. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  310. package/resources/v1/subscriptions/future-update.js +3 -0
  311. package/resources/v1/subscriptions/future-update.js.map +1 -1
  312. package/resources/v1/subscriptions/future-update.mjs +3 -0
  313. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  314. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  315. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  316. package/resources/v1/subscriptions/index.mjs.map +1 -1
  317. package/resources/v1/subscriptions/invoice.d.mts +3 -0
  318. package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
  319. package/resources/v1/subscriptions/invoice.d.ts +3 -0
  320. package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
  321. package/resources/v1/subscriptions/invoice.js +3 -0
  322. package/resources/v1/subscriptions/invoice.js.map +1 -1
  323. package/resources/v1/subscriptions/invoice.mjs +3 -0
  324. package/resources/v1/subscriptions/invoice.mjs.map +1 -1
  325. package/resources/v1/subscriptions/subscriptions.d.mts +1140 -172
  326. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  327. package/resources/v1/subscriptions/subscriptions.d.ts +1140 -172
  328. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  329. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  330. package/resources/v1/subscriptions/subscriptions.mjs +2 -2
  331. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  332. package/resources/v1/subscriptions/usage.d.mts +3 -0
  333. package/resources/v1/subscriptions/usage.d.mts.map +1 -1
  334. package/resources/v1/subscriptions/usage.d.ts +3 -0
  335. package/resources/v1/subscriptions/usage.d.ts.map +1 -1
  336. package/resources/v1/subscriptions/usage.js +3 -0
  337. package/resources/v1/subscriptions/usage.js.map +1 -1
  338. package/resources/v1/subscriptions/usage.mjs +3 -0
  339. package/resources/v1/subscriptions/usage.mjs.map +1 -1
  340. package/resources/v1/subscriptions.d.mts.map +1 -1
  341. package/resources/v1/subscriptions.d.ts.map +1 -1
  342. package/resources/v1/subscriptions.mjs.map +1 -1
  343. package/resources/v1/usage.d.mts +4 -1
  344. package/resources/v1/usage.d.mts.map +1 -1
  345. package/resources/v1/usage.d.ts +4 -1
  346. package/resources/v1/usage.d.ts.map +1 -1
  347. package/resources/v1/usage.js +3 -0
  348. package/resources/v1/usage.js.map +1 -1
  349. package/resources/v1/usage.mjs +3 -0
  350. package/resources/v1/usage.mjs.map +1 -1
  351. package/resources/v1/v1.d.mts +22 -6
  352. package/resources/v1/v1.d.mts.map +1 -1
  353. package/resources/v1/v1.d.ts +22 -6
  354. package/resources/v1/v1.d.ts.map +1 -1
  355. package/resources/v1/v1.js +18 -2
  356. package/resources/v1/v1.js.map +1 -1
  357. package/resources/v1/v1.mjs +18 -2
  358. package/resources/v1/v1.mjs.map +1 -1
  359. package/resources/v1-beta/customers/assignments.d.mts +175 -0
  360. package/resources/v1-beta/customers/assignments.d.mts.map +1 -0
  361. package/resources/v1-beta/customers/assignments.d.ts +175 -0
  362. package/resources/v1-beta/customers/assignments.d.ts.map +1 -0
  363. package/resources/v1-beta/customers/assignments.js +59 -0
  364. package/resources/v1-beta/customers/assignments.js.map +1 -0
  365. package/resources/v1-beta/customers/assignments.mjs +55 -0
  366. package/resources/v1-beta/customers/assignments.mjs.map +1 -0
  367. package/resources/v1-beta/customers/customers.d.mts +18 -0
  368. package/resources/v1-beta/customers/customers.d.mts.map +1 -0
  369. package/resources/v1-beta/customers/customers.d.ts +18 -0
  370. package/resources/v1-beta/customers/customers.d.ts.map +1 -0
  371. package/resources/v1-beta/customers/customers.js +25 -0
  372. package/resources/v1-beta/customers/customers.js.map +1 -0
  373. package/resources/v1-beta/customers/customers.mjs +20 -0
  374. package/resources/v1-beta/customers/customers.mjs.map +1 -0
  375. package/resources/v1-beta/customers/entities.d.mts +284 -0
  376. package/resources/v1-beta/customers/entities.d.mts.map +1 -0
  377. package/resources/v1-beta/customers/entities.d.ts +284 -0
  378. package/resources/v1-beta/customers/entities.d.ts.map +1 -0
  379. package/resources/v1-beta/customers/entities.js +96 -0
  380. package/resources/v1-beta/customers/entities.js.map +1 -0
  381. package/resources/v1-beta/customers/entities.mjs +92 -0
  382. package/resources/v1-beta/customers/entities.mjs.map +1 -0
  383. package/resources/v1-beta/customers/entitlements.d.mts +236 -0
  384. package/resources/v1-beta/customers/entitlements.d.mts.map +1 -0
  385. package/resources/v1-beta/customers/entitlements.d.ts +236 -0
  386. package/resources/v1-beta/customers/entitlements.d.ts.map +1 -0
  387. package/resources/v1-beta/customers/entitlements.js +24 -0
  388. package/resources/v1-beta/customers/entitlements.js.map +1 -0
  389. package/resources/v1-beta/customers/entitlements.mjs +20 -0
  390. package/resources/v1-beta/customers/entitlements.mjs.map +1 -0
  391. package/resources/v1-beta/customers/index.d.mts +5 -0
  392. package/resources/v1-beta/customers/index.d.mts.map +1 -0
  393. package/resources/v1-beta/customers/index.d.ts +5 -0
  394. package/resources/v1-beta/customers/index.d.ts.map +1 -0
  395. package/resources/v1-beta/customers/index.js +13 -0
  396. package/resources/v1-beta/customers/index.js.map +1 -0
  397. package/resources/v1-beta/customers/index.mjs +6 -0
  398. package/resources/v1-beta/customers/index.mjs.map +1 -0
  399. package/resources/v1-beta/customers.d.mts +2 -0
  400. package/resources/v1-beta/customers.d.mts.map +1 -0
  401. package/resources/v1-beta/customers.d.ts +2 -0
  402. package/resources/v1-beta/customers.d.ts.map +1 -0
  403. package/resources/v1-beta/customers.js +6 -0
  404. package/resources/v1-beta/customers.js.map +1 -0
  405. package/resources/v1-beta/customers.mjs +3 -0
  406. package/resources/v1-beta/customers.mjs.map +1 -0
  407. package/resources/v1-beta/entity-types.d.mts +143 -0
  408. package/resources/v1-beta/entity-types.d.mts.map +1 -0
  409. package/resources/v1-beta/entity-types.d.ts +143 -0
  410. package/resources/v1-beta/entity-types.d.ts.map +1 -0
  411. package/resources/v1-beta/entity-types.js +55 -0
  412. package/resources/v1-beta/entity-types.js.map +1 -0
  413. package/resources/v1-beta/entity-types.mjs +51 -0
  414. package/resources/v1-beta/entity-types.mjs.map +1 -0
  415. package/resources/v1-beta/index.d.mts +4 -0
  416. package/resources/v1-beta/index.d.mts.map +1 -0
  417. package/resources/v1-beta/index.d.ts +4 -0
  418. package/resources/v1-beta/index.d.ts.map +1 -0
  419. package/resources/v1-beta/index.js +11 -0
  420. package/resources/v1-beta/index.js.map +1 -0
  421. package/resources/v1-beta/index.mjs +5 -0
  422. package/resources/v1-beta/index.mjs.map +1 -0
  423. package/resources/v1-beta/v1-beta.d.mts +14 -0
  424. package/resources/v1-beta/v1-beta.d.mts.map +1 -0
  425. package/resources/v1-beta/v1-beta.d.ts +14 -0
  426. package/resources/v1-beta/v1-beta.d.ts.map +1 -0
  427. package/resources/v1-beta/v1-beta.js +21 -0
  428. package/resources/v1-beta/v1-beta.js.map +1 -0
  429. package/resources/v1-beta/v1-beta.mjs +16 -0
  430. package/resources/v1-beta/v1-beta.mjs.map +1 -0
  431. package/resources/v1-beta.d.mts +2 -0
  432. package/resources/v1-beta.d.mts.map +1 -0
  433. package/resources/v1-beta.d.ts +2 -0
  434. package/resources/v1-beta.d.ts.map +1 -0
  435. package/resources/v1-beta.js +6 -0
  436. package/resources/v1-beta.js.map +1 -0
  437. package/resources/v1-beta.mjs +3 -0
  438. package/resources/v1-beta.mjs.map +1 -0
  439. package/resources/v1.d.mts.map +1 -1
  440. package/resources/v1.d.ts.map +1 -1
  441. package/resources/v1.mjs.map +1 -1
  442. package/resources.d.mts.map +1 -1
  443. package/resources.d.ts.map +1 -1
  444. package/resources.mjs.map +1 -1
  445. package/src/client.ts +28 -10
  446. package/src/internal/types.ts +6 -8
  447. package/src/internal/utils/env.ts +2 -2
  448. package/src/internal/utils/log.ts +2 -1
  449. package/src/internal/utils/query.ts +7 -0
  450. package/src/internal/utils.ts +1 -0
  451. package/src/resources/index.ts +1 -0
  452. package/src/resources/v1/addons/addons.ts +2451 -0
  453. package/src/resources/v1/addons/entitlements.ts +1153 -0
  454. package/src/resources/v1/addons/index.ts +26 -0
  455. package/src/resources/v1/coupons.ts +17 -4
  456. package/src/resources/v1/credits/credits.ts +422 -0
  457. package/src/resources/v1/credits/custom-currencies.ts +372 -0
  458. package/src/resources/v1/credits/grants.ts +795 -0
  459. package/src/resources/v1/credits/index.ts +30 -0
  460. package/src/resources/v1/credits.ts +3 -0
  461. package/src/resources/v1/customers/customers.ts +2526 -69
  462. package/src/resources/v1/customers/index.ts +15 -0
  463. package/src/resources/v1/customers/integrations.ts +252 -0
  464. package/src/resources/v1/customers/payment-method.ts +3 -0
  465. package/src/resources/v1/customers/promotional-entitlements.ts +4 -1
  466. package/src/resources/v1/events.ts +75 -1
  467. package/src/resources/v1/{events/features.ts → features.ts} +29 -512
  468. package/src/resources/v1/index.ts +55 -6
  469. package/src/resources/v1/plans/entitlements.ts +1145 -0
  470. package/src/resources/v1/plans/index.ts +25 -0
  471. package/src/resources/v1/plans/plans.ts +2069 -0
  472. package/src/resources/v1/plans.ts +3 -0
  473. package/src/resources/v1/products.ts +24 -428
  474. package/src/resources/v1/subscriptions/future-update.ts +3 -0
  475. package/src/resources/v1/subscriptions/invoice.ts +3 -0
  476. package/src/resources/v1/subscriptions/subscriptions.ts +3910 -1330
  477. package/src/resources/v1/subscriptions/usage.ts +3 -0
  478. package/src/resources/v1/usage.ts +4 -1
  479. package/src/resources/v1/v1.ts +126 -12
  480. package/src/resources/v1-beta/customers/assignments.ts +225 -0
  481. package/src/resources/v1-beta/customers/customers.ts +71 -0
  482. package/src/resources/v1-beta/customers/entities.ts +360 -0
  483. package/src/resources/v1-beta/customers/entitlements.ts +325 -0
  484. package/src/resources/v1-beta/customers/index.ts +26 -0
  485. package/src/resources/v1-beta/customers.ts +3 -0
  486. package/src/resources/v1-beta/entity-types.ts +179 -0
  487. package/src/resources/v1-beta/index.ts +12 -0
  488. package/src/resources/v1-beta/v1-beta.ts +35 -0
  489. package/src/resources/v1-beta.ts +3 -0
  490. package/src/version.ts +1 -1
  491. package/uploads.d.mts +1 -0
  492. package/uploads.d.mts.map +1 -1
  493. package/uploads.d.ts +1 -0
  494. package/uploads.d.ts.map +1 -1
  495. package/uploads.mjs +1 -0
  496. package/uploads.mjs.map +1 -1
  497. package/version.d.mts +1 -1
  498. package/version.d.ts +1 -1
  499. package/version.js +1 -1
  500. package/version.mjs +1 -1
  501. package/resources/v1/events/addons/addons.d.mts +0 -605
  502. package/resources/v1/events/addons/addons.d.mts.map +0 -1
  503. package/resources/v1/events/addons/addons.d.ts +0 -605
  504. package/resources/v1/events/addons/addons.d.ts.map +0 -1
  505. package/resources/v1/events/addons/addons.js.map +0 -1
  506. package/resources/v1/events/addons/addons.mjs.map +0 -1
  507. package/resources/v1/events/addons/draft.d.mts +0 -121
  508. package/resources/v1/events/addons/draft.d.mts.map +0 -1
  509. package/resources/v1/events/addons/draft.d.ts +0 -121
  510. package/resources/v1/events/addons/draft.d.ts.map +0 -1
  511. package/resources/v1/events/addons/draft.js +0 -22
  512. package/resources/v1/events/addons/draft.js.map +0 -1
  513. package/resources/v1/events/addons/draft.mjs +0 -18
  514. package/resources/v1/events/addons/draft.mjs.map +0 -1
  515. package/resources/v1/events/addons/index.d.mts +0 -3
  516. package/resources/v1/events/addons/index.d.mts.map +0 -1
  517. package/resources/v1/events/addons/index.d.ts +0 -3
  518. package/resources/v1/events/addons/index.d.ts.map +0 -1
  519. package/resources/v1/events/addons/index.js.map +0 -1
  520. package/resources/v1/events/addons/index.mjs.map +0 -1
  521. package/resources/v1/events/addons.d.mts.map +0 -1
  522. package/resources/v1/events/addons.d.ts.map +0 -1
  523. package/resources/v1/events/addons.js.map +0 -1
  524. package/resources/v1/events/addons.mjs.map +0 -1
  525. package/resources/v1/events/events.d.mts +0 -75
  526. package/resources/v1/events/events.d.mts.map +0 -1
  527. package/resources/v1/events/events.d.ts +0 -75
  528. package/resources/v1/events/events.d.ts.map +0 -1
  529. package/resources/v1/events/events.js +0 -32
  530. package/resources/v1/events/events.js.map +0 -1
  531. package/resources/v1/events/events.mjs +0 -27
  532. package/resources/v1/events/events.mjs.map +0 -1
  533. package/resources/v1/events/features.d.mts +0 -856
  534. package/resources/v1/events/features.d.mts.map +0 -1
  535. package/resources/v1/events/features.d.ts +0 -856
  536. package/resources/v1/events/features.d.ts.map +0 -1
  537. package/resources/v1/events/features.js.map +0 -1
  538. package/resources/v1/events/features.mjs.map +0 -1
  539. package/resources/v1/events/index.d.mts +0 -5
  540. package/resources/v1/events/index.d.mts.map +0 -1
  541. package/resources/v1/events/index.d.ts +0 -5
  542. package/resources/v1/events/index.d.ts.map +0 -1
  543. package/resources/v1/events/index.js +0 -13
  544. package/resources/v1/events/index.js.map +0 -1
  545. package/resources/v1/events/index.mjs +0 -6
  546. package/resources/v1/events/index.mjs.map +0 -1
  547. package/resources/v1/events/plans.d.mts +0 -348
  548. package/resources/v1/events/plans.d.mts.map +0 -1
  549. package/resources/v1/events/plans.d.ts +0 -348
  550. package/resources/v1/events/plans.d.ts.map +0 -1
  551. package/resources/v1/events/plans.js +0 -30
  552. package/resources/v1/events/plans.js.map +0 -1
  553. package/resources/v1/events/plans.mjs +0 -26
  554. package/resources/v1/events/plans.mjs.map +0 -1
  555. package/src/resources/v1/events/addons/addons.ts +0 -761
  556. package/src/resources/v1/events/addons/draft.ts +0 -151
  557. package/src/resources/v1/events/addons/index.ts +0 -17
  558. package/src/resources/v1/events/events.ts +0 -160
  559. package/src/resources/v1/events/index.ts +0 -39
  560. package/src/resources/v1/events/plans.ts +0 -429
  561. /package/resources/v1/{events/addons.d.mts → addons.d.mts} +0 -0
  562. /package/resources/v1/{events/addons.d.ts → addons.d.ts} +0 -0
  563. /package/resources/v1/{events/addons.mjs → addons.mjs} +0 -0
  564. /package/src/resources/v1/{events/addons.ts → addons.ts} +0 -0
@@ -0,0 +1,2451 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as EntitlementsAPI from './entitlements';
5
+ import {
6
+ AddonPackageEntitlement,
7
+ EntitlementCreateParams,
8
+ EntitlementCreateResponse,
9
+ EntitlementDeleteParams,
10
+ EntitlementListResponse,
11
+ EntitlementUpdateParams,
12
+ Entitlements,
13
+ } from './entitlements';
14
+ import { APIPromise } from '../../../core/api-promise';
15
+ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
16
+ import { RequestOptions } from '../../../internal/request-options';
17
+ import { path } from '../../../internal/utils/path';
18
+
19
+ /**
20
+ * Operations related to addons
21
+ */
22
+ export class Addons extends APIResource {
23
+ entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
24
+
25
+ /**
26
+ * Creates a new addon in draft status, associated with a specific product.
27
+ */
28
+ create(body: AddonCreateParams, options?: RequestOptions): APIPromise<Addon> {
29
+ return this._client.post('/api/v1/addons', { body, ...options });
30
+ }
31
+
32
+ /**
33
+ * Retrieves an addon by its unique identifier, including entitlements and pricing
34
+ * details.
35
+ */
36
+ retrieve(id: string, options?: RequestOptions): APIPromise<Addon> {
37
+ return this._client.get(path`/api/v1/addons/${id}`, options);
38
+ }
39
+
40
+ /**
41
+ * Updates an existing addon's properties such as display name, description, and
42
+ * metadata.
43
+ */
44
+ update(id: string, body: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon> {
45
+ return this._client.patch(path`/api/v1/addons/${id}`, { body, ...options });
46
+ }
47
+
48
+ /**
49
+ * Retrieves a paginated list of addons in the environment.
50
+ */
51
+ list(
52
+ query: AddonListParams | null | undefined = {},
53
+ options?: RequestOptions,
54
+ ): PagePromise<AddonListResponsesMyCursorIDPage, AddonListResponse> {
55
+ return this._client.getAPIList('/api/v1/addons', MyCursorIDPage<AddonListResponse>, {
56
+ query,
57
+ ...options,
58
+ });
59
+ }
60
+
61
+ /**
62
+ * Archives an addon, preventing it from being used in new subscriptions.
63
+ */
64
+ archive(id: string, options?: RequestOptions): APIPromise<Addon> {
65
+ return this._client.post(path`/api/v1/addons/${id}/archive`, options);
66
+ }
67
+
68
+ /**
69
+ * Creates a draft version of an existing addon for modification before publishing.
70
+ */
71
+ createDraft(id: string, options?: RequestOptions): APIPromise<Addon> {
72
+ return this._client.post(path`/api/v1/addons/${id}/draft`, options);
73
+ }
74
+
75
+ /**
76
+ * Retrieves the list of charges configured on an addon.
77
+ */
78
+ listCharges(
79
+ id: string,
80
+ query: AddonListChargesParams | null | undefined = {},
81
+ options?: RequestOptions,
82
+ ): PagePromise<ChargeListDataMyCursorIDPage, ChargeList.Data> {
83
+ return this._client.getAPIList(path`/api/v1/addons/${id}/charges`, MyCursorIDPage<ChargeList.Data>, {
84
+ query,
85
+ ...options,
86
+ });
87
+ }
88
+
89
+ /**
90
+ * Publishes a draft addon, making it available for use in subscriptions.
91
+ */
92
+ publish(id: string, body: AddonPublishParams, options?: RequestOptions): APIPromise<AddonPublishResponse> {
93
+ return this._client.post(path`/api/v1/addons/${id}/publish`, { body, ...options });
94
+ }
95
+
96
+ /**
97
+ * Removes a draft version of an addon.
98
+ */
99
+ removeDraft(id: string, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse> {
100
+ return this._client.delete(path`/api/v1/addons/${id}/draft`, options);
101
+ }
102
+ }
103
+
104
+ export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
105
+
106
+ export type ChargeListDataMyCursorIDPage = MyCursorIDPage<ChargeList.Data>;
107
+
108
+ /**
109
+ * Response object
110
+ */
111
+ export interface Addon {
112
+ /**
113
+ * Addon configuration object
114
+ */
115
+ data: Addon.Data;
116
+ }
117
+
118
+ export namespace Addon {
119
+ /**
120
+ * Addon configuration object
121
+ */
122
+ export interface Data {
123
+ /**
124
+ * The unique identifier for the entity
125
+ */
126
+ id: string;
127
+
128
+ /**
129
+ * The unique identifier for the entity in the billing provider
130
+ */
131
+ billingId: string | null;
132
+
133
+ /**
134
+ * Timestamp of when the record was created
135
+ */
136
+ createdAt: string;
137
+
138
+ /**
139
+ * List of addons the addon is dependant on
140
+ */
141
+ dependencies: Array<string> | null;
142
+
143
+ /**
144
+ * The description of the package
145
+ */
146
+ description: string | null;
147
+
148
+ /**
149
+ * The display name of the package
150
+ */
151
+ displayName: string;
152
+
153
+ /**
154
+ * List of entitlements of the package
155
+ */
156
+ entitlements: Array<Data.Entitlement>;
157
+
158
+ /**
159
+ * Indicates if the package is the latest version
160
+ */
161
+ isLatest: boolean | null;
162
+
163
+ /**
164
+ * The maximum quantity of this addon that can be added to a subscription
165
+ */
166
+ maxQuantity: number | null;
167
+
168
+ /**
169
+ * Metadata associated with the entity
170
+ */
171
+ metadata: { [key: string]: string };
172
+
173
+ /**
174
+ * The pricing type of the package
175
+ */
176
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
177
+
178
+ /**
179
+ * The product id of the package
180
+ */
181
+ productId: string;
182
+
183
+ /**
184
+ * The status of the package
185
+ */
186
+ status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
187
+
188
+ /**
189
+ * Timestamp of when the record was last updated
190
+ */
191
+ updatedAt: string;
192
+
193
+ /**
194
+ * The version number of the package
195
+ */
196
+ versionNumber: number;
197
+ }
198
+
199
+ export namespace Data {
200
+ /**
201
+ * Entitlement reference with type and identifier
202
+ */
203
+ export interface Entitlement {
204
+ /**
205
+ * The unique identifier for the entity
206
+ */
207
+ id: string;
208
+
209
+ type: 'FEATURE' | 'CREDIT';
210
+ }
211
+ }
212
+ }
213
+
214
+ /**
215
+ * Response list object
216
+ */
217
+ export interface ChargeList {
218
+ data: Array<ChargeList.Data>;
219
+
220
+ /**
221
+ * Pagination metadata including cursors for navigating through results
222
+ */
223
+ pagination: ChargeList.Pagination;
224
+ }
225
+
226
+ export namespace ChargeList {
227
+ /**
228
+ * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
229
+ * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
230
+ * own many of these — one per currency / billing period / feature.
231
+ */
232
+ export interface Data {
233
+ /**
234
+ * Unique identifier of the charge
235
+ */
236
+ id: string;
237
+
238
+ /**
239
+ * The billing cadence (RECURRING or ONE_OFF)
240
+ */
241
+ billingCadence: 'RECURRING' | 'ONE_OFF';
242
+
243
+ /**
244
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
245
+ */
246
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
247
+
248
+ /**
249
+ * The billing period (MONTHLY or ANNUALLY)
250
+ */
251
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
252
+
253
+ /**
254
+ * Timestamp when the charge was created
255
+ */
256
+ createdAt: string;
257
+
258
+ /**
259
+ * ISO country code for localized pricing, if any
260
+ */
261
+ billingCountryCode?: string | null;
262
+
263
+ /**
264
+ * Identifier in the external billing integration (e.g. Stripe price id), if any
265
+ */
266
+ billingId?: string | null;
267
+
268
+ /**
269
+ * Block size for usage-based pricing
270
+ */
271
+ blockSize?: number | null;
272
+
273
+ /**
274
+ * When credits are granted (for credit-based pricing)
275
+ */
276
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
277
+
278
+ /**
279
+ * Credit rate configuration for credit-based pricing
280
+ */
281
+ creditRate?: Data.CreditRate | null;
282
+
283
+ /**
284
+ * Identifier in the linked CRM, if any
285
+ */
286
+ crmId?: string | null;
287
+
288
+ /**
289
+ * Deep link to the charge in the linked CRM, if any
290
+ */
291
+ crmLinkUrl?: string | null;
292
+
293
+ /**
294
+ * The feature this charge meters, if metered
295
+ */
296
+ featureId?: string | null;
297
+
298
+ /**
299
+ * Maximum unit quantity that can be purchased
300
+ */
301
+ maxUnitQuantity?: number | null;
302
+
303
+ /**
304
+ * Minimum unit quantity that can be purchased
305
+ */
306
+ minUnitQuantity?: number | null;
307
+
308
+ /**
309
+ * The flat price amount and currency, when applicable
310
+ */
311
+ price?: Data.Price | null;
312
+
313
+ /**
314
+ * Tiered pricing rows when the charge is tiered
315
+ */
316
+ tiers?: Array<Data.Tier> | null;
317
+
318
+ /**
319
+ * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
320
+ */
321
+ tiersMode?: 'VOLUME' | 'GRADUATED' | null;
322
+
323
+ /**
324
+ * Custom currency identifier for top-up pricing, if any
325
+ */
326
+ topUpCustomCurrencyId?: string | null;
327
+
328
+ /**
329
+ * True if this charge is referenced by at least one subscription
330
+ */
331
+ usedInSubscriptions?: boolean | null;
332
+ }
333
+
334
+ export namespace Data {
335
+ /**
336
+ * Credit rate configuration for credit-based pricing
337
+ */
338
+ export interface CreditRate {
339
+ /**
340
+ * Credit rate amount
341
+ */
342
+ amount: number;
343
+
344
+ /**
345
+ * Custom currency identifier
346
+ */
347
+ currencyId: string;
348
+
349
+ /**
350
+ * Optional cost formula expression
351
+ */
352
+ costFormula?: string | null;
353
+ }
354
+
355
+ /**
356
+ * The flat price amount and currency, when applicable
357
+ */
358
+ export interface Price {
359
+ /**
360
+ * The price amount
361
+ */
362
+ amount: number;
363
+
364
+ /**
365
+ * ISO 4217 currency code
366
+ */
367
+ currency:
368
+ | 'usd'
369
+ | 'aed'
370
+ | 'all'
371
+ | 'amd'
372
+ | 'ang'
373
+ | 'aud'
374
+ | 'awg'
375
+ | 'azn'
376
+ | 'bam'
377
+ | 'bbd'
378
+ | 'bdt'
379
+ | 'bgn'
380
+ | 'bif'
381
+ | 'bmd'
382
+ | 'bnd'
383
+ | 'bsd'
384
+ | 'bwp'
385
+ | 'byn'
386
+ | 'bzd'
387
+ | 'brl'
388
+ | 'cad'
389
+ | 'cdf'
390
+ | 'chf'
391
+ | 'cny'
392
+ | 'czk'
393
+ | 'dkk'
394
+ | 'dop'
395
+ | 'dzd'
396
+ | 'egp'
397
+ | 'etb'
398
+ | 'eur'
399
+ | 'fjd'
400
+ | 'gbp'
401
+ | 'gel'
402
+ | 'gip'
403
+ | 'gmd'
404
+ | 'gyd'
405
+ | 'hkd'
406
+ | 'hrk'
407
+ | 'htg'
408
+ | 'idr'
409
+ | 'ils'
410
+ | 'inr'
411
+ | 'isk'
412
+ | 'jmd'
413
+ | 'jpy'
414
+ | 'kes'
415
+ | 'kgs'
416
+ | 'khr'
417
+ | 'kmf'
418
+ | 'krw'
419
+ | 'kyd'
420
+ | 'kzt'
421
+ | 'lbp'
422
+ | 'lkr'
423
+ | 'lrd'
424
+ | 'lsl'
425
+ | 'mad'
426
+ | 'mdl'
427
+ | 'mga'
428
+ | 'mkd'
429
+ | 'mmk'
430
+ | 'mnt'
431
+ | 'mop'
432
+ | 'mro'
433
+ | 'mvr'
434
+ | 'mwk'
435
+ | 'mxn'
436
+ | 'myr'
437
+ | 'mzn'
438
+ | 'nad'
439
+ | 'ngn'
440
+ | 'nok'
441
+ | 'npr'
442
+ | 'nzd'
443
+ | 'pgk'
444
+ | 'php'
445
+ | 'pkr'
446
+ | 'pln'
447
+ | 'qar'
448
+ | 'ron'
449
+ | 'rsd'
450
+ | 'rub'
451
+ | 'rwf'
452
+ | 'sar'
453
+ | 'sbd'
454
+ | 'scr'
455
+ | 'sek'
456
+ | 'sgd'
457
+ | 'sle'
458
+ | 'sll'
459
+ | 'sos'
460
+ | 'szl'
461
+ | 'thb'
462
+ | 'tjs'
463
+ | 'top'
464
+ | 'try'
465
+ | 'ttd'
466
+ | 'tzs'
467
+ | 'uah'
468
+ | 'uzs'
469
+ | 'vnd'
470
+ | 'vuv'
471
+ | 'wst'
472
+ | 'xaf'
473
+ | 'xcd'
474
+ | 'yer'
475
+ | 'zar'
476
+ | 'zmw'
477
+ | 'clp'
478
+ | 'djf'
479
+ | 'gnf'
480
+ | 'ugx'
481
+ | 'pyg'
482
+ | 'xof'
483
+ | 'xpf';
484
+ }
485
+
486
+ /**
487
+ * A single tier within a tiered charge
488
+ */
489
+ export interface Tier {
490
+ /**
491
+ * Flat price for this tier
492
+ */
493
+ flatPrice?: Tier.FlatPrice | null;
494
+
495
+ /**
496
+ * Per-unit price in this tier
497
+ */
498
+ unitPrice?: Tier.UnitPrice | null;
499
+
500
+ /**
501
+ * Upper bound of this tier (null for unlimited)
502
+ */
503
+ upTo?: number | null;
504
+ }
505
+
506
+ export namespace Tier {
507
+ /**
508
+ * Flat price for this tier
509
+ */
510
+ export interface FlatPrice {
511
+ /**
512
+ * The price amount
513
+ */
514
+ amount: number;
515
+
516
+ /**
517
+ * ISO 4217 currency code
518
+ */
519
+ currency:
520
+ | 'usd'
521
+ | 'aed'
522
+ | 'all'
523
+ | 'amd'
524
+ | 'ang'
525
+ | 'aud'
526
+ | 'awg'
527
+ | 'azn'
528
+ | 'bam'
529
+ | 'bbd'
530
+ | 'bdt'
531
+ | 'bgn'
532
+ | 'bif'
533
+ | 'bmd'
534
+ | 'bnd'
535
+ | 'bsd'
536
+ | 'bwp'
537
+ | 'byn'
538
+ | 'bzd'
539
+ | 'brl'
540
+ | 'cad'
541
+ | 'cdf'
542
+ | 'chf'
543
+ | 'cny'
544
+ | 'czk'
545
+ | 'dkk'
546
+ | 'dop'
547
+ | 'dzd'
548
+ | 'egp'
549
+ | 'etb'
550
+ | 'eur'
551
+ | 'fjd'
552
+ | 'gbp'
553
+ | 'gel'
554
+ | 'gip'
555
+ | 'gmd'
556
+ | 'gyd'
557
+ | 'hkd'
558
+ | 'hrk'
559
+ | 'htg'
560
+ | 'idr'
561
+ | 'ils'
562
+ | 'inr'
563
+ | 'isk'
564
+ | 'jmd'
565
+ | 'jpy'
566
+ | 'kes'
567
+ | 'kgs'
568
+ | 'khr'
569
+ | 'kmf'
570
+ | 'krw'
571
+ | 'kyd'
572
+ | 'kzt'
573
+ | 'lbp'
574
+ | 'lkr'
575
+ | 'lrd'
576
+ | 'lsl'
577
+ | 'mad'
578
+ | 'mdl'
579
+ | 'mga'
580
+ | 'mkd'
581
+ | 'mmk'
582
+ | 'mnt'
583
+ | 'mop'
584
+ | 'mro'
585
+ | 'mvr'
586
+ | 'mwk'
587
+ | 'mxn'
588
+ | 'myr'
589
+ | 'mzn'
590
+ | 'nad'
591
+ | 'ngn'
592
+ | 'nok'
593
+ | 'npr'
594
+ | 'nzd'
595
+ | 'pgk'
596
+ | 'php'
597
+ | 'pkr'
598
+ | 'pln'
599
+ | 'qar'
600
+ | 'ron'
601
+ | 'rsd'
602
+ | 'rub'
603
+ | 'rwf'
604
+ | 'sar'
605
+ | 'sbd'
606
+ | 'scr'
607
+ | 'sek'
608
+ | 'sgd'
609
+ | 'sle'
610
+ | 'sll'
611
+ | 'sos'
612
+ | 'szl'
613
+ | 'thb'
614
+ | 'tjs'
615
+ | 'top'
616
+ | 'try'
617
+ | 'ttd'
618
+ | 'tzs'
619
+ | 'uah'
620
+ | 'uzs'
621
+ | 'vnd'
622
+ | 'vuv'
623
+ | 'wst'
624
+ | 'xaf'
625
+ | 'xcd'
626
+ | 'yer'
627
+ | 'zar'
628
+ | 'zmw'
629
+ | 'clp'
630
+ | 'djf'
631
+ | 'gnf'
632
+ | 'ugx'
633
+ | 'pyg'
634
+ | 'xof'
635
+ | 'xpf';
636
+ }
637
+
638
+ /**
639
+ * Per-unit price in this tier
640
+ */
641
+ export interface UnitPrice {
642
+ /**
643
+ * The price amount
644
+ */
645
+ amount: number;
646
+
647
+ /**
648
+ * ISO 4217 currency code
649
+ */
650
+ currency:
651
+ | 'usd'
652
+ | 'aed'
653
+ | 'all'
654
+ | 'amd'
655
+ | 'ang'
656
+ | 'aud'
657
+ | 'awg'
658
+ | 'azn'
659
+ | 'bam'
660
+ | 'bbd'
661
+ | 'bdt'
662
+ | 'bgn'
663
+ | 'bif'
664
+ | 'bmd'
665
+ | 'bnd'
666
+ | 'bsd'
667
+ | 'bwp'
668
+ | 'byn'
669
+ | 'bzd'
670
+ | 'brl'
671
+ | 'cad'
672
+ | 'cdf'
673
+ | 'chf'
674
+ | 'cny'
675
+ | 'czk'
676
+ | 'dkk'
677
+ | 'dop'
678
+ | 'dzd'
679
+ | 'egp'
680
+ | 'etb'
681
+ | 'eur'
682
+ | 'fjd'
683
+ | 'gbp'
684
+ | 'gel'
685
+ | 'gip'
686
+ | 'gmd'
687
+ | 'gyd'
688
+ | 'hkd'
689
+ | 'hrk'
690
+ | 'htg'
691
+ | 'idr'
692
+ | 'ils'
693
+ | 'inr'
694
+ | 'isk'
695
+ | 'jmd'
696
+ | 'jpy'
697
+ | 'kes'
698
+ | 'kgs'
699
+ | 'khr'
700
+ | 'kmf'
701
+ | 'krw'
702
+ | 'kyd'
703
+ | 'kzt'
704
+ | 'lbp'
705
+ | 'lkr'
706
+ | 'lrd'
707
+ | 'lsl'
708
+ | 'mad'
709
+ | 'mdl'
710
+ | 'mga'
711
+ | 'mkd'
712
+ | 'mmk'
713
+ | 'mnt'
714
+ | 'mop'
715
+ | 'mro'
716
+ | 'mvr'
717
+ | 'mwk'
718
+ | 'mxn'
719
+ | 'myr'
720
+ | 'mzn'
721
+ | 'nad'
722
+ | 'ngn'
723
+ | 'nok'
724
+ | 'npr'
725
+ | 'nzd'
726
+ | 'pgk'
727
+ | 'php'
728
+ | 'pkr'
729
+ | 'pln'
730
+ | 'qar'
731
+ | 'ron'
732
+ | 'rsd'
733
+ | 'rub'
734
+ | 'rwf'
735
+ | 'sar'
736
+ | 'sbd'
737
+ | 'scr'
738
+ | 'sek'
739
+ | 'sgd'
740
+ | 'sle'
741
+ | 'sll'
742
+ | 'sos'
743
+ | 'szl'
744
+ | 'thb'
745
+ | 'tjs'
746
+ | 'top'
747
+ | 'try'
748
+ | 'ttd'
749
+ | 'tzs'
750
+ | 'uah'
751
+ | 'uzs'
752
+ | 'vnd'
753
+ | 'vuv'
754
+ | 'wst'
755
+ | 'xaf'
756
+ | 'xcd'
757
+ | 'yer'
758
+ | 'zar'
759
+ | 'zmw'
760
+ | 'clp'
761
+ | 'djf'
762
+ | 'gnf'
763
+ | 'ugx'
764
+ | 'pyg'
765
+ | 'xof'
766
+ | 'xpf';
767
+ }
768
+ }
769
+ }
770
+
771
+ /**
772
+ * Pagination metadata including cursors for navigating through results
773
+ */
774
+ export interface Pagination {
775
+ /**
776
+ * Cursor for fetching the next page of results, or null if no additional pages
777
+ * exist
778
+ */
779
+ next: string | null;
780
+
781
+ /**
782
+ * Cursor for fetching the previous page of results, or null if at the beginning
783
+ */
784
+ prev: string | null;
785
+ }
786
+ }
787
+
788
+ /**
789
+ * Addon configuration object
790
+ */
791
+ export interface AddonListResponse {
792
+ /**
793
+ * The unique identifier for the entity
794
+ */
795
+ id: string;
796
+
797
+ /**
798
+ * The unique identifier for the entity in the billing provider
799
+ */
800
+ billingId: string | null;
801
+
802
+ /**
803
+ * Timestamp of when the record was created
804
+ */
805
+ createdAt: string;
806
+
807
+ /**
808
+ * List of addons the addon is dependant on
809
+ */
810
+ dependencies: Array<string> | null;
811
+
812
+ /**
813
+ * The description of the package
814
+ */
815
+ description: string | null;
816
+
817
+ /**
818
+ * The display name of the package
819
+ */
820
+ displayName: string;
821
+
822
+ /**
823
+ * List of entitlements of the package
824
+ */
825
+ entitlements: Array<AddonListResponse.Entitlement>;
826
+
827
+ /**
828
+ * Indicates if the package is the latest version
829
+ */
830
+ isLatest: boolean | null;
831
+
832
+ /**
833
+ * The maximum quantity of this addon that can be added to a subscription
834
+ */
835
+ maxQuantity: number | null;
836
+
837
+ /**
838
+ * Metadata associated with the entity
839
+ */
840
+ metadata: { [key: string]: string };
841
+
842
+ /**
843
+ * The pricing type of the package
844
+ */
845
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
846
+
847
+ /**
848
+ * The product id of the package
849
+ */
850
+ productId: string;
851
+
852
+ /**
853
+ * The status of the package
854
+ */
855
+ status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
856
+
857
+ /**
858
+ * Timestamp of when the record was last updated
859
+ */
860
+ updatedAt: string;
861
+
862
+ /**
863
+ * The version number of the package
864
+ */
865
+ versionNumber: number;
866
+ }
867
+
868
+ export namespace AddonListResponse {
869
+ /**
870
+ * Entitlement reference with type and identifier
871
+ */
872
+ export interface Entitlement {
873
+ /**
874
+ * The unique identifier for the entity
875
+ */
876
+ id: string;
877
+
878
+ type: 'FEATURE' | 'CREDIT';
879
+ }
880
+ }
881
+
882
+ /**
883
+ * Response containing task ID for publish operation
884
+ */
885
+ export interface AddonPublishResponse {
886
+ data: AddonPublishResponse.Data;
887
+ }
888
+
889
+ export namespace AddonPublishResponse {
890
+ export interface Data {
891
+ /**
892
+ * Task ID for tracking the async publish operation
893
+ */
894
+ taskId: string | null;
895
+ }
896
+ }
897
+
898
+ /**
899
+ * Response confirming the addon draft was removed.
900
+ */
901
+ export interface AddonRemoveDraftResponse {
902
+ data: AddonRemoveDraftResponse.Data;
903
+ }
904
+
905
+ export namespace AddonRemoveDraftResponse {
906
+ export interface Data {
907
+ /**
908
+ * The unique identifier for the entity
909
+ */
910
+ id: string;
911
+ }
912
+ }
913
+
914
+ export interface AddonCreateParams {
915
+ /**
916
+ * The unique identifier for the entity
917
+ */
918
+ id: string;
919
+
920
+ /**
921
+ * The display name of the package
922
+ */
923
+ displayName: string;
924
+
925
+ /**
926
+ * The product id of the package
927
+ */
928
+ productId: string;
929
+
930
+ /**
931
+ * The unique identifier for the entity in the billing provider
932
+ */
933
+ billingId?: string | null;
934
+
935
+ /**
936
+ * The description of the package
937
+ */
938
+ description?: string | null;
939
+
940
+ /**
941
+ * The maximum quantity of this addon that can be added to a subscription
942
+ */
943
+ maxQuantity?: number | null;
944
+
945
+ /**
946
+ * Metadata associated with the entity
947
+ */
948
+ metadata?: { [key: string]: string };
949
+
950
+ /**
951
+ * The pricing type of the package
952
+ */
953
+ pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
954
+
955
+ /**
956
+ * The status of the package
957
+ */
958
+ status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
959
+ }
960
+
961
+ export interface AddonUpdateParams {
962
+ /**
963
+ * The unique identifier for the entity in the billing provider
964
+ */
965
+ billingId?: string | null;
966
+
967
+ /**
968
+ * Pricing configuration to set on the addon draft
969
+ */
970
+ charges?: AddonUpdateParams.Charges;
971
+
972
+ /**
973
+ * List of addons the addon is dependant on
974
+ */
975
+ dependencies?: Array<string> | null;
976
+
977
+ /**
978
+ * The description of the package
979
+ */
980
+ description?: string | null;
981
+
982
+ /**
983
+ * The display name of the package
984
+ */
985
+ displayName?: string;
986
+
987
+ /**
988
+ * The maximum quantity of this addon that can be added to a subscription
989
+ */
990
+ maxQuantity?: number | null;
991
+
992
+ /**
993
+ * Metadata associated with the entity
994
+ */
995
+ metadata?: { [key: string]: string };
996
+
997
+ /**
998
+ * The status of the package
999
+ */
1000
+ status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
1001
+ }
1002
+
1003
+ export namespace AddonUpdateParams {
1004
+ /**
1005
+ * Pricing configuration to set on the addon draft
1006
+ */
1007
+ export interface Charges {
1008
+ /**
1009
+ * The pricing type (FREE, PAID, or CUSTOM)
1010
+ */
1011
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
1012
+
1013
+ /**
1014
+ * Deprecated: billing integration ID
1015
+ */
1016
+ billingId?: string;
1017
+
1018
+ /**
1019
+ * Minimum spend configuration per billing period
1020
+ */
1021
+ minimumSpend?: Array<Charges.MinimumSpend> | null;
1022
+
1023
+ /**
1024
+ * When overage charges are billed
1025
+ */
1026
+ overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
1027
+
1028
+ /**
1029
+ * Array of overage pricing model configurations
1030
+ */
1031
+ overagePricingModels?: Array<Charges.OveragePricingModel>;
1032
+
1033
+ /**
1034
+ * Array of pricing model configurations
1035
+ */
1036
+ pricingModels?: Array<Charges.PricingModel>;
1037
+ }
1038
+
1039
+ export namespace Charges {
1040
+ /**
1041
+ * Minimum spend configuration for a billing period.
1042
+ */
1043
+ export interface MinimumSpend {
1044
+ /**
1045
+ * The billing period
1046
+ */
1047
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
1048
+
1049
+ /**
1050
+ * The minimum spend amount
1051
+ */
1052
+ minimum: MinimumSpend.Minimum;
1053
+ }
1054
+
1055
+ export namespace MinimumSpend {
1056
+ /**
1057
+ * The minimum spend amount
1058
+ */
1059
+ export interface Minimum {
1060
+ /**
1061
+ * The price amount
1062
+ */
1063
+ amount: number;
1064
+
1065
+ /**
1066
+ * The price currency
1067
+ */
1068
+ currency?:
1069
+ | 'usd'
1070
+ | 'aed'
1071
+ | 'all'
1072
+ | 'amd'
1073
+ | 'ang'
1074
+ | 'aud'
1075
+ | 'awg'
1076
+ | 'azn'
1077
+ | 'bam'
1078
+ | 'bbd'
1079
+ | 'bdt'
1080
+ | 'bgn'
1081
+ | 'bif'
1082
+ | 'bmd'
1083
+ | 'bnd'
1084
+ | 'bsd'
1085
+ | 'bwp'
1086
+ | 'byn'
1087
+ | 'bzd'
1088
+ | 'brl'
1089
+ | 'cad'
1090
+ | 'cdf'
1091
+ | 'chf'
1092
+ | 'cny'
1093
+ | 'czk'
1094
+ | 'dkk'
1095
+ | 'dop'
1096
+ | 'dzd'
1097
+ | 'egp'
1098
+ | 'etb'
1099
+ | 'eur'
1100
+ | 'fjd'
1101
+ | 'gbp'
1102
+ | 'gel'
1103
+ | 'gip'
1104
+ | 'gmd'
1105
+ | 'gyd'
1106
+ | 'hkd'
1107
+ | 'hrk'
1108
+ | 'htg'
1109
+ | 'idr'
1110
+ | 'ils'
1111
+ | 'inr'
1112
+ | 'isk'
1113
+ | 'jmd'
1114
+ | 'jpy'
1115
+ | 'kes'
1116
+ | 'kgs'
1117
+ | 'khr'
1118
+ | 'kmf'
1119
+ | 'krw'
1120
+ | 'kyd'
1121
+ | 'kzt'
1122
+ | 'lbp'
1123
+ | 'lkr'
1124
+ | 'lrd'
1125
+ | 'lsl'
1126
+ | 'mad'
1127
+ | 'mdl'
1128
+ | 'mga'
1129
+ | 'mkd'
1130
+ | 'mmk'
1131
+ | 'mnt'
1132
+ | 'mop'
1133
+ | 'mro'
1134
+ | 'mvr'
1135
+ | 'mwk'
1136
+ | 'mxn'
1137
+ | 'myr'
1138
+ | 'mzn'
1139
+ | 'nad'
1140
+ | 'ngn'
1141
+ | 'nok'
1142
+ | 'npr'
1143
+ | 'nzd'
1144
+ | 'pgk'
1145
+ | 'php'
1146
+ | 'pkr'
1147
+ | 'pln'
1148
+ | 'qar'
1149
+ | 'ron'
1150
+ | 'rsd'
1151
+ | 'rub'
1152
+ | 'rwf'
1153
+ | 'sar'
1154
+ | 'sbd'
1155
+ | 'scr'
1156
+ | 'sek'
1157
+ | 'sgd'
1158
+ | 'sle'
1159
+ | 'sll'
1160
+ | 'sos'
1161
+ | 'szl'
1162
+ | 'thb'
1163
+ | 'tjs'
1164
+ | 'top'
1165
+ | 'try'
1166
+ | 'ttd'
1167
+ | 'tzs'
1168
+ | 'uah'
1169
+ | 'uzs'
1170
+ | 'vnd'
1171
+ | 'vuv'
1172
+ | 'wst'
1173
+ | 'xaf'
1174
+ | 'xcd'
1175
+ | 'yer'
1176
+ | 'zar'
1177
+ | 'zmw'
1178
+ | 'clp'
1179
+ | 'djf'
1180
+ | 'gnf'
1181
+ | 'ugx'
1182
+ | 'pyg'
1183
+ | 'xof'
1184
+ | 'xpf';
1185
+ }
1186
+ }
1187
+
1188
+ /**
1189
+ * Overage pricing model configuration.
1190
+ */
1191
+ export interface OveragePricingModel {
1192
+ /**
1193
+ * The billing model for overages
1194
+ */
1195
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1196
+
1197
+ /**
1198
+ * Price periods for overage pricing
1199
+ */
1200
+ pricePeriods: Array<OveragePricingModel.PricePeriod>;
1201
+
1202
+ /**
1203
+ * The billing cadence for overages
1204
+ */
1205
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
1206
+
1207
+ /**
1208
+ * Entitlement configuration for the overage feature
1209
+ */
1210
+ entitlement?: OveragePricingModel.Entitlement;
1211
+
1212
+ /**
1213
+ * The feature ID for overage pricing
1214
+ */
1215
+ featureId?: string;
1216
+
1217
+ /**
1218
+ * Custom currency ID for overage top-up
1219
+ */
1220
+ topUpCustomCurrencyId?: string;
1221
+ }
1222
+
1223
+ export namespace OveragePricingModel {
1224
+ /**
1225
+ * Price configuration for a specific billing period.
1226
+ */
1227
+ export interface PricePeriod {
1228
+ /**
1229
+ * The billing period (MONTHLY or ANNUALLY)
1230
+ */
1231
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
1232
+
1233
+ /**
1234
+ * ISO country code for localized pricing
1235
+ */
1236
+ billingCountryCode?: string;
1237
+
1238
+ /**
1239
+ * Block size for usage-based pricing
1240
+ */
1241
+ blockSize?: number;
1242
+
1243
+ /**
1244
+ * When credits are granted
1245
+ */
1246
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1247
+
1248
+ /**
1249
+ * Credit rate configuration for credit-based pricing
1250
+ */
1251
+ creditRate?: PricePeriod.CreditRate;
1252
+
1253
+ /**
1254
+ * The price amount and currency
1255
+ */
1256
+ price?: PricePeriod.Price;
1257
+
1258
+ /**
1259
+ * Tiered pricing configuration
1260
+ */
1261
+ tiers?: Array<PricePeriod.Tier>;
1262
+ }
1263
+
1264
+ export namespace PricePeriod {
1265
+ /**
1266
+ * Credit rate configuration for credit-based pricing
1267
+ */
1268
+ export interface CreditRate {
1269
+ /**
1270
+ * The credit rate amount
1271
+ */
1272
+ amount: number;
1273
+
1274
+ /**
1275
+ * The custom currency ID
1276
+ */
1277
+ currencyId: string;
1278
+
1279
+ /**
1280
+ * Optional cost formula expression
1281
+ */
1282
+ costFormula?: string;
1283
+ }
1284
+
1285
+ /**
1286
+ * The price amount and currency
1287
+ */
1288
+ export interface Price {
1289
+ /**
1290
+ * The price amount
1291
+ */
1292
+ amount: number;
1293
+
1294
+ /**
1295
+ * The price currency
1296
+ */
1297
+ currency?:
1298
+ | 'usd'
1299
+ | 'aed'
1300
+ | 'all'
1301
+ | 'amd'
1302
+ | 'ang'
1303
+ | 'aud'
1304
+ | 'awg'
1305
+ | 'azn'
1306
+ | 'bam'
1307
+ | 'bbd'
1308
+ | 'bdt'
1309
+ | 'bgn'
1310
+ | 'bif'
1311
+ | 'bmd'
1312
+ | 'bnd'
1313
+ | 'bsd'
1314
+ | 'bwp'
1315
+ | 'byn'
1316
+ | 'bzd'
1317
+ | 'brl'
1318
+ | 'cad'
1319
+ | 'cdf'
1320
+ | 'chf'
1321
+ | 'cny'
1322
+ | 'czk'
1323
+ | 'dkk'
1324
+ | 'dop'
1325
+ | 'dzd'
1326
+ | 'egp'
1327
+ | 'etb'
1328
+ | 'eur'
1329
+ | 'fjd'
1330
+ | 'gbp'
1331
+ | 'gel'
1332
+ | 'gip'
1333
+ | 'gmd'
1334
+ | 'gyd'
1335
+ | 'hkd'
1336
+ | 'hrk'
1337
+ | 'htg'
1338
+ | 'idr'
1339
+ | 'ils'
1340
+ | 'inr'
1341
+ | 'isk'
1342
+ | 'jmd'
1343
+ | 'jpy'
1344
+ | 'kes'
1345
+ | 'kgs'
1346
+ | 'khr'
1347
+ | 'kmf'
1348
+ | 'krw'
1349
+ | 'kyd'
1350
+ | 'kzt'
1351
+ | 'lbp'
1352
+ | 'lkr'
1353
+ | 'lrd'
1354
+ | 'lsl'
1355
+ | 'mad'
1356
+ | 'mdl'
1357
+ | 'mga'
1358
+ | 'mkd'
1359
+ | 'mmk'
1360
+ | 'mnt'
1361
+ | 'mop'
1362
+ | 'mro'
1363
+ | 'mvr'
1364
+ | 'mwk'
1365
+ | 'mxn'
1366
+ | 'myr'
1367
+ | 'mzn'
1368
+ | 'nad'
1369
+ | 'ngn'
1370
+ | 'nok'
1371
+ | 'npr'
1372
+ | 'nzd'
1373
+ | 'pgk'
1374
+ | 'php'
1375
+ | 'pkr'
1376
+ | 'pln'
1377
+ | 'qar'
1378
+ | 'ron'
1379
+ | 'rsd'
1380
+ | 'rub'
1381
+ | 'rwf'
1382
+ | 'sar'
1383
+ | 'sbd'
1384
+ | 'scr'
1385
+ | 'sek'
1386
+ | 'sgd'
1387
+ | 'sle'
1388
+ | 'sll'
1389
+ | 'sos'
1390
+ | 'szl'
1391
+ | 'thb'
1392
+ | 'tjs'
1393
+ | 'top'
1394
+ | 'try'
1395
+ | 'ttd'
1396
+ | 'tzs'
1397
+ | 'uah'
1398
+ | 'uzs'
1399
+ | 'vnd'
1400
+ | 'vuv'
1401
+ | 'wst'
1402
+ | 'xaf'
1403
+ | 'xcd'
1404
+ | 'yer'
1405
+ | 'zar'
1406
+ | 'zmw'
1407
+ | 'clp'
1408
+ | 'djf'
1409
+ | 'gnf'
1410
+ | 'ugx'
1411
+ | 'pyg'
1412
+ | 'xof'
1413
+ | 'xpf';
1414
+ }
1415
+
1416
+ /**
1417
+ * A tier in tiered pricing.
1418
+ */
1419
+ export interface Tier {
1420
+ /**
1421
+ * Flat price for this tier
1422
+ */
1423
+ flatPrice?: Tier.FlatPrice;
1424
+
1425
+ /**
1426
+ * Per-unit price in this tier
1427
+ */
1428
+ unitPrice?: Tier.UnitPrice;
1429
+
1430
+ /**
1431
+ * Upper bound of this tier (null for unlimited)
1432
+ */
1433
+ upTo?: number;
1434
+ }
1435
+
1436
+ export namespace Tier {
1437
+ /**
1438
+ * Flat price for this tier
1439
+ */
1440
+ export interface FlatPrice {
1441
+ /**
1442
+ * The price amount
1443
+ */
1444
+ amount: number;
1445
+
1446
+ /**
1447
+ * The price currency
1448
+ */
1449
+ currency?:
1450
+ | 'usd'
1451
+ | 'aed'
1452
+ | 'all'
1453
+ | 'amd'
1454
+ | 'ang'
1455
+ | 'aud'
1456
+ | 'awg'
1457
+ | 'azn'
1458
+ | 'bam'
1459
+ | 'bbd'
1460
+ | 'bdt'
1461
+ | 'bgn'
1462
+ | 'bif'
1463
+ | 'bmd'
1464
+ | 'bnd'
1465
+ | 'bsd'
1466
+ | 'bwp'
1467
+ | 'byn'
1468
+ | 'bzd'
1469
+ | 'brl'
1470
+ | 'cad'
1471
+ | 'cdf'
1472
+ | 'chf'
1473
+ | 'cny'
1474
+ | 'czk'
1475
+ | 'dkk'
1476
+ | 'dop'
1477
+ | 'dzd'
1478
+ | 'egp'
1479
+ | 'etb'
1480
+ | 'eur'
1481
+ | 'fjd'
1482
+ | 'gbp'
1483
+ | 'gel'
1484
+ | 'gip'
1485
+ | 'gmd'
1486
+ | 'gyd'
1487
+ | 'hkd'
1488
+ | 'hrk'
1489
+ | 'htg'
1490
+ | 'idr'
1491
+ | 'ils'
1492
+ | 'inr'
1493
+ | 'isk'
1494
+ | 'jmd'
1495
+ | 'jpy'
1496
+ | 'kes'
1497
+ | 'kgs'
1498
+ | 'khr'
1499
+ | 'kmf'
1500
+ | 'krw'
1501
+ | 'kyd'
1502
+ | 'kzt'
1503
+ | 'lbp'
1504
+ | 'lkr'
1505
+ | 'lrd'
1506
+ | 'lsl'
1507
+ | 'mad'
1508
+ | 'mdl'
1509
+ | 'mga'
1510
+ | 'mkd'
1511
+ | 'mmk'
1512
+ | 'mnt'
1513
+ | 'mop'
1514
+ | 'mro'
1515
+ | 'mvr'
1516
+ | 'mwk'
1517
+ | 'mxn'
1518
+ | 'myr'
1519
+ | 'mzn'
1520
+ | 'nad'
1521
+ | 'ngn'
1522
+ | 'nok'
1523
+ | 'npr'
1524
+ | 'nzd'
1525
+ | 'pgk'
1526
+ | 'php'
1527
+ | 'pkr'
1528
+ | 'pln'
1529
+ | 'qar'
1530
+ | 'ron'
1531
+ | 'rsd'
1532
+ | 'rub'
1533
+ | 'rwf'
1534
+ | 'sar'
1535
+ | 'sbd'
1536
+ | 'scr'
1537
+ | 'sek'
1538
+ | 'sgd'
1539
+ | 'sle'
1540
+ | 'sll'
1541
+ | 'sos'
1542
+ | 'szl'
1543
+ | 'thb'
1544
+ | 'tjs'
1545
+ | 'top'
1546
+ | 'try'
1547
+ | 'ttd'
1548
+ | 'tzs'
1549
+ | 'uah'
1550
+ | 'uzs'
1551
+ | 'vnd'
1552
+ | 'vuv'
1553
+ | 'wst'
1554
+ | 'xaf'
1555
+ | 'xcd'
1556
+ | 'yer'
1557
+ | 'zar'
1558
+ | 'zmw'
1559
+ | 'clp'
1560
+ | 'djf'
1561
+ | 'gnf'
1562
+ | 'ugx'
1563
+ | 'pyg'
1564
+ | 'xof'
1565
+ | 'xpf';
1566
+ }
1567
+
1568
+ /**
1569
+ * Per-unit price in this tier
1570
+ */
1571
+ export interface UnitPrice {
1572
+ /**
1573
+ * The price amount
1574
+ */
1575
+ amount: number;
1576
+
1577
+ /**
1578
+ * The price currency
1579
+ */
1580
+ currency?:
1581
+ | 'usd'
1582
+ | 'aed'
1583
+ | 'all'
1584
+ | 'amd'
1585
+ | 'ang'
1586
+ | 'aud'
1587
+ | 'awg'
1588
+ | 'azn'
1589
+ | 'bam'
1590
+ | 'bbd'
1591
+ | 'bdt'
1592
+ | 'bgn'
1593
+ | 'bif'
1594
+ | 'bmd'
1595
+ | 'bnd'
1596
+ | 'bsd'
1597
+ | 'bwp'
1598
+ | 'byn'
1599
+ | 'bzd'
1600
+ | 'brl'
1601
+ | 'cad'
1602
+ | 'cdf'
1603
+ | 'chf'
1604
+ | 'cny'
1605
+ | 'czk'
1606
+ | 'dkk'
1607
+ | 'dop'
1608
+ | 'dzd'
1609
+ | 'egp'
1610
+ | 'etb'
1611
+ | 'eur'
1612
+ | 'fjd'
1613
+ | 'gbp'
1614
+ | 'gel'
1615
+ | 'gip'
1616
+ | 'gmd'
1617
+ | 'gyd'
1618
+ | 'hkd'
1619
+ | 'hrk'
1620
+ | 'htg'
1621
+ | 'idr'
1622
+ | 'ils'
1623
+ | 'inr'
1624
+ | 'isk'
1625
+ | 'jmd'
1626
+ | 'jpy'
1627
+ | 'kes'
1628
+ | 'kgs'
1629
+ | 'khr'
1630
+ | 'kmf'
1631
+ | 'krw'
1632
+ | 'kyd'
1633
+ | 'kzt'
1634
+ | 'lbp'
1635
+ | 'lkr'
1636
+ | 'lrd'
1637
+ | 'lsl'
1638
+ | 'mad'
1639
+ | 'mdl'
1640
+ | 'mga'
1641
+ | 'mkd'
1642
+ | 'mmk'
1643
+ | 'mnt'
1644
+ | 'mop'
1645
+ | 'mro'
1646
+ | 'mvr'
1647
+ | 'mwk'
1648
+ | 'mxn'
1649
+ | 'myr'
1650
+ | 'mzn'
1651
+ | 'nad'
1652
+ | 'ngn'
1653
+ | 'nok'
1654
+ | 'npr'
1655
+ | 'nzd'
1656
+ | 'pgk'
1657
+ | 'php'
1658
+ | 'pkr'
1659
+ | 'pln'
1660
+ | 'qar'
1661
+ | 'ron'
1662
+ | 'rsd'
1663
+ | 'rub'
1664
+ | 'rwf'
1665
+ | 'sar'
1666
+ | 'sbd'
1667
+ | 'scr'
1668
+ | 'sek'
1669
+ | 'sgd'
1670
+ | 'sle'
1671
+ | 'sll'
1672
+ | 'sos'
1673
+ | 'szl'
1674
+ | 'thb'
1675
+ | 'tjs'
1676
+ | 'top'
1677
+ | 'try'
1678
+ | 'ttd'
1679
+ | 'tzs'
1680
+ | 'uah'
1681
+ | 'uzs'
1682
+ | 'vnd'
1683
+ | 'vuv'
1684
+ | 'wst'
1685
+ | 'xaf'
1686
+ | 'xcd'
1687
+ | 'yer'
1688
+ | 'zar'
1689
+ | 'zmw'
1690
+ | 'clp'
1691
+ | 'djf'
1692
+ | 'gnf'
1693
+ | 'ugx'
1694
+ | 'pyg'
1695
+ | 'xof'
1696
+ | 'xpf';
1697
+ }
1698
+ }
1699
+ }
1700
+
1701
+ /**
1702
+ * Entitlement configuration for the overage feature
1703
+ */
1704
+ export interface Entitlement {
1705
+ /**
1706
+ * The feature ID for the entitlement
1707
+ */
1708
+ featureId: string;
1709
+
1710
+ /**
1711
+ * Whether the limit is soft (allows overage)
1712
+ */
1713
+ hasSoftLimit?: boolean;
1714
+
1715
+ /**
1716
+ * Whether usage is unlimited
1717
+ */
1718
+ hasUnlimitedUsage?: boolean;
1719
+
1720
+ /**
1721
+ * Monthly reset configuration
1722
+ */
1723
+ monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
1724
+
1725
+ /**
1726
+ * The usage reset period
1727
+ */
1728
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1729
+
1730
+ /**
1731
+ * The usage limit before overage kicks in
1732
+ */
1733
+ usageLimit?: number;
1734
+
1735
+ /**
1736
+ * Weekly reset configuration
1737
+ */
1738
+ weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
1739
+
1740
+ /**
1741
+ * Yearly reset configuration
1742
+ */
1743
+ yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
1744
+ }
1745
+
1746
+ export namespace Entitlement {
1747
+ /**
1748
+ * Monthly reset configuration
1749
+ */
1750
+ export interface MonthlyResetPeriodConfiguration {
1751
+ /**
1752
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
1753
+ */
1754
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1755
+ }
1756
+
1757
+ /**
1758
+ * Weekly reset configuration
1759
+ */
1760
+ export interface WeeklyResetPeriodConfiguration {
1761
+ /**
1762
+ * Reset anchor (SubscriptionStart or specific day)
1763
+ */
1764
+ accordingTo:
1765
+ | 'SubscriptionStart'
1766
+ | 'EverySunday'
1767
+ | 'EveryMonday'
1768
+ | 'EveryTuesday'
1769
+ | 'EveryWednesday'
1770
+ | 'EveryThursday'
1771
+ | 'EveryFriday'
1772
+ | 'EverySaturday';
1773
+ }
1774
+
1775
+ /**
1776
+ * Yearly reset configuration
1777
+ */
1778
+ export interface YearlyResetPeriodConfiguration {
1779
+ /**
1780
+ * Reset anchor (SubscriptionStart)
1781
+ */
1782
+ accordingTo: 'SubscriptionStart';
1783
+ }
1784
+ }
1785
+ }
1786
+
1787
+ /**
1788
+ * A pricing model configuration with billing details and price periods.
1789
+ */
1790
+ export interface PricingModel {
1791
+ /**
1792
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
1793
+ */
1794
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1795
+
1796
+ /**
1797
+ * Array of price period configurations (at least one required)
1798
+ */
1799
+ pricePeriods: Array<PricingModel.PricePeriod>;
1800
+
1801
+ /**
1802
+ * The billing cadence (RECURRING or ONE_OFF)
1803
+ */
1804
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
1805
+
1806
+ /**
1807
+ * The feature ID this pricing model is associated with
1808
+ */
1809
+ featureId?: string;
1810
+
1811
+ /**
1812
+ * Maximum number of units (max 999999)
1813
+ */
1814
+ maxUnitQuantity?: number;
1815
+
1816
+ /**
1817
+ * Minimum number of units
1818
+ */
1819
+ minUnitQuantity?: number;
1820
+
1821
+ /**
1822
+ * Monthly reset period configuration
1823
+ */
1824
+ monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
1825
+
1826
+ /**
1827
+ * The usage reset period
1828
+ */
1829
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1830
+
1831
+ /**
1832
+ * The tiered pricing mode (VOLUME or GRADUATED)
1833
+ */
1834
+ tiersMode?: 'VOLUME' | 'GRADUATED';
1835
+
1836
+ /**
1837
+ * The custom currency ID for top-up pricing
1838
+ */
1839
+ topUpCustomCurrencyId?: string;
1840
+
1841
+ /**
1842
+ * Weekly reset period configuration
1843
+ */
1844
+ weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
1845
+
1846
+ /**
1847
+ * Yearly reset period configuration
1848
+ */
1849
+ yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
1850
+ }
1851
+
1852
+ export namespace PricingModel {
1853
+ /**
1854
+ * Price configuration for a specific billing period.
1855
+ */
1856
+ export interface PricePeriod {
1857
+ /**
1858
+ * The billing period (MONTHLY or ANNUALLY)
1859
+ */
1860
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
1861
+
1862
+ /**
1863
+ * ISO country code for localized pricing
1864
+ */
1865
+ billingCountryCode?: string;
1866
+
1867
+ /**
1868
+ * Block size for usage-based pricing
1869
+ */
1870
+ blockSize?: number;
1871
+
1872
+ /**
1873
+ * When credits are granted
1874
+ */
1875
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1876
+
1877
+ /**
1878
+ * Credit rate configuration for credit-based pricing
1879
+ */
1880
+ creditRate?: PricePeriod.CreditRate;
1881
+
1882
+ /**
1883
+ * The price amount and currency
1884
+ */
1885
+ price?: PricePeriod.Price;
1886
+
1887
+ /**
1888
+ * Tiered pricing configuration
1889
+ */
1890
+ tiers?: Array<PricePeriod.Tier>;
1891
+ }
1892
+
1893
+ export namespace PricePeriod {
1894
+ /**
1895
+ * Credit rate configuration for credit-based pricing
1896
+ */
1897
+ export interface CreditRate {
1898
+ /**
1899
+ * The credit rate amount
1900
+ */
1901
+ amount: number;
1902
+
1903
+ /**
1904
+ * The custom currency ID
1905
+ */
1906
+ currencyId: string;
1907
+
1908
+ /**
1909
+ * Optional cost formula expression
1910
+ */
1911
+ costFormula?: string;
1912
+ }
1913
+
1914
+ /**
1915
+ * The price amount and currency
1916
+ */
1917
+ export interface Price {
1918
+ /**
1919
+ * The price amount
1920
+ */
1921
+ amount: number;
1922
+
1923
+ /**
1924
+ * The price currency
1925
+ */
1926
+ currency?:
1927
+ | 'usd'
1928
+ | 'aed'
1929
+ | 'all'
1930
+ | 'amd'
1931
+ | 'ang'
1932
+ | 'aud'
1933
+ | 'awg'
1934
+ | 'azn'
1935
+ | 'bam'
1936
+ | 'bbd'
1937
+ | 'bdt'
1938
+ | 'bgn'
1939
+ | 'bif'
1940
+ | 'bmd'
1941
+ | 'bnd'
1942
+ | 'bsd'
1943
+ | 'bwp'
1944
+ | 'byn'
1945
+ | 'bzd'
1946
+ | 'brl'
1947
+ | 'cad'
1948
+ | 'cdf'
1949
+ | 'chf'
1950
+ | 'cny'
1951
+ | 'czk'
1952
+ | 'dkk'
1953
+ | 'dop'
1954
+ | 'dzd'
1955
+ | 'egp'
1956
+ | 'etb'
1957
+ | 'eur'
1958
+ | 'fjd'
1959
+ | 'gbp'
1960
+ | 'gel'
1961
+ | 'gip'
1962
+ | 'gmd'
1963
+ | 'gyd'
1964
+ | 'hkd'
1965
+ | 'hrk'
1966
+ | 'htg'
1967
+ | 'idr'
1968
+ | 'ils'
1969
+ | 'inr'
1970
+ | 'isk'
1971
+ | 'jmd'
1972
+ | 'jpy'
1973
+ | 'kes'
1974
+ | 'kgs'
1975
+ | 'khr'
1976
+ | 'kmf'
1977
+ | 'krw'
1978
+ | 'kyd'
1979
+ | 'kzt'
1980
+ | 'lbp'
1981
+ | 'lkr'
1982
+ | 'lrd'
1983
+ | 'lsl'
1984
+ | 'mad'
1985
+ | 'mdl'
1986
+ | 'mga'
1987
+ | 'mkd'
1988
+ | 'mmk'
1989
+ | 'mnt'
1990
+ | 'mop'
1991
+ | 'mro'
1992
+ | 'mvr'
1993
+ | 'mwk'
1994
+ | 'mxn'
1995
+ | 'myr'
1996
+ | 'mzn'
1997
+ | 'nad'
1998
+ | 'ngn'
1999
+ | 'nok'
2000
+ | 'npr'
2001
+ | 'nzd'
2002
+ | 'pgk'
2003
+ | 'php'
2004
+ | 'pkr'
2005
+ | 'pln'
2006
+ | 'qar'
2007
+ | 'ron'
2008
+ | 'rsd'
2009
+ | 'rub'
2010
+ | 'rwf'
2011
+ | 'sar'
2012
+ | 'sbd'
2013
+ | 'scr'
2014
+ | 'sek'
2015
+ | 'sgd'
2016
+ | 'sle'
2017
+ | 'sll'
2018
+ | 'sos'
2019
+ | 'szl'
2020
+ | 'thb'
2021
+ | 'tjs'
2022
+ | 'top'
2023
+ | 'try'
2024
+ | 'ttd'
2025
+ | 'tzs'
2026
+ | 'uah'
2027
+ | 'uzs'
2028
+ | 'vnd'
2029
+ | 'vuv'
2030
+ | 'wst'
2031
+ | 'xaf'
2032
+ | 'xcd'
2033
+ | 'yer'
2034
+ | 'zar'
2035
+ | 'zmw'
2036
+ | 'clp'
2037
+ | 'djf'
2038
+ | 'gnf'
2039
+ | 'ugx'
2040
+ | 'pyg'
2041
+ | 'xof'
2042
+ | 'xpf';
2043
+ }
2044
+
2045
+ /**
2046
+ * A tier in tiered pricing.
2047
+ */
2048
+ export interface Tier {
2049
+ /**
2050
+ * Flat price for this tier
2051
+ */
2052
+ flatPrice?: Tier.FlatPrice;
2053
+
2054
+ /**
2055
+ * Per-unit price in this tier
2056
+ */
2057
+ unitPrice?: Tier.UnitPrice;
2058
+
2059
+ /**
2060
+ * Upper bound of this tier (null for unlimited)
2061
+ */
2062
+ upTo?: number;
2063
+ }
2064
+
2065
+ export namespace Tier {
2066
+ /**
2067
+ * Flat price for this tier
2068
+ */
2069
+ export interface FlatPrice {
2070
+ /**
2071
+ * The price amount
2072
+ */
2073
+ amount: number;
2074
+
2075
+ /**
2076
+ * The price currency
2077
+ */
2078
+ currency?:
2079
+ | 'usd'
2080
+ | 'aed'
2081
+ | 'all'
2082
+ | 'amd'
2083
+ | 'ang'
2084
+ | 'aud'
2085
+ | 'awg'
2086
+ | 'azn'
2087
+ | 'bam'
2088
+ | 'bbd'
2089
+ | 'bdt'
2090
+ | 'bgn'
2091
+ | 'bif'
2092
+ | 'bmd'
2093
+ | 'bnd'
2094
+ | 'bsd'
2095
+ | 'bwp'
2096
+ | 'byn'
2097
+ | 'bzd'
2098
+ | 'brl'
2099
+ | 'cad'
2100
+ | 'cdf'
2101
+ | 'chf'
2102
+ | 'cny'
2103
+ | 'czk'
2104
+ | 'dkk'
2105
+ | 'dop'
2106
+ | 'dzd'
2107
+ | 'egp'
2108
+ | 'etb'
2109
+ | 'eur'
2110
+ | 'fjd'
2111
+ | 'gbp'
2112
+ | 'gel'
2113
+ | 'gip'
2114
+ | 'gmd'
2115
+ | 'gyd'
2116
+ | 'hkd'
2117
+ | 'hrk'
2118
+ | 'htg'
2119
+ | 'idr'
2120
+ | 'ils'
2121
+ | 'inr'
2122
+ | 'isk'
2123
+ | 'jmd'
2124
+ | 'jpy'
2125
+ | 'kes'
2126
+ | 'kgs'
2127
+ | 'khr'
2128
+ | 'kmf'
2129
+ | 'krw'
2130
+ | 'kyd'
2131
+ | 'kzt'
2132
+ | 'lbp'
2133
+ | 'lkr'
2134
+ | 'lrd'
2135
+ | 'lsl'
2136
+ | 'mad'
2137
+ | 'mdl'
2138
+ | 'mga'
2139
+ | 'mkd'
2140
+ | 'mmk'
2141
+ | 'mnt'
2142
+ | 'mop'
2143
+ | 'mro'
2144
+ | 'mvr'
2145
+ | 'mwk'
2146
+ | 'mxn'
2147
+ | 'myr'
2148
+ | 'mzn'
2149
+ | 'nad'
2150
+ | 'ngn'
2151
+ | 'nok'
2152
+ | 'npr'
2153
+ | 'nzd'
2154
+ | 'pgk'
2155
+ | 'php'
2156
+ | 'pkr'
2157
+ | 'pln'
2158
+ | 'qar'
2159
+ | 'ron'
2160
+ | 'rsd'
2161
+ | 'rub'
2162
+ | 'rwf'
2163
+ | 'sar'
2164
+ | 'sbd'
2165
+ | 'scr'
2166
+ | 'sek'
2167
+ | 'sgd'
2168
+ | 'sle'
2169
+ | 'sll'
2170
+ | 'sos'
2171
+ | 'szl'
2172
+ | 'thb'
2173
+ | 'tjs'
2174
+ | 'top'
2175
+ | 'try'
2176
+ | 'ttd'
2177
+ | 'tzs'
2178
+ | 'uah'
2179
+ | 'uzs'
2180
+ | 'vnd'
2181
+ | 'vuv'
2182
+ | 'wst'
2183
+ | 'xaf'
2184
+ | 'xcd'
2185
+ | 'yer'
2186
+ | 'zar'
2187
+ | 'zmw'
2188
+ | 'clp'
2189
+ | 'djf'
2190
+ | 'gnf'
2191
+ | 'ugx'
2192
+ | 'pyg'
2193
+ | 'xof'
2194
+ | 'xpf';
2195
+ }
2196
+
2197
+ /**
2198
+ * Per-unit price in this tier
2199
+ */
2200
+ export interface UnitPrice {
2201
+ /**
2202
+ * The price amount
2203
+ */
2204
+ amount: number;
2205
+
2206
+ /**
2207
+ * The price currency
2208
+ */
2209
+ currency?:
2210
+ | 'usd'
2211
+ | 'aed'
2212
+ | 'all'
2213
+ | 'amd'
2214
+ | 'ang'
2215
+ | 'aud'
2216
+ | 'awg'
2217
+ | 'azn'
2218
+ | 'bam'
2219
+ | 'bbd'
2220
+ | 'bdt'
2221
+ | 'bgn'
2222
+ | 'bif'
2223
+ | 'bmd'
2224
+ | 'bnd'
2225
+ | 'bsd'
2226
+ | 'bwp'
2227
+ | 'byn'
2228
+ | 'bzd'
2229
+ | 'brl'
2230
+ | 'cad'
2231
+ | 'cdf'
2232
+ | 'chf'
2233
+ | 'cny'
2234
+ | 'czk'
2235
+ | 'dkk'
2236
+ | 'dop'
2237
+ | 'dzd'
2238
+ | 'egp'
2239
+ | 'etb'
2240
+ | 'eur'
2241
+ | 'fjd'
2242
+ | 'gbp'
2243
+ | 'gel'
2244
+ | 'gip'
2245
+ | 'gmd'
2246
+ | 'gyd'
2247
+ | 'hkd'
2248
+ | 'hrk'
2249
+ | 'htg'
2250
+ | 'idr'
2251
+ | 'ils'
2252
+ | 'inr'
2253
+ | 'isk'
2254
+ | 'jmd'
2255
+ | 'jpy'
2256
+ | 'kes'
2257
+ | 'kgs'
2258
+ | 'khr'
2259
+ | 'kmf'
2260
+ | 'krw'
2261
+ | 'kyd'
2262
+ | 'kzt'
2263
+ | 'lbp'
2264
+ | 'lkr'
2265
+ | 'lrd'
2266
+ | 'lsl'
2267
+ | 'mad'
2268
+ | 'mdl'
2269
+ | 'mga'
2270
+ | 'mkd'
2271
+ | 'mmk'
2272
+ | 'mnt'
2273
+ | 'mop'
2274
+ | 'mro'
2275
+ | 'mvr'
2276
+ | 'mwk'
2277
+ | 'mxn'
2278
+ | 'myr'
2279
+ | 'mzn'
2280
+ | 'nad'
2281
+ | 'ngn'
2282
+ | 'nok'
2283
+ | 'npr'
2284
+ | 'nzd'
2285
+ | 'pgk'
2286
+ | 'php'
2287
+ | 'pkr'
2288
+ | 'pln'
2289
+ | 'qar'
2290
+ | 'ron'
2291
+ | 'rsd'
2292
+ | 'rub'
2293
+ | 'rwf'
2294
+ | 'sar'
2295
+ | 'sbd'
2296
+ | 'scr'
2297
+ | 'sek'
2298
+ | 'sgd'
2299
+ | 'sle'
2300
+ | 'sll'
2301
+ | 'sos'
2302
+ | 'szl'
2303
+ | 'thb'
2304
+ | 'tjs'
2305
+ | 'top'
2306
+ | 'try'
2307
+ | 'ttd'
2308
+ | 'tzs'
2309
+ | 'uah'
2310
+ | 'uzs'
2311
+ | 'vnd'
2312
+ | 'vuv'
2313
+ | 'wst'
2314
+ | 'xaf'
2315
+ | 'xcd'
2316
+ | 'yer'
2317
+ | 'zar'
2318
+ | 'zmw'
2319
+ | 'clp'
2320
+ | 'djf'
2321
+ | 'gnf'
2322
+ | 'ugx'
2323
+ | 'pyg'
2324
+ | 'xof'
2325
+ | 'xpf';
2326
+ }
2327
+ }
2328
+ }
2329
+
2330
+ /**
2331
+ * Monthly reset period configuration
2332
+ */
2333
+ export interface MonthlyResetPeriodConfiguration {
2334
+ /**
2335
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
2336
+ */
2337
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
2338
+ }
2339
+
2340
+ /**
2341
+ * Weekly reset period configuration
2342
+ */
2343
+ export interface WeeklyResetPeriodConfiguration {
2344
+ /**
2345
+ * Reset anchor (SubscriptionStart or specific day)
2346
+ */
2347
+ accordingTo:
2348
+ | 'SubscriptionStart'
2349
+ | 'EverySunday'
2350
+ | 'EveryMonday'
2351
+ | 'EveryTuesday'
2352
+ | 'EveryWednesday'
2353
+ | 'EveryThursday'
2354
+ | 'EveryFriday'
2355
+ | 'EverySaturday';
2356
+ }
2357
+
2358
+ /**
2359
+ * Yearly reset period configuration
2360
+ */
2361
+ export interface YearlyResetPeriodConfiguration {
2362
+ /**
2363
+ * Reset anchor (SubscriptionStart)
2364
+ */
2365
+ accordingTo: 'SubscriptionStart';
2366
+ }
2367
+ }
2368
+ }
2369
+ }
2370
+
2371
+ export interface AddonListParams extends MyCursorIDPageParams {
2372
+ /**
2373
+ * Filter by creation date using range operators: gt, gte, lt, lte
2374
+ */
2375
+ createdAt?: AddonListParams.CreatedAt;
2376
+
2377
+ /**
2378
+ * Filter by product ID
2379
+ */
2380
+ productId?: string;
2381
+
2382
+ /**
2383
+ * Filter by status. Supports comma-separated values for multiple statuses
2384
+ */
2385
+ status?: Array<'DRAFT' | 'PUBLISHED' | 'ARCHIVED'>;
2386
+ }
2387
+
2388
+ export namespace AddonListParams {
2389
+ /**
2390
+ * Filter by creation date using range operators: gt, gte, lt, lte
2391
+ */
2392
+ export interface CreatedAt {
2393
+ /**
2394
+ * Greater than the specified createdAt value
2395
+ */
2396
+ gt?: string;
2397
+
2398
+ /**
2399
+ * Greater than or equal to the specified createdAt value
2400
+ */
2401
+ gte?: string;
2402
+
2403
+ /**
2404
+ * Less than the specified createdAt value
2405
+ */
2406
+ lt?: string;
2407
+
2408
+ /**
2409
+ * Less than or equal to the specified createdAt value
2410
+ */
2411
+ lte?: string;
2412
+ }
2413
+ }
2414
+
2415
+ export interface AddonListChargesParams extends MyCursorIDPageParams {}
2416
+
2417
+ export interface AddonPublishParams {
2418
+ /**
2419
+ * The migration type of the package
2420
+ */
2421
+ migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
2422
+ }
2423
+
2424
+ Addons.Entitlements = Entitlements;
2425
+
2426
+ export declare namespace Addons {
2427
+ export {
2428
+ type Addon as Addon,
2429
+ type ChargeList as ChargeList,
2430
+ type AddonListResponse as AddonListResponse,
2431
+ type AddonPublishResponse as AddonPublishResponse,
2432
+ type AddonRemoveDraftResponse as AddonRemoveDraftResponse,
2433
+ type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage,
2434
+ type ChargeListDataMyCursorIDPage as ChargeListDataMyCursorIDPage,
2435
+ type AddonCreateParams as AddonCreateParams,
2436
+ type AddonUpdateParams as AddonUpdateParams,
2437
+ type AddonListParams as AddonListParams,
2438
+ type AddonListChargesParams as AddonListChargesParams,
2439
+ type AddonPublishParams as AddonPublishParams,
2440
+ };
2441
+
2442
+ export {
2443
+ Entitlements as Entitlements,
2444
+ type AddonPackageEntitlement as AddonPackageEntitlement,
2445
+ type EntitlementCreateResponse as EntitlementCreateResponse,
2446
+ type EntitlementListResponse as EntitlementListResponse,
2447
+ type EntitlementCreateParams as EntitlementCreateParams,
2448
+ type EntitlementUpdateParams as EntitlementUpdateParams,
2449
+ type EntitlementDeleteParams as EntitlementDeleteParams,
2450
+ };
2451
+ }