@stigg/typescript 0.1.0-beta.1 → 0.1.0-beta.13

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 (484) hide show
  1. package/CHANGELOG.md +114 -0
  2. package/api-promise.d.mts +1 -0
  3. package/api-promise.d.mts.map +1 -1
  4. package/api-promise.d.ts +1 -0
  5. package/api-promise.d.ts.map +1 -1
  6. package/api-promise.mjs +1 -0
  7. package/api-promise.mjs.map +1 -1
  8. package/client.d.mts.map +1 -1
  9. package/client.d.ts.map +1 -1
  10. package/client.mjs.map +1 -1
  11. package/core/api-promise.d.mts.map +1 -1
  12. package/core/api-promise.d.ts.map +1 -1
  13. package/core/api-promise.mjs.map +1 -1
  14. package/core/error.mjs.map +1 -1
  15. package/core/pagination.d.mts.map +1 -1
  16. package/core/pagination.d.ts.map +1 -1
  17. package/core/pagination.mjs.map +1 -1
  18. package/core/resource.d.mts.map +1 -1
  19. package/core/resource.d.ts.map +1 -1
  20. package/core/uploads.d.mts.map +1 -1
  21. package/core/uploads.d.ts.map +1 -1
  22. package/core/uploads.mjs.map +1 -1
  23. package/error.d.mts +1 -0
  24. package/error.d.mts.map +1 -1
  25. package/error.d.ts +1 -0
  26. package/error.d.ts.map +1 -1
  27. package/error.mjs +1 -0
  28. package/error.mjs.map +1 -1
  29. package/index.d.mts.map +1 -1
  30. package/index.d.ts.map +1 -1
  31. package/index.mjs.map +1 -1
  32. package/internal/detect-platform.mjs.map +1 -1
  33. package/internal/headers.mjs.map +1 -1
  34. package/internal/parse.d.mts.map +1 -1
  35. package/internal/parse.d.ts.map +1 -1
  36. package/internal/parse.mjs.map +1 -1
  37. package/internal/qs/formats.d.mts.map +1 -1
  38. package/internal/qs/formats.d.ts.map +1 -1
  39. package/internal/qs/index.d.mts +2 -2
  40. package/internal/qs/index.d.mts.map +1 -1
  41. package/internal/qs/index.d.ts +2 -2
  42. package/internal/qs/index.d.ts.map +1 -1
  43. package/internal/qs/index.mjs.map +1 -1
  44. package/internal/qs/stringify.d.mts.map +1 -1
  45. package/internal/qs/stringify.d.ts.map +1 -1
  46. package/internal/qs/stringify.mjs.map +1 -1
  47. package/internal/qs/utils.d.mts.map +1 -1
  48. package/internal/qs/utils.d.ts.map +1 -1
  49. package/internal/qs/utils.mjs.map +1 -1
  50. package/internal/request-options.d.mts.map +1 -1
  51. package/internal/request-options.d.ts.map +1 -1
  52. package/internal/shims.d.mts +6 -0
  53. package/internal/shims.d.mts.map +1 -1
  54. package/internal/shims.d.ts +6 -0
  55. package/internal/shims.d.ts.map +1 -1
  56. package/internal/to-file.d.mts.map +1 -1
  57. package/internal/to-file.d.ts.map +1 -1
  58. package/internal/to-file.mjs.map +1 -1
  59. package/internal/types.d.mts +4 -4
  60. package/internal/types.d.mts.map +1 -1
  61. package/internal/types.d.ts +4 -4
  62. package/internal/types.d.ts.map +1 -1
  63. package/internal/uploads.d.mts.map +1 -1
  64. package/internal/uploads.d.ts.map +1 -1
  65. package/internal/uploads.mjs.map +1 -1
  66. package/internal/utils/base64.mjs.map +1 -1
  67. package/internal/utils/log.d.mts.map +1 -1
  68. package/internal/utils/log.d.ts.map +1 -1
  69. package/internal/utils/log.mjs.map +1 -1
  70. package/internal/utils/path.mjs.map +1 -1
  71. package/internal/utils/query.mjs.map +1 -1
  72. package/internal/utils/values.mjs.map +1 -1
  73. package/internal/utils.d.mts.map +1 -1
  74. package/internal/utils.d.ts.map +1 -1
  75. package/internal/utils.mjs.map +1 -1
  76. package/package.json +1 -1
  77. package/pagination.d.mts +1 -0
  78. package/pagination.d.mts.map +1 -1
  79. package/pagination.d.ts +1 -0
  80. package/pagination.d.ts.map +1 -1
  81. package/pagination.mjs +1 -0
  82. package/pagination.mjs.map +1 -1
  83. package/resource.d.mts +1 -0
  84. package/resource.d.mts.map +1 -1
  85. package/resource.d.ts +1 -0
  86. package/resource.d.ts.map +1 -1
  87. package/resource.mjs +1 -0
  88. package/resource.mjs.map +1 -1
  89. package/resources/index.d.mts.map +1 -1
  90. package/resources/index.d.ts.map +1 -1
  91. package/resources/index.mjs.map +1 -1
  92. package/resources/v1/addons/addons.d.mts +231 -1
  93. package/resources/v1/addons/addons.d.mts.map +1 -1
  94. package/resources/v1/addons/addons.d.ts +231 -1
  95. package/resources/v1/addons/addons.d.ts.map +1 -1
  96. package/resources/v1/addons/addons.js +65 -0
  97. package/resources/v1/addons/addons.js.map +1 -1
  98. package/resources/v1/addons/addons.mjs +65 -0
  99. package/resources/v1/addons/addons.mjs.map +1 -1
  100. package/resources/v1/addons/entitlements.d.mts +31 -0
  101. package/resources/v1/addons/entitlements.d.mts.map +1 -1
  102. package/resources/v1/addons/entitlements.d.ts +31 -0
  103. package/resources/v1/addons/entitlements.d.ts.map +1 -1
  104. package/resources/v1/addons/entitlements.js +31 -0
  105. package/resources/v1/addons/entitlements.js.map +1 -1
  106. package/resources/v1/addons/entitlements.mjs +31 -0
  107. package/resources/v1/addons/entitlements.mjs.map +1 -1
  108. package/resources/v1/addons/index.d.mts +1 -1
  109. package/resources/v1/addons/index.d.mts.map +1 -1
  110. package/resources/v1/addons/index.d.ts +1 -1
  111. package/resources/v1/addons/index.d.ts.map +1 -1
  112. package/resources/v1/addons/index.js.map +1 -1
  113. package/resources/v1/addons/index.mjs.map +1 -1
  114. package/resources/v1/addons.d.mts.map +1 -1
  115. package/resources/v1/addons.d.ts.map +1 -1
  116. package/resources/v1/addons.mjs.map +1 -1
  117. package/resources/v1/coupons.d.mts +36 -0
  118. package/resources/v1/coupons.d.mts.map +1 -1
  119. package/resources/v1/coupons.d.ts +36 -0
  120. package/resources/v1/coupons.d.ts.map +1 -1
  121. package/resources/v1/coupons.js +36 -0
  122. package/resources/v1/coupons.js.map +1 -1
  123. package/resources/v1/coupons.mjs +36 -0
  124. package/resources/v1/coupons.mjs.map +1 -1
  125. package/resources/v1/{events/credits → credits}/credits.d.mts +57 -10
  126. package/resources/v1/credits/credits.d.mts.map +1 -0
  127. package/resources/v1/{events/credits → credits}/credits.d.ts +57 -10
  128. package/resources/v1/credits/credits.d.ts.map +1 -0
  129. package/resources/v1/{events/credits → credits}/credits.js +28 -3
  130. package/resources/v1/credits/credits.js.map +1 -0
  131. package/resources/v1/{events/credits → credits}/credits.mjs +27 -2
  132. package/resources/v1/credits/credits.mjs.map +1 -0
  133. package/resources/v1/{events/credits → credits}/custom-currencies.d.mts +63 -221
  134. package/resources/v1/credits/custom-currencies.d.mts.map +1 -0
  135. package/resources/v1/{events/credits → credits}/custom-currencies.d.ts +63 -221
  136. package/resources/v1/credits/custom-currencies.d.ts.map +1 -0
  137. package/resources/v1/{events/credits → credits}/custom-currencies.js +52 -3
  138. package/resources/v1/credits/custom-currencies.js.map +1 -0
  139. package/resources/v1/{events/credits → credits}/custom-currencies.mjs +52 -3
  140. package/resources/v1/credits/custom-currencies.mjs.map +1 -0
  141. package/resources/v1/{events/credits → credits}/grants.d.mts +32 -4
  142. package/resources/v1/credits/grants.d.mts.map +1 -0
  143. package/resources/v1/{events/credits → credits}/grants.d.ts +32 -4
  144. package/resources/v1/credits/grants.d.ts.map +1 -0
  145. package/resources/v1/{events/credits → credits}/grants.js +31 -3
  146. package/resources/v1/credits/grants.js.map +1 -0
  147. package/resources/v1/{events/credits → credits}/grants.mjs +31 -3
  148. package/resources/v1/credits/grants.mjs.map +1 -0
  149. package/resources/v1/credits/index.d.mts +4 -0
  150. package/resources/v1/credits/index.d.mts.map +1 -0
  151. package/resources/v1/credits/index.d.ts +4 -0
  152. package/resources/v1/credits/index.d.ts.map +1 -0
  153. package/resources/v1/credits/index.js.map +1 -0
  154. package/resources/v1/credits/index.mjs.map +1 -0
  155. package/resources/v1/credits.d.mts.map +1 -0
  156. package/resources/v1/credits.d.ts.map +1 -0
  157. package/resources/v1/{events/credits.js → credits.js} +1 -1
  158. package/resources/v1/credits.js.map +1 -0
  159. package/resources/v1/credits.mjs.map +1 -0
  160. package/resources/v1/customers/customers.d.mts +82 -5
  161. package/resources/v1/customers/customers.d.mts.map +1 -1
  162. package/resources/v1/customers/customers.d.ts +82 -5
  163. package/resources/v1/customers/customers.d.ts.map +1 -1
  164. package/resources/v1/customers/customers.js +77 -0
  165. package/resources/v1/customers/customers.js.map +1 -1
  166. package/resources/v1/customers/customers.mjs +77 -0
  167. package/resources/v1/customers/customers.mjs.map +1 -1
  168. package/resources/v1/customers/index.d.mts.map +1 -1
  169. package/resources/v1/customers/index.d.ts.map +1 -1
  170. package/resources/v1/customers/index.mjs.map +1 -1
  171. package/resources/v1/customers/integrations.d.mts +50 -3
  172. package/resources/v1/customers/integrations.d.mts.map +1 -1
  173. package/resources/v1/customers/integrations.d.ts +50 -3
  174. package/resources/v1/customers/integrations.d.ts.map +1 -1
  175. package/resources/v1/customers/integrations.js +47 -0
  176. package/resources/v1/customers/integrations.js.map +1 -1
  177. package/resources/v1/customers/integrations.mjs +47 -0
  178. package/resources/v1/customers/integrations.mjs.map +1 -1
  179. package/resources/v1/customers/payment-method.d.mts +17 -1
  180. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  181. package/resources/v1/customers/payment-method.d.ts +17 -1
  182. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  183. package/resources/v1/customers/payment-method.js +16 -0
  184. package/resources/v1/customers/payment-method.js.map +1 -1
  185. package/resources/v1/customers/payment-method.mjs +16 -0
  186. package/resources/v1/customers/payment-method.mjs.map +1 -1
  187. package/resources/v1/customers/promotional-entitlements.d.mts +51 -0
  188. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
  189. package/resources/v1/customers/promotional-entitlements.d.ts +51 -0
  190. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
  191. package/resources/v1/customers/promotional-entitlements.js +51 -0
  192. package/resources/v1/customers/promotional-entitlements.js.map +1 -1
  193. package/resources/v1/customers/promotional-entitlements.mjs +51 -0
  194. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
  195. package/resources/v1/customers.d.mts.map +1 -1
  196. package/resources/v1/customers.d.ts.map +1 -1
  197. package/resources/v1/customers.mjs.map +1 -1
  198. package/resources/v1/events/beta/beta.d.mts +14 -0
  199. package/resources/v1/events/beta/beta.d.mts.map +1 -0
  200. package/resources/v1/events/beta/beta.d.ts +14 -0
  201. package/resources/v1/events/beta/beta.d.ts.map +1 -0
  202. package/resources/v1/events/beta/beta.js +21 -0
  203. package/resources/v1/events/beta/beta.js.map +1 -0
  204. package/resources/v1/events/beta/beta.mjs +16 -0
  205. package/resources/v1/events/beta/beta.mjs.map +1 -0
  206. package/resources/v1/events/beta/customers/assignments.d.mts +178 -0
  207. package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -0
  208. package/resources/v1/events/beta/customers/assignments.d.ts +178 -0
  209. package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -0
  210. package/resources/v1/events/beta/customers/assignments.js +62 -0
  211. package/resources/v1/events/beta/customers/assignments.js.map +1 -0
  212. package/resources/v1/events/beta/customers/assignments.mjs +58 -0
  213. package/resources/v1/events/beta/customers/assignments.mjs.map +1 -0
  214. package/resources/v1/events/beta/customers/customers.d.mts +18 -0
  215. package/resources/v1/events/beta/customers/customers.d.mts.map +1 -0
  216. package/resources/v1/events/beta/customers/customers.d.ts +18 -0
  217. package/resources/v1/events/beta/customers/customers.d.ts.map +1 -0
  218. package/resources/v1/events/beta/customers/customers.js +25 -0
  219. package/resources/v1/events/beta/customers/customers.js.map +1 -0
  220. package/resources/v1/events/beta/customers/customers.mjs +20 -0
  221. package/resources/v1/events/beta/customers/customers.mjs.map +1 -0
  222. package/resources/v1/events/beta/customers/entities.d.mts +304 -0
  223. package/resources/v1/events/beta/customers/entities.d.mts.map +1 -0
  224. package/resources/v1/events/beta/customers/entities.d.ts +304 -0
  225. package/resources/v1/events/beta/customers/entities.d.ts.map +1 -0
  226. package/resources/v1/events/beta/customers/entities.js +105 -0
  227. package/resources/v1/events/beta/customers/entities.js.map +1 -0
  228. package/resources/v1/events/beta/customers/entities.mjs +101 -0
  229. package/resources/v1/events/beta/customers/entities.mjs.map +1 -0
  230. package/resources/v1/events/beta/customers/entitlements.d.mts +238 -0
  231. package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -0
  232. package/resources/v1/events/beta/customers/entitlements.d.ts +238 -0
  233. package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -0
  234. package/resources/v1/events/beta/customers/entitlements.js +26 -0
  235. package/resources/v1/events/beta/customers/entitlements.js.map +1 -0
  236. package/resources/v1/events/beta/customers/entitlements.mjs +22 -0
  237. package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -0
  238. package/resources/v1/events/beta/customers/index.d.mts +5 -0
  239. package/resources/v1/events/beta/customers/index.d.mts.map +1 -0
  240. package/resources/v1/events/beta/customers/index.d.ts +5 -0
  241. package/resources/v1/events/beta/customers/index.d.ts.map +1 -0
  242. package/resources/v1/events/beta/customers/index.js +13 -0
  243. package/resources/v1/events/beta/customers/index.js.map +1 -0
  244. package/resources/v1/events/beta/customers/index.mjs +6 -0
  245. package/resources/v1/events/beta/customers/index.mjs.map +1 -0
  246. package/resources/v1/events/beta/customers.d.mts +2 -0
  247. package/resources/v1/events/beta/customers.d.mts.map +1 -0
  248. package/resources/v1/events/beta/customers.d.ts +2 -0
  249. package/resources/v1/events/beta/customers.d.ts.map +1 -0
  250. package/resources/v1/events/beta/customers.js +6 -0
  251. package/resources/v1/events/beta/customers.js.map +1 -0
  252. package/resources/v1/events/beta/customers.mjs +3 -0
  253. package/resources/v1/events/beta/customers.mjs.map +1 -0
  254. package/resources/v1/events/beta/entity-types.d.mts +144 -0
  255. package/resources/v1/events/beta/entity-types.d.mts.map +1 -0
  256. package/resources/v1/events/beta/entity-types.d.ts +144 -0
  257. package/resources/v1/events/beta/entity-types.d.ts.map +1 -0
  258. package/resources/v1/events/beta/entity-types.js +56 -0
  259. package/resources/v1/events/beta/entity-types.js.map +1 -0
  260. package/resources/v1/events/beta/entity-types.mjs +52 -0
  261. package/resources/v1/events/beta/entity-types.mjs.map +1 -0
  262. package/resources/v1/events/beta/index.d.mts +4 -0
  263. package/resources/v1/events/beta/index.d.mts.map +1 -0
  264. package/resources/v1/events/beta/index.d.ts +4 -0
  265. package/resources/v1/events/beta/index.d.ts.map +1 -0
  266. package/resources/v1/events/beta/index.js +11 -0
  267. package/resources/v1/events/beta/index.js.map +1 -0
  268. package/resources/v1/events/beta/index.mjs +5 -0
  269. package/resources/v1/events/beta/index.mjs.map +1 -0
  270. package/resources/v1/events/beta.d.mts +2 -0
  271. package/resources/v1/events/beta.d.mts.map +1 -0
  272. package/resources/v1/events/beta.d.ts +2 -0
  273. package/resources/v1/events/beta.d.ts.map +1 -0
  274. package/resources/v1/events/beta.js +6 -0
  275. package/resources/v1/events/beta.js.map +1 -0
  276. package/resources/v1/events/beta.mjs +3 -0
  277. package/resources/v1/events/beta.mjs.map +1 -0
  278. package/resources/v1/events/events.d.mts +17 -4
  279. package/resources/v1/events/events.d.mts.map +1 -1
  280. package/resources/v1/events/events.d.ts +17 -4
  281. package/resources/v1/events/events.d.ts.map +1 -1
  282. package/resources/v1/events/events.js +17 -4
  283. package/resources/v1/events/events.js.map +1 -1
  284. package/resources/v1/events/events.mjs +17 -4
  285. package/resources/v1/events/events.mjs.map +1 -1
  286. package/resources/v1/events/index.d.mts +1 -1
  287. package/resources/v1/events/index.d.mts.map +1 -1
  288. package/resources/v1/events/index.d.ts +1 -1
  289. package/resources/v1/events/index.d.ts.map +1 -1
  290. package/resources/v1/events/index.js +3 -3
  291. package/resources/v1/events/index.js.map +1 -1
  292. package/resources/v1/events/index.mjs +1 -1
  293. package/resources/v1/events/index.mjs.map +1 -1
  294. package/resources/v1/events.d.mts.map +1 -1
  295. package/resources/v1/events.d.ts.map +1 -1
  296. package/resources/v1/events.mjs.map +1 -1
  297. package/resources/v1/features.d.mts +43 -0
  298. package/resources/v1/features.d.mts.map +1 -1
  299. package/resources/v1/features.d.ts +43 -0
  300. package/resources/v1/features.d.ts.map +1 -1
  301. package/resources/v1/features.js +43 -0
  302. package/resources/v1/features.js.map +1 -1
  303. package/resources/v1/features.mjs +43 -0
  304. package/resources/v1/features.mjs.map +1 -1
  305. package/resources/v1/index.d.mts +3 -2
  306. package/resources/v1/index.d.mts.map +1 -1
  307. package/resources/v1/index.d.ts +3 -2
  308. package/resources/v1/index.d.ts.map +1 -1
  309. package/resources/v1/index.js +11 -9
  310. package/resources/v1/index.js.map +1 -1
  311. package/resources/v1/index.mjs +1 -0
  312. package/resources/v1/index.mjs.map +1 -1
  313. package/resources/v1/plans/entitlements.d.mts +31 -0
  314. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  315. package/resources/v1/plans/entitlements.d.ts +31 -0
  316. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  317. package/resources/v1/plans/entitlements.js +31 -0
  318. package/resources/v1/plans/entitlements.js.map +1 -1
  319. package/resources/v1/plans/entitlements.mjs +31 -0
  320. package/resources/v1/plans/entitlements.mjs.map +1 -1
  321. package/resources/v1/plans/index.d.mts +1 -1
  322. package/resources/v1/plans/index.d.mts.map +1 -1
  323. package/resources/v1/plans/index.d.ts +1 -1
  324. package/resources/v1/plans/index.d.ts.map +1 -1
  325. package/resources/v1/plans/index.js.map +1 -1
  326. package/resources/v1/plans/index.mjs.map +1 -1
  327. package/resources/v1/plans/plans.d.mts +412 -1
  328. package/resources/v1/plans/plans.d.mts.map +1 -1
  329. package/resources/v1/plans/plans.d.ts +412 -1
  330. package/resources/v1/plans/plans.d.ts.map +1 -1
  331. package/resources/v1/plans/plans.js +81 -0
  332. package/resources/v1/plans/plans.js.map +1 -1
  333. package/resources/v1/plans/plans.mjs +81 -0
  334. package/resources/v1/plans/plans.mjs.map +1 -1
  335. package/resources/v1/plans.d.mts.map +1 -1
  336. package/resources/v1/plans.d.ts.map +1 -1
  337. package/resources/v1/plans.mjs.map +1 -1
  338. package/resources/v1/products.d.mts +43 -0
  339. package/resources/v1/products.d.mts.map +1 -1
  340. package/resources/v1/products.d.ts +43 -0
  341. package/resources/v1/products.d.ts.map +1 -1
  342. package/resources/v1/products.js +43 -0
  343. package/resources/v1/products.js.map +1 -1
  344. package/resources/v1/products.mjs +43 -0
  345. package/resources/v1/products.mjs.map +1 -1
  346. package/resources/v1/subscriptions/future-update.d.mts +16 -0
  347. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  348. package/resources/v1/subscriptions/future-update.d.ts +16 -0
  349. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  350. package/resources/v1/subscriptions/future-update.js +16 -0
  351. package/resources/v1/subscriptions/future-update.js.map +1 -1
  352. package/resources/v1/subscriptions/future-update.mjs +16 -0
  353. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  354. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  355. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  356. package/resources/v1/subscriptions/index.mjs.map +1 -1
  357. package/resources/v1/subscriptions/invoice.d.mts +6 -0
  358. package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
  359. package/resources/v1/subscriptions/invoice.d.ts +6 -0
  360. package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
  361. package/resources/v1/subscriptions/invoice.js +6 -0
  362. package/resources/v1/subscriptions/invoice.js.map +1 -1
  363. package/resources/v1/subscriptions/invoice.mjs +6 -0
  364. package/resources/v1/subscriptions/invoice.mjs.map +1 -1
  365. package/resources/v1/subscriptions/subscriptions.d.mts +93 -9
  366. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  367. package/resources/v1/subscriptions/subscriptions.d.ts +93 -9
  368. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  369. package/resources/v1/subscriptions/subscriptions.js +81 -0
  370. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  371. package/resources/v1/subscriptions/subscriptions.mjs +81 -0
  372. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  373. package/resources/v1/subscriptions/usage.d.mts +13 -0
  374. package/resources/v1/subscriptions/usage.d.mts.map +1 -1
  375. package/resources/v1/subscriptions/usage.d.ts +13 -0
  376. package/resources/v1/subscriptions/usage.d.ts.map +1 -1
  377. package/resources/v1/subscriptions/usage.js +13 -0
  378. package/resources/v1/subscriptions/usage.js.map +1 -1
  379. package/resources/v1/subscriptions/usage.mjs +13 -0
  380. package/resources/v1/subscriptions/usage.mjs.map +1 -1
  381. package/resources/v1/subscriptions.d.mts.map +1 -1
  382. package/resources/v1/subscriptions.d.ts.map +1 -1
  383. package/resources/v1/subscriptions.mjs.map +1 -1
  384. package/resources/v1/usage.d.mts +24 -0
  385. package/resources/v1/usage.d.mts.map +1 -1
  386. package/resources/v1/usage.d.ts +24 -0
  387. package/resources/v1/usage.d.ts.map +1 -1
  388. package/resources/v1/usage.js +24 -0
  389. package/resources/v1/usage.js.map +1 -1
  390. package/resources/v1/usage.mjs +24 -0
  391. package/resources/v1/usage.mjs.map +1 -1
  392. package/resources/v1/v1.d.mts +8 -4
  393. package/resources/v1/v1.d.mts.map +1 -1
  394. package/resources/v1/v1.d.ts +8 -4
  395. package/resources/v1/v1.d.ts.map +1 -1
  396. package/resources/v1/v1.js +4 -0
  397. package/resources/v1/v1.js.map +1 -1
  398. package/resources/v1/v1.mjs +4 -0
  399. package/resources/v1/v1.mjs.map +1 -1
  400. package/resources/v1.d.mts.map +1 -1
  401. package/resources/v1.d.ts.map +1 -1
  402. package/resources/v1.mjs.map +1 -1
  403. package/resources.d.mts.map +1 -1
  404. package/resources.d.ts.map +1 -1
  405. package/resources.mjs.map +1 -1
  406. package/src/resources/v1/addons/addons.ts +625 -0
  407. package/src/resources/v1/addons/entitlements.ts +31 -0
  408. package/src/resources/v1/addons/index.ts +3 -0
  409. package/src/resources/v1/coupons.ts +36 -0
  410. package/src/resources/v1/{events/credits → credits}/credits.ts +61 -16
  411. package/src/resources/v1/{events/credits → credits}/custom-currencies.ts +65 -259
  412. package/src/resources/v1/{events/credits → credits}/grants.ts +33 -5
  413. package/src/resources/v1/{events/credits → credits}/index.ts +1 -4
  414. package/src/resources/v1/customers/customers.ts +92 -5
  415. package/src/resources/v1/customers/integrations.ts +55 -2
  416. package/src/resources/v1/customers/payment-method.ts +19 -1
  417. package/src/resources/v1/customers/promotional-entitlements.ts +51 -0
  418. package/src/resources/v1/events/beta/beta.ts +35 -0
  419. package/src/resources/v1/events/beta/customers/assignments.ts +228 -0
  420. package/src/resources/v1/events/beta/customers/customers.ts +71 -0
  421. package/src/resources/v1/events/beta/customers/entities.ts +381 -0
  422. package/src/resources/v1/events/beta/customers/entitlements.ts +327 -0
  423. package/src/resources/v1/events/beta/customers/index.ts +26 -0
  424. package/src/resources/v1/events/beta/customers.ts +3 -0
  425. package/src/resources/v1/events/beta/entity-types.ts +180 -0
  426. package/src/resources/v1/events/beta/index.ts +12 -0
  427. package/src/resources/v1/events/beta.ts +3 -0
  428. package/src/resources/v1/events/events.ts +18 -23
  429. package/src/resources/v1/events/index.ts +1 -10
  430. package/src/resources/v1/features.ts +43 -0
  431. package/src/resources/v1/index.ts +19 -0
  432. package/src/resources/v1/plans/entitlements.ts +31 -0
  433. package/src/resources/v1/plans/index.ts +6 -0
  434. package/src/resources/v1/plans/plans.ts +1201 -0
  435. package/src/resources/v1/products.ts +43 -0
  436. package/src/resources/v1/subscriptions/future-update.ts +16 -0
  437. package/src/resources/v1/subscriptions/invoice.ts +6 -0
  438. package/src/resources/v1/subscriptions/subscriptions.ts +93 -9
  439. package/src/resources/v1/subscriptions/usage.ts +13 -0
  440. package/src/resources/v1/usage.ts +24 -0
  441. package/src/resources/v1/v1.ts +42 -0
  442. package/src/version.ts +1 -1
  443. package/uploads.d.mts +1 -0
  444. package/uploads.d.mts.map +1 -1
  445. package/uploads.d.ts +1 -0
  446. package/uploads.d.ts.map +1 -1
  447. package/uploads.mjs +1 -0
  448. package/uploads.mjs.map +1 -1
  449. package/version.d.mts +1 -1
  450. package/version.d.mts.map +1 -1
  451. package/version.d.ts +1 -1
  452. package/version.d.ts.map +1 -1
  453. package/version.js +1 -1
  454. package/version.js.map +1 -1
  455. package/version.mjs +1 -1
  456. package/version.mjs.map +1 -1
  457. package/resources/v1/events/credits/credits.d.mts.map +0 -1
  458. package/resources/v1/events/credits/credits.d.ts.map +0 -1
  459. package/resources/v1/events/credits/credits.js.map +0 -1
  460. package/resources/v1/events/credits/credits.mjs.map +0 -1
  461. package/resources/v1/events/credits/custom-currencies.d.mts.map +0 -1
  462. package/resources/v1/events/credits/custom-currencies.d.ts.map +0 -1
  463. package/resources/v1/events/credits/custom-currencies.js.map +0 -1
  464. package/resources/v1/events/credits/custom-currencies.mjs.map +0 -1
  465. package/resources/v1/events/credits/grants.d.mts.map +0 -1
  466. package/resources/v1/events/credits/grants.d.ts.map +0 -1
  467. package/resources/v1/events/credits/grants.js.map +0 -1
  468. package/resources/v1/events/credits/grants.mjs.map +0 -1
  469. package/resources/v1/events/credits/index.d.mts +0 -4
  470. package/resources/v1/events/credits/index.d.mts.map +0 -1
  471. package/resources/v1/events/credits/index.d.ts +0 -4
  472. package/resources/v1/events/credits/index.d.ts.map +0 -1
  473. package/resources/v1/events/credits/index.js.map +0 -1
  474. package/resources/v1/events/credits/index.mjs.map +0 -1
  475. package/resources/v1/events/credits.d.mts.map +0 -1
  476. package/resources/v1/events/credits.d.ts.map +0 -1
  477. package/resources/v1/events/credits.js.map +0 -1
  478. package/resources/v1/events/credits.mjs.map +0 -1
  479. /package/resources/v1/{events/credits → credits}/index.js +0 -0
  480. /package/resources/v1/{events/credits → credits}/index.mjs +0 -0
  481. /package/resources/v1/{events/credits.d.mts → credits.d.mts} +0 -0
  482. /package/resources/v1/{events/credits.d.ts → credits.d.ts} +0 -0
  483. /package/resources/v1/{events/credits.mjs → credits.mjs} +0 -0
  484. /package/src/resources/v1/{events/credits.ts → credits.ts} +0 -0
@@ -1,122 +1,102 @@
1
- import { APIResource } from "../../../../core/resource.mjs";
2
- import { APIPromise } from "../../../../core/api-promise.mjs";
3
- import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../../core/pagination.mjs";
4
- import { RequestOptions } from "../../../../internal/request-options.mjs";
1
+ import { APIResource } from "../../../core/resource.mjs";
2
+ import { APIPromise } from "../../../core/api-promise.mjs";
3
+ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
4
+ import { RequestOptions } from "../../../internal/request-options.mjs";
5
5
  /**
6
6
  * Operations related to custom currencies
7
7
  */
8
8
  export declare class CustomCurrencies extends APIResource {
9
9
  /**
10
10
  * Creates a new custom currency in the environment.
11
- */
12
- create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyCreateResponse>;
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const customCurrencyResponse =
15
+ * await client.v1.credits.customCurrencies.create({
16
+ * id: 'id',
17
+ * displayName: 'displayName',
18
+ * });
19
+ * ```
20
+ */
21
+ create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
13
22
  /**
14
23
  * Updates an existing custom currency. Only the supplied fields are modified.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const customCurrencyResponse =
28
+ * await client.v1.credits.customCurrencies.update(
29
+ * 'currencyId',
30
+ * );
31
+ * ```
15
32
  */
16
- update(currencyID: string, body: CustomCurrencyUpdateParams, options?: RequestOptions): APIPromise<CustomCurrencyUpdateResponse>;
33
+ update(currencyID: string, body: CustomCurrencyUpdateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
17
34
  /**
18
35
  * Retrieves a paginated list of custom currencies in the environment. Archived
19
36
  * currencies are excluded by default; pass `status=ARCHIVED` (or
20
37
  * `status=ACTIVE,ARCHIVED`) to include them.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * // Automatically fetches more pages as needed.
42
+ * for await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {
43
+ * // ...
44
+ * }
45
+ * ```
21
46
  */
22
47
  list(query?: CustomCurrencyListParams | null | undefined, options?: RequestOptions): PagePromise<CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyListResponse>;
23
48
  /**
24
49
  * Archives a custom currency. Fails if the currency is still associated with any
25
50
  * active plan or addon — use the associated-entities endpoint first to inspect
26
51
  * dependencies.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const customCurrencyResponse =
56
+ * await client.v1.credits.customCurrencies.archive(
57
+ * 'currencyId',
58
+ * );
59
+ * ```
27
60
  */
28
- archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyArchiveResponse>;
61
+ archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
29
62
  /**
30
63
  * Lists the active plans and addons that reference a custom currency. Useful
31
64
  * before archiving to inspect dependencies.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * const response =
69
+ * await client.v1.credits.customCurrencies.listAssociatedEntities(
70
+ * 'currencyId',
71
+ * );
72
+ * ```
32
73
  */
33
74
  listAssociatedEntities(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyListAssociatedEntitiesResponse>;
34
75
  /**
35
76
  * Restores a previously archived custom currency. Fails if another active currency
36
77
  * with the same ID already exists.
37
- */
38
- unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyUnarchiveResponse>;
78
+ *
79
+ * @example
80
+ * ```ts
81
+ * const customCurrencyResponse =
82
+ * await client.v1.credits.customCurrencies.unarchive(
83
+ * 'currencyId',
84
+ * );
85
+ * ```
86
+ */
87
+ unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
39
88
  }
40
89
  export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCurrencyListResponse>;
41
90
  /**
42
91
  * Response object
43
92
  */
44
- export interface CustomCurrencyCreateResponse {
45
- /**
46
- * A custom currency used to denominate credit-based entitlements and pricing
47
- */
48
- data: CustomCurrencyCreateResponse.Data;
49
- }
50
- export declare namespace CustomCurrencyCreateResponse {
51
- /**
52
- * A custom currency used to denominate credit-based entitlements and pricing
53
- */
54
- interface Data {
55
- /**
56
- * The unique identifier for the custom currency
57
- */
58
- id: string;
59
- /**
60
- * Timestamp of when the record was deleted
61
- */
62
- archivedAt: string | null;
63
- /**
64
- * Timestamp of when the record was created
65
- */
66
- createdAt: string;
67
- /**
68
- * Description of the currency
69
- */
70
- description: string | null;
71
- /**
72
- * The display name of the custom currency
73
- */
74
- displayName: string;
75
- /**
76
- * Metadata associated with the entity
77
- */
78
- metadata: {
79
- [key: string]: string;
80
- };
81
- /**
82
- * The symbol used to represent the custom currency
83
- */
84
- symbol: string | null;
85
- /**
86
- * Singular and plural unit labels for a custom currency
87
- */
88
- units: Data.Units | null;
89
- /**
90
- * Timestamp of when the record was last updated
91
- */
92
- updatedAt: string;
93
- }
94
- namespace Data {
95
- /**
96
- * Singular and plural unit labels for a custom currency
97
- */
98
- interface Units {
99
- /**
100
- * Plural form of the unit label
101
- */
102
- plural: string | null;
103
- /**
104
- * Singular form of the unit label
105
- */
106
- singular: string | null;
107
- }
108
- }
109
- }
110
- /**
111
- * Response object
112
- */
113
- export interface CustomCurrencyUpdateResponse {
93
+ export interface CustomCurrencyResponse {
114
94
  /**
115
95
  * A custom currency used to denominate credit-based entitlements and pricing
116
96
  */
117
- data: CustomCurrencyUpdateResponse.Data;
97
+ data: CustomCurrencyResponse.Data;
118
98
  }
119
- export declare namespace CustomCurrencyUpdateResponse {
99
+ export declare namespace CustomCurrencyResponse {
120
100
  /**
121
101
  * A custom currency used to denominate credit-based entitlements and pricing
122
102
  */
@@ -234,75 +214,6 @@ export declare namespace CustomCurrencyListResponse {
234
214
  singular: string | null;
235
215
  }
236
216
  }
237
- /**
238
- * Response object
239
- */
240
- export interface CustomCurrencyArchiveResponse {
241
- /**
242
- * A custom currency used to denominate credit-based entitlements and pricing
243
- */
244
- data: CustomCurrencyArchiveResponse.Data;
245
- }
246
- export declare namespace CustomCurrencyArchiveResponse {
247
- /**
248
- * A custom currency used to denominate credit-based entitlements and pricing
249
- */
250
- interface Data {
251
- /**
252
- * The unique identifier for the custom currency
253
- */
254
- id: string;
255
- /**
256
- * Timestamp of when the record was deleted
257
- */
258
- archivedAt: string | null;
259
- /**
260
- * Timestamp of when the record was created
261
- */
262
- createdAt: string;
263
- /**
264
- * Description of the currency
265
- */
266
- description: string | null;
267
- /**
268
- * The display name of the custom currency
269
- */
270
- displayName: string;
271
- /**
272
- * Metadata associated with the entity
273
- */
274
- metadata: {
275
- [key: string]: string;
276
- };
277
- /**
278
- * The symbol used to represent the custom currency
279
- */
280
- symbol: string | null;
281
- /**
282
- * Singular and plural unit labels for a custom currency
283
- */
284
- units: Data.Units | null;
285
- /**
286
- * Timestamp of when the record was last updated
287
- */
288
- updatedAt: string;
289
- }
290
- namespace Data {
291
- /**
292
- * Singular and plural unit labels for a custom currency
293
- */
294
- interface Units {
295
- /**
296
- * Plural form of the unit label
297
- */
298
- plural: string | null;
299
- /**
300
- * Singular form of the unit label
301
- */
302
- singular: string | null;
303
- }
304
- }
305
- }
306
217
  /**
307
218
  * List of entities (plans or addons) that reference a custom currency
308
219
  */
@@ -328,75 +239,6 @@ export declare namespace CustomCurrencyListAssociatedEntitiesResponse {
328
239
  type: string;
329
240
  }
330
241
  }
331
- /**
332
- * Response object
333
- */
334
- export interface CustomCurrencyUnarchiveResponse {
335
- /**
336
- * A custom currency used to denominate credit-based entitlements and pricing
337
- */
338
- data: CustomCurrencyUnarchiveResponse.Data;
339
- }
340
- export declare namespace CustomCurrencyUnarchiveResponse {
341
- /**
342
- * A custom currency used to denominate credit-based entitlements and pricing
343
- */
344
- interface Data {
345
- /**
346
- * The unique identifier for the custom currency
347
- */
348
- id: string;
349
- /**
350
- * Timestamp of when the record was deleted
351
- */
352
- archivedAt: string | null;
353
- /**
354
- * Timestamp of when the record was created
355
- */
356
- createdAt: string;
357
- /**
358
- * Description of the currency
359
- */
360
- description: string | null;
361
- /**
362
- * The display name of the custom currency
363
- */
364
- displayName: string;
365
- /**
366
- * Metadata associated with the entity
367
- */
368
- metadata: {
369
- [key: string]: string;
370
- };
371
- /**
372
- * The symbol used to represent the custom currency
373
- */
374
- symbol: string | null;
375
- /**
376
- * Singular and plural unit labels for a custom currency
377
- */
378
- units: Data.Units | null;
379
- /**
380
- * Timestamp of when the record was last updated
381
- */
382
- updatedAt: string;
383
- }
384
- namespace Data {
385
- /**
386
- * Singular and plural unit labels for a custom currency
387
- */
388
- interface Units {
389
- /**
390
- * Plural form of the unit label
391
- */
392
- plural: string | null;
393
- /**
394
- * Singular form of the unit label
395
- */
396
- singular: string | null;
397
- }
398
- }
399
- }
400
242
  export interface CustomCurrencyCreateParams {
401
243
  /**
402
244
  * The unique identifier for the new custom currency
@@ -492,6 +334,6 @@ export interface CustomCurrencyListParams extends MyCursorIDPageParams {
492
334
  status?: Array<'ACTIVE' | 'ARCHIVED'>;
493
335
  }
494
336
  export declare namespace CustomCurrencies {
495
- export { type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse, type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse, type CustomCurrencyListResponse as CustomCurrencyListResponse, type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse, type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse, type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse, type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage, type CustomCurrencyCreateParams as CustomCurrencyCreateParams, type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams, type CustomCurrencyListParams as CustomCurrencyListParams, };
337
+ export { type CustomCurrencyResponse as CustomCurrencyResponse, type CustomCurrencyListResponse as CustomCurrencyListResponse, type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse, type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage, type CustomCurrencyCreateParams as CustomCurrencyCreateParams, type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams, type CustomCurrencyListParams as CustomCurrencyListParams, };
496
338
  }
497
339
  //# sourceMappingURL=custom-currencies.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom-currencies.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/credits/custom-currencies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,qCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItG;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,0BAA0B,CAAC;IAQrF;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIzF;;;;;;;;;;;OAWG;IACH,sBAAsB,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAO3D;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAG5F;AAED,MAAM,MAAM,yCAAyC,GAAG,cAAc,CAAC,0BAA0B,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,0BAA0B,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4CAA4C;IAC3D,IAAI,EAAE,KAAK,CAAC,4CAA4C,CAAC,IAAI,CAAC,CAAC;CAChE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -1,122 +1,102 @@
1
- import { APIResource } from "../../../../core/resource.js";
2
- import { APIPromise } from "../../../../core/api-promise.js";
3
- import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../../core/pagination.js";
4
- import { RequestOptions } from "../../../../internal/request-options.js";
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import { APIPromise } from "../../../core/api-promise.js";
3
+ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
4
+ import { RequestOptions } from "../../../internal/request-options.js";
5
5
  /**
6
6
  * Operations related to custom currencies
7
7
  */
8
8
  export declare class CustomCurrencies extends APIResource {
9
9
  /**
10
10
  * Creates a new custom currency in the environment.
11
- */
12
- create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyCreateResponse>;
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const customCurrencyResponse =
15
+ * await client.v1.credits.customCurrencies.create({
16
+ * id: 'id',
17
+ * displayName: 'displayName',
18
+ * });
19
+ * ```
20
+ */
21
+ create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
13
22
  /**
14
23
  * Updates an existing custom currency. Only the supplied fields are modified.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const customCurrencyResponse =
28
+ * await client.v1.credits.customCurrencies.update(
29
+ * 'currencyId',
30
+ * );
31
+ * ```
15
32
  */
16
- update(currencyID: string, body: CustomCurrencyUpdateParams, options?: RequestOptions): APIPromise<CustomCurrencyUpdateResponse>;
33
+ update(currencyID: string, body: CustomCurrencyUpdateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
17
34
  /**
18
35
  * Retrieves a paginated list of custom currencies in the environment. Archived
19
36
  * currencies are excluded by default; pass `status=ARCHIVED` (or
20
37
  * `status=ACTIVE,ARCHIVED`) to include them.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * // Automatically fetches more pages as needed.
42
+ * for await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {
43
+ * // ...
44
+ * }
45
+ * ```
21
46
  */
22
47
  list(query?: CustomCurrencyListParams | null | undefined, options?: RequestOptions): PagePromise<CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyListResponse>;
23
48
  /**
24
49
  * Archives a custom currency. Fails if the currency is still associated with any
25
50
  * active plan or addon — use the associated-entities endpoint first to inspect
26
51
  * dependencies.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const customCurrencyResponse =
56
+ * await client.v1.credits.customCurrencies.archive(
57
+ * 'currencyId',
58
+ * );
59
+ * ```
27
60
  */
28
- archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyArchiveResponse>;
61
+ archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
29
62
  /**
30
63
  * Lists the active plans and addons that reference a custom currency. Useful
31
64
  * before archiving to inspect dependencies.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * const response =
69
+ * await client.v1.credits.customCurrencies.listAssociatedEntities(
70
+ * 'currencyId',
71
+ * );
72
+ * ```
32
73
  */
33
74
  listAssociatedEntities(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyListAssociatedEntitiesResponse>;
34
75
  /**
35
76
  * Restores a previously archived custom currency. Fails if another active currency
36
77
  * with the same ID already exists.
37
- */
38
- unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyUnarchiveResponse>;
78
+ *
79
+ * @example
80
+ * ```ts
81
+ * const customCurrencyResponse =
82
+ * await client.v1.credits.customCurrencies.unarchive(
83
+ * 'currencyId',
84
+ * );
85
+ * ```
86
+ */
87
+ unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
39
88
  }
40
89
  export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCurrencyListResponse>;
41
90
  /**
42
91
  * Response object
43
92
  */
44
- export interface CustomCurrencyCreateResponse {
45
- /**
46
- * A custom currency used to denominate credit-based entitlements and pricing
47
- */
48
- data: CustomCurrencyCreateResponse.Data;
49
- }
50
- export declare namespace CustomCurrencyCreateResponse {
51
- /**
52
- * A custom currency used to denominate credit-based entitlements and pricing
53
- */
54
- interface Data {
55
- /**
56
- * The unique identifier for the custom currency
57
- */
58
- id: string;
59
- /**
60
- * Timestamp of when the record was deleted
61
- */
62
- archivedAt: string | null;
63
- /**
64
- * Timestamp of when the record was created
65
- */
66
- createdAt: string;
67
- /**
68
- * Description of the currency
69
- */
70
- description: string | null;
71
- /**
72
- * The display name of the custom currency
73
- */
74
- displayName: string;
75
- /**
76
- * Metadata associated with the entity
77
- */
78
- metadata: {
79
- [key: string]: string;
80
- };
81
- /**
82
- * The symbol used to represent the custom currency
83
- */
84
- symbol: string | null;
85
- /**
86
- * Singular and plural unit labels for a custom currency
87
- */
88
- units: Data.Units | null;
89
- /**
90
- * Timestamp of when the record was last updated
91
- */
92
- updatedAt: string;
93
- }
94
- namespace Data {
95
- /**
96
- * Singular and plural unit labels for a custom currency
97
- */
98
- interface Units {
99
- /**
100
- * Plural form of the unit label
101
- */
102
- plural: string | null;
103
- /**
104
- * Singular form of the unit label
105
- */
106
- singular: string | null;
107
- }
108
- }
109
- }
110
- /**
111
- * Response object
112
- */
113
- export interface CustomCurrencyUpdateResponse {
93
+ export interface CustomCurrencyResponse {
114
94
  /**
115
95
  * A custom currency used to denominate credit-based entitlements and pricing
116
96
  */
117
- data: CustomCurrencyUpdateResponse.Data;
97
+ data: CustomCurrencyResponse.Data;
118
98
  }
119
- export declare namespace CustomCurrencyUpdateResponse {
99
+ export declare namespace CustomCurrencyResponse {
120
100
  /**
121
101
  * A custom currency used to denominate credit-based entitlements and pricing
122
102
  */
@@ -234,75 +214,6 @@ export declare namespace CustomCurrencyListResponse {
234
214
  singular: string | null;
235
215
  }
236
216
  }
237
- /**
238
- * Response object
239
- */
240
- export interface CustomCurrencyArchiveResponse {
241
- /**
242
- * A custom currency used to denominate credit-based entitlements and pricing
243
- */
244
- data: CustomCurrencyArchiveResponse.Data;
245
- }
246
- export declare namespace CustomCurrencyArchiveResponse {
247
- /**
248
- * A custom currency used to denominate credit-based entitlements and pricing
249
- */
250
- interface Data {
251
- /**
252
- * The unique identifier for the custom currency
253
- */
254
- id: string;
255
- /**
256
- * Timestamp of when the record was deleted
257
- */
258
- archivedAt: string | null;
259
- /**
260
- * Timestamp of when the record was created
261
- */
262
- createdAt: string;
263
- /**
264
- * Description of the currency
265
- */
266
- description: string | null;
267
- /**
268
- * The display name of the custom currency
269
- */
270
- displayName: string;
271
- /**
272
- * Metadata associated with the entity
273
- */
274
- metadata: {
275
- [key: string]: string;
276
- };
277
- /**
278
- * The symbol used to represent the custom currency
279
- */
280
- symbol: string | null;
281
- /**
282
- * Singular and plural unit labels for a custom currency
283
- */
284
- units: Data.Units | null;
285
- /**
286
- * Timestamp of when the record was last updated
287
- */
288
- updatedAt: string;
289
- }
290
- namespace Data {
291
- /**
292
- * Singular and plural unit labels for a custom currency
293
- */
294
- interface Units {
295
- /**
296
- * Plural form of the unit label
297
- */
298
- plural: string | null;
299
- /**
300
- * Singular form of the unit label
301
- */
302
- singular: string | null;
303
- }
304
- }
305
- }
306
217
  /**
307
218
  * List of entities (plans or addons) that reference a custom currency
308
219
  */
@@ -328,75 +239,6 @@ export declare namespace CustomCurrencyListAssociatedEntitiesResponse {
328
239
  type: string;
329
240
  }
330
241
  }
331
- /**
332
- * Response object
333
- */
334
- export interface CustomCurrencyUnarchiveResponse {
335
- /**
336
- * A custom currency used to denominate credit-based entitlements and pricing
337
- */
338
- data: CustomCurrencyUnarchiveResponse.Data;
339
- }
340
- export declare namespace CustomCurrencyUnarchiveResponse {
341
- /**
342
- * A custom currency used to denominate credit-based entitlements and pricing
343
- */
344
- interface Data {
345
- /**
346
- * The unique identifier for the custom currency
347
- */
348
- id: string;
349
- /**
350
- * Timestamp of when the record was deleted
351
- */
352
- archivedAt: string | null;
353
- /**
354
- * Timestamp of when the record was created
355
- */
356
- createdAt: string;
357
- /**
358
- * Description of the currency
359
- */
360
- description: string | null;
361
- /**
362
- * The display name of the custom currency
363
- */
364
- displayName: string;
365
- /**
366
- * Metadata associated with the entity
367
- */
368
- metadata: {
369
- [key: string]: string;
370
- };
371
- /**
372
- * The symbol used to represent the custom currency
373
- */
374
- symbol: string | null;
375
- /**
376
- * Singular and plural unit labels for a custom currency
377
- */
378
- units: Data.Units | null;
379
- /**
380
- * Timestamp of when the record was last updated
381
- */
382
- updatedAt: string;
383
- }
384
- namespace Data {
385
- /**
386
- * Singular and plural unit labels for a custom currency
387
- */
388
- interface Units {
389
- /**
390
- * Plural form of the unit label
391
- */
392
- plural: string | null;
393
- /**
394
- * Singular form of the unit label
395
- */
396
- singular: string | null;
397
- }
398
- }
399
- }
400
242
  export interface CustomCurrencyCreateParams {
401
243
  /**
402
244
  * The unique identifier for the new custom currency
@@ -492,6 +334,6 @@ export interface CustomCurrencyListParams extends MyCursorIDPageParams {
492
334
  status?: Array<'ACTIVE' | 'ARCHIVED'>;
493
335
  }
494
336
  export declare namespace CustomCurrencies {
495
- export { type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse, type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse, type CustomCurrencyListResponse as CustomCurrencyListResponse, type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse, type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse, type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse, type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage, type CustomCurrencyCreateParams as CustomCurrencyCreateParams, type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams, type CustomCurrencyListParams as CustomCurrencyListParams, };
337
+ export { type CustomCurrencyResponse as CustomCurrencyResponse, type CustomCurrencyListResponse as CustomCurrencyListResponse, type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse, type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage, type CustomCurrencyCreateParams as CustomCurrencyCreateParams, type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams, type CustomCurrencyListParams as CustomCurrencyListParams, };
496
338
  }
497
339
  //# sourceMappingURL=custom-currencies.d.ts.map