@flexprice/sdk 2.1.44-dev.7 → 2.1.45-dev.8

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 (451) hide show
  1. package/FUNCTIONS.md +3 -3
  2. package/USAGE.md +1 -1
  3. package/docs/sdk/models/accounting-period-response.md +21 -0
  4. package/docs/sdk/models/accounting-period-status.md +17 -0
  5. package/docs/sdk/models/accountingperiod-filter-order.md +15 -0
  6. package/docs/sdk/models/accountingperiod-filter.md +25 -0
  7. package/docs/sdk/models/amortization-method.md +17 -0
  8. package/docs/sdk/models/contract-association-response.md +18 -0
  9. package/docs/sdk/models/contract-filter-order.md +15 -0
  10. package/docs/sdk/models/contract-filter.md +28 -0
  11. package/docs/sdk/models/contract-response.md +25 -0
  12. package/docs/sdk/models/contract-status.md +17 -0
  13. package/docs/sdk/models/create-price-request.md +1 -0
  14. package/docs/sdk/models/create-product-request.md +20 -0
  15. package/docs/sdk/models/delete-product-request.md +17 -0
  16. package/docs/sdk/models/get-contract-request.md +17 -0
  17. package/docs/sdk/models/get-journal-entry-request.md +17 -0
  18. package/docs/sdk/models/get-performance-obligation-request.md +17 -0
  19. package/docs/sdk/models/get-product-request.md +17 -0
  20. package/docs/sdk/models/invoice-filter.md +1 -0
  21. package/docs/sdk/models/journal-direction.md +17 -0
  22. package/docs/sdk/models/journal-entry-response.md +26 -0
  23. package/docs/sdk/models/journal-event-type.md +17 -0
  24. package/docs/sdk/models/journal-filter-order.md +15 -0
  25. package/docs/sdk/models/journal-filter.md +32 -0
  26. package/docs/sdk/models/journal-line-response.md +19 -0
  27. package/docs/sdk/models/ledger-account-key.md +17 -0
  28. package/docs/sdk/models/list-accounting-periods-response.md +16 -0
  29. package/docs/sdk/models/list-contracts-response.md +16 -0
  30. package/docs/sdk/models/list-journal-entries-response.md +16 -0
  31. package/docs/sdk/models/list-payments-request.md +2 -1
  32. package/docs/sdk/models/list-performance-obligations-response.md +16 -0
  33. package/docs/sdk/models/list-products-order.md +15 -0
  34. package/docs/sdk/models/list-products-request.md +23 -0
  35. package/docs/sdk/models/list-products-response.md +16 -0
  36. package/docs/sdk/models/list-products-status.md +15 -0
  37. package/docs/sdk/models/performance-obligation-association-response.md +18 -0
  38. package/docs/sdk/models/performance-obligation-response.md +26 -0
  39. package/docs/sdk/models/performance-obligation-status.md +17 -0
  40. package/docs/sdk/models/pob-filter-order.md +15 -0
  41. package/docs/sdk/models/pob-filter.md +28 -0
  42. package/docs/sdk/models/price-filter.md +1 -0
  43. package/docs/sdk/models/price-price.md +1 -0
  44. package/docs/sdk/models/price-response.md +1 -0
  45. package/docs/sdk/models/product-filter-order.md +15 -0
  46. package/docs/sdk/models/product-filter.md +25 -0
  47. package/docs/sdk/models/product-response.md +21 -0
  48. package/docs/sdk/models/recognition-method.md +17 -0
  49. package/docs/sdk/models/rev-rec-entity-type.md +17 -0
  50. package/docs/sdk/models/revenue-breakdown.md +18 -0
  51. package/docs/sdk/models/revenue-report-group-by.md +15 -0
  52. package/docs/sdk/models/rollforward-request.md +28 -0
  53. package/docs/sdk/models/rollforward-response.md +17 -0
  54. package/docs/sdk/models/rollforward-row.md +22 -0
  55. package/docs/sdk/models/update-price-request.md +1 -0
  56. package/docs/sdk/models/update-product-request-request.md +19 -0
  57. package/docs/sdk/models/update-product-request.md +16 -0
  58. package/docs/sdk/models/waterfall-cell.md +18 -0
  59. package/docs/sdk/models/waterfall-request.md +29 -0
  60. package/docs/sdk/models/waterfall-response.md +17 -0
  61. package/docs/sdk/models/waterfall-row.md +18 -0
  62. package/docs/sdks/accountingperiods/README.md +78 -0
  63. package/docs/sdks/contracts/README.md +150 -0
  64. package/docs/sdks/journalentries/README.md +150 -0
  65. package/docs/sdks/performanceobligations/README.md +150 -0
  66. package/docs/sdks/products/README.md +445 -0
  67. package/docs/sdks/revenuereports/README.md +164 -0
  68. package/esm/funcs/accounting-periods-query-accounting-period.d.ts +17 -0
  69. package/esm/funcs/accounting-periods-query-accounting-period.d.ts.map +1 -0
  70. package/esm/funcs/accounting-periods-query-accounting-period.js +83 -0
  71. package/esm/funcs/accounting-periods-query-accounting-period.js.map +1 -0
  72. package/esm/funcs/contracts-get-contract.d.ts +17 -0
  73. package/esm/funcs/contracts-get-contract.d.ts.map +1 -0
  74. package/esm/funcs/contracts-get-contract.js +91 -0
  75. package/esm/funcs/contracts-get-contract.js.map +1 -0
  76. package/esm/funcs/contracts-query-contract.d.ts +17 -0
  77. package/esm/funcs/contracts-query-contract.d.ts.map +1 -0
  78. package/esm/funcs/contracts-query-contract.js +83 -0
  79. package/esm/funcs/contracts-query-contract.js.map +1 -0
  80. package/esm/funcs/journal-entries-get-journal-entry.d.ts +17 -0
  81. package/esm/funcs/journal-entries-get-journal-entry.d.ts.map +1 -0
  82. package/esm/funcs/journal-entries-get-journal-entry.js +91 -0
  83. package/esm/funcs/journal-entries-get-journal-entry.js.map +1 -0
  84. package/esm/funcs/journal-entries-query-journal-entry.d.ts +17 -0
  85. package/esm/funcs/journal-entries-query-journal-entry.d.ts.map +1 -0
  86. package/esm/funcs/journal-entries-query-journal-entry.js +83 -0
  87. package/esm/funcs/journal-entries-query-journal-entry.js.map +1 -0
  88. package/esm/funcs/payments-list-payments.js +1 -0
  89. package/esm/funcs/payments-list-payments.js.map +1 -1
  90. package/esm/funcs/performance-obligations-get-performance-obligation.d.ts +17 -0
  91. package/esm/funcs/performance-obligations-get-performance-obligation.d.ts.map +1 -0
  92. package/esm/funcs/performance-obligations-get-performance-obligation.js +91 -0
  93. package/esm/funcs/performance-obligations-get-performance-obligation.js.map +1 -0
  94. package/esm/funcs/performance-obligations-query-performance-obligation.d.ts +17 -0
  95. package/esm/funcs/performance-obligations-query-performance-obligation.d.ts.map +1 -0
  96. package/esm/funcs/performance-obligations-query-performance-obligation.js +83 -0
  97. package/esm/funcs/performance-obligations-query-performance-obligation.js.map +1 -0
  98. package/esm/funcs/products-create-product.d.ts +17 -0
  99. package/esm/funcs/products-create-product.d.ts.map +1 -0
  100. package/esm/funcs/products-create-product.js +83 -0
  101. package/esm/funcs/products-create-product.js.map +1 -0
  102. package/esm/funcs/products-delete-product.d.ts +17 -0
  103. package/esm/funcs/products-delete-product.d.ts.map +1 -0
  104. package/esm/funcs/products-delete-product.js +91 -0
  105. package/esm/funcs/products-delete-product.js.map +1 -0
  106. package/esm/funcs/products-get-product.d.ts +17 -0
  107. package/esm/funcs/products-get-product.d.ts.map +1 -0
  108. package/esm/funcs/products-get-product.js +91 -0
  109. package/esm/funcs/products-get-product.js.map +1 -0
  110. package/esm/funcs/products-list-products.d.ts +17 -0
  111. package/esm/funcs/products-list-products.d.ts.map +1 -0
  112. package/esm/funcs/products-list-products.js +95 -0
  113. package/esm/funcs/products-list-products.js.map +1 -0
  114. package/esm/funcs/products-query-product.d.ts +17 -0
  115. package/esm/funcs/products-query-product.d.ts.map +1 -0
  116. package/esm/funcs/products-query-product.js +83 -0
  117. package/esm/funcs/products-query-product.js.map +1 -0
  118. package/esm/funcs/products-update-product.d.ts +17 -0
  119. package/esm/funcs/products-update-product.d.ts.map +1 -0
  120. package/esm/funcs/products-update-product.js +93 -0
  121. package/esm/funcs/products-update-product.js.map +1 -0
  122. package/esm/funcs/revenue-reports-get-revenue-rollforward.d.ts +17 -0
  123. package/esm/funcs/revenue-reports-get-revenue-rollforward.d.ts.map +1 -0
  124. package/esm/funcs/revenue-reports-get-revenue-rollforward.js +83 -0
  125. package/esm/funcs/revenue-reports-get-revenue-rollforward.js.map +1 -0
  126. package/esm/funcs/revenue-reports-get-revenue-waterfall.d.ts +17 -0
  127. package/esm/funcs/revenue-reports-get-revenue-waterfall.d.ts.map +1 -0
  128. package/esm/funcs/revenue-reports-get-revenue-waterfall.js +83 -0
  129. package/esm/funcs/revenue-reports-get-revenue-waterfall.js.map +1 -0
  130. package/esm/lib/config.d.ts +2 -2
  131. package/esm/lib/config.js +2 -2
  132. package/esm/sdk/accounting-periods.d.ts +12 -0
  133. package/esm/sdk/accounting-periods.d.ts.map +1 -0
  134. package/esm/sdk/accounting-periods.js +18 -0
  135. package/esm/sdk/accounting-periods.js.map +1 -0
  136. package/esm/sdk/contracts.d.ts +19 -0
  137. package/esm/sdk/contracts.d.ts.map +1 -0
  138. package/esm/sdk/contracts.js +28 -0
  139. package/esm/sdk/contracts.js.map +1 -0
  140. package/esm/sdk/journal-entries.d.ts +19 -0
  141. package/esm/sdk/journal-entries.d.ts.map +1 -0
  142. package/esm/sdk/journal-entries.js +28 -0
  143. package/esm/sdk/journal-entries.js.map +1 -0
  144. package/esm/sdk/models/accounting-period-response.d.ts +18 -0
  145. package/esm/sdk/models/accounting-period-response.d.ts.map +1 -0
  146. package/esm/sdk/models/accounting-period-response.js +31 -0
  147. package/esm/sdk/models/accounting-period-response.js.map +1 -0
  148. package/esm/sdk/models/accounting-period-status.d.ts +12 -0
  149. package/esm/sdk/models/accounting-period-status.d.ts.map +1 -0
  150. package/esm/sdk/models/accounting-period-status.js +13 -0
  151. package/esm/sdk/models/accounting-period-status.js.map +1 -0
  152. package/esm/sdk/models/accountingperiod-filter.d.ts +44 -0
  153. package/esm/sdk/models/accountingperiod-filter.d.ts.map +1 -0
  154. package/esm/sdk/models/accountingperiod-filter.js +40 -0
  155. package/esm/sdk/models/accountingperiod-filter.js.map +1 -0
  156. package/esm/sdk/models/amortization-method.d.ts +11 -0
  157. package/esm/sdk/models/amortization-method.d.ts.map +1 -0
  158. package/esm/sdk/models/amortization-method.js +12 -0
  159. package/esm/sdk/models/amortization-method.js.map +1 -0
  160. package/esm/sdk/models/contract-association-response.d.ts +14 -0
  161. package/esm/sdk/models/contract-association-response.d.ts.map +1 -0
  162. package/esm/sdk/models/contract-association-response.js +25 -0
  163. package/esm/sdk/models/contract-association-response.js.map +1 -0
  164. package/esm/sdk/models/contract-filter.d.ts +50 -0
  165. package/esm/sdk/models/contract-filter.d.ts.map +1 -0
  166. package/esm/sdk/models/contract-filter.js +46 -0
  167. package/esm/sdk/models/contract-filter.js.map +1 -0
  168. package/esm/sdk/models/contract-response.d.ts +23 -0
  169. package/esm/sdk/models/contract-response.d.ts.map +1 -0
  170. package/esm/sdk/models/contract-response.js +38 -0
  171. package/esm/sdk/models/contract-response.js.map +1 -0
  172. package/esm/sdk/models/contract-status.d.ts +14 -0
  173. package/esm/sdk/models/contract-status.d.ts.map +1 -0
  174. package/esm/sdk/models/contract-status.js +15 -0
  175. package/esm/sdk/models/contract-status.js.map +1 -0
  176. package/esm/sdk/models/create-price-request.d.ts +2 -0
  177. package/esm/sdk/models/create-price-request.d.ts.map +1 -1
  178. package/esm/sdk/models/create-price-request.js +2 -0
  179. package/esm/sdk/models/create-price-request.js.map +1 -1
  180. package/esm/sdk/models/create-product-request.d.ts +16 -0
  181. package/esm/sdk/models/create-product-request.d.ts.map +1 -0
  182. package/esm/sdk/models/create-product-request.js +19 -0
  183. package/esm/sdk/models/create-product-request.js.map +1 -0
  184. package/esm/sdk/models/delete-product-op.d.ts +15 -0
  185. package/esm/sdk/models/delete-product-op.d.ts.map +1 -0
  186. package/esm/sdk/models/delete-product-op.js +12 -0
  187. package/esm/sdk/models/delete-product-op.js.map +1 -0
  188. package/esm/sdk/models/get-contract-op.d.ts +15 -0
  189. package/esm/sdk/models/get-contract-op.d.ts.map +1 -0
  190. package/esm/sdk/models/get-contract-op.js +12 -0
  191. package/esm/sdk/models/get-contract-op.js.map +1 -0
  192. package/esm/sdk/models/get-journal-entry-op.d.ts +15 -0
  193. package/esm/sdk/models/get-journal-entry-op.d.ts.map +1 -0
  194. package/esm/sdk/models/get-journal-entry-op.js +12 -0
  195. package/esm/sdk/models/get-journal-entry-op.js.map +1 -0
  196. package/esm/sdk/models/get-performance-obligation-op.d.ts +15 -0
  197. package/esm/sdk/models/get-performance-obligation-op.d.ts.map +1 -0
  198. package/esm/sdk/models/get-performance-obligation-op.js +12 -0
  199. package/esm/sdk/models/get-performance-obligation-op.js.map +1 -0
  200. package/esm/sdk/models/get-product-op.d.ts +15 -0
  201. package/esm/sdk/models/get-product-op.d.ts.map +1 -0
  202. package/esm/sdk/models/get-product-op.js +12 -0
  203. package/esm/sdk/models/get-product-op.js.map +1 -0
  204. package/esm/sdk/models/index.d.ts +45 -0
  205. package/esm/sdk/models/index.d.ts.map +1 -1
  206. package/esm/sdk/models/index.js +45 -0
  207. package/esm/sdk/models/index.js.map +1 -1
  208. package/esm/sdk/models/invoice-filter.d.ts +5 -0
  209. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  210. package/esm/sdk/models/invoice-filter.js +2 -0
  211. package/esm/sdk/models/invoice-filter.js.map +1 -1
  212. package/esm/sdk/models/journal-direction.d.ts +10 -0
  213. package/esm/sdk/models/journal-direction.d.ts.map +1 -0
  214. package/esm/sdk/models/journal-direction.js +11 -0
  215. package/esm/sdk/models/journal-direction.js.map +1 -0
  216. package/esm/sdk/models/journal-entry-response.d.ts +24 -0
  217. package/esm/sdk/models/journal-entry-response.d.ts.map +1 -0
  218. package/esm/sdk/models/journal-entry-response.js +41 -0
  219. package/esm/sdk/models/journal-entry-response.js.map +1 -0
  220. package/esm/sdk/models/journal-event-type.d.ts +19 -0
  221. package/esm/sdk/models/journal-event-type.d.ts.map +1 -0
  222. package/esm/sdk/models/journal-event-type.js +20 -0
  223. package/esm/sdk/models/journal-event-type.js.map +1 -0
  224. package/esm/sdk/models/journal-filter.d.ts +60 -0
  225. package/esm/sdk/models/journal-filter.d.ts.map +1 -0
  226. package/esm/sdk/models/journal-filter.js +55 -0
  227. package/esm/sdk/models/journal-filter.js.map +1 -0
  228. package/esm/sdk/models/journal-line-response.d.ts +16 -0
  229. package/esm/sdk/models/journal-line-response.d.ts.map +1 -0
  230. package/esm/sdk/models/journal-line-response.js +25 -0
  231. package/esm/sdk/models/journal-line-response.js.map +1 -0
  232. package/esm/sdk/models/ledger-account-key.d.ts +18 -0
  233. package/esm/sdk/models/ledger-account-key.d.ts.map +1 -0
  234. package/esm/sdk/models/ledger-account-key.js +19 -0
  235. package/esm/sdk/models/ledger-account-key.js.map +1 -0
  236. package/esm/sdk/models/list-accounting-periods-response.d.ts +13 -0
  237. package/esm/sdk/models/list-accounting-periods-response.d.ts.map +1 -0
  238. package/esm/sdk/models/list-accounting-periods-response.js +17 -0
  239. package/esm/sdk/models/list-accounting-periods-response.js.map +1 -0
  240. package/esm/sdk/models/list-contracts-response.d.ts +13 -0
  241. package/esm/sdk/models/list-contracts-response.d.ts.map +1 -0
  242. package/esm/sdk/models/list-contracts-response.js +17 -0
  243. package/esm/sdk/models/list-contracts-response.js.map +1 -0
  244. package/esm/sdk/models/list-journal-entries-response.d.ts +13 -0
  245. package/esm/sdk/models/list-journal-entries-response.d.ts.map +1 -0
  246. package/esm/sdk/models/list-journal-entries-response.js +17 -0
  247. package/esm/sdk/models/list-journal-entries-response.js.map +1 -0
  248. package/esm/sdk/models/list-payments-op.d.ts +5 -0
  249. package/esm/sdk/models/list-payments-op.d.ts.map +1 -1
  250. package/esm/sdk/models/list-payments-op.js +2 -0
  251. package/esm/sdk/models/list-payments-op.js.map +1 -1
  252. package/esm/sdk/models/list-performance-obligations-response.d.ts +13 -0
  253. package/esm/sdk/models/list-performance-obligations-response.d.ts.map +1 -0
  254. package/esm/sdk/models/list-performance-obligations-response.js +17 -0
  255. package/esm/sdk/models/list-performance-obligations-response.js.map +1 -0
  256. package/esm/sdk/models/list-products-op.d.ts +44 -0
  257. package/esm/sdk/models/list-products-op.d.ts.map +1 -0
  258. package/esm/sdk/models/list-products-op.js +41 -0
  259. package/esm/sdk/models/list-products-op.js.map +1 -0
  260. package/esm/sdk/models/list-products-response.d.ts +13 -0
  261. package/esm/sdk/models/list-products-response.d.ts.map +1 -0
  262. package/esm/sdk/models/list-products-response.js +17 -0
  263. package/esm/sdk/models/list-products-response.js.map +1 -0
  264. package/esm/sdk/models/performance-obligation-association-response.d.ts +14 -0
  265. package/esm/sdk/models/performance-obligation-association-response.d.ts.map +1 -0
  266. package/esm/sdk/models/performance-obligation-association-response.js +25 -0
  267. package/esm/sdk/models/performance-obligation-association-response.js.map +1 -0
  268. package/esm/sdk/models/performance-obligation-response.d.ts +26 -0
  269. package/esm/sdk/models/performance-obligation-response.d.ts.map +1 -0
  270. package/esm/sdk/models/performance-obligation-response.js +42 -0
  271. package/esm/sdk/models/performance-obligation-response.js.map +1 -0
  272. package/esm/sdk/models/performance-obligation-status.d.ts +14 -0
  273. package/esm/sdk/models/performance-obligation-status.d.ts.map +1 -0
  274. package/esm/sdk/models/performance-obligation-status.js +15 -0
  275. package/esm/sdk/models/performance-obligation-status.js.map +1 -0
  276. package/esm/sdk/models/pob-filter.d.ts +51 -0
  277. package/esm/sdk/models/pob-filter.d.ts.map +1 -0
  278. package/esm/sdk/models/pob-filter.js +47 -0
  279. package/esm/sdk/models/pob-filter.js.map +1 -0
  280. package/esm/sdk/models/price-filter.d.ts +2 -0
  281. package/esm/sdk/models/price-filter.d.ts.map +1 -1
  282. package/esm/sdk/models/price-filter.js +2 -0
  283. package/esm/sdk/models/price-filter.js.map +1 -1
  284. package/esm/sdk/models/price-price.d.ts +1 -0
  285. package/esm/sdk/models/price-price.d.ts.map +1 -1
  286. package/esm/sdk/models/price-price.js +2 -0
  287. package/esm/sdk/models/price-price.js.map +1 -1
  288. package/esm/sdk/models/price-response.d.ts +1 -0
  289. package/esm/sdk/models/price-response.d.ts.map +1 -1
  290. package/esm/sdk/models/price-response.js +2 -0
  291. package/esm/sdk/models/price-response.js.map +1 -1
  292. package/esm/sdk/models/product-filter.d.ts +43 -0
  293. package/esm/sdk/models/product-filter.d.ts.map +1 -0
  294. package/esm/sdk/models/product-filter.js +39 -0
  295. package/esm/sdk/models/product-filter.js.map +1 -0
  296. package/esm/sdk/models/product-response.d.ts +17 -0
  297. package/esm/sdk/models/product-response.d.ts.map +1 -0
  298. package/esm/sdk/models/product-response.js +28 -0
  299. package/esm/sdk/models/product-response.js.map +1 -0
  300. package/esm/sdk/models/recognition-method.d.ts +13 -0
  301. package/esm/sdk/models/recognition-method.d.ts.map +1 -0
  302. package/esm/sdk/models/recognition-method.js +14 -0
  303. package/esm/sdk/models/recognition-method.js.map +1 -0
  304. package/esm/sdk/models/rev-rec-entity-type.d.ts +17 -0
  305. package/esm/sdk/models/rev-rec-entity-type.d.ts.map +1 -0
  306. package/esm/sdk/models/rev-rec-entity-type.js +18 -0
  307. package/esm/sdk/models/rev-rec-entity-type.js.map +1 -0
  308. package/esm/sdk/models/revenue-breakdown.d.ts +16 -0
  309. package/esm/sdk/models/revenue-breakdown.d.ts.map +1 -0
  310. package/esm/sdk/models/revenue-breakdown.js +17 -0
  311. package/esm/sdk/models/revenue-breakdown.js.map +1 -0
  312. package/esm/sdk/models/revenue-report-group-by.d.ts +11 -0
  313. package/esm/sdk/models/revenue-report-group-by.d.ts.map +1 -0
  314. package/esm/sdk/models/revenue-report-group-by.js +12 -0
  315. package/esm/sdk/models/revenue-report-group-by.js.map +1 -0
  316. package/esm/sdk/models/rollforward-request.d.ts +49 -0
  317. package/esm/sdk/models/rollforward-request.d.ts.map +1 -0
  318. package/esm/sdk/models/rollforward-request.js +35 -0
  319. package/esm/sdk/models/rollforward-request.js.map +1 -0
  320. package/esm/sdk/models/rollforward-response.d.ts +20 -0
  321. package/esm/sdk/models/rollforward-response.d.ts.map +1 -0
  322. package/esm/sdk/models/rollforward-response.js +18 -0
  323. package/esm/sdk/models/rollforward-response.js.map +1 -0
  324. package/esm/sdk/models/rollforward-row.d.ts +26 -0
  325. package/esm/sdk/models/rollforward-row.d.ts.map +1 -0
  326. package/esm/sdk/models/rollforward-row.js +29 -0
  327. package/esm/sdk/models/rollforward-row.js.map +1 -0
  328. package/esm/sdk/models/update-price-request.d.ts +5 -0
  329. package/esm/sdk/models/update-price-request.d.ts.map +1 -1
  330. package/esm/sdk/models/update-price-request.js +2 -0
  331. package/esm/sdk/models/update-price-request.js.map +1 -1
  332. package/esm/sdk/models/update-product-op.d.ts +21 -0
  333. package/esm/sdk/models/update-product-op.d.ts.map +1 -0
  334. package/esm/sdk/models/update-product-op.js +14 -0
  335. package/esm/sdk/models/update-product-op.js.map +1 -0
  336. package/esm/sdk/models/update-product-request.d.ts +14 -0
  337. package/esm/sdk/models/update-product-request.d.ts.map +1 -0
  338. package/esm/sdk/models/update-product-request.js +13 -0
  339. package/esm/sdk/models/update-product-request.js.map +1 -0
  340. package/esm/sdk/models/waterfall-cell.d.ts +23 -0
  341. package/esm/sdk/models/waterfall-cell.d.ts.map +1 -0
  342. package/esm/sdk/models/waterfall-cell.js +18 -0
  343. package/esm/sdk/models/waterfall-cell.js.map +1 -0
  344. package/esm/sdk/models/waterfall-request.d.ts +48 -0
  345. package/esm/sdk/models/waterfall-request.d.ts.map +1 -0
  346. package/esm/sdk/models/waterfall-request.js +34 -0
  347. package/esm/sdk/models/waterfall-request.js.map +1 -0
  348. package/esm/sdk/models/waterfall-response.d.ts +18 -0
  349. package/esm/sdk/models/waterfall-response.d.ts.map +1 -0
  350. package/esm/sdk/models/waterfall-response.js +19 -0
  351. package/esm/sdk/models/waterfall-response.js.map +1 -0
  352. package/esm/sdk/models/waterfall-row.d.ts +17 -0
  353. package/esm/sdk/models/waterfall-row.d.ts.map +1 -0
  354. package/esm/sdk/models/waterfall-row.js +25 -0
  355. package/esm/sdk/models/waterfall-row.js.map +1 -0
  356. package/esm/sdk/performance-obligations.d.ts +19 -0
  357. package/esm/sdk/performance-obligations.d.ts.map +1 -0
  358. package/esm/sdk/performance-obligations.js +28 -0
  359. package/esm/sdk/performance-obligations.js.map +1 -0
  360. package/esm/sdk/products.d.ts +47 -0
  361. package/esm/sdk/products.d.ts.map +1 -0
  362. package/esm/sdk/products.js +68 -0
  363. package/esm/sdk/products.js.map +1 -0
  364. package/esm/sdk/revenue-reports.d.ts +19 -0
  365. package/esm/sdk/revenue-reports.d.ts.map +1 -0
  366. package/esm/sdk/revenue-reports.js +28 -0
  367. package/esm/sdk/revenue-reports.js.map +1 -0
  368. package/esm/sdk/sdk.d.ts +18 -0
  369. package/esm/sdk/sdk.d.ts.map +1 -1
  370. package/esm/sdk/sdk.js +30 -0
  371. package/esm/sdk/sdk.js.map +1 -1
  372. package/examples/{activityListActivity.example.ts → accountingPeriodsQueryAccountingPeriod.example.ts} +2 -2
  373. package/jsr.json +1 -1
  374. package/package.json +1 -1
  375. package/src/funcs/accounting-periods-query-accounting-period.ts +172 -0
  376. package/src/funcs/contracts-get-contract.ts +181 -0
  377. package/src/funcs/contracts-query-contract.ts +172 -0
  378. package/src/funcs/journal-entries-get-journal-entry.ts +181 -0
  379. package/src/funcs/journal-entries-query-journal-entry.ts +172 -0
  380. package/src/funcs/payments-list-payments.ts +1 -0
  381. package/src/funcs/performance-obligations-get-performance-obligation.ts +182 -0
  382. package/src/funcs/performance-obligations-query-performance-obligation.ts +172 -0
  383. package/src/funcs/products-create-product.ts +172 -0
  384. package/src/funcs/products-delete-product.ts +181 -0
  385. package/src/funcs/products-get-product.ts +181 -0
  386. package/src/funcs/products-list-products.ts +189 -0
  387. package/src/funcs/products-query-product.ts +172 -0
  388. package/src/funcs/products-update-product.ts +187 -0
  389. package/src/funcs/revenue-reports-get-revenue-rollforward.ts +172 -0
  390. package/src/funcs/revenue-reports-get-revenue-waterfall.ts +172 -0
  391. package/src/lib/config.ts +2 -2
  392. package/src/sdk/accounting-periods.ts +27 -0
  393. package/src/sdk/contracts.ts +45 -0
  394. package/src/sdk/journal-entries.ts +45 -0
  395. package/src/sdk/models/accounting-period-response.ts +60 -0
  396. package/src/sdk/models/accounting-period-status.ts +24 -0
  397. package/src/sdk/models/accountingperiod-filter.ts +100 -0
  398. package/src/sdk/models/amortization-method.ts +20 -0
  399. package/src/sdk/models/contract-association-response.ts +51 -0
  400. package/src/sdk/models/contract-filter.ts +106 -0
  401. package/src/sdk/models/contract-response.ts +76 -0
  402. package/src/sdk/models/contract-status.ts +26 -0
  403. package/src/sdk/models/create-price-request.ts +4 -0
  404. package/src/sdk/models/create-product-request.ts +44 -0
  405. package/src/sdk/models/delete-product-op.ts +33 -0
  406. package/src/sdk/models/get-contract-op.ts +33 -0
  407. package/src/sdk/models/get-journal-entry-op.ts +33 -0
  408. package/src/sdk/models/get-performance-obligation-op.ts +35 -0
  409. package/src/sdk/models/get-product-op.ts +33 -0
  410. package/src/sdk/models/index.ts +45 -0
  411. package/src/sdk/models/invoice-filter.ts +9 -0
  412. package/src/sdk/models/journal-direction.ts +19 -0
  413. package/src/sdk/models/journal-entry-response.ts +81 -0
  414. package/src/sdk/models/journal-event-type.ts +31 -0
  415. package/src/sdk/models/journal-filter.ts +129 -0
  416. package/src/sdk/models/journal-line-response.ts +55 -0
  417. package/src/sdk/models/ledger-account-key.ts +30 -0
  418. package/src/sdk/models/list-accounting-periods-response.ts +41 -0
  419. package/src/sdk/models/list-contracts-response.ts +41 -0
  420. package/src/sdk/models/list-journal-entries-response.ts +41 -0
  421. package/src/sdk/models/list-payments-op.ts +7 -0
  422. package/src/sdk/models/list-performance-obligations-response.ts +42 -0
  423. package/src/sdk/models/list-products-op.ts +89 -0
  424. package/src/sdk/models/list-products-response.ts +41 -0
  425. package/src/sdk/models/performance-obligation-association-response.ts +55 -0
  426. package/src/sdk/models/performance-obligation-response.ts +87 -0
  427. package/src/sdk/models/performance-obligation-status.ts +28 -0
  428. package/src/sdk/models/pob-filter.ts +112 -0
  429. package/src/sdk/models/price-filter.ts +4 -0
  430. package/src/sdk/models/price-price.ts +3 -0
  431. package/src/sdk/models/price-response.ts +3 -0
  432. package/src/sdk/models/product-filter.ts +90 -0
  433. package/src/sdk/models/product-response.ts +54 -0
  434. package/src/sdk/models/recognition-method.ts +25 -0
  435. package/src/sdk/models/rev-rec-entity-type.ts +29 -0
  436. package/src/sdk/models/revenue-breakdown.ts +40 -0
  437. package/src/sdk/models/revenue-report-group-by.ts +18 -0
  438. package/src/sdk/models/rollforward-request.ts +97 -0
  439. package/src/sdk/models/rollforward-response.ts +49 -0
  440. package/src/sdk/models/rollforward-row.ts +65 -0
  441. package/src/sdk/models/update-price-request.ts +7 -0
  442. package/src/sdk/models/update-product-op.ts +46 -0
  443. package/src/sdk/models/update-product-request.ts +33 -0
  444. package/src/sdk/models/waterfall-cell.ts +50 -0
  445. package/src/sdk/models/waterfall-request.ts +93 -0
  446. package/src/sdk/models/waterfall-response.ts +47 -0
  447. package/src/sdk/models/waterfall-row.ts +52 -0
  448. package/src/sdk/performance-obligations.ts +45 -0
  449. package/src/sdk/products.ts +119 -0
  450. package/src/sdk/revenue-reports.ts +45 -0
  451. package/src/sdk/sdk.ts +38 -0
