@flexprice/sdk 2.1.30 → 2.1.33

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 (559) hide show
  1. package/README.md +2 -2
  2. package/docs/sdk/models/add-addon-params.md +5 -4
  3. package/docs/sdk/models/add-addon-request.md +1 -0
  4. package/docs/sdk/models/add-addon-to-subscription-request.md +1 -0
  5. package/docs/sdk/models/aggregated-entitlement-bucket.md +1 -0
  6. package/docs/sdk/models/aggregated-entitlement.md +16 -10
  7. package/docs/sdk/models/analytics-column.md +18 -0
  8. package/docs/sdk/models/analytics-filter.md +18 -0
  9. package/docs/sdk/models/analytics-query-meta.md +15 -0
  10. package/docs/sdk/models/analytics-query-request.md +23 -0
  11. package/docs/sdk/models/analytics-query-result.md +17 -0
  12. package/docs/sdk/models/analytics-sort-spec.md +16 -0
  13. package/docs/sdk/models/analytics-time-spec-raw.md +16 -0
  14. package/docs/sdk/models/analytics-variable.md +20 -0
  15. package/docs/sdk/models/analytics-view-definition.md +27 -0
  16. package/docs/sdk/models/cancel-checkout-session-request.md +17 -0
  17. package/docs/sdk/models/changed-addon-association-action.md +19 -0
  18. package/docs/sdk/models/changed-addon-association.md +20 -0
  19. package/docs/sdk/models/changed-resources.md +6 -5
  20. package/docs/sdk/models/checkout-action.md +2 -2
  21. package/docs/sdk/models/checkout-configuration.md +1 -0
  22. package/docs/sdk/models/checkout-params.md +1 -0
  23. package/docs/sdk/models/checkout-session-response.md +1 -0
  24. package/docs/sdk/models/column-role.md +17 -0
  25. package/docs/sdk/models/column-type.md +17 -0
  26. package/docs/sdk/models/create-checkout-session-request.md +1 -0
  27. package/docs/sdk/models/create-entitlement-request.md +1 -0
  28. package/docs/sdk/models/create-invoice-request.md +1 -0
  29. package/docs/sdk/models/create-scheduled-task-request.md +1 -1
  30. package/docs/sdk/models/create-subscription-request.md +1 -0
  31. package/docs/sdk/models/create-view-request.md +24 -0
  32. package/docs/sdk/models/entitlement-grant-status.md +17 -0
  33. package/docs/sdk/models/entity-creation-conflict-policies.md +15 -0
  34. package/docs/sdk/models/entity-creation-options.md +15 -0
  35. package/docs/sdk/models/entity-creation-result.md +16 -0
  36. package/docs/sdk/models/entity-creation-status.md +17 -0
  37. package/docs/sdk/models/event.md +11 -10
  38. package/docs/sdk/models/execute-subscription-modify-request-request.md +1 -1
  39. package/docs/sdk/models/execute-subscription-modify-request.md +2 -0
  40. package/docs/sdk/models/fact-status.md +17 -0
  41. package/docs/sdk/models/feature-usage-summary.md +18 -11
  42. package/docs/sdk/models/filter-operator-type.md +3 -1
  43. package/docs/sdk/models/get-event-by-id-response.md +1 -0
  44. package/docs/sdk/models/grain.md +17 -0
  45. package/docs/sdk/models/grant-allowance-state.md +27 -0
  46. package/docs/sdk/models/grant-state.md +15 -0
  47. package/docs/sdk/models/invoice-filter.md +3 -1
  48. package/docs/sdk/models/invoice-response.md +2 -0
  49. package/docs/sdk/models/invoice-source-type.md +15 -0
  50. package/docs/sdk/models/line-item-change.md +20 -0
  51. package/docs/sdk/models/line-item-grouping.md +17 -0
  52. package/docs/sdk/models/metric.md +17 -0
  53. package/docs/sdk/models/modify-subscription-line-item.md +1 -0
  54. package/docs/sdk/models/modify-subscription-params.md +1 -0
  55. package/docs/sdk/models/modify-subscription-type.md +15 -0
  56. package/docs/sdk/models/on-existing-entity-policy.md +15 -0
  57. package/docs/sdk/models/override-entitlement-request.md +7 -0
  58. package/docs/sdk/models/pay-invoice-params.md +17 -0
  59. package/docs/sdk/models/preview-subscription-modify-request.md +1 -1
  60. package/docs/sdk/models/price-filter.md +22 -21
  61. package/docs/sdk/models/query-analytics-view-request.md +19 -0
  62. package/docs/sdk/models/remove-addon-ref.md +18 -0
  63. package/docs/sdk/models/remove-addon-request.md +1 -0
  64. package/docs/sdk/models/revenue-allocation-policy.md +17 -0
  65. package/docs/sdk/models/revenue-analytics-request.md +28 -0
  66. package/docs/sdk/models/revenue-analytics-response.md +17 -0
  67. package/docs/sdk/models/revenue-analytics-row.md +28 -0
  68. package/docs/sdk/models/revenue-granularity.md +17 -0
  69. package/docs/sdk/models/scheduled-task-entity-type.md +1 -1
  70. package/docs/sdk/models/shape.md +17 -0
  71. package/docs/sdk/models/sort-direction.md +3 -1
  72. package/docs/sdk/models/sub-modify-bulk-addon-params.md +16 -0
  73. package/docs/sdk/models/sub-modify-line-item-change-request.md +21 -0
  74. package/docs/sdk/models/subscription-change-entity-type.md +2 -2
  75. package/docs/sdk/models/subscription-modify-type.md +2 -2
  76. package/docs/sdk/models/subscription-response-v2.md +1 -0
  77. package/docs/sdk/models/subscription-response.md +1 -0
  78. package/docs/sdk/models/subscription-schedule-response.md +2 -2
  79. package/docs/sdk/models/update-entitlement-request.md +15 -15
  80. package/docs/sdk/models/usage-analytic-item.md +1 -0
  81. package/docs/sdk/models/variable-type.md +17 -0
  82. package/docs/sdk/models/view-query-request.md +15 -0
  83. package/docs/sdk/models/view-response.md +18 -0
  84. package/docs/sdks/analytics/README.md +329 -0
  85. package/docs/sdks/checkout/README.md +74 -2
  86. package/docs/sdks/invoices/README.md +1 -0
  87. package/docs/sdks/subscriptions/README.md +6 -4
  88. package/esm/funcs/analytics-create-analytics-view.d.ts +17 -0
  89. package/esm/funcs/analytics-create-analytics-view.d.ts.map +1 -0
  90. package/esm/funcs/analytics-create-analytics-view.js +83 -0
  91. package/esm/funcs/analytics-create-analytics-view.js.map +1 -0
  92. package/esm/funcs/analytics-get-revenue-analytics.d.ts +17 -0
  93. package/esm/funcs/analytics-get-revenue-analytics.d.ts.map +1 -0
  94. package/esm/funcs/analytics-get-revenue-analytics.js +83 -0
  95. package/esm/funcs/analytics-get-revenue-analytics.js.map +1 -0
  96. package/esm/funcs/analytics-query-analytics-view.d.ts +17 -0
  97. package/esm/funcs/analytics-query-analytics-view.d.ts.map +1 -0
  98. package/esm/funcs/analytics-query-analytics-view.js +93 -0
  99. package/esm/funcs/analytics-query-analytics-view.js.map +1 -0
  100. package/esm/funcs/analytics-query-analytics.d.ts +17 -0
  101. package/esm/funcs/analytics-query-analytics.d.ts.map +1 -0
  102. package/esm/funcs/analytics-query-analytics.js +83 -0
  103. package/esm/funcs/analytics-query-analytics.js.map +1 -0
  104. package/esm/funcs/checkout-cancel-checkout-session.d.ts +14 -0
  105. package/esm/funcs/checkout-cancel-checkout-session.d.ts.map +1 -0
  106. package/esm/funcs/checkout-cancel-checkout-session.js +88 -0
  107. package/esm/funcs/checkout-cancel-checkout-session.js.map +1 -0
  108. package/esm/funcs/invoices-create-invoice.d.ts +1 -0
  109. package/esm/funcs/invoices-create-invoice.d.ts.map +1 -1
  110. package/esm/funcs/invoices-create-invoice.js +1 -0
  111. package/esm/funcs/invoices-create-invoice.js.map +1 -1
  112. package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +2 -1
  113. package/esm/funcs/subscriptions-execute-subscription-modify.d.ts.map +1 -1
  114. package/esm/funcs/subscriptions-execute-subscription-modify.js +2 -1
  115. package/esm/funcs/subscriptions-execute-subscription-modify.js.map +1 -1
  116. package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +2 -1
  117. package/esm/funcs/subscriptions-preview-subscription-modify.d.ts.map +1 -1
  118. package/esm/funcs/subscriptions-preview-subscription-modify.js +2 -1
  119. package/esm/funcs/subscriptions-preview-subscription-modify.js.map +1 -1
  120. package/esm/lib/config.d.ts +3 -3
  121. package/esm/lib/config.js +3 -3
  122. package/esm/sdk/analytics.d.ts +33 -0
  123. package/esm/sdk/analytics.d.ts.map +1 -0
  124. package/esm/sdk/analytics.js +48 -0
  125. package/esm/sdk/analytics.js.map +1 -0
  126. package/esm/sdk/checkout.d.ts +4 -0
  127. package/esm/sdk/checkout.d.ts.map +1 -1
  128. package/esm/sdk/checkout.js +7 -0
  129. package/esm/sdk/checkout.js.map +1 -1
  130. package/esm/sdk/invoices.d.ts +1 -0
  131. package/esm/sdk/invoices.d.ts.map +1 -1
  132. package/esm/sdk/invoices.js +1 -0
  133. package/esm/sdk/invoices.js.map +1 -1
  134. package/esm/sdk/models/add-addon-params.d.ts +3 -0
  135. package/esm/sdk/models/add-addon-params.d.ts.map +1 -1
  136. package/esm/sdk/models/add-addon-params.js +2 -0
  137. package/esm/sdk/models/add-addon-params.js.map +1 -1
  138. package/esm/sdk/models/add-addon-request.d.ts +3 -0
  139. package/esm/sdk/models/add-addon-request.d.ts.map +1 -1
  140. package/esm/sdk/models/add-addon-request.js +3 -0
  141. package/esm/sdk/models/add-addon-request.js.map +1 -1
  142. package/esm/sdk/models/add-addon-to-subscription-request.d.ts +3 -0
  143. package/esm/sdk/models/add-addon-to-subscription-request.d.ts.map +1 -1
  144. package/esm/sdk/models/add-addon-to-subscription-request.js +3 -0
  145. package/esm/sdk/models/add-addon-to-subscription-request.js.map +1 -1
  146. package/esm/sdk/models/aggregated-entitlement-bucket.d.ts +1 -0
  147. package/esm/sdk/models/aggregated-entitlement-bucket.d.ts.map +1 -1
  148. package/esm/sdk/models/aggregated-entitlement-bucket.js +2 -0
  149. package/esm/sdk/models/aggregated-entitlement-bucket.js.map +1 -1
  150. package/esm/sdk/models/aggregated-entitlement.d.ts +9 -0
  151. package/esm/sdk/models/aggregated-entitlement.d.ts.map +1 -1
  152. package/esm/sdk/models/aggregated-entitlement.js +15 -0
  153. package/esm/sdk/models/aggregated-entitlement.js.map +1 -1
  154. package/esm/sdk/models/analytics-column.d.ts +15 -0
  155. package/esm/sdk/models/analytics-column.d.ts.map +1 -0
  156. package/esm/sdk/models/analytics-column.js +19 -0
  157. package/esm/sdk/models/analytics-column.js.map +1 -0
  158. package/esm/sdk/models/analytics-filter.d.ts +24 -0
  159. package/esm/sdk/models/analytics-filter.d.ts.map +1 -0
  160. package/esm/sdk/models/analytics-filter.js +28 -0
  161. package/esm/sdk/models/analytics-filter.js.map +1 -0
  162. package/esm/sdk/models/analytics-query-meta.d.ts +10 -0
  163. package/esm/sdk/models/analytics-query-meta.d.ts.map +1 -0
  164. package/esm/sdk/models/analytics-query-meta.js +19 -0
  165. package/esm/sdk/models/analytics-query-meta.js.map +1 -0
  166. package/esm/sdk/models/analytics-query-request.d.ts +19 -0
  167. package/esm/sdk/models/analytics-query-request.d.ts.map +1 -0
  168. package/esm/sdk/models/analytics-query-request.js +14 -0
  169. package/esm/sdk/models/analytics-query-request.js.map +1 -0
  170. package/esm/sdk/models/analytics-query-result.d.ts +14 -0
  171. package/esm/sdk/models/analytics-query-result.d.ts.map +1 -0
  172. package/esm/sdk/models/analytics-query-result.js +18 -0
  173. package/esm/sdk/models/analytics-query-result.js.map +1 -0
  174. package/esm/sdk/models/analytics-sort-spec.d.ts +20 -0
  175. package/esm/sdk/models/analytics-sort-spec.d.ts.map +1 -0
  176. package/esm/sdk/models/analytics-sort-spec.js +24 -0
  177. package/esm/sdk/models/analytics-sort-spec.js.map +1 -0
  178. package/esm/sdk/models/analytics-time-spec-raw.d.ts +20 -0
  179. package/esm/sdk/models/analytics-time-spec-raw.d.ts.map +1 -0
  180. package/esm/sdk/models/analytics-time-spec-raw.js +24 -0
  181. package/esm/sdk/models/analytics-time-spec-raw.js.map +1 -0
  182. package/esm/sdk/models/analytics-variable.d.ts +24 -0
  183. package/esm/sdk/models/analytics-variable.d.ts.map +1 -0
  184. package/esm/sdk/models/analytics-variable.js +28 -0
  185. package/esm/sdk/models/analytics-variable.js.map +1 -0
  186. package/esm/sdk/models/analytics-view-definition.d.ts +37 -0
  187. package/esm/sdk/models/analytics-view-definition.d.ts.map +1 -0
  188. package/esm/sdk/models/analytics-view-definition.js +41 -0
  189. package/esm/sdk/models/analytics-view-definition.js.map +1 -0
  190. package/esm/sdk/models/cancel-checkout-session-op.d.ts +15 -0
  191. package/esm/sdk/models/cancel-checkout-session-op.d.ts.map +1 -0
  192. package/esm/sdk/models/cancel-checkout-session-op.js +12 -0
  193. package/esm/sdk/models/cancel-checkout-session-op.js.map +1 -0
  194. package/esm/sdk/models/changed-addon-association-action.d.ts +16 -0
  195. package/esm/sdk/models/changed-addon-association-action.d.ts.map +1 -0
  196. package/esm/sdk/models/changed-addon-association-action.js +14 -0
  197. package/esm/sdk/models/changed-addon-association-action.js.map +1 -0
  198. package/esm/sdk/models/changed-addon-association.d.ts +20 -0
  199. package/esm/sdk/models/changed-addon-association.d.ts.map +1 -0
  200. package/esm/sdk/models/changed-addon-association.js +30 -0
  201. package/esm/sdk/models/changed-addon-association.js.map +1 -0
  202. package/esm/sdk/models/changed-resources.d.ts +2 -0
  203. package/esm/sdk/models/changed-resources.d.ts.map +1 -1
  204. package/esm/sdk/models/changed-resources.js +3 -0
  205. package/esm/sdk/models/changed-resources.js.map +1 -1
  206. package/esm/sdk/models/checkout-action.d.ts +1 -0
  207. package/esm/sdk/models/checkout-action.d.ts.map +1 -1
  208. package/esm/sdk/models/checkout-action.js +1 -0
  209. package/esm/sdk/models/checkout-action.js.map +1 -1
  210. package/esm/sdk/models/checkout-configuration.d.ts +3 -0
  211. package/esm/sdk/models/checkout-configuration.d.ts.map +1 -1
  212. package/esm/sdk/models/checkout-configuration.js +3 -0
  213. package/esm/sdk/models/checkout-configuration.js.map +1 -1
  214. package/esm/sdk/models/checkout-params.d.ts +3 -0
  215. package/esm/sdk/models/checkout-params.d.ts.map +1 -1
  216. package/esm/sdk/models/checkout-params.js +3 -0
  217. package/esm/sdk/models/checkout-params.js.map +1 -1
  218. package/esm/sdk/models/checkout-session-response.d.ts +2 -0
  219. package/esm/sdk/models/checkout-session-response.d.ts.map +1 -1
  220. package/esm/sdk/models/checkout-session-response.js +3 -0
  221. package/esm/sdk/models/checkout-session-response.js.map +1 -1
  222. package/esm/sdk/models/column-role.d.ts +10 -0
  223. package/esm/sdk/models/column-role.d.ts.map +1 -0
  224. package/esm/sdk/models/column-role.js +11 -0
  225. package/esm/sdk/models/column-role.js.map +1 -0
  226. package/esm/sdk/models/column-type.d.ts +11 -0
  227. package/esm/sdk/models/column-type.d.ts.map +1 -0
  228. package/esm/sdk/models/column-type.js +12 -0
  229. package/esm/sdk/models/column-type.js.map +1 -0
  230. package/esm/sdk/models/create-checkout-session-request.d.ts +3 -0
  231. package/esm/sdk/models/create-checkout-session-request.d.ts.map +1 -1
  232. package/esm/sdk/models/create-checkout-session-request.js +3 -0
  233. package/esm/sdk/models/create-checkout-session-request.js.map +1 -1
  234. package/esm/sdk/models/create-entitlement-request.d.ts +2 -0
  235. package/esm/sdk/models/create-entitlement-request.d.ts.map +1 -1
  236. package/esm/sdk/models/create-entitlement-request.js +2 -0
  237. package/esm/sdk/models/create-entitlement-request.js.map +1 -1
  238. package/esm/sdk/models/create-invoice-request.d.ts +3 -0
  239. package/esm/sdk/models/create-invoice-request.d.ts.map +1 -1
  240. package/esm/sdk/models/create-invoice-request.js +2 -0
  241. package/esm/sdk/models/create-invoice-request.js.map +1 -1
  242. package/esm/sdk/models/create-subscription-request.d.ts +3 -0
  243. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  244. package/esm/sdk/models/create-subscription-request.js +3 -0
  245. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  246. package/esm/sdk/models/create-view-request.d.ts +15 -0
  247. package/esm/sdk/models/create-view-request.d.ts.map +1 -0
  248. package/esm/sdk/models/create-view-request.js +14 -0
  249. package/esm/sdk/models/create-view-request.js.map +1 -0
  250. package/esm/sdk/models/entitlement-grant-status.d.ts +10 -0
  251. package/esm/sdk/models/entitlement-grant-status.d.ts.map +1 -0
  252. package/esm/sdk/models/entitlement-grant-status.js +11 -0
  253. package/esm/sdk/models/entitlement-grant-status.js.map +1 -0
  254. package/esm/sdk/models/entity-creation-conflict-policies.d.ts +13 -0
  255. package/esm/sdk/models/entity-creation-conflict-policies.d.ts.map +1 -0
  256. package/esm/sdk/models/entity-creation-conflict-policies.js +18 -0
  257. package/esm/sdk/models/entity-creation-conflict-policies.js.map +1 -0
  258. package/esm/sdk/models/entity-creation-options.d.ts +13 -0
  259. package/esm/sdk/models/entity-creation-options.d.ts.map +1 -0
  260. package/esm/sdk/models/entity-creation-options.js +18 -0
  261. package/esm/sdk/models/entity-creation-options.js.map +1 -0
  262. package/esm/sdk/models/entity-creation-result.d.ts +12 -0
  263. package/esm/sdk/models/entity-creation-result.d.ts.map +1 -0
  264. package/esm/sdk/models/entity-creation-result.js +21 -0
  265. package/esm/sdk/models/entity-creation-result.js.map +1 -0
  266. package/esm/sdk/models/entity-creation-status.d.ts +11 -0
  267. package/esm/sdk/models/entity-creation-status.d.ts.map +1 -0
  268. package/esm/sdk/models/entity-creation-status.js +12 -0
  269. package/esm/sdk/models/entity-creation-status.js.map +1 -0
  270. package/esm/sdk/models/event.d.ts +1 -0
  271. package/esm/sdk/models/event.d.ts.map +1 -1
  272. package/esm/sdk/models/event.js +2 -0
  273. package/esm/sdk/models/event.js.map +1 -1
  274. package/esm/sdk/models/execute-subscription-modify-request.d.ts +6 -0
  275. package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
  276. package/esm/sdk/models/execute-subscription-modify-request.js +6 -0
  277. package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
  278. package/esm/sdk/models/fact-status.d.ts +12 -0
  279. package/esm/sdk/models/fact-status.d.ts.map +1 -0
  280. package/esm/sdk/models/fact-status.js +13 -0
  281. package/esm/sdk/models/fact-status.js.map +1 -0
  282. package/esm/sdk/models/feature-usage-summary.d.ts +19 -0
  283. package/esm/sdk/models/feature-usage-summary.d.ts.map +1 -1
  284. package/esm/sdk/models/feature-usage-summary.js +17 -0
  285. package/esm/sdk/models/feature-usage-summary.js.map +1 -1
  286. package/esm/sdk/models/filter-operator-type.d.ts +5 -3
  287. package/esm/sdk/models/filter-operator-type.d.ts.map +1 -1
  288. package/esm/sdk/models/filter-operator-type.js +4 -2
  289. package/esm/sdk/models/filter-operator-type.js.map +1 -1
  290. package/esm/sdk/models/get-event-by-id-response.d.ts +1 -0
  291. package/esm/sdk/models/get-event-by-id-response.d.ts.map +1 -1
  292. package/esm/sdk/models/get-event-by-id-response.js +1 -0
  293. package/esm/sdk/models/get-event-by-id-response.js.map +1 -1
  294. package/esm/sdk/models/grain.d.ts +14 -0
  295. package/esm/sdk/models/grain.d.ts.map +1 -0
  296. package/esm/sdk/models/grain.js +17 -0
  297. package/esm/sdk/models/grain.js.map +1 -0
  298. package/esm/sdk/models/grant-allowance-state.d.ts +24 -0
  299. package/esm/sdk/models/grant-allowance-state.d.ts.map +1 -0
  300. package/esm/sdk/models/grant-allowance-state.js +39 -0
  301. package/esm/sdk/models/grant-allowance-state.js.map +1 -0
  302. package/esm/sdk/models/grant-state.d.ts +11 -0
  303. package/esm/sdk/models/grant-state.d.ts.map +1 -0
  304. package/esm/sdk/models/grant-state.js +16 -0
  305. package/esm/sdk/models/grant-state.js.map +1 -0
  306. package/esm/sdk/models/index.d.ts +44 -0
  307. package/esm/sdk/models/index.d.ts.map +1 -1
  308. package/esm/sdk/models/index.js +44 -0
  309. package/esm/sdk/models/index.js.map +1 -1
  310. package/esm/sdk/models/invoice-filter.d.ts +10 -0
  311. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  312. package/esm/sdk/models/invoice-filter.js +4 -0
  313. package/esm/sdk/models/invoice-filter.js.map +1 -1
  314. package/esm/sdk/models/invoice-response.d.ts +4 -0
  315. package/esm/sdk/models/invoice-response.d.ts.map +1 -1
  316. package/esm/sdk/models/invoice-response.js +6 -0
  317. package/esm/sdk/models/invoice-response.js.map +1 -1
  318. package/esm/sdk/models/invoice-source-type.d.ts +9 -0
  319. package/esm/sdk/models/invoice-source-type.d.ts.map +1 -0
  320. package/esm/sdk/models/invoice-source-type.js +10 -0
  321. package/esm/sdk/models/invoice-source-type.js.map +1 -0
  322. package/esm/sdk/models/line-item-change.d.ts +21 -0
  323. package/esm/sdk/models/line-item-change.d.ts.map +1 -0
  324. package/esm/sdk/models/line-item-change.js +20 -0
  325. package/esm/sdk/models/line-item-change.js.map +1 -0
  326. package/esm/sdk/models/line-item-grouping.d.ts +12 -0
  327. package/esm/sdk/models/line-item-grouping.d.ts.map +1 -0
  328. package/esm/sdk/models/line-item-grouping.js +13 -0
  329. package/esm/sdk/models/line-item-grouping.js.map +1 -0
  330. package/esm/sdk/models/metric.d.ts +12 -0
  331. package/esm/sdk/models/metric.d.ts.map +1 -0
  332. package/esm/sdk/models/metric.js +15 -0
  333. package/esm/sdk/models/metric.js.map +1 -0
  334. package/esm/sdk/models/modify-subscription-line-item.d.ts +2 -0
  335. package/esm/sdk/models/modify-subscription-line-item.d.ts.map +1 -1
  336. package/esm/sdk/models/modify-subscription-line-item.js +1 -0
  337. package/esm/sdk/models/modify-subscription-line-item.js.map +1 -1
  338. package/esm/sdk/models/modify-subscription-params.d.ts +3 -0
  339. package/esm/sdk/models/modify-subscription-params.d.ts.map +1 -1
  340. package/esm/sdk/models/modify-subscription-params.js +3 -0
  341. package/esm/sdk/models/modify-subscription-params.js.map +1 -1
  342. package/esm/sdk/models/modify-subscription-type.d.ts +10 -0
  343. package/esm/sdk/models/modify-subscription-type.d.ts.map +1 -0
  344. package/esm/sdk/models/modify-subscription-type.js +11 -0
  345. package/esm/sdk/models/modify-subscription-type.js.map +1 -0
  346. package/esm/sdk/models/on-existing-entity-policy.d.ts +10 -0
  347. package/esm/sdk/models/on-existing-entity-policy.d.ts.map +1 -0
  348. package/esm/sdk/models/on-existing-entity-policy.js +11 -0
  349. package/esm/sdk/models/on-existing-entity-policy.js.map +1 -0
  350. package/esm/sdk/models/override-entitlement-request.d.ts +18 -0
  351. package/esm/sdk/models/override-entitlement-request.d.ts.map +1 -1
  352. package/esm/sdk/models/override-entitlement-request.js +18 -0
  353. package/esm/sdk/models/override-entitlement-request.js.map +1 -1
  354. package/esm/sdk/models/pay-invoice-params.d.ts +12 -0
  355. package/esm/sdk/models/pay-invoice-params.d.ts.map +1 -0
  356. package/esm/sdk/models/pay-invoice-params.js +17 -0
  357. package/esm/sdk/models/pay-invoice-params.js.map +1 -0
  358. package/esm/sdk/models/price-filter.d.ts +9 -0
  359. package/esm/sdk/models/price-filter.d.ts.map +1 -1
  360. package/esm/sdk/models/price-filter.js +2 -0
  361. package/esm/sdk/models/price-filter.js.map +1 -1
  362. package/esm/sdk/models/query-analytics-view-op.d.ts +21 -0
  363. package/esm/sdk/models/query-analytics-view-op.d.ts.map +1 -0
  364. package/esm/sdk/models/query-analytics-view-op.js +14 -0
  365. package/esm/sdk/models/query-analytics-view-op.js.map +1 -0
  366. package/esm/sdk/models/remove-addon-ref.d.ts +19 -0
  367. package/esm/sdk/models/remove-addon-ref.d.ts.map +1 -0
  368. package/esm/sdk/models/remove-addon-ref.js +23 -0
  369. package/esm/sdk/models/remove-addon-ref.js.map +1 -0
  370. package/esm/sdk/models/remove-addon-request.d.ts +3 -0
  371. package/esm/sdk/models/remove-addon-request.d.ts.map +1 -1
  372. package/esm/sdk/models/remove-addon-request.js +3 -0
  373. package/esm/sdk/models/remove-addon-request.js.map +1 -1
  374. package/esm/sdk/models/revenue-allocation-policy.d.ts +12 -0
  375. package/esm/sdk/models/revenue-allocation-policy.d.ts.map +1 -0
  376. package/esm/sdk/models/revenue-allocation-policy.js +13 -0
  377. package/esm/sdk/models/revenue-allocation-policy.js.map +1 -0
  378. package/esm/sdk/models/revenue-analytics-request.d.ts +70 -0
  379. package/esm/sdk/models/revenue-analytics-request.d.ts.map +1 -0
  380. package/esm/sdk/models/revenue-analytics-request.js +71 -0
  381. package/esm/sdk/models/revenue-analytics-request.js.map +1 -0
  382. package/esm/sdk/models/revenue-analytics-response.d.ts +22 -0
  383. package/esm/sdk/models/revenue-analytics-response.d.ts.map +1 -0
  384. package/esm/sdk/models/revenue-analytics-response.js +23 -0
  385. package/esm/sdk/models/revenue-analytics-response.js.map +1 -0
  386. package/esm/sdk/models/revenue-analytics-row.d.ts +38 -0
  387. package/esm/sdk/models/revenue-analytics-row.d.ts.map +1 -0
  388. package/esm/sdk/models/revenue-analytics-row.js +43 -0
  389. package/esm/sdk/models/revenue-analytics-row.js.map +1 -0
  390. package/esm/sdk/models/revenue-granularity.d.ts +13 -0
  391. package/esm/sdk/models/revenue-granularity.d.ts.map +1 -0
  392. package/esm/sdk/models/revenue-granularity.js +14 -0
  393. package/esm/sdk/models/revenue-granularity.js.map +1 -0
  394. package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
  395. package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
  396. package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
  397. package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
  398. package/esm/sdk/models/shape.d.ts +12 -0
  399. package/esm/sdk/models/shape.d.ts.map +1 -0
  400. package/esm/sdk/models/shape.js +15 -0
  401. package/esm/sdk/models/shape.js.map +1 -0
  402. package/esm/sdk/models/sort-direction.d.ts +5 -3
  403. package/esm/sdk/models/sort-direction.d.ts.map +1 -1
  404. package/esm/sdk/models/sort-direction.js +4 -2
  405. package/esm/sdk/models/sort-direction.js.map +1 -1
  406. package/esm/sdk/models/sub-modify-bulk-addon-params.d.ts +16 -0
  407. package/esm/sdk/models/sub-modify-bulk-addon-params.d.ts.map +1 -0
  408. package/esm/sdk/models/sub-modify-bulk-addon-params.js +15 -0
  409. package/esm/sdk/models/sub-modify-bulk-addon-params.js.map +1 -0
  410. package/esm/sdk/models/sub-modify-line-item-change-request.d.ts +13 -0
  411. package/esm/sdk/models/sub-modify-line-item-change-request.d.ts.map +1 -0
  412. package/esm/sdk/models/sub-modify-line-item-change-request.js +18 -0
  413. package/esm/sdk/models/sub-modify-line-item-change-request.js.map +1 -0
  414. package/esm/sdk/models/subscription-change-entity-type.d.ts +1 -1
  415. package/esm/sdk/models/subscription-change-entity-type.js +1 -1
  416. package/esm/sdk/models/subscription-change-entity-type.js.map +1 -1
  417. package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
  418. package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
  419. package/esm/sdk/models/subscription-modify-type.js +1 -0
  420. package/esm/sdk/models/subscription-modify-type.js.map +1 -1
  421. package/esm/sdk/models/subscription-response-v2.d.ts +2 -0
  422. package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
  423. package/esm/sdk/models/subscription-response-v2.js +3 -0
  424. package/esm/sdk/models/subscription-response-v2.js.map +1 -1
  425. package/esm/sdk/models/subscription-response.d.ts +2 -0
  426. package/esm/sdk/models/subscription-response.d.ts.map +1 -1
  427. package/esm/sdk/models/subscription-response.js +3 -0
  428. package/esm/sdk/models/subscription-response.js.map +1 -1
  429. package/esm/sdk/models/subscription-schedule-response.d.ts +6 -16
  430. package/esm/sdk/models/subscription-schedule-response.d.ts.map +1 -1
  431. package/esm/sdk/models/subscription-schedule-response.js +2 -12
  432. package/esm/sdk/models/subscription-schedule-response.js.map +1 -1
  433. package/esm/sdk/models/update-entitlement-request.d.ts +2 -8
  434. package/esm/sdk/models/update-entitlement-request.d.ts.map +1 -1
  435. package/esm/sdk/models/update-entitlement-request.js +2 -2
  436. package/esm/sdk/models/update-entitlement-request.js.map +1 -1
  437. package/esm/sdk/models/usage-analytic-item.d.ts +4 -0
  438. package/esm/sdk/models/usage-analytic-item.d.ts.map +1 -1
  439. package/esm/sdk/models/usage-analytic-item.js +2 -0
  440. package/esm/sdk/models/usage-analytic-item.js.map +1 -1
  441. package/esm/sdk/models/variable-type.d.ts +16 -0
  442. package/esm/sdk/models/variable-type.d.ts.map +1 -0
  443. package/esm/sdk/models/variable-type.js +17 -0
  444. package/esm/sdk/models/variable-type.js.map +1 -0
  445. package/esm/sdk/models/view-query-request.d.ts +16 -0
  446. package/esm/sdk/models/view-query-request.d.ts.map +1 -0
  447. package/esm/sdk/models/view-query-request.js +12 -0
  448. package/esm/sdk/models/view-query-request.js.map +1 -0
  449. package/esm/sdk/models/view-response.d.ts +14 -0
  450. package/esm/sdk/models/view-response.d.ts.map +1 -0
  451. package/esm/sdk/models/view-response.js +18 -0
  452. package/esm/sdk/models/view-response.js.map +1 -0
  453. package/esm/sdk/sdk.d.ts +3 -0
  454. package/esm/sdk/sdk.d.ts.map +1 -1
  455. package/esm/sdk/sdk.js +5 -0
  456. package/esm/sdk/sdk.js.map +1 -1
  457. package/esm/sdk/subscriptions.d.ts +4 -2
  458. package/esm/sdk/subscriptions.d.ts.map +1 -1
  459. package/esm/sdk/subscriptions.js +4 -2
  460. package/esm/sdk/subscriptions.js.map +1 -1
  461. package/examples/README.md +1 -1
  462. package/jsr.json +1 -1
  463. package/package.json +1 -1
  464. package/src/funcs/analytics-create-analytics-view.ts +172 -0
  465. package/src/funcs/analytics-get-revenue-analytics.ts +172 -0
  466. package/src/funcs/analytics-query-analytics-view.ts +186 -0
  467. package/src/funcs/analytics-query-analytics.ts +172 -0
  468. package/src/funcs/checkout-cancel-checkout-session.ts +179 -0
  469. package/src/funcs/invoices-create-invoice.ts +1 -0
  470. package/src/funcs/subscriptions-execute-subscription-modify.ts +2 -1
  471. package/src/funcs/subscriptions-preview-subscription-modify.ts +2 -1
  472. package/src/lib/config.ts +3 -3
  473. package/src/sdk/analytics.ts +83 -0
  474. package/src/sdk/checkout.ts +15 -0
  475. package/src/sdk/invoices.ts +1 -0
  476. package/src/sdk/models/add-addon-params.ts +8 -0
  477. package/src/sdk/models/add-addon-request.ts +5 -0
  478. package/src/sdk/models/add-addon-to-subscription-request.ts +5 -0
  479. package/src/sdk/models/aggregated-entitlement-bucket.ts +3 -0
  480. package/src/sdk/models/aggregated-entitlement.ts +29 -0
  481. package/src/sdk/models/analytics-column.ts +39 -0
  482. package/src/sdk/models/analytics-filter.ts +65 -0
  483. package/src/sdk/models/analytics-query-meta.ts +39 -0
  484. package/src/sdk/models/analytics-query-request.ts +38 -0
  485. package/src/sdk/models/analytics-query-result.ts +43 -0
  486. package/src/sdk/models/analytics-sort-spec.ts +59 -0
  487. package/src/sdk/models/analytics-time-spec-raw.ts +55 -0
  488. package/src/sdk/models/analytics-variable.ts +67 -0
  489. package/src/sdk/models/analytics-view-definition.ts +108 -0
  490. package/src/sdk/models/cancel-checkout-session-op.ts +35 -0
  491. package/src/sdk/models/changed-addon-association-action.ts +27 -0
  492. package/src/sdk/models/changed-addon-association.ts +61 -0
  493. package/src/sdk/models/changed-resources.ts +9 -0
  494. package/src/sdk/models/checkout-action.ts +1 -0
  495. package/src/sdk/models/checkout-configuration.ts +9 -0
  496. package/src/sdk/models/checkout-params.ts +9 -0
  497. package/src/sdk/models/checkout-session-response.ts +7 -0
  498. package/src/sdk/models/column-role.ts +17 -0
  499. package/src/sdk/models/column-type.ts +18 -0
  500. package/src/sdk/models/create-checkout-session-request.ts +9 -0
  501. package/src/sdk/models/create-entitlement-request.ts +4 -0
  502. package/src/sdk/models/create-invoice-request.ts +8 -0
  503. package/src/sdk/models/create-subscription-request.ts +8 -0
  504. package/src/sdk/models/create-view-request.ts +38 -0
  505. package/src/sdk/models/entitlement-grant-status.ts +19 -0
  506. package/src/sdk/models/entity-creation-conflict-policies.ts +44 -0
  507. package/src/sdk/models/entity-creation-options.ts +47 -0
  508. package/src/sdk/models/entity-creation-result.ts +45 -0
  509. package/src/sdk/models/entity-creation-status.ts +20 -0
  510. package/src/sdk/models/event.ts +3 -0
  511. package/src/sdk/models/execute-subscription-modify-request.ts +20 -0
  512. package/src/sdk/models/fact-status.ts +20 -0
  513. package/src/sdk/models/feature-usage-summary.ts +43 -0
  514. package/src/sdk/models/filter-operator-type.ts +12 -5
  515. package/src/sdk/models/get-event-by-id-response.ts +2 -0
  516. package/src/sdk/models/grain.ts +22 -0
  517. package/src/sdk/models/grant-allowance-state.ts +77 -0
  518. package/src/sdk/models/grant-state.ts +33 -0
  519. package/src/sdk/models/index.ts +44 -0
  520. package/src/sdk/models/invoice-filter.ts +18 -0
  521. package/src/sdk/models/invoice-response.ts +14 -0
  522. package/src/sdk/models/invoice-source-type.ts +16 -0
  523. package/src/sdk/models/line-item-change.ts +48 -0
  524. package/src/sdk/models/line-item-grouping.ts +24 -0
  525. package/src/sdk/models/metric.ts +20 -0
  526. package/src/sdk/models/modify-subscription-line-item.ts +3 -0
  527. package/src/sdk/models/modify-subscription-params.ts +8 -0
  528. package/src/sdk/models/modify-subscription-type.ts +17 -0
  529. package/src/sdk/models/on-existing-entity-policy.ts +17 -0
  530. package/src/sdk/models/override-entitlement-request.ts +46 -0
  531. package/src/sdk/models/pay-invoice-params.ts +38 -0
  532. package/src/sdk/models/price-filter.ts +11 -0
  533. package/src/sdk/models/query-analytics-view-op.ts +44 -0
  534. package/src/sdk/models/remove-addon-ref.ts +51 -0
  535. package/src/sdk/models/remove-addon-request.ts +5 -0
  536. package/src/sdk/models/revenue-allocation-policy.ts +24 -0
  537. package/src/sdk/models/revenue-analytics-request.ts +168 -0
  538. package/src/sdk/models/revenue-analytics-response.ts +59 -0
  539. package/src/sdk/models/revenue-analytics-row.ts +88 -0
  540. package/src/sdk/models/revenue-granularity.ts +25 -0
  541. package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
  542. package/src/sdk/models/shape.ts +20 -0
  543. package/src/sdk/models/sort-direction.ts +12 -4
  544. package/src/sdk/models/sub-modify-bulk-addon-params.ts +43 -0
  545. package/src/sdk/models/sub-modify-line-item-change-request.ts +45 -0
  546. package/src/sdk/models/subscription-change-entity-type.ts +1 -1
  547. package/src/sdk/models/subscription-modify-type.ts +1 -0
  548. package/src/sdk/models/subscription-response-v2.ts +7 -0
  549. package/src/sdk/models/subscription-response.ts +7 -0
  550. package/src/sdk/models/subscription-schedule-response.ts +4 -48
  551. package/src/sdk/models/update-entitlement-request.ts +4 -10
  552. package/src/sdk/models/usage-analytic-item.ts +6 -0
  553. package/src/sdk/models/variable-type.ts +24 -0
  554. package/src/sdk/models/view-query-request.ts +30 -0
  555. package/src/sdk/models/view-response.ts +39 -0
  556. package/src/sdk/sdk.ts +6 -0
  557. package/src/sdk/subscriptions.ts +4 -2
  558. package/docs/sdk/models/configuration.md +0 -16
  559. package/docs/sdk/models/execution-result.md +0 -16
@@ -52,6 +52,14 @@ export type PriceFilter = {
52
52
  startTime?: Date | undefined;
53
53
  status?: Status | undefined;
54
54
  subscriptionId?: string | undefined;
55
+ /**
56
+ * UpdatedAfter matches prices edited since the given time. TimeRangeFilter
57
+ *
58
+ * @remarks
59
+ * above filters on created_at, so it cannot see an edit to an existing
60
+ * price.
61
+ */
62
+ updatedAfter?: string | undefined;
55
63
  };
56
64
 
57
65
  /** @internal */
@@ -80,6 +88,7 @@ export type PriceFilter$Outbound = {
80
88
  start_time?: string | undefined;
81
89
  status?: string | undefined;
82
90
  subscription_id?: string | undefined;
91
+ updated_after?: string | undefined;
83
92
  };
84
93
 
85
94
  /** @internal */
@@ -107,6 +116,7 @@ export const PriceFilter$outboundSchema: z.ZodMiniType<
107
116
  startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
108
117
  status: z.optional(Status$outboundSchema),
109
118
  subscriptionId: z.optional(z.string()),
119
+ updatedAfter: z.optional(z.string()),
110
120
  }),
111
121
  z.transform((v) => {
112
122
  return remap$(v, {
@@ -122,6 +132,7 @@ export const PriceFilter$outboundSchema: z.ZodMiniType<
122
132
  startDateLt: "start_date_lt",
123
133
  startTime: "start_time",
124
134
  subscriptionId: "subscription_id",
135
+ updatedAfter: "updated_after",
125
136
  });
126
137
  }),
127
138
  );
@@ -0,0 +1,44 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import {
7
+ ViewQueryRequest,
8
+ ViewQueryRequest$Outbound,
9
+ ViewQueryRequest$outboundSchema,
10
+ } from "./view-query-request.js";
11
+
12
+ export type QueryAnalyticsViewRequest = {
13
+ /**
14
+ * View ID
15
+ */
16
+ id: string;
17
+ /**
18
+ * View query request
19
+ */
20
+ body: ViewQueryRequest;
21
+ };
22
+
23
+ /** @internal */
24
+ export type QueryAnalyticsViewRequest$Outbound = {
25
+ id: string;
26
+ body: ViewQueryRequest$Outbound;
27
+ };
28
+
29
+ /** @internal */
30
+ export const QueryAnalyticsViewRequest$outboundSchema: z.ZodMiniType<
31
+ QueryAnalyticsViewRequest$Outbound,
32
+ QueryAnalyticsViewRequest
33
+ > = z.object({
34
+ id: z.string(),
35
+ body: ViewQueryRequest$outboundSchema,
36
+ });
37
+
38
+ export function queryAnalyticsViewRequestToJSON(
39
+ queryAnalyticsViewRequest: QueryAnalyticsViewRequest,
40
+ ): string {
41
+ return JSON.stringify(
42
+ QueryAnalyticsViewRequest$outboundSchema.parse(queryAnalyticsViewRequest),
43
+ );
44
+ }
@@ -0,0 +1,51 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import {
8
+ ProrationBehavior,
9
+ ProrationBehavior$outboundSchema,
10
+ } from "./proration-behavior.js";
11
+
12
+ export type RemoveAddonRef = {
13
+ associationId?: string | undefined;
14
+ effectiveDate?: Date | undefined;
15
+ prorationBehavior?: ProrationBehavior | undefined;
16
+ reason?: string | undefined;
17
+ };
18
+
19
+ /** @internal */
20
+ export type RemoveAddonRef$Outbound = {
21
+ association_id?: string | undefined;
22
+ effective_date?: string | undefined;
23
+ proration_behavior?: string | undefined;
24
+ reason?: string | undefined;
25
+ };
26
+
27
+ /** @internal */
28
+ export const RemoveAddonRef$outboundSchema: z.ZodMiniType<
29
+ RemoveAddonRef$Outbound,
30
+ RemoveAddonRef
31
+ > = z.pipe(
32
+ z.object({
33
+ associationId: z.optional(z.string()),
34
+ effectiveDate: z.optional(
35
+ z.pipe(z.date(), z.transform(v => v.toISOString())),
36
+ ),
37
+ prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
38
+ reason: z.optional(z.string()),
39
+ }),
40
+ z.transform((v) => {
41
+ return remap$(v, {
42
+ associationId: "association_id",
43
+ effectiveDate: "effective_date",
44
+ prorationBehavior: "proration_behavior",
45
+ });
46
+ }),
47
+ );
48
+
49
+ export function removeAddonRefToJSON(removeAddonRef: RemoveAddonRef): string {
50
+ return JSON.stringify(RemoveAddonRef$outboundSchema.parse(removeAddonRef));
51
+ }
@@ -8,9 +8,11 @@ import {
8
8
  ProrationBehavior,
9
9
  ProrationBehavior$outboundSchema,
10
10
  } from "./proration-behavior.js";
