@flexprice/sdk 2.1.11 → 2.1.18

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 (546) hide show
  1. package/docs/sdk/models/attributed-to-customer-result.md +17 -0
  2. package/docs/sdk/models/bucket-summary.md +26 -0
  3. package/docs/sdk/models/bucket.md +16 -0
  4. package/docs/sdk/models/cancel-subscription-request.md +7 -7
  5. package/docs/sdk/models/changed-subscription.md +7 -5
  6. package/docs/sdk/models/commitment-bucket-request.md +22 -0
  7. package/docs/sdk/models/coupon-response.md +1 -0
  8. package/docs/sdk/models/coupon.md +1 -0
  9. package/docs/sdk/models/create-coupon-request.md +1 -0
  10. package/docs/sdk/models/create-invoice-line-item-request.md +25 -22
  11. package/docs/sdk/models/create-subscription-line-item-request.md +1 -0
  12. package/docs/sdk/models/create-subscription-request.md +3 -2
  13. package/docs/sdk/models/create-tax-association-request.md +12 -10
  14. package/docs/sdk/models/create-user-request.md +1 -0
  15. package/docs/sdk/models/create-user-response.md +2 -0
  16. package/docs/sdk/models/debug-tracker-status.md +2 -2
  17. package/docs/sdk/models/debug-tracker.md +1 -0
  18. package/docs/sdk/models/delete-service-account-request.md +17 -0
  19. package/docs/sdk/models/delink-integration-mapping-request.md +21 -0
  20. package/docs/sdk/models/entity-integration-mapping-response.md +1 -0
  21. package/docs/sdk/models/entity-sync-config.md +16 -0
  22. package/docs/sdk/models/execute-subscription-modify-request-request.md +1 -1
  23. package/docs/sdk/models/execute-subscription-modify-request.md +4 -1
  24. package/docs/sdk/models/failure-point-type.md +1 -1
  25. package/docs/sdk/models/get-coupon-association-request.md +17 -0
  26. package/docs/sdk/models/get-entity-integration-mappings-request.md +19 -0
  27. package/docs/sdk/models/get-usage-analytics-request.md +13 -12
  28. package/docs/sdk/models/inheritance-action.md +15 -0
  29. package/docs/sdk/models/integration-config-entry.md +17 -0
  30. package/docs/sdk/models/integration-config-response.md +15 -0
  31. package/docs/sdk/models/invoice-billing-reason.md +1 -1
  32. package/docs/sdk/models/invoice-filter.md +2 -0
  33. package/docs/sdk/models/invoice-line-item-response.md +38 -36
  34. package/docs/sdk/models/invoice-sync-settings.md +15 -0
  35. package/docs/sdk/models/line-item-commitment-config.md +10 -9
  36. package/docs/sdk/models/list-coupon-associations-request.md +19 -0
  37. package/docs/sdk/models/list-coupon-associations-response.md +16 -0
  38. package/docs/sdk/models/list-entity-integration-mappings-response.md +16 -0
  39. package/docs/sdk/models/meter-usage-attribution.md +17 -0
  40. package/docs/sdk/models/payment-gateway-type.md +1 -1
  41. package/docs/sdk/models/preview-subscription-modify-request.md +1 -1
  42. package/docs/sdk/models/price-filter.md +1 -0
  43. package/docs/sdk/models/price-price.md +43 -42
  44. package/docs/sdk/models/price-response.md +48 -47
  45. package/docs/sdk/models/s3-export-config.md +20 -0
  46. package/docs/sdk/models/secret-provider.md +1 -1
  47. package/docs/sdk/models/sub-modify-coupon-action.md +15 -0
  48. package/docs/sdk/models/sub-modify-coupon-params.md +24 -0
  49. package/docs/sdk/models/sub-modify-inheritance-request.md +5 -3
  50. package/docs/sdk/models/sub-modify-tax-action.md +15 -0
  51. package/docs/sdk/models/sub-modify-tax-params.md +20 -0
  52. package/docs/sdk/models/sub-modify-trial-end-request.md +18 -0
  53. package/docs/sdk/models/subscription-coupon-input.md +20 -0
  54. package/docs/sdk/models/subscription-line-item-response.md +1 -0
  55. package/docs/sdk/models/subscription-modify-type.md +2 -2
  56. package/docs/sdk/models/subscription-phase-create-request.md +4 -3
  57. package/docs/sdk/models/subscription-response-v2.md +2 -0
  58. package/docs/sdk/models/subscription-response.md +1 -0
  59. package/docs/sdk/models/subscription-subscription-line-item.md +1 -0
  60. package/docs/sdk/models/sync-config.md +23 -0
  61. package/docs/sdk/models/tax-association-response.md +2 -0
  62. package/docs/sdk/models/time-of-day-bucket.md +22 -0
  63. package/docs/sdk/models/trial-end-action.md +15 -0
  64. package/docs/sdk/models/update-service-account-request-request.md +21 -0
  65. package/docs/sdk/models/update-service-account-request.md +17 -0
  66. package/docs/sdk/models/update-service-account-response.md +21 -0
  67. package/docs/sdk/models/update-subscription-line-item-request.md +17 -16
  68. package/docs/sdk/models/update-user-request.md +16 -0
  69. package/docs/sdk/models/update-user-response.md +21 -0
  70. package/docs/sdk/models/usage-analytic-item.md +34 -33
  71. package/docs/sdk/models/usage-analytic-point.md +11 -9
  72. package/docs/sdk/models/user-response.md +2 -0
  73. package/docs/sdk/models/window-size.md +2 -2
  74. package/docs/sdks/couponassociations/README.md +150 -0
  75. package/docs/sdks/integrations/README.md +223 -0
  76. package/docs/sdks/subscriptions/README.md +4 -4
  77. package/docs/sdks/users/README.md +221 -0
  78. package/esm/funcs/coupon-associations-get-coupon-association.d.ts +17 -0
  79. package/esm/funcs/coupon-associations-get-coupon-association.d.ts.map +1 -0
  80. package/esm/funcs/coupon-associations-get-coupon-association.js +91 -0
  81. package/esm/funcs/coupon-associations-get-coupon-association.js.map +1 -0
  82. package/esm/funcs/coupon-associations-list-coupon-associations.d.ts +17 -0
  83. package/esm/funcs/coupon-associations-list-coupon-associations.d.ts.map +1 -0
  84. package/esm/funcs/coupon-associations-list-coupon-associations.js +91 -0
  85. package/esm/funcs/coupon-associations-list-coupon-associations.js.map +1 -0
  86. package/esm/funcs/integrations-delink-integration-mapping.d.ts +17 -0
  87. package/esm/funcs/integrations-delink-integration-mapping.d.ts.map +1 -0
  88. package/esm/funcs/integrations-delink-integration-mapping.js +83 -0
  89. package/esm/funcs/integrations-delink-integration-mapping.js.map +1 -0
  90. package/esm/funcs/integrations-get-entity-integration-mappings.d.ts +17 -0
  91. package/esm/funcs/integrations-get-entity-integration-mappings.d.ts.map +1 -0
  92. package/esm/funcs/integrations-get-entity-integration-mappings.js +91 -0
  93. package/esm/funcs/integrations-get-entity-integration-mappings.js.map +1 -0
  94. package/esm/funcs/integrations-get-integration-config.d.ts +17 -0
  95. package/esm/funcs/integrations-get-integration-config.d.ts.map +1 -0
  96. package/esm/funcs/integrations-get-integration-config.js +72 -0
  97. package/esm/funcs/integrations-get-integration-config.js.map +1 -0
  98. package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +1 -1
  99. package/esm/funcs/subscriptions-execute-subscription-modify.js +1 -1
  100. package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +1 -1
  101. package/esm/funcs/subscriptions-preview-subscription-modify.js +1 -1
  102. package/esm/funcs/users-delete-service-account.d.ts +17 -0
  103. package/esm/funcs/users-delete-service-account.d.ts.map +1 -0
  104. package/esm/funcs/users-delete-service-account.js +91 -0
  105. package/esm/funcs/users-delete-service-account.js.map +1 -0
  106. package/esm/funcs/users-update-service-account.d.ts +17 -0
  107. package/esm/funcs/users-update-service-account.d.ts.map +1 -0
  108. package/esm/funcs/users-update-service-account.js +93 -0
  109. package/esm/funcs/users-update-service-account.js.map +1 -0
  110. package/esm/funcs/users-update-user.d.ts +17 -0
  111. package/esm/funcs/users-update-user.d.ts.map +1 -0
  112. package/esm/funcs/users-update-user.js +83 -0
  113. package/esm/funcs/users-update-user.js.map +1 -0
  114. package/esm/hooks/types.d.ts +1 -0
  115. package/esm/hooks/types.d.ts.map +1 -1
  116. package/esm/lib/config.d.ts +3 -3
  117. package/esm/lib/config.js +3 -3
  118. package/esm/lib/encodings.js +1 -1
  119. package/esm/lib/encodings.js.map +1 -1
  120. package/esm/lib/matchers.js +1 -1
  121. package/esm/lib/matchers.js.map +1 -1
  122. package/esm/lib/primitives.d.ts +1 -0
  123. package/esm/lib/primitives.d.ts.map +1 -1
  124. package/esm/lib/primitives.js +17 -0
  125. package/esm/lib/primitives.js.map +1 -1
  126. package/esm/lib/sdks.d.ts.map +1 -1
  127. package/esm/lib/sdks.js +50 -16
  128. package/esm/lib/sdks.js.map +1 -1
  129. package/esm/sdk/coupon-associations.d.ts +19 -0
  130. package/esm/sdk/coupon-associations.d.ts.map +1 -0
  131. package/esm/sdk/coupon-associations.js +28 -0
  132. package/esm/sdk/coupon-associations.js.map +1 -0
  133. package/esm/sdk/integrations.d.ts +21 -0
  134. package/esm/sdk/integrations.d.ts.map +1 -1
  135. package/esm/sdk/integrations.js +30 -0
  136. package/esm/sdk/integrations.js.map +1 -1
  137. package/esm/sdk/models/attributed-to-customer-result.d.ts +15 -0
  138. package/esm/sdk/models/attributed-to-customer-result.d.ts.map +1 -0
  139. package/esm/sdk/models/attributed-to-customer-result.js +24 -0
  140. package/esm/sdk/models/attributed-to-customer-result.js.map +1 -0
  141. package/esm/sdk/models/bucket-summary.d.ts +31 -0
  142. package/esm/sdk/models/bucket-summary.d.ts.map +1 -0
  143. package/esm/sdk/models/bucket-summary.js +40 -0
  144. package/esm/sdk/models/bucket-summary.js.map +1 -0
  145. package/esm/sdk/models/bucket.d.ts +19 -0
  146. package/esm/sdk/models/bucket.d.ts.map +1 -0
  147. package/esm/sdk/models/bucket.js +24 -0
  148. package/esm/sdk/models/bucket.js.map +1 -0
  149. package/esm/sdk/models/cancel-subscription-request.d.ts +8 -0
  150. package/esm/sdk/models/cancel-subscription-request.d.ts.map +1 -1
  151. package/esm/sdk/models/cancel-subscription-request.js.map +1 -1
  152. package/esm/sdk/models/changed-subscription.d.ts +2 -0
  153. package/esm/sdk/models/changed-subscription.d.ts.map +1 -1
  154. package/esm/sdk/models/changed-subscription.js +10 -2
  155. package/esm/sdk/models/changed-subscription.js.map +1 -1
  156. package/esm/sdk/models/commitment-bucket-request.d.ts +29 -0
  157. package/esm/sdk/models/commitment-bucket-request.d.ts.map +1 -0
  158. package/esm/sdk/models/commitment-bucket-request.js +30 -0
  159. package/esm/sdk/models/commitment-bucket-request.js.map +1 -0
  160. package/esm/sdk/models/coupon-response.d.ts +1 -0
  161. package/esm/sdk/models/coupon-response.d.ts.map +1 -1
  162. package/esm/sdk/models/coupon-response.js +2 -0
  163. package/esm/sdk/models/coupon-response.js.map +1 -1
  164. package/esm/sdk/models/coupon.d.ts +1 -0
  165. package/esm/sdk/models/coupon.d.ts.map +1 -1
  166. package/esm/sdk/models/coupon.js +2 -0
  167. package/esm/sdk/models/coupon.js.map +1 -1
  168. package/esm/sdk/models/create-coupon-request.d.ts +2 -0
  169. package/esm/sdk/models/create-coupon-request.d.ts.map +1 -1
  170. package/esm/sdk/models/create-coupon-request.js +2 -0
  171. package/esm/sdk/models/create-coupon-request.js.map +1 -1
  172. package/esm/sdk/models/create-invoice-line-item-request.d.ts +18 -0
  173. package/esm/sdk/models/create-invoice-line-item-request.d.ts.map +1 -1
  174. package/esm/sdk/models/create-invoice-line-item-request.js +6 -0
  175. package/esm/sdk/models/create-invoice-line-item-request.js.map +1 -1
  176. package/esm/sdk/models/create-subscription-line-item-request.d.ts +3 -0
  177. package/esm/sdk/models/create-subscription-line-item-request.d.ts.map +1 -1
  178. package/esm/sdk/models/create-subscription-line-item-request.js +3 -0
  179. package/esm/sdk/models/create-subscription-line-item-request.js.map +1 -1
  180. package/esm/sdk/models/create-subscription-request.d.ts +15 -0
  181. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  182. package/esm/sdk/models/create-subscription-request.js +3 -0
  183. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  184. package/esm/sdk/models/create-tax-association-request.d.ts +10 -0
  185. package/esm/sdk/models/create-tax-association-request.d.ts.map +1 -1
  186. package/esm/sdk/models/create-tax-association-request.js +4 -0
  187. package/esm/sdk/models/create-tax-association-request.js.map +1 -1
  188. package/esm/sdk/models/create-user-request.d.ts +5 -0
  189. package/esm/sdk/models/create-user-request.d.ts.map +1 -1
  190. package/esm/sdk/models/create-user-request.js +1 -0
  191. package/esm/sdk/models/create-user-request.js.map +1 -1
  192. package/esm/sdk/models/create-user-response.d.ts +4 -0
  193. package/esm/sdk/models/create-user-response.d.ts.map +1 -1
  194. package/esm/sdk/models/create-user-response.js +2 -0
  195. package/esm/sdk/models/create-user-response.js.map +1 -1
  196. package/esm/sdk/models/debug-tracker-status.d.ts +2 -0
  197. package/esm/sdk/models/debug-tracker-status.d.ts.map +1 -1
  198. package/esm/sdk/models/debug-tracker-status.js +2 -0
  199. package/esm/sdk/models/debug-tracker-status.js.map +1 -1
  200. package/esm/sdk/models/debug-tracker.d.ts +2 -0
  201. package/esm/sdk/models/debug-tracker.d.ts.map +1 -1
  202. package/esm/sdk/models/debug-tracker.js +3 -0
  203. package/esm/sdk/models/debug-tracker.js.map +1 -1
  204. package/esm/sdk/models/delete-service-account-op.d.ts +15 -0
  205. package/esm/sdk/models/delete-service-account-op.d.ts.map +1 -0
  206. package/esm/sdk/models/delete-service-account-op.js +12 -0
  207. package/esm/sdk/models/delete-service-account-op.js.map +1 -0
  208. package/esm/sdk/models/delink-integration-mapping-request.d.ts +17 -0
  209. package/esm/sdk/models/delink-integration-mapping-request.d.ts.map +1 -0
  210. package/esm/sdk/models/delink-integration-mapping-request.js +22 -0
  211. package/esm/sdk/models/delink-integration-mapping-request.js.map +1 -0
  212. package/esm/sdk/models/entity-integration-mapping-response.d.ts +3 -0
  213. package/esm/sdk/models/entity-integration-mapping-response.d.ts.map +1 -1
  214. package/esm/sdk/models/entity-integration-mapping-response.js +1 -0
  215. package/esm/sdk/models/entity-integration-mapping-response.js.map +1 -1
  216. package/esm/sdk/models/entity-sync-config.d.ts +17 -0
  217. package/esm/sdk/models/entity-sync-config.d.ts.map +1 -0
  218. package/esm/sdk/models/entity-sync-config.js +15 -0
  219. package/esm/sdk/models/entity-sync-config.js.map +1 -0
  220. package/esm/sdk/models/execute-subscription-modify-request.d.ts +9 -0
  221. package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
  222. package/esm/sdk/models/execute-subscription-modify-request.js +9 -0
  223. package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
  224. package/esm/sdk/models/failure-point-type.d.ts +1 -0
  225. package/esm/sdk/models/failure-point-type.d.ts.map +1 -1
  226. package/esm/sdk/models/failure-point-type.js +1 -0
  227. package/esm/sdk/models/failure-point-type.js.map +1 -1
  228. package/esm/sdk/models/get-coupon-association-op.d.ts +15 -0
  229. package/esm/sdk/models/get-coupon-association-op.d.ts.map +1 -0
  230. package/esm/sdk/models/get-coupon-association-op.js +12 -0
  231. package/esm/sdk/models/get-coupon-association-op.js.map +1 -0
  232. package/esm/sdk/models/get-entity-integration-mappings-op.d.ts +20 -0
  233. package/esm/sdk/models/get-entity-integration-mappings-op.d.ts.map +1 -0
  234. package/esm/sdk/models/get-entity-integration-mappings-op.js +19 -0
  235. package/esm/sdk/models/get-entity-integration-mappings-op.js.map +1 -0
  236. package/esm/sdk/models/get-usage-analytics-request.d.ts +10 -0
  237. package/esm/sdk/models/get-usage-analytics-request.d.ts.map +1 -1
  238. package/esm/sdk/models/get-usage-analytics-request.js +2 -0
  239. package/esm/sdk/models/get-usage-analytics-request.js.map +1 -1
  240. package/esm/sdk/models/index.d.ts +32 -0
  241. package/esm/sdk/models/index.d.ts.map +1 -1
  242. package/esm/sdk/models/index.js +32 -0
  243. package/esm/sdk/models/index.js.map +1 -1
  244. package/esm/sdk/models/inheritance-action.d.ts +10 -0
  245. package/esm/sdk/models/inheritance-action.d.ts.map +1 -0
  246. package/esm/sdk/models/inheritance-action.js +11 -0
  247. package/esm/sdk/models/inheritance-action.js.map +1 -0
  248. package/esm/sdk/models/integration-config-entry.d.ts +14 -0
  249. package/esm/sdk/models/integration-config-entry.d.ts.map +1 -0
  250. package/esm/sdk/models/integration-config-entry.js +24 -0
  251. package/esm/sdk/models/integration-config-entry.js.map +1 -0
  252. package/esm/sdk/models/integration-config-response.d.ts +11 -0
  253. package/esm/sdk/models/integration-config-response.d.ts.map +1 -0
  254. package/esm/sdk/models/integration-config-response.js +15 -0
  255. package/esm/sdk/models/integration-config-response.js.map +1 -0
  256. package/esm/sdk/models/invoice-billing-reason.d.ts +1 -0
  257. package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
  258. package/esm/sdk/models/invoice-billing-reason.js +1 -0
  259. package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
  260. package/esm/sdk/models/invoice-filter.d.ts +11 -0
  261. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  262. package/esm/sdk/models/invoice-filter.js +4 -0
  263. package/esm/sdk/models/invoice-filter.js.map +1 -1
  264. package/esm/sdk/models/invoice-line-item-response.d.ts +11 -0
  265. package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
  266. package/esm/sdk/models/invoice-line-item-response.js +4 -0
  267. package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
  268. package/esm/sdk/models/invoice-sync-settings.d.ts +11 -0
  269. package/esm/sdk/models/invoice-sync-settings.d.ts.map +1 -0
  270. package/esm/sdk/models/invoice-sync-settings.js +20 -0
  271. package/esm/sdk/models/invoice-sync-settings.js.map +1 -0
  272. package/esm/sdk/models/line-item-commitment-config.d.ts +11 -0
  273. package/esm/sdk/models/line-item-commitment-config.d.ts.map +1 -1
  274. package/esm/sdk/models/line-item-commitment-config.js +3 -0
  275. package/esm/sdk/models/line-item-commitment-config.js.map +1 -1
  276. package/esm/sdk/models/list-coupon-associations-op.d.ts +35 -0
  277. package/esm/sdk/models/list-coupon-associations-op.d.ts.map +1 -0
  278. package/esm/sdk/models/list-coupon-associations-op.js +23 -0
  279. package/esm/sdk/models/list-coupon-associations-op.js.map +1 -0
  280. package/esm/sdk/models/list-coupon-associations-response.d.ts +13 -0
  281. package/esm/sdk/models/list-coupon-associations-response.d.ts.map +1 -0
  282. package/esm/sdk/models/list-coupon-associations-response.js +17 -0
  283. package/esm/sdk/models/list-coupon-associations-response.js.map +1 -0
  284. package/esm/sdk/models/list-entity-integration-mappings-response.d.ts +13 -0
  285. package/esm/sdk/models/list-entity-integration-mappings-response.d.ts.map +1 -0
  286. package/esm/sdk/models/list-entity-integration-mappings-response.js +17 -0
  287. package/esm/sdk/models/list-entity-integration-mappings-response.js.map +1 -0
  288. package/esm/sdk/models/meter-usage-attribution.d.ts +12 -0
  289. package/esm/sdk/models/meter-usage-attribution.d.ts.map +1 -0
  290. package/esm/sdk/models/meter-usage-attribution.js +23 -0
  291. package/esm/sdk/models/meter-usage-attribution.js.map +1 -0
  292. package/esm/sdk/models/payment-gateway-type.d.ts +1 -0
  293. package/esm/sdk/models/payment-gateway-type.d.ts.map +1 -1
  294. package/esm/sdk/models/payment-gateway-type.js +1 -0
  295. package/esm/sdk/models/payment-gateway-type.js.map +1 -1
  296. package/esm/sdk/models/price-filter.d.ts +3 -0
  297. package/esm/sdk/models/price-filter.d.ts.map +1 -1
  298. package/esm/sdk/models/price-filter.js +3 -0
  299. package/esm/sdk/models/price-filter.js.map +1 -1
  300. package/esm/sdk/models/price-price.d.ts +9 -0
  301. package/esm/sdk/models/price-price.d.ts.map +1 -1
  302. package/esm/sdk/models/price-price.js +1 -0
  303. package/esm/sdk/models/price-price.js.map +1 -1
  304. package/esm/sdk/models/price-response.d.ts +9 -0
  305. package/esm/sdk/models/price-response.d.ts.map +1 -1
  306. package/esm/sdk/models/price-response.js +1 -0
  307. package/esm/sdk/models/price-response.js.map +1 -1
  308. package/esm/sdk/models/s3-export-config.d.ts +29 -0
  309. package/esm/sdk/models/s3-export-config.d.ts.map +1 -0
  310. package/esm/sdk/models/s3-export-config.js +27 -0
  311. package/esm/sdk/models/s3-export-config.js.map +1 -0
  312. package/esm/sdk/models/secret-provider.d.ts +1 -0
  313. package/esm/sdk/models/secret-provider.d.ts.map +1 -1
  314. package/esm/sdk/models/secret-provider.js +1 -0
  315. package/esm/sdk/models/secret-provider.js.map +1 -1
  316. package/esm/sdk/models/sub-modify-coupon-action.d.ts +10 -0
  317. package/esm/sdk/models/sub-modify-coupon-action.d.ts.map +1 -0
  318. package/esm/sdk/models/sub-modify-coupon-action.js +11 -0
  319. package/esm/sdk/models/sub-modify-coupon-action.js.map +1 -0
  320. package/esm/sdk/models/sub-modify-coupon-params.d.ts +48 -0
  321. package/esm/sdk/models/sub-modify-coupon-params.d.ts.map +1 -0
  322. package/esm/sdk/models/sub-modify-coupon-params.js +31 -0
  323. package/esm/sdk/models/sub-modify-coupon-params.js.map +1 -0
  324. package/esm/sdk/models/sub-modify-inheritance-request.d.ts +11 -0
  325. package/esm/sdk/models/sub-modify-inheritance-request.d.ts.map +1 -1
  326. package/esm/sdk/models/sub-modify-inheritance-request.js +4 -0
  327. package/esm/sdk/models/sub-modify-inheritance-request.js.map +1 -1
  328. package/esm/sdk/models/sub-modify-tax-action.d.ts +10 -0
  329. package/esm/sdk/models/sub-modify-tax-action.d.ts.map +1 -0
  330. package/esm/sdk/models/sub-modify-tax-action.js +11 -0
  331. package/esm/sdk/models/sub-modify-tax-action.js.map +1 -0
  332. package/esm/sdk/models/sub-modify-tax-params.d.ts +28 -0
  333. package/esm/sdk/models/sub-modify-tax-params.d.ts.map +1 -0
  334. package/esm/sdk/models/sub-modify-tax-params.js +23 -0
  335. package/esm/sdk/models/sub-modify-tax-params.js.map +1 -0
  336. package/esm/sdk/models/sub-modify-trial-end-request.d.ts +18 -0
  337. package/esm/sdk/models/sub-modify-trial-end-request.d.ts.map +1 -0
  338. package/esm/sdk/models/sub-modify-trial-end-request.js +19 -0
  339. package/esm/sdk/models/sub-modify-trial-end-request.js.map +1 -0
  340. package/esm/sdk/models/subscription-coupon-input.d.ts +30 -0
  341. package/esm/sdk/models/subscription-coupon-input.d.ts.map +1 -0
  342. package/esm/sdk/models/subscription-coupon-input.js +23 -0
  343. package/esm/sdk/models/subscription-coupon-input.js.map +1 -0
  344. package/esm/sdk/models/subscription-line-item-response.d.ts +2 -0
  345. package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
  346. package/esm/sdk/models/subscription-line-item-response.js +3 -0
  347. package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
  348. package/esm/sdk/models/subscription-modify-type.d.ts +3 -0
  349. package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
  350. package/esm/sdk/models/subscription-modify-type.js +3 -0
  351. package/esm/sdk/models/subscription-modify-type.js.map +1 -1
  352. package/esm/sdk/models/subscription-phase-create-request.d.ts +8 -2
  353. package/esm/sdk/models/subscription-phase-create-request.d.ts.map +1 -1
  354. package/esm/sdk/models/subscription-phase-create-request.js +3 -0
  355. package/esm/sdk/models/subscription-phase-create-request.js.map +1 -1
  356. package/esm/sdk/models/subscription-response-v2.d.ts +16 -0
  357. package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
  358. package/esm/sdk/models/subscription-response-v2.js +4 -0
  359. package/esm/sdk/models/subscription-response-v2.js.map +1 -1
  360. package/esm/sdk/models/subscription-response.d.ts +8 -0
  361. package/esm/sdk/models/subscription-response.d.ts.map +1 -1
  362. package/esm/sdk/models/subscription-response.js +2 -0
  363. package/esm/sdk/models/subscription-response.js.map +1 -1
  364. package/esm/sdk/models/subscription-subscription-line-item.d.ts +2 -0
  365. package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
  366. package/esm/sdk/models/subscription-subscription-line-item.js +3 -0
  367. package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
  368. package/esm/sdk/models/sync-config.d.ts +21 -0
  369. package/esm/sdk/models/sync-config.d.ts.map +1 -0
  370. package/esm/sdk/models/sync-config.js +31 -0
  371. package/esm/sdk/models/sync-config.js.map +1 -0
  372. package/esm/sdk/models/tax-association-response.d.ts +8 -0
  373. package/esm/sdk/models/tax-association-response.d.ts.map +1 -1
  374. package/esm/sdk/models/tax-association-response.js +4 -0
  375. package/esm/sdk/models/tax-association-response.js.map +1 -1
  376. package/esm/sdk/models/time-of-day-bucket.d.ts +31 -0
  377. package/esm/sdk/models/time-of-day-bucket.d.ts.map +1 -0
  378. package/esm/sdk/models/time-of-day-bucket.js +32 -0
  379. package/esm/sdk/models/time-of-day-bucket.js.map +1 -0
  380. package/esm/sdk/models/trial-end-action.d.ts +10 -0
  381. package/esm/sdk/models/trial-end-action.d.ts.map +1 -0
  382. package/esm/sdk/models/trial-end-action.js +11 -0
  383. package/esm/sdk/models/trial-end-action.js.map +1 -0
  384. package/esm/sdk/models/update-service-account-op.d.ts +21 -0
  385. package/esm/sdk/models/update-service-account-op.d.ts.map +1 -0
  386. package/esm/sdk/models/update-service-account-op.js +14 -0
  387. package/esm/sdk/models/update-service-account-op.js.map +1 -0
  388. package/esm/sdk/models/update-service-account-request.d.ts +12 -0
  389. package/esm/sdk/models/update-service-account-request.d.ts.map +1 -0
  390. package/esm/sdk/models/update-service-account-request.js +12 -0
  391. package/esm/sdk/models/update-service-account-request.js.map +1 -0
  392. package/esm/sdk/models/update-service-account-response.d.ts +23 -0
  393. package/esm/sdk/models/update-service-account-response.d.ts.map +1 -0
  394. package/esm/sdk/models/update-service-account-response.js +22 -0
  395. package/esm/sdk/models/update-service-account-response.js.map +1 -0
  396. package/esm/sdk/models/update-subscription-line-item-request.d.ts +6 -0
  397. package/esm/sdk/models/update-subscription-line-item-request.d.ts.map +1 -1
  398. package/esm/sdk/models/update-subscription-line-item-request.js +3 -0
  399. package/esm/sdk/models/update-subscription-line-item-request.js.map +1 -1
  400. package/esm/sdk/models/update-user-request.d.ts +18 -0
  401. package/esm/sdk/models/update-user-request.d.ts.map +1 -0
  402. package/esm/sdk/models/update-user-request.js +13 -0
  403. package/esm/sdk/models/update-user-request.js.map +1 -0
  404. package/esm/sdk/models/update-user-response.d.ts +23 -0
  405. package/esm/sdk/models/update-user-response.d.ts.map +1 -0
  406. package/esm/sdk/models/update-user-response.js +22 -0
  407. package/esm/sdk/models/update-user-response.js.map +1 -0
  408. package/esm/sdk/models/usage-analytic-item.d.ts +8 -0
  409. package/esm/sdk/models/usage-analytic-item.d.ts.map +1 -1
  410. package/esm/sdk/models/usage-analytic-item.js +3 -0
  411. package/esm/sdk/models/usage-analytic-item.js.map +1 -1
  412. package/esm/sdk/models/usage-analytic-point.d.ts +8 -0
  413. package/esm/sdk/models/usage-analytic-point.d.ts.map +1 -1
  414. package/esm/sdk/models/usage-analytic-point.js +4 -0
  415. package/esm/sdk/models/usage-analytic-point.js.map +1 -1
  416. package/esm/sdk/models/user-response.d.ts +4 -0
  417. package/esm/sdk/models/user-response.d.ts.map +1 -1
  418. package/esm/sdk/models/user-response.js +2 -0
  419. package/esm/sdk/models/user-response.js.map +1 -1
  420. package/esm/sdk/models/window-size.d.ts +1 -1
  421. package/esm/sdk/models/window-size.js +1 -1
  422. package/esm/sdk/models/window-size.js.map +1 -1
  423. package/esm/sdk/sdk.d.ts +3 -0
  424. package/esm/sdk/sdk.d.ts.map +1 -1
  425. package/esm/sdk/sdk.js +5 -0
  426. package/esm/sdk/sdk.js.map +1 -1
  427. package/esm/sdk/subscriptions.d.ts +2 -2
  428. package/esm/sdk/subscriptions.js +2 -2
  429. package/esm/sdk/users.d.ts +21 -0
  430. package/esm/sdk/users.d.ts.map +1 -1
  431. package/esm/sdk/users.js +30 -0
  432. package/esm/sdk/users.js.map +1 -1
  433. package/esm/types/async.d.ts.map +1 -1
  434. package/esm/types/async.js +6 -6
  435. package/esm/types/async.js.map +1 -1
  436. package/esm/types/primitives.d.ts +0 -2
  437. package/esm/types/primitives.d.ts.map +1 -1
  438. package/esm/types/primitives.js +0 -22
  439. package/esm/types/primitives.js.map +1 -1
  440. package/jsr.json +1 -1
  441. package/package.json +1 -1
  442. package/src/funcs/coupon-associations-get-coupon-association.ts +182 -0
  443. package/src/funcs/coupon-associations-list-coupon-associations.ts +188 -0
  444. package/src/funcs/integrations-delink-integration-mapping.ts +173 -0
  445. package/src/funcs/integrations-get-entity-integration-mappings.ts +186 -0
  446. package/src/funcs/integrations-get-integration-config.ts +152 -0
  447. package/src/funcs/subscriptions-execute-subscription-modify.ts +1 -1
  448. package/src/funcs/subscriptions-preview-subscription-modify.ts +1 -1
  449. package/src/funcs/users-delete-service-account.ts +182 -0
  450. package/src/funcs/users-update-service-account.ts +187 -0
  451. package/src/funcs/users-update-user.ts +172 -0
  452. package/src/hooks/types.ts +1 -0
  453. package/src/lib/config.ts +3 -3
  454. package/src/lib/encodings.ts +1 -1
  455. package/src/lib/matchers.ts +1 -1
  456. package/src/lib/primitives.ts +16 -0
  457. package/src/lib/sdks.ts +54 -17
  458. package/src/sdk/coupon-associations.ts +45 -0
  459. package/src/sdk/integrations.ts +54 -0
  460. package/src/sdk/models/attributed-to-customer-result.ts +55 -0
  461. package/src/sdk/models/bucket-summary.ts +80 -0
  462. package/src/sdk/models/bucket.ts +45 -0
  463. package/src/sdk/models/cancel-subscription-request.ts +8 -0
  464. package/src/sdk/models/changed-subscription.ts +18 -5
  465. package/src/sdk/models/commitment-bucket-request.ts +72 -0
  466. package/src/sdk/models/coupon-response.ts +3 -0
  467. package/src/sdk/models/coupon.ts +3 -0
  468. package/src/sdk/models/create-coupon-request.ts +4 -0
  469. package/src/sdk/models/create-invoice-line-item-request.ts +24 -0
  470. package/src/sdk/models/create-subscription-line-item-request.ts +11 -0
  471. package/src/sdk/models/create-subscription-request.ts +23 -0
  472. package/src/sdk/models/create-tax-association-request.ts +14 -0
  473. package/src/sdk/models/create-user-request.ts +6 -0
  474. package/src/sdk/models/create-user-response.ts +4 -0
  475. package/src/sdk/models/debug-tracker-status.ts +2 -0
  476. package/src/sdk/models/debug-tracker.ts +9 -0
  477. package/src/sdk/models/delete-service-account-op.ts +35 -0
  478. package/src/sdk/models/delink-integration-mapping-request.ts +52 -0
  479. package/src/sdk/models/entity-integration-mapping-response.ts +2 -0
  480. package/src/sdk/models/entity-sync-config.ts +39 -0
  481. package/src/sdk/models/execute-subscription-modify-request.ts +27 -0
  482. package/src/sdk/models/failure-point-type.ts +1 -0
  483. package/src/sdk/models/get-coupon-association-op.ts +35 -0
  484. package/src/sdk/models/get-entity-integration-mappings-op.ts +50 -0
  485. package/src/sdk/models/get-usage-analytics-request.ts +12 -0
  486. package/src/sdk/models/index.ts +32 -0
  487. package/src/sdk/models/inheritance-action.ts +17 -0
  488. package/src/sdk/models/integration-config-entry.ts +49 -0
  489. package/src/sdk/models/integration-config-response.ts +35 -0
  490. package/src/sdk/models/invoice-billing-reason.ts +1 -0
  491. package/src/sdk/models/invoice-filter.ts +17 -0
  492. package/src/sdk/models/invoice-line-item-response.ts +15 -0
  493. package/src/sdk/models/invoice-sync-settings.ts +43 -0
  494. package/src/sdk/models/line-item-commitment-config.ts +19 -0
  495. package/src/sdk/models/list-coupon-associations-op.ts +69 -0
  496. package/src/sdk/models/list-coupon-associations-response.ts +41 -0
  497. package/src/sdk/models/list-entity-integration-mappings-response.ts +44 -0
  498. package/src/sdk/models/meter-usage-attribution.ts +45 -0
  499. package/src/sdk/models/payment-gateway-type.ts +1 -0
  500. package/src/sdk/models/price-filter.ts +8 -0
  501. package/src/sdk/models/price-price.ts +10 -0
  502. package/src/sdk/models/price-response.ts +10 -0
  503. package/src/sdk/models/s3-export-config.ts +70 -0
  504. package/src/sdk/models/secret-provider.ts +1 -0
  505. package/src/sdk/models/sub-modify-coupon-action.ts +17 -0
  506. package/src/sdk/models/sub-modify-coupon-params.ts +92 -0
  507. package/src/sdk/models/sub-modify-inheritance-request.ts +17 -0
  508. package/src/sdk/models/sub-modify-tax-action.ts +17 -0
  509. package/src/sdk/models/sub-modify-tax-params.ts +64 -0
  510. package/src/sdk/models/sub-modify-trial-end-request.ts +50 -0
  511. package/src/sdk/models/subscription-coupon-input.ts +62 -0
  512. package/src/sdk/models/subscription-line-item-response.ts +9 -0
  513. package/src/sdk/models/subscription-modify-type.ts +3 -0
  514. package/src/sdk/models/subscription-phase-create-request.ts +16 -2
  515. package/src/sdk/models/subscription-response-v2.ts +20 -0
  516. package/src/sdk/models/subscription-response.ts +10 -0
  517. package/src/sdk/models/subscription-subscription-line-item.ts +9 -0
  518. package/src/sdk/models/sync-config.ts +65 -0
  519. package/src/sdk/models/tax-association-response.ts +12 -0
  520. package/src/sdk/models/time-of-day-bucket.ts +74 -0
  521. package/src/sdk/models/trial-end-action.ts +17 -0
  522. package/src/sdk/models/update-service-account-op.ts +46 -0
  523. package/src/sdk/models/update-service-account-request.ts +32 -0
  524. package/src/sdk/models/update-service-account-response.ts +51 -0
  525. package/src/sdk/models/update-subscription-line-item-request.ts +14 -0
  526. package/src/sdk/models/update-user-request.ts +33 -0
  527. package/src/sdk/models/update-user-response.ts +51 -0
  528. package/src/sdk/models/usage-analytic-item.ts +13 -0
  529. package/src/sdk/models/usage-analytic-point.ts +12 -0
  530. package/src/sdk/models/user-response.ts +4 -0
  531. package/src/sdk/models/window-size.ts +1 -1
  532. package/src/sdk/sdk.ts +6 -0
  533. package/src/sdk/subscriptions.ts +2 -2
  534. package/src/sdk/users.ts +56 -0
  535. package/src/types/async.ts +8 -7
  536. package/src/types/primitives.ts +0 -26
  537. package/esm/lib/dlv.d.ts +0 -14
  538. package/esm/lib/dlv.d.ts.map +0 -1
  539. package/esm/lib/dlv.js +0 -46
  540. package/esm/lib/dlv.js.map +0 -1
  541. package/esm/lib/is-plain-object.d.ts +0 -2
  542. package/esm/lib/is-plain-object.d.ts.map +0 -1
  543. package/esm/lib/is-plain-object.js +0 -38
  544. package/esm/lib/is-plain-object.js.map +0 -1
  545. package/src/lib/dlv.ts +0 -53
  546. package/src/lib/is-plain-object.ts +0 -43