package/docs/sdk/models/list-contracts-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListContractsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListContractsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListContractsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `items` | [models.ContractResponse](../../sdk/models/contract-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-journal-entries-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListJournalEntriesResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListJournalEntriesResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListJournalEntriesResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
15
+ | `items` | [models.JournalEntryResponse](../../sdk/models/journal-entry-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-payments-request.md CHANGED
@@ -28,4 +28,5 @@ let value: ListPaymentsRequest = {};
28
28
  | `paymentStatus` | *string* | :heavy_minus_sign: | N/A |
29
29
  | `sort` | *string* | :heavy_minus_sign: | N/A |
30
30
  | `startTime` | *string* | :heavy_minus_sign: | N/A |
31
- | `status` | [models.ListPaymentsStatus](../../sdk/models/list-payments-status.md) | :heavy_minus_sign: | N/A |
31
+ | `status` | [models.ListPaymentsStatus](../../sdk/models/list-payments-status.md) | :heavy_minus_sign: | N/A |
32
+ | `updatedAtGte` | *string* | :heavy_minus_sign: | UpdatedAtGTE bounds updated_at, which every lifecycle change bumps. |
package/docs/sdk/models/list-performance-obligations-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListPerformanceObligationsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListPerformanceObligationsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListPerformanceObligationsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `items` | [models.PerformanceObligationResponse](../../sdk/models/performance-obligation-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-products-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # ListProductsOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListProductsOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListProductsOrder = "desc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/list-products-request.md ADDED
@@ -0,0 +1,23 @@
1
+ # ListProductsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListProductsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListProductsRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
15
+ | `endTime` | *string* | :heavy_minus_sign: | N/A |
16
+ | `expand` | *string* | :heavy_minus_sign: | N/A |
17
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
18
+ | `lookupKeys` | *string*[] | :heavy_minus_sign: | N/A |
19
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
20
+ | `order` | [models.ListProductsOrder](../../sdk/models/list-products-order.md) | :heavy_minus_sign: | N/A |
21
+ | `productIds` | *string*[] | :heavy_minus_sign: | N/A |
22
+ | `startTime` | *string* | :heavy_minus_sign: | N/A |
23
+ | `status` | [models.ListProductsStatus](../../sdk/models/list-products-status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-products-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListProductsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListProductsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListProductsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `items` | [models.ProductResponse](../../sdk/models/product-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-products-status.md ADDED
@@ -0,0 +1,15 @@
1
+ # ListProductsStatus
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListProductsStatus } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListProductsStatus = "archived";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "published" | "deleted" | "archived"
15
+ ```
package/docs/sdk/models/performance-obligation-association-response.md ADDED
@@ -0,0 +1,18 @@
1
+ # PerformanceObligationAssociationResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PerformanceObligationAssociationResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PerformanceObligationAssociationResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
16
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `entityType` | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.md) | :heavy_minus_sign: | N/A |
18
+ | `id` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/performance-obligation-response.md ADDED
@@ -0,0 +1,26 @@
1
+ # PerformanceObligationResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PerformanceObligationResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PerformanceObligationResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
15
+ | `amortizationMethod` | [models.AmortizationMethod](../../sdk/models/amortization-method.md) | :heavy_minus_sign: | N/A |
16
+ | `associations` | [models.PerformanceObligationAssociationResponse](../../sdk/models/performance-obligation-association-response.md)[] | :heavy_minus_sign: | N/A |
17
+ | `contractId` | *string* | :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
+ | `id` | *string* | :heavy_minus_sign: | N/A |
20
+ | `name` | *string* | :heavy_minus_sign: | N/A |
21
+ | `pobStatus` | [models.PerformanceObligationStatus](../../sdk/models/performance-obligation-status.md) | :heavy_minus_sign: | N/A |
22
+ | `recognitionMethod` | [models.RecognitionMethod](../../sdk/models/recognition-method.md) | :heavy_minus_sign: | N/A |
23
+ | `serviceEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
24
+ | `serviceStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
26
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/performance-obligation-status.md ADDED
@@ -0,0 +1,17 @@
1
+ # PerformanceObligationStatus
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PerformanceObligationStatus } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PerformanceObligationStatus = "satisfied";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "draft" | "active" | "satisfied" | "cancelled" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/pob-filter-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # PobFilterOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PobFilterOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PobFilterOrder = "asc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/pob-filter.md ADDED
@@ -0,0 +1,28 @@
1
+ # PobFilter
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PobFilter } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PobFilter = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `contractIds` | *string*[] | :heavy_minus_sign: | N/A |
16
+ | `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
17
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
+ | `expand` | *string* | :heavy_minus_sign: | N/A |
19
+ | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
20
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
21
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
22
+ | `order` | [models.PobFilterOrder](../../sdk/models/pob-filter-order.md) | :heavy_minus_sign: | N/A |
23
+ | `performanceObligationIds` | *string*[] | :heavy_minus_sign: | N/A |
24
+ | `pobStatuses` | [models.PerformanceObligationStatus](../../sdk/models/performance-obligation-status.md)[] | :heavy_minus_sign: | N/A |
25
+ | `recognitionMethods` | [models.RecognitionMethod](../../sdk/models/recognition-method.md)[] | :heavy_minus_sign: | N/A |
26
+ | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
27
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
28
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-filter.md CHANGED
@@ -26,6 +26,7 @@ let value: PriceFilter = {};
26
26
  | `parentPriceId` | *string* | :heavy_minus_sign: | N/A |
27
27
  | `planIds` | *string*[] | :heavy_minus_sign: | Price override filtering fields |
28
28
  | `priceIds` | *string*[] | :heavy_minus_sign: | N/A |
29
+ | `productIds` | *string*[] | :heavy_minus_sign: | N/A |
29
30
  | `sort` | *string* | :heavy_minus_sign: | N/A |
30
31
  | `startDateLt` | *string* | :heavy_minus_sign: | N/A |
31
32
  | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-price.md CHANGED
@@ -43,6 +43,7 @@ let value: PricePrice = {};
43
43
  | `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
44
44
  | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
45
45
  | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
46
+ | `productId` | *string* | :heavy_minus_sign: | N/A |
46
47
  | `sequence` | *number* | :heavy_minus_sign: | Sequence is the monotonic stamp bumped on every state change that<br/>subscription line items need to react to. Read by the plan-price sync;<br/>set by the database (DEFAULT nextval) on create and by the price<br/>repository on termination / compatibility-affecting edits. |
47
48
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the price |
48
49
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-response.md CHANGED
@@ -77,6 +77,7 @@ let value: PriceResponse = {
77
77
  | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
78
78
  | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
79
79
  | `pricingUnit` | [models.PriceUnitResponse](../../sdk/models/price-unit-response.md) | :heavy_minus_sign: | N/A |
80
+ | `productId` | *string* | :heavy_minus_sign: | N/A |
80
81
  | `sequence` | *number* | :heavy_minus_sign: | Sequence is the monotonic stamp bumped on every state change that<br/>subscription line items need to react to. Read by the plan-price sync;<br/>set by the database (DEFAULT nextval) on create and by the price<br/>repository on termination / compatibility-affecting edits. |
81
82
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the price |
82
83
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/product-filter-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # ProductFilterOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ProductFilterOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ProductFilterOrder = "desc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/product-filter.md ADDED
@@ -0,0 +1,25 @@
1
+ # ProductFilter
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ProductFilter } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ProductFilter = {};
9
+ ```
10
+
11
+ ## Fields
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: | N/A |
17
+ | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
18
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
19
+ | `lookupKeys` | *string*[] | :heavy_minus_sign: | N/A |
20
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
21
+ | `order` | [models.ProductFilterOrder](../../sdk/models/product-filter-order.md) | :heavy_minus_sign: | N/A |
22
+ | `productIds` | *string*[] | :heavy_minus_sign: | N/A |
23
+ | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :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
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/product-response.md ADDED
@@ -0,0 +1,21 @@
1
+ # ProductResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ProductResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ProductResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
16
+ | `description` | *string* | :heavy_minus_sign: | N/A |
17
+ | `id` | *string* | :heavy_minus_sign: | N/A |
18
+ | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
19
+ | `name` | *string* | :heavy_minus_sign: | N/A |
20
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
21
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/recognition-method.md ADDED
@@ -0,0 +1,17 @@
1
+ # RecognitionMethod
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RecognitionMethod } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RecognitionMethod = "point_in_time";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "point_in_time" | "straight_line" | "as_consumed" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/rev-rec-entity-type.md ADDED
@@ -0,0 +1,17 @@
1
+ # RevRecEntityType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RevRecEntityType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RevRecEntityType = "credit_note";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "subscription" | "subscription_line_item" | "invoice" | "credit_note" | "payment" | "refund" | "pob" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/revenue-breakdown.md ADDED
@@ -0,0 +1,18 @@
1
+ # RevenueBreakdown
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RevenueBreakdown } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RevenueBreakdown = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
15
+ | `actual` | *string* | :heavy_minus_sign: | N/A |
16
+ | `pending` | *string* | :heavy_minus_sign: | N/A |
17
+ | `scheduled` | *string* | :heavy_minus_sign: | N/A |
18
+ | `total` | *string* | :heavy_minus_sign: | actual + pending + scheduled |
package/docs/sdk/models/revenue-report-group-by.md ADDED
@@ -0,0 +1,15 @@
1
+ # RevenueReportGroupBy
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RevenueReportGroupBy } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RevenueReportGroupBy = "contract_id";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "customer_id" | "contract_id" | "pob_id"
15
+ ```
package/docs/sdk/models/rollforward-request.md ADDED
@@ -0,0 +1,28 @@
1
+ # RollforwardRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RollforwardRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RollforwardRequest = {
9
+ currency: "Lek",
10
+ periodStart: new Date("2024-12-15T11:11:43.474Z"),
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
18
+ | `accounts` | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md)[] | :heavy_minus_sign: | defaults to [deferred_revenue] |
19
+ | `contractIds` | *string*[] | :heavy_minus_sign: | N/A |
20
+ | `currency` | *string* | :heavy_check_mark: | N/A |
21
+ | `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
22
+ | `groupBy` | [models.RevenueReportGroupBy](../../sdk/models/revenue-report-group-by.md)[] | :heavy_minus_sign: | N/A |
23
+ | `limit` | *number* | :heavy_minus_sign: | item rows per page; totals are never paged |
24
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
25
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | YYYY-MM, an ended month; defaults to period_start |
26
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | YYYY-MM |
27
+ | `pobIds` | *string*[] | :heavy_minus_sign: | N/A |
28
+ | `postedBy` | *string* | :heavy_minus_sign: | only entries posted at or before it: the books as they were then |
package/docs/sdk/models/rollforward-response.md ADDED
@@ -0,0 +1,17 @@
1
+ # RollforwardResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RollforwardResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RollforwardResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `items` | [models.RollforwardRow](../../sdk/models/rollforward-row.md)[] | :heavy_minus_sign: | per period, account and group; empty without group_by |
16
+ | `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
17
+ | `totals` | [models.RollforwardRow](../../sdk/models/rollforward-row.md)[] | :heavy_minus_sign: | per period and account, all groups |
package/docs/sdk/models/rollforward-row.md ADDED
@@ -0,0 +1,22 @@
1
+ # RollforwardRow
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { RollforwardRow } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: RollforwardRow = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
15
+ | `account` | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md) | :heavy_minus_sign: | N/A |
16
+ | `closing` | *string* | :heavy_minus_sign: | N/A |
17
+ | `contractId` | *string* | :heavy_minus_sign: | N/A |
18
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
19
+ | `movements` | Record<string, *string*> | :heavy_minus_sign: | a missing category is 0 |
20
+ | `opening` | *string* | :heavy_minus_sign: | N/A |
21
+ | `period` | *string* | :heavy_minus_sign: | YYYY-MM |
22
+ | `pobId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/update-price-request.md CHANGED
@@ -23,6 +23,7 @@ let value: UpdatePriceRequest = {};
23
23
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
24
24
  | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the price unit amount (for CUSTOM price unit type, FLAT_FEE/PACKAGE billing models) |
25
25
  | `priceUnitTiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the price unit tiers (for CUSTOM price unit type, TIERED billing model) |
26
+ | `productId` | *string* | :heavy_minus_sign: | ProductID sets the price's product while it has none; once set it never changes. |
26
27
  | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
27
28
  | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | Tiers determines the pricing tiers for this line item |
28
29
  | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |