@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.20

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 (507) hide show
  1. package/CHANGELOG.md +162 -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/credits/credits.d.mts +163 -11
  126. package/resources/v1/credits/credits.d.mts.map +1 -1
  127. package/resources/v1/credits/credits.d.ts +163 -11
  128. package/resources/v1/credits/credits.d.ts.map +1 -1
  129. package/resources/v1/credits/credits.js +32 -4
  130. package/resources/v1/credits/credits.js.map +1 -1
  131. package/resources/v1/credits/credits.mjs +32 -4
  132. package/resources/v1/credits/credits.mjs.map +1 -1
  133. package/resources/v1/credits/custom-currencies.d.mts +59 -10
  134. package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
  135. package/resources/v1/credits/custom-currencies.d.ts +59 -10
  136. package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
  137. package/resources/v1/credits/custom-currencies.js +49 -0
  138. package/resources/v1/credits/custom-currencies.js.map +1 -1
  139. package/resources/v1/credits/custom-currencies.mjs +49 -0
  140. package/resources/v1/credits/custom-currencies.mjs.map +1 -1
  141. package/resources/v1/credits/grants.d.mts +28 -0
  142. package/resources/v1/credits/grants.d.mts.map +1 -1
  143. package/resources/v1/credits/grants.d.ts +28 -0
  144. package/resources/v1/credits/grants.d.ts.map +1 -1
  145. package/resources/v1/credits/grants.js +28 -0
  146. package/resources/v1/credits/grants.js.map +1 -1
  147. package/resources/v1/credits/grants.mjs +28 -0
  148. package/resources/v1/credits/grants.mjs.map +1 -1
  149. package/resources/v1/credits/index.d.mts +2 -3
  150. package/resources/v1/credits/index.d.mts.map +1 -1
  151. package/resources/v1/credits/index.d.ts +2 -3
  152. package/resources/v1/credits/index.d.ts.map +1 -1
  153. package/resources/v1/credits/index.js +1 -3
  154. package/resources/v1/credits/index.js.map +1 -1
  155. package/resources/v1/credits/index.mjs +0 -1
  156. package/resources/v1/credits/index.mjs.map +1 -1
  157. package/resources/v1/credits.d.mts.map +1 -1
  158. package/resources/v1/credits.d.ts.map +1 -1
  159. package/resources/v1/credits.mjs.map +1 -1
  160. package/resources/v1/customers/customers.d.mts +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/data-export/data-export.d.mts +126 -0
  279. package/resources/v1/events/data-export/data-export.d.mts.map +1 -0
  280. package/resources/v1/events/data-export/data-export.d.ts +126 -0
  281. package/resources/v1/events/data-export/data-export.d.ts.map +1 -0
  282. package/resources/v1/events/data-export/data-export.js +45 -0
  283. package/resources/v1/events/data-export/data-export.js.map +1 -0
  284. package/resources/v1/events/data-export/data-export.mjs +40 -0
  285. package/resources/v1/events/data-export/data-export.mjs.map +1 -0
  286. package/resources/v1/events/data-export/destinations.d.mts +202 -0
  287. package/resources/v1/events/data-export/destinations.d.mts.map +1 -0
  288. package/resources/v1/events/data-export/destinations.d.ts +202 -0
  289. package/resources/v1/events/data-export/destinations.d.ts.map +1 -0
  290. package/resources/v1/events/data-export/destinations.js +41 -0
  291. package/resources/v1/events/data-export/destinations.js.map +1 -0
  292. package/resources/v1/events/data-export/destinations.mjs +37 -0
  293. package/resources/v1/events/data-export/destinations.mjs.map +1 -0
  294. package/resources/v1/events/data-export/index.d.mts +3 -0
  295. package/resources/v1/events/data-export/index.d.mts.map +1 -0
  296. package/resources/v1/events/data-export/index.d.ts +3 -0
  297. package/resources/v1/events/data-export/index.d.ts.map +1 -0
  298. package/resources/v1/events/data-export/index.js +9 -0
  299. package/resources/v1/events/data-export/index.js.map +1 -0
  300. package/resources/v1/events/data-export/index.mjs +4 -0
  301. package/resources/v1/events/data-export/index.mjs.map +1 -0
  302. package/resources/v1/events/data-export.d.mts +2 -0
  303. package/resources/v1/events/data-export.d.mts.map +1 -0
  304. package/resources/v1/events/data-export.d.ts +2 -0
  305. package/resources/v1/events/data-export.d.ts.map +1 -0
  306. package/resources/v1/events/data-export.js +6 -0
  307. package/resources/v1/events/data-export.js.map +1 -0
  308. package/resources/v1/events/data-export.mjs +3 -0
  309. package/resources/v1/events/data-export.mjs.map +1 -0
  310. package/resources/v1/events/events.d.mts +87 -0
  311. package/resources/v1/events/events.d.mts.map +1 -0
  312. package/resources/v1/events/events.d.ts +87 -0
  313. package/resources/v1/events/events.d.ts.map +1 -0
  314. package/resources/v1/events/events.js +44 -0
  315. package/resources/v1/events/events.js.map +1 -0
  316. package/resources/v1/events/events.mjs +39 -0
  317. package/resources/v1/events/events.mjs.map +1 -0
  318. package/resources/v1/events/index.d.mts +4 -0
  319. package/resources/v1/events/index.d.mts.map +1 -0
  320. package/resources/v1/events/index.d.ts +4 -0
  321. package/resources/v1/events/index.d.ts.map +1 -0
  322. package/resources/v1/events/index.js +11 -0
  323. package/resources/v1/events/index.js.map +1 -0
  324. package/resources/v1/events/index.mjs +5 -0
  325. package/resources/v1/events/index.mjs.map +1 -0
  326. package/resources/v1/events.d.mts +1 -65
  327. package/resources/v1/events.d.mts.map +1 -1
  328. package/resources/v1/events.d.ts +1 -65
  329. package/resources/v1/events.d.ts.map +1 -1
  330. package/resources/v1/events.js +2 -15
  331. package/resources/v1/events.js.map +1 -1
  332. package/resources/v1/events.mjs +1 -13
  333. package/resources/v1/events.mjs.map +1 -1
  334. package/resources/v1/features.d.mts +43 -0
  335. package/resources/v1/features.d.mts.map +1 -1
  336. package/resources/v1/features.d.ts +43 -0
  337. package/resources/v1/features.d.ts.map +1 -1
  338. package/resources/v1/features.js +43 -0
  339. package/resources/v1/features.js.map +1 -1
  340. package/resources/v1/features.mjs +43 -0
  341. package/resources/v1/features.mjs.map +1 -1
  342. package/resources/v1/index.d.mts +4 -4
  343. package/resources/v1/index.d.mts.map +1 -1
  344. package/resources/v1/index.d.ts +4 -4
  345. package/resources/v1/index.d.ts.map +1 -1
  346. package/resources/v1/index.js +6 -6
  347. package/resources/v1/index.js.map +1 -1
  348. package/resources/v1/index.mjs +1 -1
  349. package/resources/v1/index.mjs.map +1 -1
  350. package/resources/v1/plans/entitlements.d.mts +31 -0
  351. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  352. package/resources/v1/plans/entitlements.d.ts +31 -0
  353. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  354. package/resources/v1/plans/entitlements.js +31 -0
  355. package/resources/v1/plans/entitlements.js.map +1 -1
  356. package/resources/v1/plans/entitlements.mjs +31 -0
  357. package/resources/v1/plans/entitlements.mjs.map +1 -1
  358. package/resources/v1/plans/index.d.mts +1 -1
  359. package/resources/v1/plans/index.d.mts.map +1 -1
  360. package/resources/v1/plans/index.d.ts +1 -1
  361. package/resources/v1/plans/index.d.ts.map +1 -1
  362. package/resources/v1/plans/index.js.map +1 -1
  363. package/resources/v1/plans/index.mjs.map +1 -1
  364. package/resources/v1/plans/plans.d.mts +412 -1
  365. package/resources/v1/plans/plans.d.mts.map +1 -1
  366. package/resources/v1/plans/plans.d.ts +412 -1
  367. package/resources/v1/plans/plans.d.ts.map +1 -1
  368. package/resources/v1/plans/plans.js +81 -0
  369. package/resources/v1/plans/plans.js.map +1 -1
  370. package/resources/v1/plans/plans.mjs +81 -0
  371. package/resources/v1/plans/plans.mjs.map +1 -1
  372. package/resources/v1/plans.d.mts.map +1 -1
  373. package/resources/v1/plans.d.ts.map +1 -1
  374. package/resources/v1/plans.mjs.map +1 -1
  375. package/resources/v1/products.d.mts +43 -0
  376. package/resources/v1/products.d.mts.map +1 -1
  377. package/resources/v1/products.d.ts +43 -0
  378. package/resources/v1/products.d.ts.map +1 -1
  379. package/resources/v1/products.js +43 -0
  380. package/resources/v1/products.js.map +1 -1
  381. package/resources/v1/products.mjs +43 -0
  382. package/resources/v1/products.mjs.map +1 -1
  383. package/resources/v1/subscriptions/future-update.d.mts +16 -0
  384. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  385. package/resources/v1/subscriptions/future-update.d.ts +16 -0
  386. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  387. package/resources/v1/subscriptions/future-update.js +16 -0
  388. package/resources/v1/subscriptions/future-update.js.map +1 -1
  389. package/resources/v1/subscriptions/future-update.mjs +16 -0
  390. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  391. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  392. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  393. package/resources/v1/subscriptions/index.mjs.map +1 -1
  394. package/resources/v1/subscriptions/invoice.d.mts +6 -0
  395. package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
  396. package/resources/v1/subscriptions/invoice.d.ts +6 -0
  397. package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
  398. package/resources/v1/subscriptions/invoice.js +6 -0
  399. package/resources/v1/subscriptions/invoice.js.map +1 -1
  400. package/resources/v1/subscriptions/invoice.mjs +6 -0
  401. package/resources/v1/subscriptions/invoice.mjs.map +1 -1
  402. package/resources/v1/subscriptions/subscriptions.d.mts +101 -9
  403. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  404. package/resources/v1/subscriptions/subscriptions.d.ts +101 -9
  405. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  406. package/resources/v1/subscriptions/subscriptions.js +81 -0
  407. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  408. package/resources/v1/subscriptions/subscriptions.mjs +81 -0
  409. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  410. package/resources/v1/subscriptions/usage.d.mts +13 -0
  411. package/resources/v1/subscriptions/usage.d.mts.map +1 -1
  412. package/resources/v1/subscriptions/usage.d.ts +13 -0
  413. package/resources/v1/subscriptions/usage.d.ts.map +1 -1
  414. package/resources/v1/subscriptions/usage.js +13 -0
  415. package/resources/v1/subscriptions/usage.js.map +1 -1
  416. package/resources/v1/subscriptions/usage.mjs +13 -0
  417. package/resources/v1/subscriptions/usage.mjs.map +1 -1
  418. package/resources/v1/subscriptions.d.mts.map +1 -1
  419. package/resources/v1/subscriptions.d.ts.map +1 -1
  420. package/resources/v1/subscriptions.mjs.map +1 -1
  421. package/resources/v1/usage.d.mts +24 -0
  422. package/resources/v1/usage.d.mts.map +1 -1
  423. package/resources/v1/usage.d.ts +24 -0
  424. package/resources/v1/usage.d.ts.map +1 -1
  425. package/resources/v1/usage.js +24 -0
  426. package/resources/v1/usage.js.map +1 -1
  427. package/resources/v1/usage.mjs +24 -0
  428. package/resources/v1/usage.mjs.map +1 -1
  429. package/resources/v1/v1.d.mts +8 -8
  430. package/resources/v1/v1.d.mts.map +1 -1
  431. package/resources/v1/v1.d.ts +8 -8
  432. package/resources/v1/v1.d.ts.map +1 -1
  433. package/resources/v1/v1.js +2 -2
  434. package/resources/v1/v1.js.map +1 -1
  435. package/resources/v1/v1.mjs +2 -2
  436. package/resources/v1/v1.mjs.map +1 -1
  437. package/resources/v1.d.mts.map +1 -1
  438. package/resources/v1.d.ts.map +1 -1
  439. package/resources/v1.mjs.map +1 -1
  440. package/resources.d.mts.map +1 -1
  441. package/resources.d.ts.map +1 -1
  442. package/resources.mjs.map +1 -1
  443. package/src/resources/v1/addons/addons.ts +625 -0
  444. package/src/resources/v1/addons/entitlements.ts +31 -0
  445. package/src/resources/v1/addons/index.ts +3 -0
  446. package/src/resources/v1/coupons.ts +36 -0
  447. package/src/resources/v1/credits/credits.ts +194 -20
  448. package/src/resources/v1/credits/custom-currencies.ts +60 -11
  449. package/src/resources/v1/credits/grants.ts +28 -0
  450. package/src/resources/v1/credits/index.ts +3 -6
  451. package/src/resources/v1/customers/customers.ts +92 -5
  452. package/src/resources/v1/customers/integrations.ts +55 -2
  453. package/src/resources/v1/customers/payment-method.ts +19 -1
  454. package/src/resources/v1/customers/promotional-entitlements.ts +51 -0
  455. package/src/resources/v1/events/beta/beta.ts +35 -0
  456. package/src/resources/v1/events/beta/customers/assignments.ts +228 -0
  457. package/src/resources/v1/events/beta/customers/customers.ts +71 -0
  458. package/src/resources/v1/events/beta/customers/entities.ts +381 -0
  459. package/src/resources/v1/events/beta/customers/entitlements.ts +327 -0
  460. package/src/resources/v1/events/beta/customers/index.ts +26 -0
  461. package/src/resources/v1/events/beta/customers.ts +3 -0
  462. package/src/resources/v1/events/beta/entity-types.ts +180 -0
  463. package/src/resources/v1/events/beta/index.ts +12 -0
  464. package/src/resources/v1/events/beta.ts +3 -0
  465. package/src/resources/v1/events/data-export/data-export.ts +170 -0
  466. package/src/resources/v1/events/data-export/destinations.ts +243 -0
  467. package/src/resources/v1/events/data-export/index.ts +15 -0
  468. package/src/resources/v1/events/data-export.ts +3 -0
  469. package/src/resources/v1/events/events.ts +116 -0
  470. package/src/resources/v1/events/index.ts +11 -0
  471. package/src/resources/v1/events.ts +1 -75
  472. package/src/resources/v1/features.ts +43 -0
  473. package/src/resources/v1/index.ts +12 -1
  474. package/src/resources/v1/plans/entitlements.ts +31 -0
  475. package/src/resources/v1/plans/index.ts +6 -0
  476. package/src/resources/v1/plans/plans.ts +1201 -0
  477. package/src/resources/v1/products.ts +43 -0
  478. package/src/resources/v1/subscriptions/future-update.ts +16 -0
  479. package/src/resources/v1/subscriptions/invoice.ts +6 -0
  480. package/src/resources/v1/subscriptions/subscriptions.ts +103 -9
  481. package/src/resources/v1/subscriptions/usage.ts +13 -0
  482. package/src/resources/v1/usage.ts +24 -0
  483. package/src/resources/v1/v1.ts +24 -2
  484. package/src/version.ts +1 -1
  485. package/uploads.d.mts +1 -0
  486. package/uploads.d.mts.map +1 -1
  487. package/uploads.d.ts +1 -0
  488. package/uploads.d.ts.map +1 -1
  489. package/uploads.mjs +1 -0
  490. package/uploads.mjs.map +1 -1
  491. package/version.d.mts +1 -1
  492. package/version.d.mts.map +1 -1
  493. package/version.d.ts +1 -1
  494. package/version.d.ts.map +1 -1
  495. package/version.js +1 -1
  496. package/version.js.map +1 -1
  497. package/version.mjs +1 -1
  498. package/version.mjs.map +1 -1
  499. package/resources/v1/credits/auto-recharge.d.mts +0 -84
  500. package/resources/v1/credits/auto-recharge.d.mts.map +0 -1
  501. package/resources/v1/credits/auto-recharge.d.ts +0 -84
  502. package/resources/v1/credits/auto-recharge.d.ts.map +0 -1
  503. package/resources/v1/credits/auto-recharge.js +0 -16
  504. package/resources/v1/credits/auto-recharge.js.map +0 -1
  505. package/resources/v1/credits/auto-recharge.mjs +0 -12
  506. package/resources/v1/credits/auto-recharge.mjs.map +0 -1
  507. package/src/resources/v1/credits/auto-recharge.ts +0 -109
@@ -1 +1 @@
1
- {"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/v1/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,cAAc,EAA0C;OAE1D,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,IAAgC,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,YAAY,CACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,cAA2C,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,EAAU,EAAE,IAAgC,EAAE,OAAwB;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
1
+ {"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/v1/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAE/F,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,IAAgC,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,cAA2C,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAU,EAAE,IAAgC,EAAE,OAAwB;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
@@ -7,11 +7,27 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
7
7
  export declare class FutureUpdate extends APIResource {
8
8
  /**
9
9
  * Cancels a subscription update that is pending payment completion.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const cancelSubscription =
14
+ * await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
15
+ * 'x',
16
+ * );
17
+ * ```
10
18
  */
11
19
  cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
12
20
  /**
13
21
  * Cancels a scheduled subscription update, such as a future downgrade or plan
14
22
  * change.
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const cancelSubscription =
27
+ * await client.v1.subscriptions.futureUpdate.cancelSchedule(
28
+ * 'x',
29
+ * );
30
+ * ```
15
31
  */
16
32
  cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
17
33
  }
@@ -1 +1 @@
1
- {"version":3,"file":"future-update.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}
1
+ {"version":3,"file":"future-update.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}
@@ -7,11 +7,27 @@ import { RequestOptions } from "../../../internal/request-options.js";
7
7
  export declare class FutureUpdate extends APIResource {
8
8
  /**
9
9
  * Cancels a subscription update that is pending payment completion.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const cancelSubscription =
14
+ * await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
15
+ * 'x',
16
+ * );
17
+ * ```
10
18
  */
11
19
  cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
12
20
  /**
13
21
  * Cancels a scheduled subscription update, such as a future downgrade or plan
14
22
  * change.
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const cancelSubscription =
27
+ * await client.v1.subscriptions.futureUpdate.cancelSchedule(
28
+ * 'x',
29
+ * );
30
+ * ```
15
31
  */
16
32
  cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
17
33
  }
@@ -1 +1 @@
1
- {"version":3,"file":"future-update.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}
1
+ {"version":3,"file":"future-update.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}
@@ -10,6 +10,14 @@ const path_1 = require("../../../internal/utils/path.js");
10
10
  class FutureUpdate extends resource_1.APIResource {
11
11
  /**
12
12
  * Cancels a subscription update that is pending payment completion.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const cancelSubscription =
17
+ * await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
18
+ * 'x',
19
+ * );
20
+ * ```
13
21
  */
14
22
  cancelPendingPayment(id, options) {
15
23
  return this._client.delete((0, path_1.path) `/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
@@ -17,6 +25,14 @@ class FutureUpdate extends resource_1.APIResource {
17
25
  /**
18
26
  * Cancels a scheduled subscription update, such as a future downgrade or plan
19
27
  * change.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const cancelSubscription =
32
+ * await client.v1.subscriptions.futureUpdate.cancelSchedule(
33
+ * 'x',
34
+ * );
35
+ * ```
20
36
  */
21
37
  cancelSchedule(id, options) {
22
38
  return this._client.delete((0, path_1.path) `/api/v1/subscriptions/${id}/future-update/schedule`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"future-update.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF;AAfD,oCAeC"}
1
+ {"version":3,"file":"future-update.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF;AA/BD,oCA+BC"}
@@ -7,6 +7,14 @@ import { path } from "../../../internal/utils/path.mjs";
7
7
  export class FutureUpdate extends APIResource {
8
8
  /**
9
9
  * Cancels a subscription update that is pending payment completion.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const cancelSubscription =
14
+ * await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
15
+ * 'x',
16
+ * );
17
+ * ```
10
18
  */
11
19
  cancelPendingPayment(id, options) {
12
20
  return this._client.delete(path `/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
@@ -14,6 +22,14 @@ export class FutureUpdate extends APIResource {
14
22
  /**
15
23
  * Cancels a scheduled subscription update, such as a future downgrade or plan
16
24
  * change.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const cancelSubscription =
29
+ * await client.v1.subscriptions.futureUpdate.cancelSchedule(
30
+ * 'x',
31
+ * );
32
+ * ```
17
33
  */
18
34
  cancelSchedule(id, options) {
19
35
  return this._client.delete(path `/api/v1/subscriptions/${id}/future-update/schedule`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"future-update.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF"}
1
+ {"version":3,"file":"future-update.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/index.ts"],"names":[],"mappings":"OAEO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE;OACzC,EAAE,OAAO,EAAE,KAAK,yBAAyB,EAAE;OAC3C,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,EAC/B,KAAK,uCAAuC,GAC7C;OACM,EACL,KAAK,EACL,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,GAC5B"}
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,4BAAwB;AACxE,OAAO,EAAE,OAAO,EAAE,KAAK,yBAAyB,EAAE,sBAAkB;AACpE,OAAO,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,EAC/B,KAAK,uCAAuC,GAC7C,4BAAwB;AACzB,OAAO,EACL,KAAK,EACL,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,GAC5B,oBAAgB"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/index.ts"],"names":[],"mappings":"OAEO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE;OACzC,EAAE,OAAO,EAAE,KAAK,yBAAyB,EAAE;OAC3C,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,EAC/B,KAAK,uCAAuC,GAC7C;OACM,EACL,KAAK,EACL,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,GAC5B"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,2BAAwB;AACxE,OAAO,EAAE,OAAO,EAAE,KAAK,yBAAyB,EAAE,qBAAkB;AACpE,OAAO,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,EAC/B,KAAK,uCAAuC,GAC7C,2BAAwB;AACzB,OAAO,EACL,KAAK,EACL,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,GAC5B,mBAAgB"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,YAAY,EAA2B;OACzC,EAAE,OAAO,EAAkC;OAC3C,EACL,aAAa,GAgBd;OACM,EACL,KAAK,GAIN"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,YAAY,EAA2B,4BAAwB;AACxE,OAAO,EAAE,OAAO,EAAkC,sBAAkB;AACpE,OAAO,EACL,aAAa,GAgBd,4BAAwB;AACzB,OAAO,EACL,KAAK,GAIN,oBAAgB"}
@@ -8,6 +8,12 @@ export declare class Invoice extends APIResource {
8
8
  /**
9
9
  * Marks the latest invoice of a subscription as paid in the billing provider. The
10
10
  * invoice must exist and have an OPEN status.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const response =
15
+ * await client.v1.subscriptions.invoice.markAsPaid('x');
16
+ * ```
11
17
  */
12
18
  markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse>;
13
19
  }
@@ -1 +1 @@
1
- {"version":3,"file":"invoice.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
1
+ {"version":3,"file":"invoice.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
@@ -8,6 +8,12 @@ export declare class Invoice extends APIResource {
8
8
  /**
9
9
  * Marks the latest invoice of a subscription as paid in the billing provider. The
10
10
  * invoice must exist and have an OPEN status.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const response =
15
+ * await client.v1.subscriptions.invoice.markAsPaid('x');
16
+ * ```
11
17
  */
12
18
  markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse>;
13
19
  }
@@ -1 +1 @@
1
- {"version":3,"file":"invoice.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
1
+ {"version":3,"file":"invoice.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
@@ -11,6 +11,12 @@ class Invoice extends resource_1.APIResource {
11
11
  /**
12
12
  * Marks the latest invoice of a subscription as paid in the billing provider. The
13
13
  * invoice must exist and have an OPEN status.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const response =
18
+ * await client.v1.subscriptions.invoice.markAsPaid('x');
19
+ * ```
14
20
  */
15
21
  markAsPaid(id, options) {
16
22
  return this._client.post((0, path_1.path) `/api/v1/subscriptions/${id}/invoice/paid`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"invoice.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF;AARD,0BAQC"}
1
+ {"version":3,"file":"invoice.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF;AAdD,0BAcC"}
@@ -8,6 +8,12 @@ export class Invoice extends APIResource {
8
8
  /**
9
9
  * Marks the latest invoice of a subscription as paid in the billing provider. The
10
10
  * invoice must exist and have an OPEN status.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const response =
15
+ * await client.v1.subscriptions.invoice.markAsPaid('x');
16
+ * ```
11
17
  */
12
18
  markAsPaid(id, options) {
13
19
  return this._client.post(path `/api/v1/subscriptions/${id}/invoice/paid`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"invoice.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF"}
1
+ {"version":3,"file":"invoice.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF"}
@@ -15,51 +15,132 @@ export declare class Subscriptions extends APIResource {
15
15
  /**
16
16
  * Retrieves a subscription by its unique identifier, including plan details,
17
17
  * billing period, status, and add-ons.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const subscription = await client.v1.subscriptions.retrieve(
22
+ * 'x',
23
+ * );
24
+ * ```
18
25
  */
19
26
  retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
20
27
  /**
21
28
  * Updates an active subscription's properties including billing period, add-ons,
22
29
  * unit quantities, and discounts.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const subscription = await client.v1.subscriptions.update(
34
+ * 'x',
35
+ * );
36
+ * ```
23
37
  */
24
38
  update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
25
39
  /**
26
40
  * Retrieves a paginated list of subscriptions, with optional filters for customer,
27
41
  * status, and plan.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * // Automatically fetches more pages as needed.
46
+ * for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
47
+ * // ...
48
+ * }
49
+ * ```
28
50
  */
29
51
  list(query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
30
52
  /**
31
53
  * Cancels an active subscription, either immediately or at a specified time such
32
54
  * as end of billing period.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const subscription = await client.v1.subscriptions.cancel(
59
+ * 'x',
60
+ * );
61
+ * ```
33
62
  */
34
63
  cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
35
64
  /**
36
65
  * Delegates the payment responsibility of a subscription to a different customer.
37
66
  * The delegated customer will be billed for this subscription.
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * const subscription = await client.v1.subscriptions.delegate(
71
+ * 'x',
72
+ * { targetCustomerId: 'targetCustomerId' },
73
+ * );
74
+ * ```
38
75
  */
39
76
  delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
40
77
  /**
41
78
  * Imports multiple subscriptions in bulk. Used for migrating subscription data
42
79
  * from external systems.
80
+ *
81
+ * @example
82
+ * ```ts
83
+ * const response = await client.v1.subscriptions.import({
84
+ * subscriptions: [
85
+ * {
86
+ * id: 'id',
87
+ * customerId: 'customerId',
88
+ * planId: 'planId',
89
+ * },
90
+ * ],
91
+ * });
92
+ * ```
43
93
  */
44
94
  import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
45
95
  /**
46
96
  * Migrates a subscription to the latest published version of its plan or add-ons.
47
97
  * Handles prorated charges or credits automatically.
98
+ *
99
+ * @example
100
+ * ```ts
101
+ * const subscription = await client.v1.subscriptions.migrate(
102
+ * 'x',
103
+ * );
104
+ * ```
48
105
  */
49
106
  migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
50
107
  /**
51
108
  * Previews the pricing impact of creating or updating a subscription without
52
109
  * making changes. Returns estimated costs, taxes, and proration details.
110
+ *
111
+ * @example
112
+ * ```ts
113
+ * const response = await client.v1.subscriptions.preview({
114
+ * customerId: 'customerId',
115
+ * planId: 'planId',
116
+ * });
117
+ * ```
53
118
  */
54
119
  preview(body: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
55
120
  /**
56
121
  * Creates a new subscription for an existing customer. When payment is required
57
122
  * and no payment method exists, returns a checkout URL.
123
+ *
124
+ * @example
125
+ * ```ts
126
+ * const response = await client.v1.subscriptions.provision({
127
+ * customerId: 'customerId',
128
+ * planId: 'planId',
129
+ * });
130
+ * ```
58
131
  */
59
132
  provision(body: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
60
133
  /**
61
134
  * Transfers a subscription to a different resource ID. Used for multi-resource
62
135
  * products where subscriptions apply to specific entities like websites or apps.
136
+ *
137
+ * @example
138
+ * ```ts
139
+ * const subscription = await client.v1.subscriptions.transfer(
140
+ * 'x',
141
+ * { destinationResourceId: 'destinationResourceId' },
142
+ * );
143
+ * ```
63
144
  */
64
145
  transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
65
146
  }
@@ -1670,6 +1751,10 @@ export interface SubscriptionUpdateParams {
1670
1751
  billingInformation?: SubscriptionUpdateParams.BillingInformation;
1671
1752
  billingPeriod?: 'MONTHLY' | 'ANNUALLY';
1672
1753
  budget?: SubscriptionUpdateParams.Budget | null;
1754
+ /**
1755
+ * Subscription cancellation date
1756
+ */
1757
+ cancellationDate?: string | null;
1673
1758
  charges?: Array<SubscriptionUpdateParams.Charge>;
1674
1759
  entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
1675
1760
  /**
@@ -2097,7 +2182,8 @@ export declare namespace SubscriptionImportParams {
2097
2182
  quantity: number;
2098
2183
  }
2099
2184
  /**
2100
- * Charge item
2185
+ * A charge selection for a subscription (references a catalog charge with a
2186
+ * quantity).
2101
2187
  */
2102
2188
  interface Charge {
2103
2189
  /**
@@ -2105,7 +2191,7 @@ export declare namespace SubscriptionImportParams {
2105
2191
  */
2106
2192
  id: string;
2107
2193
  /**
2108
- * Charge quantity
2194
+ * Charge quantity. Minimum is 0 (zero is allowed).
2109
2195
  */
2110
2196
  quantity: number;
2111
2197
  /**
@@ -2183,7 +2269,7 @@ export interface SubscriptionPreviewParams {
2183
2269
  */
2184
2270
  trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
2185
2271
  /**
2186
- * Unit quantity for per-unit pricing
2272
+ * Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
2187
2273
  */
2188
2274
  unitQuantity?: number;
2189
2275
  }
@@ -2283,7 +2369,7 @@ export declare namespace SubscriptionPreviewParams {
2283
2369
  */
2284
2370
  featureId: string;
2285
2371
  /**
2286
- * Quantity of feature units
2372
+ * Quantity of feature units. Minimum is 0 (zero is allowed).
2287
2373
  */
2288
2374
  quantity: number;
2289
2375
  }
@@ -2365,7 +2451,8 @@ export declare namespace SubscriptionPreviewParams {
2365
2451
  }
2366
2452
  }
2367
2453
  /**
2368
- * Charge item
2454
+ * A charge selection for a subscription (references a catalog charge with a
2455
+ * quantity).
2369
2456
  */
2370
2457
  interface Charge {
2371
2458
  /**
@@ -2373,7 +2460,7 @@ export declare namespace SubscriptionPreviewParams {
2373
2460
  */
2374
2461
  id: string;
2375
2462
  /**
2376
- * Charge quantity
2463
+ * Charge quantity. Minimum is 0 (zero is allowed).
2377
2464
  */
2378
2465
  quantity: number;
2379
2466
  /**
@@ -2439,6 +2526,10 @@ export interface SubscriptionProvisionParams {
2439
2526
  */
2440
2527
  billingPeriod?: 'MONTHLY' | 'ANNUALLY';
2441
2528
  budget?: SubscriptionProvisionParams.Budget | null;
2529
+ /**
2530
+ * Subscription cancellation date
2531
+ */
2532
+ cancellationDate?: string;
2442
2533
  charges?: Array<SubscriptionProvisionParams.Charge>;
2443
2534
  /**
2444
2535
  * Checkout page configuration for payment collection
@@ -2485,7 +2576,7 @@ export interface SubscriptionProvisionParams {
2485
2576
  */
2486
2577
  trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
2487
2578
  /**
2488
- * Unit quantity
2579
+ * Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
2489
2580
  */
2490
2581
  unitQuantity?: number;
2491
2582
  }
@@ -2661,7 +2752,8 @@ export declare namespace SubscriptionProvisionParams {
2661
2752
  limit: number;
2662
2753
  }
2663
2754
  /**
2664
- * Charge item
2755
+ * A charge selection for a subscription (references a catalog charge with a
2756
+ * quantity).
2665
2757
  */
2666
2758
  interface Charge {
2667
2759
  /**
@@ -2669,7 +2761,7 @@ export declare namespace SubscriptionProvisionParams {
2669
2761
  */
2670
2762
  id: string;
2671
2763
  /**
2672
- * Charge quantity
2764
+ * Charge quantity. Minimum is 0 (zero is allowed).
2673
2765
  */
2674
2766
  quantity: number;
2675
2767
  /**