package/docs/sdk/models/entity-integration-mapping-response.md CHANGED
@@ -18,6 +18,7 @@ let value: EntityIntegrationMappingResponse = {};
18
18
  | `entityType` | [models.IntegrationEntityType](../../sdk/models/integration-entity-type.md) | :heavy_minus_sign: | N/A |
19
19
  | `environmentId` | *string* | :heavy_minus_sign: | N/A |
20
20
  | `id` | *string* | :heavy_minus_sign: | N/A |
21
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
21
22
  | `providerEntityId` | *string* | :heavy_minus_sign: | N/A |
22
23
  | `providerType` | *string* | :heavy_minus_sign: | N/A |
23
24
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/entity-sync-config.md ADDED
@@ -0,0 +1,16 @@
1
+ # EntitySyncConfig
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { EntitySyncConfig } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: EntitySyncConfig = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
15
+ | `inbound` | *boolean* | :heavy_minus_sign: | Inbound from external provider to FlexPrice |
16
+ | `outbound` | *boolean* | :heavy_minus_sign: | Outbound from FlexPrice to external provider |
package/docs/sdk/models/execute-subscription-modify-request-request.md CHANGED
@@ -8,7 +8,7 @@ import { ExecuteSubscriptionModifyRequestRequest } from "@flexprice/sdk/sdk/mode
8
8
  let value: ExecuteSubscriptionModifyRequestRequest = {
9
9
  id: "<id>",
10
10
  body: {
11
- type: "quantity_change",
11
+ type: "trial_end",
12
12
  },
13
13
  };