11
+ import { ScheduleType, ScheduleType$outboundSchema } from "./schedule-type.js";
11
12
 
12
13
  export type RemoveAddonRequest = {
13
14
  addonAssociationId: string;
15
+ changeAt?: ScheduleType | undefined;
14
16
  /**
15
17
  * EffectiveDate defaults to period end when nil; mid-period with create_prorations issues a wallet credit.
16
18
  */
@@ -22,6 +24,7 @@ export type RemoveAddonRequest = {
22
24
  /** @internal */
23
25
  export type RemoveAddonRequest$Outbound = {
24
26
  addon_association_id: string;
27
+ change_at?: string | undefined;
25
28
  effective_date?: string | undefined;
26
29
  proration_behavior?: string | undefined;
27
30
  reason?: string | undefined;
@@ -34,6 +37,7 @@ export const RemoveAddonRequest$outboundSchema: z.ZodMiniType<
34
37
  > = z.pipe(
35
38
  z.object({
36
39
  addonAssociationId: z.string(),
40
+ changeAt: z.optional(ScheduleType$outboundSchema),
37
41
  effectiveDate: z.optional(
38
42
  z.pipe(z.date(), z.transform(v => v.toISOString())),
39
43
  ),
@@ -43,6 +47,7 @@ export const RemoveAddonRequest$outboundSchema: z.ZodMiniType<
43
47
  z.transform((v) => {
44
48
  return remap$(v, {
45
49
  addonAssociationId: "addon_association_id",
50
+ changeAt: "change_at",
46
51
  effectiveDate: "effective_date",
47
52
  prorationBehavior: "proration_behavior",
48
53
  });
@@ -0,0 +1,24 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { OpenEnum } from "../../types/enums.js";
8
+
9
+ export const RevenueAllocationPolicy = {
10
+ Billed: "billed",
11
+ Amortized: "amortized",
12
+ } as const;
13
+ export type RevenueAllocationPolicy = OpenEnum<typeof RevenueAllocationPolicy>;
14
+
15
+ /** @internal */
16
+ export const RevenueAllocationPolicy$inboundSchema: z.ZodMiniType<
17
+ RevenueAllocationPolicy,
18
+ unknown
19
+ > = openEnums.inboundSchema(RevenueAllocationPolicy);
20
+ /** @internal */
21
+ export const RevenueAllocationPolicy$outboundSchema: z.ZodMiniType<
22
+ string,
23
+ RevenueAllocationPolicy
24
+ > = openEnums.outboundSchema(RevenueAllocationPolicy);
@@ -0,0 +1,168 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as types from "../../types/primitives.js";
10
+ import {
11
+ FactStatus,
12
+ FactStatus$inboundSchema,
13
+ FactStatus$outboundSchema,
14
+ } from "./fact-status.js";
15
+ import {
16
+ RevenueAllocationPolicy,
17
+ RevenueAllocationPolicy$inboundSchema,
18
+ RevenueAllocationPolicy$outboundSchema,
19
+ } from "./revenue-allocation-policy.js";
20
+ import {
21
+ RevenueGranularity,
22
+ RevenueGranularity$inboundSchema,
23
+ RevenueGranularity$outboundSchema,
24
+ } from "./revenue-granularity.js";
25
+ import { SDKValidationError } from "./sdk-validation-error.js";
26
+
27
+ export type RevenueAnalyticsRequest = {
28
+ allocationPolicy?: RevenueAllocationPolicy | undefined;
29
+ currency?: string | undefined;
30
+ /**
31
+ * Filters restrict the rows before aggregation.
32
+ */
33
+ customerIds?: Array<string> | undefined;
34
+ endTime?: Date | undefined;
35
+ granularity?: RevenueGranularity | undefined;
36
+ /**
37
+ * GroupBy dimensions: revenue_source, source (the event source recorded in
38
+ *
39
+ * @remarks
40
+ * meter_usage; requires customer_ids or subscription_ids), customer_id,
41
+ * subscription_id, price_id, meter_id, currency. revenue_source is always
42
+ * applied — every row says what kind of revenue it is — and requested
43
+ * dimensions are added on top.
44
+ */
45
+ groupBy?: Array<string> | undefined;
46
+ /**
47
+ * IncludeAdjustments breaks the non-obvious components — commitment
48
+ *
49
+ * @remarks
50
+ * true-ups, overage and revert (contra) rows — out as their own rows,
51
+ * each labeled with its kind in adjustment_type. Off, they fold into
52
+ * their parent buckets (true-up/overage into usage, reverts into their
53
+ * own source) so visible rows read as plain usage/fixed. Totals are
54
+ * identical either way.
55
+ */
56
+ includeAdjustments?: boolean | undefined;
57
+ meterIds?: Array<string> | undefined;
58
+ priceIds?: Array<string> | undefined;
59
+ /**
60
+ * StartTime/EndTime bound the day range (inclusive days derived in UTC).
61
+ *
62
+ * @remarks
63
+ * EndTime is optional and defaults to now.
64
+ */
65
+ startTime: Date;
66
+ status?: FactStatus | undefined;
67
+ subscriptionIds?: Array<string> | undefined;
68
+ };
69
+
70
+ /** @internal */
71
+ export const RevenueAnalyticsRequest$inboundSchema: z.ZodMiniType<
72
+ RevenueAnalyticsRequest,
73
+ unknown
74
+ > = z.pipe(
75
+ z.object({
76
+ allocation_policy: types.optional(RevenueAllocationPolicy$inboundSchema),
77
+ currency: types.optional(types.string()),
78
+ customer_ids: types.optional(z.array(types.string())),
79
+ end_time: types.optional(types.date()),
80
+ granularity: types.optional(RevenueGranularity$inboundSchema),
81
+ group_by: types.optional(z.array(types.string())),
82
+ include_adjustments: types.optional(types.boolean()),
83
+ meter_ids: types.optional(z.array(types.string())),
84
+ price_ids: types.optional(z.array(types.string())),
85
+ start_time: types.date(),
86
+ status: types.optional(FactStatus$inboundSchema),
87
+ subscription_ids: types.optional(z.array(types.string())),
88
+ }),
89
+ z.transform((v) => {
90
+ return remap$(v, {
91
+ "allocation_policy": "allocationPolicy",
92
+ "customer_ids": "customerIds",
93
+ "end_time": "endTime",
94
+ "group_by": "groupBy",
95
+ "include_adjustments": "includeAdjustments",
96
+ "meter_ids": "meterIds",
97
+ "price_ids": "priceIds",
98
+ "start_time": "startTime",
99
+ "subscription_ids": "subscriptionIds",
100
+ });
101
+ }),
102
+ );
103
+ /** @internal */
104
+ export type RevenueAnalyticsRequest$Outbound = {
105
+ allocation_policy?: string | undefined;
106
+ currency?: string | undefined;
107
+ customer_ids?: Array<string> | undefined;
108
+ end_time?: string | undefined;
109
+ granularity?: string | undefined;
110
+ group_by?: Array<string> | undefined;
111
+ include_adjustments?: boolean | undefined;
112
+ meter_ids?: Array<string> | undefined;
113
+ price_ids?: Array<string> | undefined;
114
+ start_time: string;
115
+ status?: string | undefined;
116
+ subscription_ids?: Array<string> | undefined;
117
+ };
118
+
119
+ /** @internal */
120
+ export const RevenueAnalyticsRequest$outboundSchema: z.ZodMiniType<
121
+ RevenueAnalyticsRequest$Outbound,
122
+ RevenueAnalyticsRequest
123
+ > = z.pipe(
124
+ z.object({
125
+ allocationPolicy: z.optional(RevenueAllocationPolicy$outboundSchema),
126
+ currency: z.optional(z.string()),
127
+ customerIds: z.optional(z.array(z.string())),
128
+ endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
129
+ granularity: z.optional(RevenueGranularity$outboundSchema),
130
+ groupBy: z.optional(z.array(z.string())),
131
+ includeAdjustments: z.optional(z.boolean()),
132
+ meterIds: z.optional(z.array(z.string())),
133
+ priceIds: z.optional(z.array(z.string())),
134
+ startTime: z.pipe(z.date(), z.transform(v => v.toISOString())),
135
+ status: z.optional(FactStatus$outboundSchema),
136
+ subscriptionIds: z.optional(z.array(z.string())),
137
+ }),
138
+ z.transform((v) => {
139
+ return remap$(v, {
140
+ allocationPolicy: "allocation_policy",
141
+ customerIds: "customer_ids",
142
+ endTime: "end_time",
143
+ groupBy: "group_by",
144
+ includeAdjustments: "include_adjustments",
145
+ meterIds: "meter_ids",
146
+ priceIds: "price_ids",
147
+ startTime: "start_time",
148
+ subscriptionIds: "subscription_ids",
149
+ });
150
+ }),
151
+ );
152
+
153
+ export function revenueAnalyticsRequestToJSON(
154
+ revenueAnalyticsRequest: RevenueAnalyticsRequest,
155
+ ): string {
156
+ return JSON.stringify(
157
+ RevenueAnalyticsRequest$outboundSchema.parse(revenueAnalyticsRequest),
158
+ );
159
+ }
160
+ export function revenueAnalyticsRequestFromJSON(
161
+ jsonString: string,
162
+ ): SafeParseResult<RevenueAnalyticsRequest, SDKValidationError> {
163
+ return safeParse(
164
+ jsonString,
165
+ (x) => RevenueAnalyticsRequest$inboundSchema.parse(JSON.parse(x)),
166
+ `Failed to parse 'RevenueAnalyticsRequest' from JSON`,
167
+ );
168
+ }
@@ -0,0 +1,59 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as types from "../../types/primitives.js";
10
+ import {
11
+ RevenueAnalyticsRequest,
12
+ RevenueAnalyticsRequest$inboundSchema,
13
+ } from "./revenue-analytics-request.js";
14
+ import {
15
+ RevenueAnalyticsRow,
16
+ RevenueAnalyticsRow$inboundSchema,
17
+ } from "./revenue-analytics-row.js";
18
+ import { SDKValidationError } from "./sdk-validation-error.js";
19
+
20
+ export type RevenueAnalyticsResponse = {
21
+ /**
22
+ * ContainsAllocated is true when any bucket includes whole-period amounts
23
+ *
24
+ * @remarks
25
+ * spread across days (amortized) or booked on a single day (billed) —
26
+ * i.e. the day view carries period-shaped charges, not only true daily
27
+ * accruals.
28
+ */
29
+ containsAllocated?: boolean | undefined;
30
+ query?: RevenueAnalyticsRequest | undefined;
31
+ rows?: Array<RevenueAnalyticsRow> | undefined;
32
+ };
33
+
34
+ /** @internal */
35
+ export const RevenueAnalyticsResponse$inboundSchema: z.ZodMiniType<
36
+ RevenueAnalyticsResponse,
37
+ unknown
38
+ > = z.pipe(
39
+ z.object({
40
+ contains_allocated: types.optional(types.boolean()),
41
+ query: types.optional(RevenueAnalyticsRequest$inboundSchema),
42
+ rows: types.optional(z.array(RevenueAnalyticsRow$inboundSchema)),
43
+ }),
44
+ z.transform((v) => {
45
+ return remap$(v, {
46
+ "contains_allocated": "containsAllocated",
47
+ });
48
+ }),
49
+ );
50
+
51
+ export function revenueAnalyticsResponseFromJSON(
52
+ jsonString: string,
53
+ ): SafeParseResult<RevenueAnalyticsResponse, SDKValidationError> {
54
+ return safeParse(
55
+ jsonString,
56
+ (x) => RevenueAnalyticsResponse$inboundSchema.parse(JSON.parse(x)),
57
+ `Failed to parse 'RevenueAnalyticsResponse' from JSON`,
58
+ );
59
+ }
@@ -0,0 +1,88 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as types from "../../types/primitives.js";
10
+ import { FactStatus, FactStatus$inboundSchema } from "./fact-status.js";
11
+ import { SDKValidationError } from "./sdk-validation-error.js";
12
+
13
+ export type RevenueAnalyticsRow = {
14
+ /**
15
+ * AdjustmentType labels rows broken out by include_adjustments:
16
+ *
17
+ * @remarks
18
+ * "commitment_trueup", "overage" or "revert". Empty for plain rows.
19
+ */
20
+ adjustmentType?: string | undefined;
21
+ billableQty?: number | undefined;
22
+ /**
23
+ * Day is set for day granularity; PeriodStart/PeriodEnd for period.
24
+ */
25
+ day?: string | undefined;
26
+ entitlementAmount?: number | undefined;
27
+ entitlementQty?: number | undefined;
28
+ /**
29
+ * Group holds the requested dimensions and their values for this bucket.
30
+ */
31
+ group?: { [k: string]: string } | undefined;
32
+ invoiceDiscount?: number | undefined;
33
+ lineDiscount?: number | undefined;
34
+ netAmount?: number | undefined;
35
+ periodEnd?: Date | undefined;
36
+ periodStart?: Date | undefined;
37
+ status?: FactStatus | undefined;
38
+ tierDelta?: number | undefined;
39
+ usageAtListRate?: number | undefined;
40
+ };
41
+
42
+ /** @internal */
43
+ export const RevenueAnalyticsRow$inboundSchema: z.ZodMiniType<
44
+ RevenueAnalyticsRow,
45
+ unknown
46
+ > = z.pipe(
47
+ z.object({
48
+ adjustment_type: types.optional(types.string()),
49
+ billable_qty: types.optional(types.number()),
50
+ day: types.optional(types.string()),
51
+ entitlement_amount: types.optional(types.number()),
52
+ entitlement_qty: types.optional(types.number()),
53
+ group: types.optional(z.record(z.string(), types.string())),
54
+ invoice_discount: types.optional(types.number()),
55
+ line_discount: types.optional(types.number()),
56
+ net_amount: types.optional(types.number()),
57
+ period_end: types.optional(types.date()),
58
+ period_start: types.optional(types.date()),
59
+ status: types.optional(FactStatus$inboundSchema),
60
+ tier_delta: types.optional(types.number()),
61
+ usage_at_list_rate: types.optional(types.number()),
62
+ }),
63
+ z.transform((v) => {
64
+ return remap$(v, {
65
+ "adjustment_type": "adjustmentType",
66
+ "billable_qty": "billableQty",
67
+ "entitlement_amount": "entitlementAmount",
68
+ "entitlement_qty": "entitlementQty",
69
+ "invoice_discount": "invoiceDiscount",
70
+ "line_discount": "lineDiscount",
71
+ "net_amount": "netAmount",
72
+ "period_end": "periodEnd",
73
+ "period_start": "periodStart",
74
+ "tier_delta": "tierDelta",
75
+ "usage_at_list_rate": "usageAtListRate",
76
+ });
77
+ }),
78
+ );
79
+
80
+ export function revenueAnalyticsRowFromJSON(
81
+ jsonString: string,
82
+ ): SafeParseResult<RevenueAnalyticsRow, SDKValidationError> {
83
+ return safeParse(
84
+ jsonString,
85
+ (x) => RevenueAnalyticsRow$inboundSchema.parse(JSON.parse(x)),
86
+ `Failed to parse 'RevenueAnalyticsRow' from JSON`,
87
+ );
88
+ }
@@ -0,0 +1,25 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { OpenEnum } from "../../types/enums.js";
8
+
9
+ export const RevenueGranularity = {
10
+ Day: "day",
11
+ Period: "period",
12
+ Total: "total",
13
+ } as const;
14
+ export type RevenueGranularity = OpenEnum<typeof RevenueGranularity>;
15
+
16
+ /** @internal */
17
+ export const RevenueGranularity$inboundSchema: z.ZodMiniType<
18
+ RevenueGranularity,
19
+ unknown
20
+ > = openEnums.inboundSchema(RevenueGranularity);
21
+ /** @internal */
22
+ export const RevenueGranularity$outboundSchema: z.ZodMiniType<
23
+ string,
24
+ RevenueGranularity
25
+ > = openEnums.outboundSchema(RevenueGranularity);
@@ -12,6 +12,7 @@ export const ScheduledTaskEntityType = {
12
12
  CreditTopups: "credit_topups",
13
13
  CreditUsage: "credit_usage",
14
14
  UsageAnalytics: "usage_analytics",
15
+ RevenueFacts: "revenue_facts",
15
16
  } as const;
16
17
  export type ScheduledTaskEntityType = OpenEnum<typeof ScheduledTaskEntityType>;
17
18
 
@@ -0,0 +1,20 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { OpenEnum } from "../../types/enums.js";
8
+
9
+ export const Shape = {
10
+ Timeseries: "timeseries",
11
+ Breakdown: "breakdown",
12
+ } as const;
13
+ export type Shape = OpenEnum<typeof Shape>;
14
+
15
+ /** @internal */
16
+ export const Shape$inboundSchema: z.ZodMiniType<Shape, unknown> = openEnums
17
+ .inboundSchema(Shape);
18
+ /** @internal */
19
+ export const Shape$outboundSchema: z.ZodMiniType<string, Shape> = openEnums
20
+ .outboundSchema(Shape);
@@ -3,14 +3,22 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v4-mini";
6
- import { ClosedEnum } from "../../types/enums.js";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { OpenEnum } from "../../types/enums.js";
7
8
 
8
9
  export const SortDirection = {
9
10
  Asc: "asc",
10
11
  Desc: "desc",
11
12
  } as const;
12
- export type SortDirection = ClosedEnum<typeof SortDirection>;
13
+ export type SortDirection = OpenEnum<typeof SortDirection>;
13
14
 
14
15
  /** @internal */
15
- export const SortDirection$outboundSchema: z.ZodMiniEnum<typeof SortDirection> =
16
- z.enum(SortDirection);
16
+ export const SortDirection$inboundSchema: z.ZodMiniType<
17
+ SortDirection,
18
+ unknown
19
+ > = openEnums.inboundSchema(SortDirection);
20
+ /** @internal */
21
+ export const SortDirection$outboundSchema: z.ZodMiniType<
22
+ string,
23
+ SortDirection
24
+ > = openEnums.outboundSchema(SortDirection);
@@ -0,0 +1,43 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import {
7
+ AddAddonToSubscriptionRequest,
8
+ AddAddonToSubscriptionRequest$Outbound,
9
+ AddAddonToSubscriptionRequest$outboundSchema,
10
+ } from "./add-addon-to-subscription-request.js";
11
+ import {
12
+ RemoveAddonRequest,
13
+ RemoveAddonRequest$Outbound,
14
+ RemoveAddonRequest$outboundSchema,
15
+ } from "./remove-addon-request.js";
16
+
17
+ export type SubModifyBulkAddonParams = {
18
+ adds?: Array<AddAddonToSubscriptionRequest> | undefined;
19
+ removes?: Array<RemoveAddonRequest> | undefined;
20
+ };
21
+
22
+ /** @internal */
23
+ export type SubModifyBulkAddonParams$Outbound = {
24
+ adds?: Array<AddAddonToSubscriptionRequest$Outbound> | undefined;
25
+ removes?: Array<RemoveAddonRequest$Outbound> | undefined;
26
+ };
27
+
28
+ /** @internal */
29
+ export const SubModifyBulkAddonParams$outboundSchema: z.ZodMiniType<
30
+ SubModifyBulkAddonParams$Outbound,
31
+ SubModifyBulkAddonParams
32
+ > = z.object({
33
+ adds: z.optional(z.array(AddAddonToSubscriptionRequest$outboundSchema)),
34
+ removes: z.optional(z.array(RemoveAddonRequest$outboundSchema)),
35
+ });
36
+
37
+ export function subModifyBulkAddonParamsToJSON(
38
+ subModifyBulkAddonParams: SubModifyBulkAddonParams,
39
+ ): string {
40
+ return JSON.stringify(
41
+ SubModifyBulkAddonParams$outboundSchema.parse(subModifyBulkAddonParams),
42
+ );
43
+ }
@@ -0,0 +1,45 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import {
8
+ LineItemChange,
9
+ LineItemChange$Outbound,
10
+ LineItemChange$outboundSchema,
11
+ } from "./line-item-change.js";
12
+
13
+ export type SubModifyLineItemChangeRequest = {
14
+ lineItems: Array<LineItemChange>;
15
+ };
16
+
17
+ /** @internal */
18
+ export type SubModifyLineItemChangeRequest$Outbound = {
19
+ line_items: Array<LineItemChange$Outbound>;
20
+ };
21
+
22
+ /** @internal */
23
+ export const SubModifyLineItemChangeRequest$outboundSchema: z.ZodMiniType<
24
+ SubModifyLineItemChangeRequest$Outbound,
25
+ SubModifyLineItemChangeRequest
26
+ > = z.pipe(
27
+ z.object({
28
+ lineItems: z.array(LineItemChange$outboundSchema),
29
+ }),
30
+ z.transform((v) => {
31
+ return remap$(v, {
32
+ lineItems: "line_items",
33
+ });
34
+ }),
35
+ );
36
+
37
+ export function subModifyLineItemChangeRequestToJSON(
38
+ subModifyLineItemChangeRequest: SubModifyLineItemChangeRequest,
39
+ ): string {
40
+ return JSON.stringify(
41
+ SubModifyLineItemChangeRequest$outboundSchema.parse(
42
+ subModifyLineItemChangeRequest,
43
+ ),
44
+ );
45
+ }