@stigg/typescript 0.1.0-beta.64 → 0.1.0-beta.66

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 (349) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/package.json +1 -1
  3. package/resources/v1/addons/addons.d.mts +59 -0
  4. package/resources/v1/addons/addons.d.mts.map +1 -1
  5. package/resources/v1/addons/addons.d.ts +59 -0
  6. package/resources/v1/addons/addons.d.ts.map +1 -1
  7. package/resources/v1/addons/addons.js +59 -0
  8. package/resources/v1/addons/addons.js.map +1 -1
  9. package/resources/v1/addons/addons.mjs +59 -0
  10. package/resources/v1/addons/addons.mjs.map +1 -1
  11. package/resources/v1/addons/entitlements.d.mts +31 -0
  12. package/resources/v1/addons/entitlements.d.mts.map +1 -1
  13. package/resources/v1/addons/entitlements.d.ts +31 -0
  14. package/resources/v1/addons/entitlements.d.ts.map +1 -1
  15. package/resources/v1/addons/entitlements.js +31 -0
  16. package/resources/v1/addons/entitlements.js.map +1 -1
  17. package/resources/v1/addons/entitlements.mjs +31 -0
  18. package/resources/v1/addons/entitlements.mjs.map +1 -1
  19. package/resources/v1/contracts.d.mts +30 -0
  20. package/resources/v1/contracts.d.mts.map +1 -1
  21. package/resources/v1/contracts.d.ts +30 -0
  22. package/resources/v1/contracts.d.ts.map +1 -1
  23. package/resources/v1/contracts.js +30 -0
  24. package/resources/v1/contracts.js.map +1 -1
  25. package/resources/v1/contracts.mjs +30 -0
  26. package/resources/v1/contracts.mjs.map +1 -1
  27. package/resources/v1/coupons.d.mts +36 -0
  28. package/resources/v1/coupons.d.mts.map +1 -1
  29. package/resources/v1/coupons.d.ts +36 -0
  30. package/resources/v1/coupons.d.ts.map +1 -1
  31. package/resources/v1/coupons.js +36 -0
  32. package/resources/v1/coupons.js.map +1 -1
  33. package/resources/v1/coupons.mjs +36 -0
  34. package/resources/v1/coupons.mjs.map +1 -1
  35. package/resources/v1/credits/consumption.d.mts +26 -0
  36. package/resources/v1/credits/consumption.d.mts.map +1 -1
  37. package/resources/v1/credits/consumption.d.ts +26 -0
  38. package/resources/v1/credits/consumption.d.ts.map +1 -1
  39. package/resources/v1/credits/consumption.js +26 -0
  40. package/resources/v1/credits/consumption.js.map +1 -1
  41. package/resources/v1/credits/consumption.mjs +26 -0
  42. package/resources/v1/credits/consumption.mjs.map +1 -1
  43. package/resources/v1/credits/credits.d.mts +25 -0
  44. package/resources/v1/credits/credits.d.mts.map +1 -1
  45. package/resources/v1/credits/credits.d.ts +25 -0
  46. package/resources/v1/credits/credits.d.ts.map +1 -1
  47. package/resources/v1/credits/credits.js +25 -0
  48. package/resources/v1/credits/credits.js.map +1 -1
  49. package/resources/v1/credits/credits.mjs +25 -0
  50. package/resources/v1/credits/credits.mjs.map +1 -1
  51. package/resources/v1/credits/custom-currencies.d.mts +49 -0
  52. package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
  53. package/resources/v1/credits/custom-currencies.d.ts +49 -0
  54. package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
  55. package/resources/v1/credits/custom-currencies.js +49 -0
  56. package/resources/v1/credits/custom-currencies.js.map +1 -1
  57. package/resources/v1/credits/custom-currencies.mjs +49 -0
  58. package/resources/v1/credits/custom-currencies.mjs.map +1 -1
  59. package/resources/v1/credits/grants.d.mts +28 -0
  60. package/resources/v1/credits/grants.d.mts.map +1 -1
  61. package/resources/v1/credits/grants.d.ts +28 -0
  62. package/resources/v1/credits/grants.d.ts.map +1 -1
  63. package/resources/v1/credits/grants.js +28 -0
  64. package/resources/v1/credits/grants.js.map +1 -1
  65. package/resources/v1/credits/grants.mjs +28 -0
  66. package/resources/v1/credits/grants.mjs.map +1 -1
  67. package/resources/v1/credits/reservations.d.mts +10 -0
  68. package/resources/v1/credits/reservations.d.mts.map +1 -1
  69. package/resources/v1/credits/reservations.d.ts +10 -0
  70. package/resources/v1/credits/reservations.d.ts.map +1 -1
  71. package/resources/v1/credits/reservations.js +10 -0
  72. package/resources/v1/credits/reservations.js.map +1 -1
  73. package/resources/v1/credits/reservations.mjs +10 -0
  74. package/resources/v1/credits/reservations.mjs.map +1 -1
  75. package/resources/v1/customers/customers.d.mts +198 -7
  76. package/resources/v1/customers/customers.d.mts.map +1 -1
  77. package/resources/v1/customers/customers.d.ts +198 -7
  78. package/resources/v1/customers/customers.d.ts.map +1 -1
  79. package/resources/v1/customers/customers.js +106 -6
  80. package/resources/v1/customers/customers.js.map +1 -1
  81. package/resources/v1/customers/customers.mjs +106 -6
  82. package/resources/v1/customers/customers.mjs.map +1 -1
  83. package/resources/v1/customers/entities/entities.d.mts +332 -0
  84. package/resources/v1/customers/entities/entities.d.mts.map +1 -0
  85. package/resources/v1/customers/entities/entities.d.ts +332 -0
  86. package/resources/v1/customers/entities/entities.d.ts.map +1 -0
  87. package/resources/v1/customers/entities/entities.js +139 -0
  88. package/resources/v1/customers/entities/entities.js.map +1 -0
  89. package/resources/v1/customers/entities/entities.mjs +134 -0
  90. package/resources/v1/customers/entities/entities.mjs.map +1 -0
  91. package/resources/v1/customers/entities/entitlements.d.mts +260 -0
  92. package/resources/v1/customers/entities/entitlements.d.mts.map +1 -0
  93. package/resources/v1/customers/entities/entitlements.d.ts +260 -0
  94. package/resources/v1/customers/entities/entitlements.d.ts.map +1 -0
  95. package/resources/v1/customers/entities/entitlements.js +87 -0
  96. package/resources/v1/customers/entities/entitlements.js.map +1 -0
  97. package/resources/v1/customers/entities/entitlements.mjs +83 -0
  98. package/resources/v1/customers/entities/entitlements.mjs.map +1 -0
  99. package/resources/v1/customers/entities/index.d.mts +3 -0
  100. package/resources/v1/customers/entities/index.d.mts.map +1 -0
  101. package/resources/v1/customers/entities/index.d.ts +3 -0
  102. package/resources/v1/customers/entities/index.d.ts.map +1 -0
  103. package/resources/v1/customers/entities/index.js +9 -0
  104. package/resources/v1/customers/entities/index.js.map +1 -0
  105. package/resources/v1/customers/entities/index.mjs +4 -0
  106. package/resources/v1/customers/entities/index.mjs.map +1 -0
  107. package/resources/v1/customers/entities.d.mts +2 -0
  108. package/resources/v1/customers/entities.d.mts.map +1 -0
  109. package/resources/v1/customers/entities.d.ts +2 -0
  110. package/resources/v1/customers/entities.d.ts.map +1 -0
  111. package/resources/v1/customers/entities.js +6 -0
  112. package/resources/v1/customers/entities.js.map +1 -0
  113. package/resources/v1/customers/entities.mjs +3 -0
  114. package/resources/v1/customers/entities.mjs.map +1 -0
  115. package/resources/v1/customers/index.d.mts +1 -0
  116. package/resources/v1/customers/index.d.mts.map +1 -1
  117. package/resources/v1/customers/index.d.ts +1 -0
  118. package/resources/v1/customers/index.d.ts.map +1 -1
  119. package/resources/v1/customers/index.js +3 -1
  120. package/resources/v1/customers/index.js.map +1 -1
  121. package/resources/v1/customers/index.mjs +1 -0
  122. package/resources/v1/customers/index.mjs.map +1 -1
  123. package/resources/v1/customers/integrations.d.mts +47 -0
  124. package/resources/v1/customers/integrations.d.mts.map +1 -1
  125. package/resources/v1/customers/integrations.d.ts +47 -0
  126. package/resources/v1/customers/integrations.d.ts.map +1 -1
  127. package/resources/v1/customers/integrations.js +47 -0
  128. package/resources/v1/customers/integrations.js.map +1 -1
  129. package/resources/v1/customers/integrations.mjs +47 -0
  130. package/resources/v1/customers/integrations.mjs.map +1 -1
  131. package/resources/v1/customers/payment-method.d.mts +16 -0
  132. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  133. package/resources/v1/customers/payment-method.d.ts +16 -0
  134. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  135. package/resources/v1/customers/payment-method.js +16 -0
  136. package/resources/v1/customers/payment-method.js.map +1 -1
  137. package/resources/v1/customers/payment-method.mjs +16 -0
  138. package/resources/v1/customers/payment-method.mjs.map +1 -1
  139. package/resources/v1/customers/promotional-entitlements.d.mts +51 -0
  140. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
  141. package/resources/v1/customers/promotional-entitlements.d.ts +51 -0
  142. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
  143. package/resources/v1/customers/promotional-entitlements.js +51 -0
  144. package/resources/v1/customers/promotional-entitlements.js.map +1 -1
  145. package/resources/v1/customers/promotional-entitlements.mjs +51 -0
  146. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
  147. package/resources/v1/entity-types.d.mts +291 -0
  148. package/resources/v1/entity-types.d.mts.map +1 -0
  149. package/resources/v1/entity-types.d.ts +291 -0
  150. package/resources/v1/entity-types.d.ts.map +1 -0
  151. package/resources/v1/entity-types.js +128 -0
  152. package/resources/v1/entity-types.js.map +1 -0
  153. package/resources/v1/entity-types.mjs +124 -0
  154. package/resources/v1/entity-types.mjs.map +1 -0
  155. package/resources/v1/events/beta/customers.d.mts +8 -0
  156. package/resources/v1/events/beta/customers.d.mts.map +1 -1
  157. package/resources/v1/events/beta/customers.d.ts +8 -0
  158. package/resources/v1/events/beta/customers.d.ts.map +1 -1
  159. package/resources/v1/events/beta/customers.js +8 -0
  160. package/resources/v1/events/beta/customers.js.map +1 -1
  161. package/resources/v1/events/beta/customers.mjs +8 -0
  162. package/resources/v1/events/beta/customers.mjs.map +1 -1
  163. package/resources/v1/events/data-export/data-export.d.mts +12 -0
  164. package/resources/v1/events/data-export/data-export.d.mts.map +1 -1
  165. package/resources/v1/events/data-export/data-export.d.ts +12 -0
  166. package/resources/v1/events/data-export/data-export.d.ts.map +1 -1
  167. package/resources/v1/events/data-export/data-export.js +12 -0
  168. package/resources/v1/events/data-export/data-export.js.map +1 -1
  169. package/resources/v1/events/data-export/data-export.mjs +12 -0
  170. package/resources/v1/events/data-export/data-export.mjs.map +1 -1
  171. package/resources/v1/events/data-export/destinations.d.mts +26 -0
  172. package/resources/v1/events/data-export/destinations.d.mts.map +1 -1
  173. package/resources/v1/events/data-export/destinations.d.ts +26 -0
  174. package/resources/v1/events/data-export/destinations.d.ts.map +1 -1
  175. package/resources/v1/events/data-export/destinations.js +26 -0
  176. package/resources/v1/events/data-export/destinations.js.map +1 -1
  177. package/resources/v1/events/data-export/destinations.mjs +26 -0
  178. package/resources/v1/events/data-export/destinations.mjs.map +1 -1
  179. package/resources/v1/events/events.d.mts +21 -0
  180. package/resources/v1/events/events.d.mts.map +1 -1
  181. package/resources/v1/events/events.d.ts +21 -0
  182. package/resources/v1/events/events.d.ts.map +1 -1
  183. package/resources/v1/events/events.js +21 -0
  184. package/resources/v1/events/events.js.map +1 -1
  185. package/resources/v1/events/events.mjs +21 -0
  186. package/resources/v1/events/events.mjs.map +1 -1
  187. package/resources/v1/features.d.mts +43 -0
  188. package/resources/v1/features.d.mts.map +1 -1
  189. package/resources/v1/features.d.ts +43 -0
  190. package/resources/v1/features.d.ts.map +1 -1
  191. package/resources/v1/features.js +43 -0
  192. package/resources/v1/features.js.map +1 -1
  193. package/resources/v1/features.mjs +43 -0
  194. package/resources/v1/features.mjs.map +1 -1
  195. package/resources/v1/index.d.mts +1 -0
  196. package/resources/v1/index.d.mts.map +1 -1
  197. package/resources/v1/index.d.ts +1 -0
  198. package/resources/v1/index.d.ts.map +1 -1
  199. package/resources/v1/index.js +3 -1
  200. package/resources/v1/index.js.map +1 -1
  201. package/resources/v1/index.mjs +1 -0
  202. package/resources/v1/index.mjs.map +1 -1
  203. package/resources/v1/plans/entitlements.d.mts +31 -0
  204. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  205. package/resources/v1/plans/entitlements.d.ts +31 -0
  206. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  207. package/resources/v1/plans/entitlements.js +31 -0
  208. package/resources/v1/plans/entitlements.js.map +1 -1
  209. package/resources/v1/plans/entitlements.mjs +31 -0
  210. package/resources/v1/plans/entitlements.mjs.map +1 -1
  211. package/resources/v1/plans/plans.d.mts +69 -0
  212. package/resources/v1/plans/plans.d.mts.map +1 -1
  213. package/resources/v1/plans/plans.d.ts +69 -0
  214. package/resources/v1/plans/plans.d.ts.map +1 -1
  215. package/resources/v1/plans/plans.js +69 -0
  216. package/resources/v1/plans/plans.js.map +1 -1
  217. package/resources/v1/plans/plans.mjs +69 -0
  218. package/resources/v1/plans/plans.mjs.map +1 -1
  219. package/resources/v1/products.d.mts +43 -0
  220. package/resources/v1/products.d.mts.map +1 -1
  221. package/resources/v1/products.d.ts +43 -0
  222. package/resources/v1/products.d.ts.map +1 -1
  223. package/resources/v1/products.js +43 -0
  224. package/resources/v1/products.js.map +1 -1
  225. package/resources/v1/products.mjs +43 -0
  226. package/resources/v1/products.mjs.map +1 -1
  227. package/resources/v1/subscriptions/future-update.d.mts +16 -0
  228. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  229. package/resources/v1/subscriptions/future-update.d.ts +16 -0
  230. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  231. package/resources/v1/subscriptions/future-update.js +16 -0
  232. package/resources/v1/subscriptions/future-update.js.map +1 -1
  233. package/resources/v1/subscriptions/future-update.mjs +16 -0
  234. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  235. package/resources/v1/subscriptions/invoice.d.mts +6 -0
  236. package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
  237. package/resources/v1/subscriptions/invoice.d.ts +6 -0
  238. package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
  239. package/resources/v1/subscriptions/invoice.js +6 -0
  240. package/resources/v1/subscriptions/invoice.js.map +1 -1
  241. package/resources/v1/subscriptions/invoice.mjs +6 -0
  242. package/resources/v1/subscriptions/invoice.mjs.map +1 -1
  243. package/resources/v1/subscriptions/subscriptions.d.mts +81 -0
  244. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  245. package/resources/v1/subscriptions/subscriptions.d.ts +81 -0
  246. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  247. package/resources/v1/subscriptions/subscriptions.js +81 -0
  248. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  249. package/resources/v1/subscriptions/subscriptions.mjs +81 -0
  250. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  251. package/resources/v1/subscriptions/usage.d.mts +13 -0
  252. package/resources/v1/subscriptions/usage.d.mts.map +1 -1
  253. package/resources/v1/subscriptions/usage.d.ts +13 -0
  254. package/resources/v1/subscriptions/usage.d.ts.map +1 -1
  255. package/resources/v1/subscriptions/usage.js +13 -0
  256. package/resources/v1/subscriptions/usage.js.map +1 -1
  257. package/resources/v1/subscriptions/usage.mjs +13 -0
  258. package/resources/v1/subscriptions/usage.mjs.map +1 -1
  259. package/resources/v1/usage.d.mts +20 -0
  260. package/resources/v1/usage.d.mts.map +1 -1
  261. package/resources/v1/usage.d.ts +20 -0
  262. package/resources/v1/usage.d.ts.map +1 -1
  263. package/resources/v1/usage.js +20 -0
  264. package/resources/v1/usage.js.map +1 -1
  265. package/resources/v1/usage.mjs +20 -0
  266. package/resources/v1/usage.mjs.map +1 -1
  267. package/resources/v1/v1.d.mts +4 -0
  268. package/resources/v1/v1.d.mts.map +1 -1
  269. package/resources/v1/v1.d.ts +4 -0
  270. package/resources/v1/v1.d.ts.map +1 -1
  271. package/resources/v1/v1.js +4 -0
  272. package/resources/v1/v1.js.map +1 -1
  273. package/resources/v1/v1.mjs +4 -0
  274. package/resources/v1/v1.mjs.map +1 -1
  275. package/resources/v1-beta/customers/assignments.d.mts +12 -33
  276. package/resources/v1-beta/customers/assignments.d.mts.map +1 -1
  277. package/resources/v1-beta/customers/assignments.d.ts +12 -33
  278. package/resources/v1-beta/customers/assignments.d.ts.map +1 -1
  279. package/resources/v1-beta/customers/assignments.js +7 -33
  280. package/resources/v1-beta/customers/assignments.js.map +1 -1
  281. package/resources/v1-beta/customers/assignments.mjs +7 -33
  282. package/resources/v1-beta/customers/assignments.mjs.map +1 -1
  283. package/resources/v1-beta/customers/entities.d.mts +18 -55
  284. package/resources/v1-beta/customers/entities.d.mts.map +1 -1
  285. package/resources/v1-beta/customers/entities.d.ts +18 -55
  286. package/resources/v1-beta/customers/entities.d.ts.map +1 -1
  287. package/resources/v1-beta/customers/entities.js +18 -55
  288. package/resources/v1-beta/customers/entities.js.map +1 -1
  289. package/resources/v1-beta/customers/entities.mjs +18 -55
  290. package/resources/v1-beta/customers/entities.mjs.map +1 -1
  291. package/resources/v1-beta/customers/entitlements.d.mts +7 -10
  292. package/resources/v1-beta/customers/entitlements.d.mts.map +1 -1
  293. package/resources/v1-beta/customers/entitlements.d.ts +7 -10
  294. package/resources/v1-beta/customers/entitlements.d.ts.map +1 -1
  295. package/resources/v1-beta/customers/entitlements.js +2 -5
  296. package/resources/v1-beta/customers/entitlements.js.map +1 -1
  297. package/resources/v1-beta/customers/entitlements.mjs +2 -5
  298. package/resources/v1-beta/customers/entitlements.mjs.map +1 -1
  299. package/resources/v1-beta/entity-types.d.mts +18 -28
  300. package/resources/v1-beta/entity-types.d.mts.map +1 -1
  301. package/resources/v1-beta/entity-types.d.ts +18 -28
  302. package/resources/v1-beta/entity-types.d.ts.map +1 -1
  303. package/resources/v1-beta/entity-types.js +6 -28
  304. package/resources/v1-beta/entity-types.js.map +1 -1
  305. package/resources/v1-beta/entity-types.mjs +6 -28
  306. package/resources/v1-beta/entity-types.mjs.map +1 -1
  307. package/src/resources/v1/addons/addons.ts +59 -0
  308. package/src/resources/v1/addons/entitlements.ts +31 -0
  309. package/src/resources/v1/contracts.ts +30 -0
  310. package/src/resources/v1/coupons.ts +36 -0
  311. package/src/resources/v1/credits/consumption.ts +26 -0
  312. package/src/resources/v1/credits/credits.ts +25 -0
  313. package/src/resources/v1/credits/custom-currencies.ts +49 -0
  314. package/src/resources/v1/credits/grants.ts +28 -0
  315. package/src/resources/v1/credits/reservations.ts +10 -0
  316. package/src/resources/v1/customers/customers.ts +237 -7
  317. package/src/resources/v1/customers/entities/entities.ts +470 -0
  318. package/src/resources/v1/customers/entities/entitlements.ts +347 -0
  319. package/src/resources/v1/customers/entities/index.ts +22 -0
  320. package/src/resources/v1/customers/entities.ts +3 -0
  321. package/src/resources/v1/customers/index.ts +12 -0
  322. package/src/resources/v1/customers/integrations.ts +47 -0
  323. package/src/resources/v1/customers/payment-method.ts +16 -0
  324. package/src/resources/v1/customers/promotional-entitlements.ts +51 -0
  325. package/src/resources/v1/entity-types.ts +402 -0
  326. package/src/resources/v1/events/beta/customers.ts +8 -0
  327. package/src/resources/v1/events/data-export/data-export.ts +12 -0
  328. package/src/resources/v1/events/data-export/destinations.ts +26 -0
  329. package/src/resources/v1/events/events.ts +21 -0
  330. package/src/resources/v1/features.ts +43 -0
  331. package/src/resources/v1/index.ts +12 -0
  332. package/src/resources/v1/plans/entitlements.ts +31 -0
  333. package/src/resources/v1/plans/plans.ts +69 -0
  334. package/src/resources/v1/products.ts +43 -0
  335. package/src/resources/v1/subscriptions/future-update.ts +16 -0
  336. package/src/resources/v1/subscriptions/invoice.ts +6 -0
  337. package/src/resources/v1/subscriptions/subscriptions.ts +81 -0
  338. package/src/resources/v1/subscriptions/usage.ts +13 -0
  339. package/src/resources/v1/usage.ts +20 -0
  340. package/src/resources/v1/v1.ts +28 -0
  341. package/src/resources/v1-beta/customers/assignments.ts +12 -33
  342. package/src/resources/v1-beta/customers/entities.ts +18 -55
  343. package/src/resources/v1-beta/customers/entitlements.ts +7 -10
  344. package/src/resources/v1-beta/entity-types.ts +21 -28
  345. package/src/version.ts +1 -1
  346. package/version.d.mts +1 -1
  347. package/version.d.ts +1 -1
  348. package/version.js +1 -1
  349. package/version.mjs +1 -1
@@ -9,15 +9,43 @@ export declare class Grants extends APIResource {
9
9
  /**
10
10
  * Creates a new credit grant for a customer with specified amount, type, and
11
11
  * optional billing configuration.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const creditGrantResponse =
16
+ * await client.v1.credits.grants.create({
17
+ * amount: 0,
18
+ * currencyId: 'currencyId',
19
+ * customerId: 'customerId',
20
+ * displayName: 'displayName',
21
+ * grantType: 'PAID',
22
+ * });
23
+ * ```
12
24
  */
13
25
  create(params: GrantCreateParams, options?: RequestOptions): APIPromise<CreditGrantResponse>;
14
26
  /**
15
27
  * Retrieves a paginated list of credit grants for a customer.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * // Automatically fetches more pages as needed.
32
+ * for await (const grantListResponse of client.v1.credits.grants.list(
33
+ * { customerId: 'customerId' },
34
+ * )) {
35
+ * // ...
36
+ * }
37
+ * ```
16
38
  */
17
39
  list(params: GrantListParams, options?: RequestOptions): PagePromise<GrantListResponsesMyCursorIDPage, GrantListResponse>;
18
40
  /**
19
41
  * Voids an existing credit grant, preventing further consumption of the remaining
20
42
  * credits.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const creditGrantResponse =
47
+ * await client.v1.credits.grants.void('x');
48
+ * ```
21
49
  */
22
50
  void(id: string, params?: GrantVoidParams | null | undefined, options?: RequestOptions): APIPromise<CreditGrantResponse>;
23
51
  }
@@ -1 +1 @@
1
- {"version":3,"file":"grants.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/credits/grants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAe5F;;OAEG;IACH,IAAI,CACF,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,iBAAiB,CAAC;IAenE;;;OAGG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAanC;AAED,MAAM,MAAM,gCAAgC,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;;OAKG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;QAE9D;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,iBAAiB,EAAE,cAAc,GAAG,YAAY,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QAEhF;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,OAAO,GAAG,kBAAkB,GAAG,mBAAmB,GAAG,IAAI,CAAC;QAEtE;;;;;;WAMG;QACH,MAAM,EAAE,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;QAE1E;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,aAAa,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC;YAEzC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,cAAc,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;YAErC;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;YAE7D;;;;eAIG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,GACT,WAAW,GACX,kBAAkB,CAAC;SACxB;KACF;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;IAE9D;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,iBAAiB,EAAE,cAAc,GAAG,YAAY,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAEhF;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,kBAAkB,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAEtE;;;;;;OAMG;IACH,MAAM,EAAE,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE1E;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;QAErC;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;QAE7D;;;;WAIG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,GACT,WAAW,GACX,kBAAkB,CAAC;KACxB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,aAAa,CAAC;IAElC;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,iBAAiB,CAAC,kBAAkB,CAAC;IAE1D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAExD;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;;OAIG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,cAAc,CAAC,EAAE,kBAAkB,CAAC,cAAc,CAAC;QAEnD;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,CAAC;KACX;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
1
+ {"version":3,"file":"grants.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/credits/grants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAe5F;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,iBAAiB,CAAC;IAenE;;;;;;;;;OASG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAanC;AAED,MAAM,MAAM,gCAAgC,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;;OAKG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;QAE9D;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,iBAAiB,EAAE,cAAc,GAAG,YAAY,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QAEhF;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,OAAO,GAAG,kBAAkB,GAAG,mBAAmB,GAAG,IAAI,CAAC;QAEtE;;;;;;WAMG;QACH,MAAM,EAAE,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;QAE1E;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,aAAa,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC;YAEzC;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,cAAc,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;YAErC;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;YAE7D;;;;eAIG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,GACT,WAAW,GACX,kBAAkB,CAAC;SACxB;KACF;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;IAE9D;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,iBAAiB,EAAE,cAAc,GAAG,YAAY,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAEhF;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,kBAAkB,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAEtE;;;;;;OAMG;IACH,MAAM,EAAE,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE1E;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;QAErC;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;QAE7D;;;;WAIG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,GACT,WAAW,GACX,kBAAkB,CAAC;KACxB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,aAAa,CAAC;IAElC;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,iBAAiB,CAAC,kBAAkB,CAAC;IAE1D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAExD;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;;OAIG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,cAAc,CAAC,EAAE,kBAAkB,CAAC,cAAc,CAAC;QAEnD;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,CAAC;KACX;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
@@ -13,6 +13,18 @@ class Grants extends resource_1.APIResource {
13
13
  /**
14
14
  * Creates a new credit grant for a customer with specified amount, type, and
15
15
  * optional billing configuration.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const creditGrantResponse =
20
+ * await client.v1.credits.grants.create({
21
+ * amount: 0,
22
+ * currencyId: 'currencyId',
23
+ * customerId: 'customerId',
24
+ * displayName: 'displayName',
25
+ * grantType: 'PAID',
26
+ * });
27
+ * ```
16
28
  */
17
29
  create(params, options) {
18
30
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -30,6 +42,16 @@ class Grants extends resource_1.APIResource {
30
42
  }
31
43
  /**
32
44
  * Retrieves a paginated list of credit grants for a customer.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * // Automatically fetches more pages as needed.
49
+ * for await (const grantListResponse of client.v1.credits.grants.list(
50
+ * { customerId: 'customerId' },
51
+ * )) {
52
+ * // ...
53
+ * }
54
+ * ```
33
55
  */
34
56
  list(params, options) {
35
57
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
@@ -48,6 +70,12 @@ class Grants extends resource_1.APIResource {
48
70
  /**
49
71
  * Voids an existing credit grant, preventing further consumption of the remaining
50
72
  * credits.
73
+ *
74
+ * @example
75
+ * ```ts
76
+ * const creditGrantResponse =
77
+ * await client.v1.credits.grants.void('x');
78
+ * ```
51
79
  */
52
80
  void(id, params = {}, options) {
53
81
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
@@ -1 +1 @@
1
- {"version":3,"file":"grants.js","sourceRoot":"","sources":["../../../src/resources/v1/credits/grants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAClG,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,CACF,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC5F,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,2BAAiC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,OAAO,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,wBA8DC"}
1
+ {"version":3,"file":"grants.js","sourceRoot":"","sources":["../../../src/resources/v1/credits/grants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAClG,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC5F,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,2BAAiC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,OAAO,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA1FD,wBA0FC"}
@@ -10,6 +10,18 @@ export class Grants extends APIResource {
10
10
  /**
11
11
  * Creates a new credit grant for a customer with specified amount, type, and
12
12
  * optional billing configuration.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const creditGrantResponse =
17
+ * await client.v1.credits.grants.create({
18
+ * amount: 0,
19
+ * currencyId: 'currencyId',
20
+ * customerId: 'customerId',
21
+ * displayName: 'displayName',
22
+ * grantType: 'PAID',
23
+ * });
24
+ * ```
13
25
  */
14
26
  create(params, options) {
15
27
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -27,6 +39,16 @@ export class Grants extends APIResource {
27
39
  }
28
40
  /**
29
41
  * Retrieves a paginated list of credit grants for a customer.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * // Automatically fetches more pages as needed.
46
+ * for await (const grantListResponse of client.v1.credits.grants.list(
47
+ * { customerId: 'customerId' },
48
+ * )) {
49
+ * // ...
50
+ * }
51
+ * ```
30
52
  */
31
53
  list(params, options) {
32
54
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
@@ -45,6 +67,12 @@ export class Grants extends APIResource {
45
67
  /**
46
68
  * Voids an existing credit grant, preventing further consumption of the remaining
47
69
  * credits.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const creditGrantResponse =
74
+ * await client.v1.credits.grants.void('x');
75
+ * ```
48
76
  */
49
77
  void(id, params = {}, options) {
50
78
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
@@ -1 +1 @@
1
- {"version":3,"file":"grants.mjs","sourceRoot":"","sources":["../../../src/resources/v1/credits/grants.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAClG,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,CACF,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC5F,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,cAAiC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,OAAO,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"grants.mjs","sourceRoot":"","sources":["../../../src/resources/v1/credits/grants.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAClG,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC5F,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,cAAiC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,OAAO,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -6,6 +6,16 @@ export declare class Reservations extends APIResource {
6
6
  * Releases a credit reservation, consuming the given amount and returning the rest
7
7
  * of the held credits to the balance. Retry a failed release with the same
8
8
  * reservation ID; it is applied once.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response =
13
+ * await client.v1.credits.reservations.release('x', {
14
+ * consumedAmount: 0,
15
+ * currencyId: 'currencyId',
16
+ * customerId: 'customerId',
17
+ * });
18
+ * ```
9
19
  */
10
20
  release(reservationID: string, params: ReservationReleaseParams, options?: RequestOptions): APIPromise<ReservationReleaseResponse>;
11
21
  }
@@ -1 +1 @@
1
- {"version":3,"file":"reservations.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAc1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;SAC3C;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"reservations.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAc1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;SAC3C;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -6,6 +6,16 @@ export declare class Reservations extends APIResource {
6
6
  * Releases a credit reservation, consuming the given amount and returning the rest
7
7
  * of the held credits to the balance. Retry a failed release with the same
8
8
  * reservation ID; it is applied once.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response =
13
+ * await client.v1.credits.reservations.release('x', {
14
+ * consumedAmount: 0,
15
+ * currencyId: 'currencyId',
16
+ * customerId: 'customerId',
17
+ * });
18
+ * ```
9
19
  */
10
20
  release(reservationID: string, params: ReservationReleaseParams, options?: RequestOptions): APIPromise<ReservationReleaseResponse>;
11
21
  }
@@ -1 +1 @@
1
- {"version":3,"file":"reservations.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAc1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;SAC3C;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"reservations.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAc1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;SAC3C;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -10,6 +10,16 @@ class Reservations extends resource_1.APIResource {
10
10
  * Releases a credit reservation, consuming the given amount and returning the rest
11
11
  * of the held credits to the balance. Retry a failed release with the same
12
12
  * reservation ID; it is applied once.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const response =
17
+ * await client.v1.credits.reservations.release('x', {
18
+ * consumedAmount: 0,
19
+ * currencyId: 'currencyId',
20
+ * customerId: 'customerId',
21
+ * });
22
+ * ```
13
23
  */
14
24
  release(reservationID, params, options) {
15
25
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"reservations.js","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;OAIG;IACH,OAAO,CACL,aAAqB,EACrB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gCAAgC,aAAa,UAAU,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,oCAwBC"}
1
+ {"version":3,"file":"reservations.js","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CACL,aAAqB,EACrB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gCAAgC,aAAa,UAAU,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAlCD,oCAkCC"}
@@ -7,6 +7,16 @@ export class Reservations extends APIResource {
7
7
  * Releases a credit reservation, consuming the given amount and returning the rest
8
8
  * of the held credits to the balance. Retry a failed release with the same
9
9
  * reservation ID; it is applied once.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const response =
14
+ * await client.v1.credits.reservations.release('x', {
15
+ * consumedAmount: 0,
16
+ * currencyId: 'currencyId',
17
+ * customerId: 'customerId',
18
+ * });
19
+ * ```
10
20
  */
11
21
  release(reservationID, params, options) {
12
22
  const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"reservations.mjs","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,OAAO,CACL,aAAqB,EACrB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gCAAgC,aAAa,UAAU,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"reservations.mjs","sourceRoot":"","sources":["../../../src/resources/v1/credits/reservations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CACL,aAAqB,EACrB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gCAAgC,aAAa,UAAU,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}