14
14
  ```
package/docs/sdk/models/execute-subscription-modify-request.md CHANGED
@@ -6,7 +6,7 @@
6
6
  import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: ExecuteSubscriptionModifyRequest = {
9
- type: "grouped_invoicing",
9
+ type: "coupon",
10
10
  };
11
11
  ```
12
12
 
@@ -14,7 +14,10 @@ let value: ExecuteSubscriptionModifyRequest = {
14
14
 
15
15
  | Field | Type | Required | Description |
16
16
  | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
17
+ | `couponParams` | [models.SubModifyCouponParams](../../sdk/models/sub-modify-coupon-params.md) | :heavy_minus_sign: | N/A |
17
18
  | `groupedInvoicingParams` | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign: | N/A |
18
19
  | `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
19
20
  | `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
21
+ | `taxParams` | [models.SubModifyTaxParams](../../sdk/models/sub-modify-tax-params.md) | :heavy_minus_sign: | N/A |
22
+ | `trialEndParams` | [models.SubModifyTrialEndRequest](../../sdk/models/sub-modify-trial-end-request.md) | :heavy_minus_sign: | N/A |
20
23
  | `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/failure-point-type.md CHANGED
@@ -13,5 +13,5 @@ let value: FailurePointType = "customer_lookup";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "customer_lookup" | "meter_lookup" | "price_lookup" | "subscription_line_item_lookup" | Unrecognized<string>
16
+ "customer_lookup" | "meter_lookup" | "price_lookup" | "subscription_line_item_lookup" | "attributed_to_customer" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/get-coupon-association-request.md ADDED
@@ -0,0 +1,17 @@
1
+ # GetCouponAssociationRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GetCouponAssociationRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GetCouponAssociationRequest = {
9
+ id: "<id>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | --------------------- | --------------------- | --------------------- | --------------------- |
17
+ | `id` | *string* | :heavy_check_mark: | Coupon Association ID |
package/docs/sdk/models/get-entity-integration-mappings-request.md ADDED
@@ -0,0 +1,19 @@
1
+ # GetEntityIntegrationMappingsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GetEntityIntegrationMappingsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GetEntityIntegrationMappingsRequest = {
9
+ entityType: "<value>",
10
+ entityId: "<id>",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
18
+ | `entityType` | *string* | :heavy_check_mark: | Entity type (customer, plan, invoice, subscription, payment, credit_note, addon, item, item_price, price) |
19
+ | `entityId` | *string* | :heavy_check_mark: | Entity ID |
package/docs/sdk/models/get-usage-analytics-request.md CHANGED
@@ -10,15 +10,16 @@ let value: GetUsageAnalyticsRequest = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
15
- | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
16
- | `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon" |
17
- | `externalCustomerId` | *string* | :heavy_minus_sign: | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise. |
18
- | `featureIds` | *string*[] | :heavy_minus_sign: | N/A |
19
- | `groupBy` | *string*[] | :heavy_minus_sign: | allowed values: "source", "feature_id", "properties.<field_name>" |
20
- | `includeChildren` | *boolean* | :heavy_minus_sign: | IncludeChildren when true folds child customers' usage into the single aggregated total.<br/>Default: false. |
21
- | `propertyFilters` | Record<string, *string*[]> | :heavy_minus_sign: | Property filters to filter the events by the keys in `properties` field of the event |
22
- | `sources` | *string*[] | :heavy_minus_sign: | N/A |
23
- | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
24
- | `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `breakdownBucket` | *boolean* | :heavy_minus_sign: | BreakdownBucket when true augments each time-series point with BucketID/PriceID<br/>and appends a BucketSummaries rollup to each item. Requires WindowSize to be set<br/>and the item to be linked to a subscription line item that has CommitmentTimeBuckets.<br/>Default: false (opt-in, backward compatible). |
16
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
+ | `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon" |
18
+ | `externalCustomerId` | *string* | :heavy_minus_sign: | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise. |
19
+ | `featureIds` | *string*[] | :heavy_minus_sign: | N/A |
20
+ | `groupBy` | *string*[] | :heavy_minus_sign: | allowed values: "source", "feature_id", "properties.<field_name>" |
21
+ | `includeChildren` | *boolean* | :heavy_minus_sign: | IncludeChildren when true folds child customers' usage into the single aggregated total.<br/>Default: false. |
22
+ | `propertyFilters` | Record<string, *string*[]> | :heavy_minus_sign: | Property filters to filter the events by the keys in `properties` field of the event |
23
+ | `sources` | *string*[] | :heavy_minus_sign: | N/A |
24
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
+ | `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/inheritance-action.md ADDED
@@ -0,0 +1,15 @@
1
+ # InheritanceAction
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InheritanceAction } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InheritanceAction = "remove";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "add" | "remove"
15
+ ```
package/docs/sdk/models/integration-config-entry.md ADDED
@@ -0,0 +1,17 @@
1
+ # IntegrationConfigEntry
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { IntegrationConfigEntry } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: IntegrationConfigEntry = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
+ | `baseConfig` | [models.SyncConfig](../../sdk/models/sync-config.md) | :heavy_minus_sign: | N/A |
16
+ | `currentConfig` | [models.SyncConfig](../../sdk/models/sync-config.md) | :heavy_minus_sign: | N/A |
17
+ | `provider` | [models.SecretProvider](../../sdk/models/secret-provider.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/integration-config-response.md ADDED
@@ -0,0 +1,15 @@
1
+ # IntegrationConfigResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { IntegrationConfigResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: IntegrationConfigResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
15
+ | `integrations` | [models.IntegrationConfigEntry](../../sdk/models/integration-config-entry.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-billing-reason.md CHANGED
@@ -11,5 +11,5 @@ let value: InvoiceBillingReason = "SUBSCRIPTION_UPDATE";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD"
14
+ "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP"
15
15
  ```
package/docs/sdk/models/invoice-filter.md CHANGED
@@ -14,6 +14,8 @@ let value: InvoiceFilter = {};
14
14
  | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `amountDueGt` | *number* | :heavy_minus_sign: | amount_due_gt filters invoices with a total amount due greater than the specified value<br/>Useful for finding invoices above a certain threshold or identifying high-value invoices |
16
16
  | `amountRemainingGt` | *number* | :heavy_minus_sign: | amount_remaining_gt filters invoices with an outstanding balance greater than the specified value<br/>Useful for finding invoices that still have significant unpaid amounts |
17
+ | `billingReason` | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md) | :heavy_minus_sign: | N/A |
18
+ | `currency` | *string* | :heavy_minus_sign: | currency filters invoices by their currency (ISO 4217 code, e.g. "usd", "eur").<br/>Matches on the invoices.currency column exactly. |
17
19
  | `customerId` | *string* | :heavy_minus_sign: | customer_id filters invoices for a specific customer using FlexPrice's internal customer ID<br/>This is the ID returned by FlexPrice when creating or retrieving customers |
18
20
  | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
21
  | `expand` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-line-item-response.md CHANGED
@@ -10,39 +10,41 @@ let value: InvoiceLineItemResponse = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | N/A |
16
- | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
17
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
19
- | `currency` | *string* | :heavy_minus_sign: | N/A |
20
- | `customerId` | *string* | :heavy_minus_sign: | N/A |
21
- | `displayName` | *string* | :heavy_minus_sign: | N/A |
22
- | `entityId` | *string* | :heavy_minus_sign: | N/A |
23
- | `entityType` | *string* | :heavy_minus_sign: | N/A |
24
- | `environmentId` | *string* | :heavy_minus_sign: | N/A |
25
- | `id` | *string* | :heavy_minus_sign: | N/A |
26
- | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
27
- | `invoiceLevelDiscount` | *string* | :heavy_minus_sign: | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice. |
28
- | `lineItemDiscount` | *string* | :heavy_minus_sign: | line_item_discount is the discount amount in invoice currency applied directly to this line item. |
29
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
30
- | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
31
- | `meterId` | *string* | :heavy_minus_sign: | N/A |
32
- | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
33
- | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
- | `planDisplayName` | *string* | :heavy_minus_sign: | N/A |
35
- | `prepaidCreditsApplied` | *string* | :heavy_minus_sign: | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application. |
36
- | `priceId` | *string* | :heavy_minus_sign: | N/A |
37
- | `priceType` | *string* | :heavy_minus_sign: | N/A |
38
- | `priceUnit` | *string* | :heavy_minus_sign: | N/A |
39
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | N/A |
40
- | `priceUnitId` | *string* | :heavy_minus_sign: | N/A |
41
- | `quantity` | *string* | :heavy_minus_sign: | N/A |
42
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
43
- | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
44
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
45
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
46
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
47
- | `usageAnalytics` | [models.SourceUsageItem](../../sdk/models/source-usage-item.md)[] | :heavy_minus_sign: | usage_analytics contains usage analytics for this line item (legacy - grouped by source) |
48
- | `usageBreakdown` | [models.UsageBreakdownItem](../../sdk/models/usage-breakdown-item.md)[] | :heavy_minus_sign: | usage_breakdown contains flexible usage breakdown for this line item (supports any grouping) |
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
17
+ | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
18
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
20
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
21
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
22
+ | `displayName` | *string* | :heavy_minus_sign: | N/A |
23
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
24
+ | `entityType` | *string* | :heavy_minus_sign: | N/A |
25
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
26
+ | `id` | *string* | :heavy_minus_sign: | N/A |
27
+ | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
28
+ | `invoiceLevelDiscount` | *string* | :heavy_minus_sign: | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice. |
29
+ | `lineItemDiscount` | *string* | :heavy_minus_sign: | line_item_discount is the discount amount in invoice currency applied directly to this line item. |
30
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
31
+ | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
32
+ | `meterId` | *string* | :heavy_minus_sign: | N/A |
33
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
35
+ | `planDisplayName` | *string* | :heavy_minus_sign: | N/A |
36
+ | `prepaidCreditsApplied` | *string* | :heavy_minus_sign: | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application. |
37
+ | `priceId` | *string* | :heavy_minus_sign: | N/A |
38
+ | `priceType` | *string* | :heavy_minus_sign: | N/A |
39
+ | `priceUnit` | *string* | :heavy_minus_sign: | N/A |
40
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | N/A |
41
+ | `priceUnitId` | *string* | :heavy_minus_sign: | N/A |
42
+ | `quantity` | *string* | :heavy_minus_sign: | N/A |
43
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
44
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
45
+ | `subscriptionLineItemId` | *string* | :heavy_minus_sign: | sub_line_item_id links this invoice line item to the subscription_line_item that generated it. |
46
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
47
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
48
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
49
+ | `usageAnalytics` | [models.SourceUsageItem](../../sdk/models/source-usage-item.md)[] | :heavy_minus_sign: | usage_analytics contains usage analytics for this line item (legacy - grouped by source) |
50
+ | `usageBreakdown` | [models.UsageBreakdownItem](../../sdk/models/usage-breakdown-item.md)[] | :heavy_minus_sign: | usage_breakdown contains flexible usage breakdown for this line item (supports any grouping) |
package/docs/sdk/models/invoice-sync-settings.md ADDED
@@ -0,0 +1,15 @@
1
+ # InvoiceSyncSettings
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InvoiceSyncSettings } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InvoiceSyncSettings = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
15
+ | `normalizeFixedTo` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/line-item-commitment-config.md CHANGED
@@ -10,12 +10,13 @@ let value: LineItemCommitmentConfig = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
15
- | `commitmentAmount` | *number* | :heavy_minus_sign: | CommitmentAmount is the minimum amount committed for this line item |
16
- | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
17
- | `commitmentQuantity` | *number* | :heavy_minus_sign: | CommitmentQuantity is the minimum quantity committed for this line item |
18
- | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
19
- | `enableTrueUp` | *boolean* | :heavy_minus_sign: | EnableTrueUp determines if true-up fee should be applied when usage is below commitment |
20
- | `isWindowCommitment` | *boolean* | :heavy_minus_sign: | IsWindowCommitment determines if commitment is applied per window (e.g., per day) rather than per billing period |
21
- | `overageFactor` | *number* | :heavy_minus_sign: | OverageFactor is a multiplier applied to usage beyond the commitment |
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `commitmentAmount` | *number* | :heavy_minus_sign: | CommitmentAmount is the minimum amount committed for this line item |
16
+ | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
17
+ | `commitmentQuantity` | *number* | :heavy_minus_sign: | CommitmentQuantity is the minimum quantity committed for this line item |
18
+ | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | CommitmentTimeBuckets defines per-bucket commitment + inline price for<br/>windows whose start UTC hour falls within each configured bucket. Each<br/>bucket carries its own price (materialized by the service). Requires<br/>IsWindowCommitment=true. |
19
+ | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
20
+ | `enableTrueUp` | *boolean* | :heavy_minus_sign: | EnableTrueUp determines if true-up fee should be applied when usage is below commitment |
21
+ | `isWindowCommitment` | *boolean* | :heavy_minus_sign: | IsWindowCommitment determines if commitment is applied per window (e.g., per day) rather than per billing period |
22
+ | `overageFactor` | *number* | :heavy_minus_sign: | OverageFactor is a multiplier applied to usage beyond the commitment |
package/docs/sdk/models/list-coupon-associations-request.md ADDED
@@ -0,0 +1,19 @@
1
+ # ListCouponAssociationsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListCouponAssociationsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListCouponAssociationsRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
15
+ | `subscriptionIds` | *string*[] | :heavy_minus_sign: | Filter by subscription IDs (max 100) |
16
+ | `couponIds` | *string*[] | :heavy_minus_sign: | Filter by coupon IDs (max 100) |
17
+ | `activeOnly` | *boolean* | :heavy_minus_sign: | Return only currently active associations |
18
+ | `limit` | *number* | :heavy_minus_sign: | Page size |
19
+ | `offset` | *number* | :heavy_minus_sign: | Page offset |
package/docs/sdk/models/list-coupon-associations-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListCouponAssociationsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListCouponAssociationsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListCouponAssociationsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
15
+ | `items` | [models.CouponAssociationResponse](../../sdk/models/coupon-association-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/list-entity-integration-mappings-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListEntityIntegrationMappingsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListEntityIntegrationMappingsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListEntityIntegrationMappingsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
15
+ | `items` | [models.EntityIntegrationMappingResponse](../../sdk/models/entity-integration-mapping-response.md)[] | :heavy_minus_sign: | N/A |
16
+ | `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |