@flexprice/sdk 2.1.43 → 2.1.44-dev.2

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 (336) hide show
  1. package/docs/sdk/models/active-window.md +16 -0
  2. package/docs/sdk/models/commitment-collection-method.md +17 -0
  3. package/docs/sdk/models/commitment-early-termination.md +17 -0
  4. package/docs/sdk/models/commitment-filter-order.md +15 -0
  5. package/docs/sdk/models/commitment-filter.md +31 -0
  6. package/docs/sdk/models/commitment-measurement.md +17 -0
  7. package/docs/sdk/models/commitment-price-input.md +19 -0
  8. package/docs/sdk/models/commitment-response.md +51 -0
  9. package/docs/sdk/models/commitment-scope-input.md +18 -0
  10. package/docs/sdk/models/commitment-scope-type.md +17 -0
  11. package/docs/sdk/models/commitment-status.md +17 -0
  12. package/docs/sdk/models/commitment-usage-breakdown.md +26 -0
  13. package/docs/sdk/models/commitment-usage-value.md +16 -0
  14. package/docs/sdk/models/create-commitment-request.md +42 -0
  15. package/docs/sdk/models/create-entitlement-request.md +1 -1
  16. package/docs/sdk/models/create-price-tier.md +1 -0
  17. package/docs/sdk/models/create-scheduled-task-request.md +1 -1
  18. package/docs/sdk/models/create-subscription-request.md +1 -0
  19. package/docs/sdk/models/delete-events-request.md +26 -0
  20. package/docs/sdk/models/delete-events-response-response.md +19 -0
  21. package/docs/sdk/models/delete-events-response.md +16 -0
  22. package/docs/sdk/models/get-commitment-request.md +17 -0
  23. package/docs/sdk/models/get-usage-by-subscription-response.md +14 -13
  24. package/docs/sdk/models/invoice-filter.md +2 -0
  25. package/docs/sdk/models/invoice-line-item-response.md +1 -0
  26. package/docs/sdk/models/list-commitments-response.md +16 -0
  27. package/docs/sdk/models/price-price-tier.md +1 -0
  28. package/docs/sdk/models/report-query-request.md +1 -0
  29. package/docs/sdk/models/scheduled-task-entity-type.md +2 -2
  30. package/docs/sdk/models/self-billing-charge-response.md +35 -0
  31. package/docs/sdk/models/self-billing-plan-response.md +18 -0
  32. package/docs/sdk/models/self-billing-summary-response.md +1 -0
  33. package/docs/sdk/models/subscription-line-item-response.md +2 -0
  34. package/docs/sdk/models/subscription-subscription-line-item.md +2 -0
  35. package/docs/sdk/models/terminate-commitment-request-request.md +18 -0
  36. package/docs/sdk/models/terminate-commitment-request.md +16 -0
  37. package/docs/sdk/models/trigger-force-run-request.md +6 -1
  38. package/docs/sdk/models/update-commitment-request-request.md +19 -0
  39. package/docs/sdk/models/update-commitment-request.md +18 -0
  40. package/docs/sdk/models/update-entitlement-request.md +1 -1
  41. package/docs/sdk/models/webhook-dto-commitment-webhook-payload.md +16 -0
  42. package/docs/sdk/models/webhook-event-name.md +1 -1
  43. package/docs/sdks/commitments/README.md +476 -0
  44. package/docs/sdks/events/README.md +86 -0
  45. package/docs/sdks/selfbilling/README.md +1 -1
  46. package/docs/sdks/webhookevents/README.md +207 -0
  47. package/esm/funcs/commitments-create-commitment.d.ts +17 -0
  48. package/esm/funcs/commitments-create-commitment.d.ts.map +1 -0
  49. package/esm/funcs/commitments-create-commitment.js +83 -0
  50. package/esm/funcs/commitments-create-commitment.js.map +1 -0
  51. package/esm/funcs/commitments-get-commitment.d.ts +17 -0
  52. package/esm/funcs/commitments-get-commitment.d.ts.map +1 -0
  53. package/esm/funcs/commitments-get-commitment.js +91 -0
  54. package/esm/funcs/commitments-get-commitment.js.map +1 -0
  55. package/esm/funcs/commitments-preview-commitment.d.ts +17 -0
  56. package/esm/funcs/commitments-preview-commitment.d.ts.map +1 -0
  57. package/esm/funcs/commitments-preview-commitment.js +83 -0
  58. package/esm/funcs/commitments-preview-commitment.js.map +1 -0
  59. package/esm/funcs/commitments-query-commitment.d.ts +17 -0
  60. package/esm/funcs/commitments-query-commitment.d.ts.map +1 -0
  61. package/esm/funcs/commitments-query-commitment.js +83 -0
  62. package/esm/funcs/commitments-query-commitment.js.map +1 -0
  63. package/esm/funcs/commitments-terminate-commitment.d.ts +17 -0
  64. package/esm/funcs/commitments-terminate-commitment.d.ts.map +1 -0
  65. package/esm/funcs/commitments-terminate-commitment.js +93 -0
  66. package/esm/funcs/commitments-terminate-commitment.js.map +1 -0
  67. package/esm/funcs/commitments-update-commitment.d.ts +17 -0
  68. package/esm/funcs/commitments-update-commitment.d.ts.map +1 -0
  69. package/esm/funcs/commitments-update-commitment.js +93 -0
  70. package/esm/funcs/commitments-update-commitment.js.map +1 -0
  71. package/esm/funcs/events-delete-events.d.ts +17 -0
  72. package/esm/funcs/events-delete-events.d.ts.map +1 -0
  73. package/esm/funcs/events-delete-events.js +86 -0
  74. package/esm/funcs/events-delete-events.js.map +1 -0
  75. package/esm/funcs/self-billing-get-self-billing-summary.d.ts +1 -1
  76. package/esm/funcs/self-billing-get-self-billing-summary.js +1 -1
  77. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.d.ts +17 -0
  78. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.d.ts.map +1 -0
  79. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.js +69 -0
  80. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.js.map +1 -0
  81. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.d.ts +17 -0
  82. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.d.ts.map +1 -0
  83. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.js +69 -0
  84. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.js.map +1 -0
  85. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.d.ts +17 -0
  86. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.d.ts.map +1 -0
  87. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.js +69 -0
  88. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.js.map +1 -0
  89. package/esm/lib/config.d.ts +3 -3
  90. package/esm/lib/config.js +3 -3
  91. package/esm/lib/config.js.map +1 -1
  92. package/esm/sdk/commitments.d.ts +47 -0
  93. package/esm/sdk/commitments.d.ts.map +1 -0
  94. package/esm/sdk/commitments.js +68 -0
  95. package/esm/sdk/commitments.js.map +1 -0
  96. package/esm/sdk/events.d.ts +7 -0
  97. package/esm/sdk/events.d.ts.map +1 -1
  98. package/esm/sdk/events.js +10 -0
  99. package/esm/sdk/events.js.map +1 -1
  100. package/esm/sdk/models/active-window.d.ts +20 -0
  101. package/esm/sdk/models/active-window.d.ts.map +1 -0
  102. package/esm/sdk/models/active-window.js +24 -0
  103. package/esm/sdk/models/active-window.js.map +1 -0
  104. package/esm/sdk/models/commitment-collection-method.d.ts +12 -0
  105. package/esm/sdk/models/commitment-collection-method.d.ts.map +1 -0
  106. package/esm/sdk/models/commitment-collection-method.js +13 -0
  107. package/esm/sdk/models/commitment-collection-method.js.map +1 -0
  108. package/esm/sdk/models/commitment-early-termination.d.ts +11 -0
  109. package/esm/sdk/models/commitment-early-termination.d.ts.map +1 -0
  110. package/esm/sdk/models/commitment-early-termination.js +12 -0
  111. package/esm/sdk/models/commitment-early-termination.js.map +1 -0
  112. package/esm/sdk/models/commitment-filter.d.ts +60 -0
  113. package/esm/sdk/models/commitment-filter.d.ts.map +1 -0
  114. package/esm/sdk/models/commitment-filter.js +51 -0
  115. package/esm/sdk/models/commitment-filter.js.map +1 -0
  116. package/esm/sdk/models/commitment-measurement.d.ts +12 -0
  117. package/esm/sdk/models/commitment-measurement.d.ts.map +1 -0
  118. package/esm/sdk/models/commitment-measurement.js +13 -0
  119. package/esm/sdk/models/commitment-measurement.js.map +1 -0
  120. package/esm/sdk/models/commitment-price-input.d.ts +24 -0
  121. package/esm/sdk/models/commitment-price-input.d.ts.map +1 -0
  122. package/esm/sdk/models/commitment-price-input.js +27 -0
  123. package/esm/sdk/models/commitment-price-input.js.map +1 -0
  124. package/esm/sdk/models/commitment-response.d.ts +56 -0
  125. package/esm/sdk/models/commitment-response.d.ts.map +1 -0
  126. package/esm/sdk/models/commitment-response.js +88 -0
  127. package/esm/sdk/models/commitment-response.js.map +1 -0
  128. package/esm/sdk/models/commitment-scope-input.d.ts +18 -0
  129. package/esm/sdk/models/commitment-scope-input.d.ts.map +1 -0
  130. package/esm/sdk/models/commitment-scope-input.js +20 -0
  131. package/esm/sdk/models/commitment-scope-input.js.map +1 -0
  132. package/esm/sdk/models/commitment-scope-type.d.ts +14 -0
  133. package/esm/sdk/models/commitment-scope-type.d.ts.map +1 -0
  134. package/esm/sdk/models/commitment-scope-type.js +15 -0
  135. package/esm/sdk/models/commitment-scope-type.js.map +1 -0
  136. package/esm/sdk/models/commitment-status.d.ts +13 -0
  137. package/esm/sdk/models/commitment-status.d.ts.map +1 -0
  138. package/esm/sdk/models/commitment-status.js +14 -0
  139. package/esm/sdk/models/commitment-status.js.map +1 -0
  140. package/esm/sdk/models/commitment-usage-breakdown.d.ts +33 -0
  141. package/esm/sdk/models/commitment-usage-breakdown.d.ts.map +1 -0
  142. package/esm/sdk/models/commitment-usage-breakdown.js +37 -0
  143. package/esm/sdk/models/commitment-usage-breakdown.js.map +1 -0
  144. package/esm/sdk/models/commitment-usage-value.d.ts +11 -0
  145. package/esm/sdk/models/commitment-usage-value.d.ts.map +1 -0
  146. package/esm/sdk/models/commitment-usage-value.js +15 -0
  147. package/esm/sdk/models/commitment-usage-value.js.map +1 -0
  148. package/esm/sdk/models/create-commitment-request.d.ts +64 -0
  149. package/esm/sdk/models/create-commitment-request.d.ts.map +1 -0
  150. package/esm/sdk/models/create-commitment-request.js +50 -0
  151. package/esm/sdk/models/create-commitment-request.js.map +1 -0
  152. package/esm/sdk/models/create-entitlement-request.d.ts +3 -0
  153. package/esm/sdk/models/create-entitlement-request.d.ts.map +1 -1
  154. package/esm/sdk/models/create-entitlement-request.js.map +1 -1
  155. package/esm/sdk/models/create-price-tier.d.ts +3 -0
  156. package/esm/sdk/models/create-price-tier.d.ts.map +1 -1
  157. package/esm/sdk/models/create-price-tier.js +3 -0
  158. package/esm/sdk/models/create-price-tier.js.map +1 -1
  159. package/esm/sdk/models/create-subscription-request.d.ts +9 -0
  160. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  161. package/esm/sdk/models/create-subscription-request.js +2 -0
  162. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  163. package/esm/sdk/models/delete-events-op.d.ts +14 -0
  164. package/esm/sdk/models/delete-events-op.d.ts.map +1 -0
  165. package/esm/sdk/models/delete-events-op.js +21 -0
  166. package/esm/sdk/models/delete-events-op.js.map +1 -0
  167. package/esm/sdk/models/delete-events-request.d.ts +38 -0
  168. package/esm/sdk/models/delete-events-request.d.ts.map +1 -0
  169. package/esm/sdk/models/delete-events-request.js +27 -0
  170. package/esm/sdk/models/delete-events-request.js.map +1 -0
  171. package/esm/sdk/models/delete-events-response.d.ts +11 -0
  172. package/esm/sdk/models/delete-events-response.d.ts.map +1 -0
  173. package/esm/sdk/models/delete-events-response.js +21 -0
  174. package/esm/sdk/models/delete-events-response.js.map +1 -0
  175. package/esm/sdk/models/get-commitment-op.d.ts +15 -0
  176. package/esm/sdk/models/get-commitment-op.d.ts.map +1 -0
  177. package/esm/sdk/models/get-commitment-op.js +12 -0
  178. package/esm/sdk/models/get-commitment-op.js.map +1 -0
  179. package/esm/sdk/models/get-usage-by-subscription-response.d.ts +5 -0
  180. package/esm/sdk/models/get-usage-by-subscription-response.d.ts.map +1 -1
  181. package/esm/sdk/models/get-usage-by-subscription-response.js +2 -0
  182. package/esm/sdk/models/get-usage-by-subscription-response.js.map +1 -1
  183. package/esm/sdk/models/index.d.ts +25 -0
  184. package/esm/sdk/models/index.d.ts.map +1 -1
  185. package/esm/sdk/models/index.js +25 -0
  186. package/esm/sdk/models/index.js.map +1 -1
  187. package/esm/sdk/models/invoice-filter.d.ts +10 -0
  188. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  189. package/esm/sdk/models/invoice-filter.js +4 -0
  190. package/esm/sdk/models/invoice-filter.js.map +1 -1
  191. package/esm/sdk/models/invoice-line-item-response.d.ts +4 -0
  192. package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
  193. package/esm/sdk/models/invoice-line-item-response.js +2 -0
  194. package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
  195. package/esm/sdk/models/list-commitments-response.d.ts +13 -0
  196. package/esm/sdk/models/list-commitments-response.d.ts.map +1 -0
  197. package/esm/sdk/models/list-commitments-response.js +17 -0
  198. package/esm/sdk/models/list-commitments-response.js.map +1 -0
  199. package/esm/sdk/models/price-price-tier.d.ts +2 -0
  200. package/esm/sdk/models/price-price-tier.d.ts.map +1 -1
  201. package/esm/sdk/models/price-price-tier.js +3 -0
  202. package/esm/sdk/models/price-price-tier.js.map +1 -1
  203. package/esm/sdk/models/price-transform-quantity.d.ts +5 -0
  204. package/esm/sdk/models/price-transform-quantity.d.ts.map +1 -1
  205. package/esm/sdk/models/price-transform-quantity.js +15 -1
  206. package/esm/sdk/models/price-transform-quantity.js.map +1 -1
  207. package/esm/sdk/models/report-query-request.d.ts +2 -0
  208. package/esm/sdk/models/report-query-request.d.ts.map +1 -1
  209. package/esm/sdk/models/report-query-request.js +1 -0
  210. package/esm/sdk/models/report-query-request.js.map +1 -1
  211. package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
  212. package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
  213. package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
  214. package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
  215. package/esm/sdk/models/self-billing-charge-response.d.ts +45 -0
  216. package/esm/sdk/models/self-billing-charge-response.d.ts.map +1 -0
  217. package/esm/sdk/models/self-billing-charge-response.js +63 -0
  218. package/esm/sdk/models/self-billing-charge-response.js.map +1 -0
  219. package/esm/sdk/models/self-billing-plan-response.d.ts +14 -0
  220. package/esm/sdk/models/self-billing-plan-response.d.ts.map +1 -0
  221. package/esm/sdk/models/self-billing-plan-response.js +18 -0
  222. package/esm/sdk/models/self-billing-plan-response.js.map +1 -0
  223. package/esm/sdk/models/self-billing-summary-response.d.ts +2 -0
  224. package/esm/sdk/models/self-billing-summary-response.d.ts.map +1 -1
  225. package/esm/sdk/models/self-billing-summary-response.js +2 -0
  226. package/esm/sdk/models/self-billing-summary-response.js.map +1 -1
  227. package/esm/sdk/models/subscription-line-item-response.d.ts +5 -0
  228. package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
  229. package/esm/sdk/models/subscription-line-item-response.js +4 -0
  230. package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
  231. package/esm/sdk/models/subscription-subscription-line-item.d.ts +5 -0
  232. package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
  233. package/esm/sdk/models/subscription-subscription-line-item.js +4 -0
  234. package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
  235. package/esm/sdk/models/terminate-commitment-op.d.ts +21 -0
  236. package/esm/sdk/models/terminate-commitment-op.d.ts.map +1 -0
  237. package/esm/sdk/models/terminate-commitment-op.js +14 -0
  238. package/esm/sdk/models/terminate-commitment-op.js.map +1 -0
  239. package/esm/sdk/models/terminate-commitment-request.d.ts +14 -0
  240. package/esm/sdk/models/terminate-commitment-request.d.ts.map +1 -0
  241. package/esm/sdk/models/terminate-commitment-request.js +19 -0
  242. package/esm/sdk/models/terminate-commitment-request.js.map +1 -0
  243. package/esm/sdk/models/trigger-force-run-request.d.ts +5 -0
  244. package/esm/sdk/models/trigger-force-run-request.d.ts.map +1 -1
  245. package/esm/sdk/models/trigger-force-run-request.js +2 -0
  246. package/esm/sdk/models/trigger-force-run-request.js.map +1 -1
  247. package/esm/sdk/models/update-commitment-op.d.ts +21 -0
  248. package/esm/sdk/models/update-commitment-op.d.ts.map +1 -0
  249. package/esm/sdk/models/update-commitment-op.js +14 -0
  250. package/esm/sdk/models/update-commitment-op.js.map +1 -0
  251. package/esm/sdk/models/update-commitment-request.d.ts +22 -0
  252. package/esm/sdk/models/update-commitment-request.d.ts.map +1 -0
  253. package/esm/sdk/models/update-commitment-request.js +21 -0
  254. package/esm/sdk/models/update-commitment-request.js.map +1 -0
  255. package/esm/sdk/models/update-entitlement-request.d.ts +3 -0
  256. package/esm/sdk/models/update-entitlement-request.d.ts.map +1 -1
  257. package/esm/sdk/models/update-entitlement-request.js.map +1 -1
  258. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.d.ts +13 -0
  259. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.d.ts.map +1 -0
  260. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.js +22 -0
  261. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.js.map +1 -0
  262. package/esm/sdk/models/webhook-event-name.d.ts +3 -0
  263. package/esm/sdk/models/webhook-event-name.d.ts.map +1 -1
  264. package/esm/sdk/models/webhook-event-name.js +3 -0
  265. package/esm/sdk/models/webhook-event-name.js.map +1 -1
  266. package/esm/sdk/sdk.d.ts +3 -0
  267. package/esm/sdk/sdk.d.ts.map +1 -1
  268. package/esm/sdk/sdk.js +5 -0
  269. package/esm/sdk/sdk.js.map +1 -1
  270. package/esm/sdk/self-billing.d.ts +1 -1
  271. package/esm/sdk/self-billing.js +1 -1
  272. package/esm/sdk/webhook-events.d.ts +21 -0
  273. package/esm/sdk/webhook-events.d.ts.map +1 -1
  274. package/esm/sdk/webhook-events.js +30 -0
  275. package/esm/sdk/webhook-events.js.map +1 -1
  276. package/jsr.json +1 -1
  277. package/package.json +1 -1
  278. package/src/funcs/commitments-create-commitment.ts +172 -0
  279. package/src/funcs/commitments-get-commitment.ts +181 -0
  280. package/src/funcs/commitments-preview-commitment.ts +172 -0
  281. package/src/funcs/commitments-query-commitment.ts +172 -0
  282. package/src/funcs/commitments-terminate-commitment.ts +187 -0
  283. package/src/funcs/commitments-update-commitment.ts +187 -0
  284. package/src/funcs/events-delete-events.ts +175 -0
  285. package/src/funcs/self-billing-get-self-billing-summary.ts +1 -1
  286. package/src/funcs/webhook-events-post-webhook-events-commitment-created.ts +144 -0
  287. package/src/funcs/webhook-events-post-webhook-events-commitment-terminated.ts +144 -0
  288. package/src/funcs/webhook-events-post-webhook-events-commitment-updated.ts +144 -0
  289. package/src/lib/config.ts +3 -3
  290. package/src/sdk/commitments.ts +121 -0
  291. package/src/sdk/events.ts +18 -0
  292. package/src/sdk/models/active-window.ts +54 -0
  293. package/src/sdk/models/commitment-collection-method.ts +26 -0
  294. package/src/sdk/models/commitment-early-termination.ts +22 -0
  295. package/src/sdk/models/commitment-filter.ts +127 -0
  296. package/src/sdk/models/commitment-measurement.ts +24 -0
  297. package/src/sdk/models/commitment-price-input.ts +64 -0
  298. package/src/sdk/models/commitment-response.ts +164 -0
  299. package/src/sdk/models/commitment-scope-input.ts +49 -0
  300. package/src/sdk/models/commitment-scope-type.ts +26 -0
  301. package/src/sdk/models/commitment-status.ts +25 -0
  302. package/src/sdk/models/commitment-usage-breakdown.ts +86 -0
  303. package/src/sdk/models/commitment-usage-value.ts +33 -0
  304. package/src/sdk/models/create-commitment-request.ts +134 -0
  305. package/src/sdk/models/create-entitlement-request.ts +3 -0
  306. package/src/sdk/models/create-price-tier.ts +9 -0
  307. package/src/sdk/models/create-subscription-request.ts +14 -0
  308. package/src/sdk/models/delete-events-op.ts +45 -0
  309. package/src/sdk/models/delete-events-request.ts +74 -0
  310. package/src/sdk/models/delete-events-response.ts +42 -0
  311. package/src/sdk/models/get-commitment-op.ts +33 -0
  312. package/src/sdk/models/get-usage-by-subscription-response.ts +11 -0
  313. package/src/sdk/models/index.ts +25 -0
  314. package/src/sdk/models/invoice-filter.ts +14 -0
  315. package/src/sdk/models/invoice-line-item-response.ts +6 -0
  316. package/src/sdk/models/list-commitments-response.ts +41 -0
  317. package/src/sdk/models/price-price-tier.ts +7 -0
  318. package/src/sdk/models/price-transform-quantity.ts +33 -1
  319. package/src/sdk/models/report-query-request.ts +3 -0
  320. package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
  321. package/src/sdk/models/self-billing-charge-response.ts +124 -0
  322. package/src/sdk/models/self-billing-plan-response.ts +41 -0
  323. package/src/sdk/models/self-billing-summary-response.ts +6 -0
  324. package/src/sdk/models/subscription-line-item-response.ts +9 -0
  325. package/src/sdk/models/subscription-subscription-line-item.ts +9 -0
  326. package/src/sdk/models/terminate-commitment-op.ts +46 -0
  327. package/src/sdk/models/terminate-commitment-request.ts +44 -0
  328. package/src/sdk/models/trigger-force-run-request.ts +7 -0
  329. package/src/sdk/models/update-commitment-op.ts +46 -0
  330. package/src/sdk/models/update-commitment-request.ts +48 -0
  331. package/src/sdk/models/update-entitlement-request.ts +3 -0
  332. package/src/sdk/models/webhook-dto-commitment-webhook-payload.ts +50 -0
  333. package/src/sdk/models/webhook-event-name.ts +3 -0
  334. package/src/sdk/sdk.ts +6 -0
  335. package/src/sdk/self-billing.ts +1 -1
  336. package/src/sdk/webhook-events.ts +48 -0
package/docs/sdk/models/get-usage-by-subscription-response.md CHANGED
@@ -10,16 +10,17 @@ let value: GetUsageBySubscriptionResponse = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
15
- | `amount` | *number* | :heavy_minus_sign: | N/A |
16
- | `charges` | [models.SubscriptionUsageByMetersResponse](../../sdk/models/subscription-usage-by-meters-response.md)[] | :heavy_minus_sign: | N/A |
17
- | `commitmentAmount` | *number* | :heavy_minus_sign: | N/A |
18
- | `commitmentUtilized` | *number* | :heavy_minus_sign: | Amount of commitment used |
19
- | `currency` | *string* | :heavy_minus_sign: | N/A |
20
- | `displayAmount` | *string* | :heavy_minus_sign: | N/A |
21
- | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
22
- | `hasOverage` | *boolean* | :heavy_minus_sign: | Whether any usage exceeded commitment |
23
- | `overageAmount` | *number* | :heavy_minus_sign: | Amount charged at overage rate |
24
- | `overageFactor` | *number* | :heavy_minus_sign: | N/A |
25
- | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
15
+ | `amount` | *number* | :heavy_minus_sign: | N/A |
16
+ | `charges` | [models.SubscriptionUsageByMetersResponse](../../sdk/models/subscription-usage-by-meters-response.md)[] | :heavy_minus_sign: | N/A |
17
+ | `commitmentAmount` | *number* | :heavy_minus_sign: | N/A |
18
+ | `commitmentUtilized` | *number* | :heavy_minus_sign: | Amount of commitment used |
19
+ | `commitments` | [models.CommitmentUsageBreakdown](../../sdk/models/commitment-usage-breakdown.md)[] | :heavy_minus_sign: | Commitments is the per-commitment usage breakdown for the window; nil when commitments v2 is off or none apply. |
20
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
21
+ | `displayAmount` | *string* | :heavy_minus_sign: | N/A |
22
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
23
+ | `hasOverage` | *boolean* | :heavy_minus_sign: | Whether any usage exceeded commitment |
24
+ | `overageAmount` | *number* | :heavy_minus_sign: | Amount charged at overage rate |
25
+ | `overageFactor` | *number* | :heavy_minus_sign: | N/A |
26
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-filter.md CHANGED
@@ -29,9 +29,11 @@ let value: InvoiceFilter = {};
29
29
  | `offset` | *number* | :heavy_minus_sign: | N/A |
30
30
  | `order` | [models.InvoiceFilterOrder](../../sdk/models/invoice-filter-order.md) | :heavy_minus_sign: | N/A |
31
31
  | `paymentStatus` | [models.PaymentStatus](../../sdk/models/payment-status.md)[] | :heavy_minus_sign: | payment_status filters by the payment state of invoices<br/>Multiple statuses can be specified to include invoices with any of the listed payment states |
32
+ | `periodEndGt` | *string* | :heavy_minus_sign: | period_end_gt filters invoices with period_end > value |
32
33
  | `periodEndGte` | *string* | :heavy_minus_sign: | period_end_gte filters invoices with period_end >= value |
33
34
  | `periodEndLte` | *string* | :heavy_minus_sign: | period_end_lte filters invoices with period_end <= value |
34
35
  | `periodStartGte` | *string* | :heavy_minus_sign: | period_start_gte filters invoices with period_start >= value |
36
+ | `periodStartLt` | *string* | :heavy_minus_sign: | period_start_lt filters invoices with period_start < value |
35
37
  | `periodStartLte` | *string* | :heavy_minus_sign: | period_start_lte filters invoices with period_start <= value |
36
38
  | `skipLineItems` | *boolean* | :heavy_minus_sign: | SkipLineItems if true, will not include line items in the response |
37
39
  | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-line-item-response.md CHANGED
@@ -14,6 +14,7 @@ let value: InvoiceLineItemResponse = {};
14
14
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `adjustedEntitlementQuantity` | *string* | :heavy_minus_sign: | adjusted_entitlement_quantity is the entitlement-covered portion deducted from raw usage.<br/>Nil when no entitlement was applied. Raw usage = Quantity + AdjustedEntitlementQuantity. |
16
16
  | `amount` | *string* | :heavy_minus_sign: | N/A |
17
+ | `commitmentId` | *string* | :heavy_minus_sign: | commitment_id links this line item to the commitment it bills. |
17
18
  | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
18
19
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
20
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-commitments-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListCommitmentsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListCommitmentsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListCommitmentsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
15
+ | `items` | [models.CommitmentResponse](../../sdk/models/commitment-response.md)[] | :heavy_minus_sign: | N/A |
16
+ | `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-price-tier.md CHANGED
@@ -13,5 +13,6 @@ let value: PricePriceTier = {};
13
13
  | Field | Type | Required | Description |
14
14
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `flatAmount` | *string* | :heavy_minus_sign: | flat_amount is the flat amount for the given tier (optional)<br/>Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c" |
16
+ | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
16
17
  | `unitAmount` | *string* | :heavy_minus_sign: | unit_amount is the amount per unit for the given tier |
17
18
  | `upTo` | *number* | :heavy_minus_sign: | up_to is the quantity up to which this tier applies. It is null for the last tier.<br/>IMPORTANT: Tier boundaries are INCLUSIVE.<br/>- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier<br/>- This behavior is consistent across both VOLUME and SLAB tier modes |
package/docs/sdk/models/report-query-request.md CHANGED
@@ -21,6 +21,7 @@ let value: ReportQueryRequest = {
21
21
  | `filters` | [models.ReportFilter](../../sdk/models/report-filter.md)[] | :heavy_minus_sign: | N/A | |
22
22
  | `grain` | [models.ReportQueryRequestGrain](../../sdk/models/report-query-request-grain.md) | :heavy_minus_sign: | N/A | |
23
23
  | `limit` | *number* | :heavy_minus_sign: | N/A | |
24
+ | `offset` | *number* | :heavy_minus_sign: | N/A | |
24
25
  | `range` | *string* | :heavy_check_mark: | N/A | 2026-09-01..2026-10-01 |
25
26
  | `shape` | [models.ReportQueryRequestShape](../../sdk/models/report-query-request-shape.md) | :heavy_check_mark: | N/A | |
26
27
  | `sort` | [models.ReportSort](../../sdk/models/report-sort.md)[] | :heavy_minus_sign: | N/A | |
package/docs/sdk/models/scheduled-task-entity-type.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { ScheduledTaskEntityType } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: ScheduledTaskEntityType = "invoice";
8
+ let value: ScheduledTaskEntityType = "credit_topups";
9
9
 
10
10
  // Open enum: unrecognized values are captured as Unrecognized<string>
11
11
  ```
@@ -13,5 +13,5 @@ let value: ScheduledTaskEntityType = "invoice";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "events" | "invoice" | "credit_topups" | "wallet_debits" | "credit_usage" | "usage_analytics" | "revenue_facts" | Unrecognized<string>
16
+ "events" | "invoice" | "credit_topups" | "wallet_debits" | "wallet_ledger" | "credit_usage" | "usage_analytics" | "revenue_facts" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/self-billing-charge-response.md ADDED
@@ -0,0 +1,35 @@
1
+ # SelfBillingChargeResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SelfBillingChargeResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SelfBillingChargeResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | Amount is a unit rate; tiered charges use tiers instead. |
16
+ | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
17
+ | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
18
+ | `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
19
+ | `bucketSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
20
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
21
+ | `displayName` | *string* | :heavy_minus_sign: | N/A |
22
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
23
+ | `lineItemId` | *string* | :heavy_minus_sign: | N/A |
24
+ | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
25
+ | `meterId` | *string* | :heavy_minus_sign: | N/A |
26
+ | `priceId` | *string* | :heavy_minus_sign: | N/A |
27
+ | `priceUnit` | *string* | :heavy_minus_sign: | N/A |
28
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | N/A |
29
+ | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
30
+ | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
31
+ | `quantity` | *string* | :heavy_minus_sign: | Quantity is the configured quantity; metered usage is returned in summary.usage. |
32
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
33
+ | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
34
+ | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
35
+ | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/self-billing-plan-response.md ADDED
@@ -0,0 +1,18 @@
1
+ # SelfBillingPlanResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SelfBillingPlanResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SelfBillingPlanResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
15
+ | `charges` | [models.SelfBillingChargeResponse](../../sdk/models/self-billing-charge-response.md)[] | :heavy_minus_sign: | N/A |
16
+ | `description` | *string* | :heavy_minus_sign: | N/A |
17
+ | `id` | *string* | :heavy_minus_sign: | N/A |
18
+ | `name` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/self-billing-summary-response.md CHANGED
@@ -31,6 +31,7 @@ let value: SelfBillingSummaryResponse = {
31
31
  | Field | Type | Required | Description |
32
32
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
33
33
  | `invoices` | [models.SelfBillingInvoice](../../sdk/models/self-billing-invoice.md)[] | :heavy_minus_sign: | N/A |
34
+ | `plan` | [models.SelfBillingPlanResponse](../../sdk/models/self-billing-plan-response.md) | :heavy_minus_sign: | N/A |
34
35
  | `status` | [models.TenantInternalStatus](../../sdk/models/tenant-internal-status.md) | :heavy_minus_sign: | N/A |
35
36
  | `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
36
37
  | `trialEndsAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-line-item-response.md CHANGED
@@ -69,6 +69,7 @@ let value: SubscriptionLineItemResponse = {
69
69
  | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
70
70
  | `meterId` | *string* | :heavy_minus_sign: | N/A |
71
71
  | `planDisplayName` | *string* | :heavy_minus_sign: | N/A |
72
+ | `predecessorLineItemId` | *string* | :heavy_minus_sign: | Version lineage, set by the service when a line item is replaced by a new version |
72
73
  | `price` | [models.PriceResponse](../../sdk/models/price-response.md) | :heavy_minus_sign: | N/A |
73
74
  | `priceId` | *string* | :heavy_minus_sign: | N/A |
74
75
  | `priceType` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
@@ -79,6 +80,7 @@ let value: SubscriptionLineItemResponse = {
79
80
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
80
81
  | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
81
82
  | `subscriptionPhaseId` | *string* | :heavy_minus_sign: | N/A |
83
+ | `successorLineItemId` | *string* | :heavy_minus_sign: | N/A |
82
84
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
83
85
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
84
86
  | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-subscription-line-item.md CHANGED
@@ -39,6 +39,7 @@ let value: SubscriptionSubscriptionLineItem = {};
39
39
  | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
40
40
  | `meterId` | *string* | :heavy_minus_sign: | N/A |
41
41
  | `planDisplayName` | *string* | :heavy_minus_sign: | N/A |
42
+ | `predecessorLineItemId` | *string* | :heavy_minus_sign: | Version lineage, set by the service when a line item is replaced by a new version |
42
43
  | `price` | [models.PricePrice](../../sdk/models/price-price.md) | :heavy_minus_sign: | N/A |
43
44
  | `priceId` | *string* | :heavy_minus_sign: | N/A |
44
45
  | `priceType` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
@@ -49,6 +50,7 @@ let value: SubscriptionSubscriptionLineItem = {};
49
50
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
50
51
  | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
51
52
  | `subscriptionPhaseId` | *string* | :heavy_minus_sign: | N/A |
53
+ | `successorLineItemId` | *string* | :heavy_minus_sign: | N/A |
52
54
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
53
55
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
54
56
  | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/terminate-commitment-request-request.md ADDED
@@ -0,0 +1,18 @@
1
+ # TerminateCommitmentRequestRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TerminateCommitmentRequestRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TerminateCommitmentRequestRequest = {
9
+ id: "<id>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
17
+ | `id` | *string* | :heavy_check_mark: | Commitment ID |
18
+ | `body` | [models.TerminateCommitmentRequest](../../sdk/models/terminate-commitment-request.md) | :heavy_minus_sign: | Termination request |
package/docs/sdk/models/terminate-commitment-request.md ADDED
@@ -0,0 +1,16 @@
1
+ # TerminateCommitmentRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TerminateCommitmentRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TerminateCommitmentRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `cancellationFee` | *string* | :heavy_minus_sign: | N/A |
16
+ | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/trigger-force-run-request.md CHANGED
@@ -5,12 +5,17 @@
5
5
  ```typescript
6
6
  import { TriggerForceRunRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: TriggerForceRunRequest = {};
8
+ let value: TriggerForceRunRequest = {
9
+ customerExternalIds: [
10
+ "<value 1>",
11
+ ],
12
+ };
9
13
  ```
10
14
 
11
15
  ## Fields
12
16
 
13
17
  | Field | Type | Required | Description |
14
18
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
19
+ | `customerExternalIds` | *string*[] | :heavy_check_mark: | Limits a wallet_ledger export to these customers; empty means every customer. |
15
20
  | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
16
21
  | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/update-commitment-request-request.md ADDED
@@ -0,0 +1,19 @@
1
+ # UpdateCommitmentRequestRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UpdateCommitmentRequestRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UpdateCommitmentRequestRequest = {
9
+ id: "<id>",
10
+ body: {},
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
18
+ | `id` | *string* | :heavy_check_mark: | Commitment ID |
19
+ | `body` | [models.UpdateCommitmentRequest](../../sdk/models/update-commitment-request.md) | :heavy_check_mark: | Commitment update |
package/docs/sdk/models/update-commitment-request.md ADDED
@@ -0,0 +1,18 @@
1
+ # UpdateCommitmentRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UpdateCommitmentRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UpdateCommitmentRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
15
+ | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
16
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
17
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
18
+ | `name` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/update-entitlement-request.md CHANGED
@@ -23,5 +23,5 @@ let value: UpdateEntitlementRequest = {};
23
23
  | `isEnabled` | *boolean* | :heavy_minus_sign: | N/A |
24
24
  | `isSoftLimit` | *boolean* | :heavy_minus_sign: | N/A |
25
25
  | `staticValue` | *string* | :heavy_minus_sign: | N/A |
26
- | `usageLimit` | *number* | :heavy_minus_sign: | N/A |
26
+ | `usageLimit` | *number* | :heavy_minus_sign: | Deprecated: use grant_quota. |
27
27
  | `usageResetPeriod` | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/webhook-dto-commitment-webhook-payload.md ADDED
@@ -0,0 +1,16 @@
1
+ # WebhookDtoCommitmentWebhookPayload
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WebhookDtoCommitmentWebhookPayload } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WebhookDtoCommitmentWebhookPayload = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `commitment` | [models.CommitmentResponse](../../sdk/models/commitment-response.md) | :heavy_minus_sign: | N/A |
16
+ | `eventType` | [models.WebhookEventName](../../sdk/models/webhook-event-name.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/webhook-event-name.md CHANGED
@@ -13,5 +13,5 @@ let value: WebhookEventName = "subscription.draft.created";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "subscription.created" | "subscription.draft.created" | "subscription.activated" | "subscription.updated" | "subscription.paused" | "subscription.cancelled" | "subscription.resumed" | "subscription.plan_changed" | "subscription.phase.created" | "subscription.phase.updated" | "subscription.phase.deleted" | "feature.created" | "feature.updated" | "feature.deleted" | "feature.wallet_balance.alert" | "entitlement.created" | "entitlement.updated" | "entitlement.deleted" | "wallet.created" | "wallet.updated" | "wallet.terminated" | "wallet.transaction.created" | "wallet.transaction.updated" | "payment.created" | "payment.updated" | "payment.failed" | "payment.success" | "payment.pending" | "refund.created" | "refund.succeeded" | "refund.failed" | "customer.created" | "customer.updated" | "customer.deleted" | "invoice.update.finalized" | "invoice.update.payment" | "invoice.update.voided" | "invoice.update" | "invoice.payment.overdue" | "invoice.sync.success" | "invoice.sync.failed" | "wallet.credit_balance.dropped" | "wallet.credit_balance.recovered" | "wallet.ongoing_balance.dropped" | "wallet.ongoing_balance.recovered" | "wallet.ongoing_balance.updated" | "subscription.spend.threshold_reached" | "subscription.spend.threshold_recovered" | "subscription.line_item_spend.threshold_reached" | "subscription.line_item_spend.threshold_recovered" | "subscription.group_spend.threshold_reached" | "subscription.group_spend.threshold_recovered" | "entitlement.grant.exhausted" | "subscription.renewal.due" | "invoice.communication.triggered" | "credit_note.created" | "credit_note.updated" | "checkout.session.initiated" | "checkout.session.completed" | "checkout.session.failed" | "checkout.session.expired" | "event.rejected" | Unrecognized<string>
16
+ "subscription.created" | "subscription.draft.created" | "subscription.activated" | "subscription.updated" | "subscription.paused" | "subscription.cancelled" | "subscription.resumed" | "subscription.plan_changed" | "subscription.phase.created" | "subscription.phase.updated" | "subscription.phase.deleted" | "feature.created" | "feature.updated" | "feature.deleted" | "feature.wallet_balance.alert" | "entitlement.created" | "entitlement.updated" | "entitlement.deleted" | "commitment.created" | "commitment.updated" | "commitment.terminated" | "wallet.created" | "wallet.updated" | "wallet.terminated" | "wallet.transaction.created" | "wallet.transaction.updated" | "payment.created" | "payment.updated" | "payment.failed" | "payment.success" | "payment.pending" | "refund.created" | "refund.succeeded" | "refund.failed" | "customer.created" | "customer.updated" | "customer.deleted" | "invoice.update.finalized" | "invoice.update.payment" | "invoice.update.voided" | "invoice.update" | "invoice.payment.overdue" | "invoice.sync.success" | "invoice.sync.failed" | "wallet.credit_balance.dropped" | "wallet.credit_balance.recovered" | "wallet.ongoing_balance.dropped" | "wallet.ongoing_balance.recovered" | "wallet.ongoing_balance.updated" | "subscription.spend.threshold_reached" | "subscription.spend.threshold_recovered" | "subscription.line_item_spend.threshold_reached" | "subscription.line_item_spend.threshold_recovered" | "subscription.group_spend.threshold_reached" | "subscription.group_spend.threshold_recovered" | "entitlement.grant.exhausted" | "subscription.renewal.due" | "invoice.communication.triggered" | "credit_note.created" | "credit_note.updated" | "checkout.session.initiated" | "checkout.session.completed" | "checkout.session.failed" | "checkout.session.expired" | "event.rejected" | Unrecognized<string>
17
17
  ```