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

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 (453) 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.d.ts.map +1 -1
  132. package/esm/lib/config.js +2 -2
  133. package/esm/lib/config.js.map +1 -1
  134. package/esm/sdk/accounting-periods.d.ts +12 -0
  135. package/esm/sdk/accounting-periods.d.ts.map +1 -0
  136. package/esm/sdk/accounting-periods.js +18 -0
  137. package/esm/sdk/accounting-periods.js.map +1 -0
  138. package/esm/sdk/contracts.d.ts +19 -0
  139. package/esm/sdk/contracts.d.ts.map +1 -0
  140. package/esm/sdk/contracts.js +28 -0
  141. package/esm/sdk/contracts.js.map +1 -0
  142. package/esm/sdk/journal-entries.d.ts +19 -0
  143. package/esm/sdk/journal-entries.d.ts.map +1 -0
  144. package/esm/sdk/journal-entries.js +28 -0
  145. package/esm/sdk/journal-entries.js.map +1 -0
  146. package/esm/sdk/models/accounting-period-response.d.ts +18 -0
  147. package/esm/sdk/models/accounting-period-response.d.ts.map +1 -0
  148. package/esm/sdk/models/accounting-period-response.js +31 -0
  149. package/esm/sdk/models/accounting-period-response.js.map +1 -0
  150. package/esm/sdk/models/accounting-period-status.d.ts +12 -0
  151. package/esm/sdk/models/accounting-period-status.d.ts.map +1 -0
  152. package/esm/sdk/models/accounting-period-status.js +13 -0
  153. package/esm/sdk/models/accounting-period-status.js.map +1 -0
  154. package/esm/sdk/models/accountingperiod-filter.d.ts +44 -0
  155. package/esm/sdk/models/accountingperiod-filter.d.ts.map +1 -0
  156. package/esm/sdk/models/accountingperiod-filter.js +40 -0
  157. package/esm/sdk/models/accountingperiod-filter.js.map +1 -0
  158. package/esm/sdk/models/amortization-method.d.ts +11 -0
  159. package/esm/sdk/models/amortization-method.d.ts.map +1 -0
  160. package/esm/sdk/models/amortization-method.js +12 -0
  161. package/esm/sdk/models/amortization-method.js.map +1 -0
  162. package/esm/sdk/models/contract-association-response.d.ts +14 -0
  163. package/esm/sdk/models/contract-association-response.d.ts.map +1 -0
  164. package/esm/sdk/models/contract-association-response.js +25 -0
  165. package/esm/sdk/models/contract-association-response.js.map +1 -0
  166. package/esm/sdk/models/contract-filter.d.ts +50 -0
  167. package/esm/sdk/models/contract-filter.d.ts.map +1 -0
  168. package/esm/sdk/models/contract-filter.js +46 -0
  169. package/esm/sdk/models/contract-filter.js.map +1 -0
  170. package/esm/sdk/models/contract-response.d.ts +23 -0
  171. package/esm/sdk/models/contract-response.d.ts.map +1 -0
  172. package/esm/sdk/models/contract-response.js +38 -0
  173. package/esm/sdk/models/contract-response.js.map +1 -0
  174. package/esm/sdk/models/contract-status.d.ts +14 -0
  175. package/esm/sdk/models/contract-status.d.ts.map +1 -0
  176. package/esm/sdk/models/contract-status.js +15 -0
  177. package/esm/sdk/models/contract-status.js.map +1 -0
  178. package/esm/sdk/models/create-price-request.d.ts +2 -0
  179. package/esm/sdk/models/create-price-request.d.ts.map +1 -1
  180. package/esm/sdk/models/create-price-request.js +2 -0
  181. package/esm/sdk/models/create-price-request.js.map +1 -1
  182. package/esm/sdk/models/create-product-request.d.ts +16 -0
  183. package/esm/sdk/models/create-product-request.d.ts.map +1 -0
  184. package/esm/sdk/models/create-product-request.js +19 -0
  185. package/esm/sdk/models/create-product-request.js.map +1 -0
  186. package/esm/sdk/models/delete-product-op.d.ts +15 -0
  187. package/esm/sdk/models/delete-product-op.d.ts.map +1 -0
  188. package/esm/sdk/models/delete-product-op.js +12 -0
  189. package/esm/sdk/models/delete-product-op.js.map +1 -0
  190. package/esm/sdk/models/get-contract-op.d.ts +15 -0
  191. package/esm/sdk/models/get-contract-op.d.ts.map +1 -0
  192. package/esm/sdk/models/get-contract-op.js +12 -0
  193. package/esm/sdk/models/get-contract-op.js.map +1 -0
  194. package/esm/sdk/models/get-journal-entry-op.d.ts +15 -0
  195. package/esm/sdk/models/get-journal-entry-op.d.ts.map +1 -0
  196. package/esm/sdk/models/get-journal-entry-op.js +12 -0
  197. package/esm/sdk/models/get-journal-entry-op.js.map +1 -0
  198. package/esm/sdk/models/get-performance-obligation-op.d.ts +15 -0
  199. package/esm/sdk/models/get-performance-obligation-op.d.ts.map +1 -0
  200. package/esm/sdk/models/get-performance-obligation-op.js +12 -0
  201. package/esm/sdk/models/get-performance-obligation-op.js.map +1 -0
  202. package/esm/sdk/models/get-product-op.d.ts +15 -0
  203. package/esm/sdk/models/get-product-op.d.ts.map +1 -0
  204. package/esm/sdk/models/get-product-op.js +12 -0
  205. package/esm/sdk/models/get-product-op.js.map +1 -0
  206. package/esm/sdk/models/index.d.ts +45 -0
  207. package/esm/sdk/models/index.d.ts.map +1 -1
  208. package/esm/sdk/models/index.js +45 -0
  209. package/esm/sdk/models/index.js.map +1 -1
  210. package/esm/sdk/models/invoice-filter.d.ts +5 -0
  211. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  212. package/esm/sdk/models/invoice-filter.js +2 -0
  213. package/esm/sdk/models/invoice-filter.js.map +1 -1
  214. package/esm/sdk/models/journal-direction.d.ts +10 -0
  215. package/esm/sdk/models/journal-direction.d.ts.map +1 -0
  216. package/esm/sdk/models/journal-direction.js +11 -0
  217. package/esm/sdk/models/journal-direction.js.map +1 -0
  218. package/esm/sdk/models/journal-entry-response.d.ts +24 -0
  219. package/esm/sdk/models/journal-entry-response.d.ts.map +1 -0
  220. package/esm/sdk/models/journal-entry-response.js +41 -0
  221. package/esm/sdk/models/journal-entry-response.js.map +1 -0
  222. package/esm/sdk/models/journal-event-type.d.ts +19 -0
  223. package/esm/sdk/models/journal-event-type.d.ts.map +1 -0
  224. package/esm/sdk/models/journal-event-type.js +20 -0
  225. package/esm/sdk/models/journal-event-type.js.map +1 -0
  226. package/esm/sdk/models/journal-filter.d.ts +60 -0
  227. package/esm/sdk/models/journal-filter.d.ts.map +1 -0
  228. package/esm/sdk/models/journal-filter.js +55 -0
  229. package/esm/sdk/models/journal-filter.js.map +1 -0
  230. package/esm/sdk/models/journal-line-response.d.ts +16 -0
  231. package/esm/sdk/models/journal-line-response.d.ts.map +1 -0
  232. package/esm/sdk/models/journal-line-response.js +25 -0
  233. package/esm/sdk/models/journal-line-response.js.map +1 -0
  234. package/esm/sdk/models/ledger-account-key.d.ts +18 -0
  235. package/esm/sdk/models/ledger-account-key.d.ts.map +1 -0
  236. package/esm/sdk/models/ledger-account-key.js +19 -0
  237. package/esm/sdk/models/ledger-account-key.js.map +1 -0
  238. package/esm/sdk/models/list-accounting-periods-response.d.ts +13 -0
  239. package/esm/sdk/models/list-accounting-periods-response.d.ts.map +1 -0
  240. package/esm/sdk/models/list-accounting-periods-response.js +17 -0
  241. package/esm/sdk/models/list-accounting-periods-response.js.map +1 -0
  242. package/esm/sdk/models/list-contracts-response.d.ts +13 -0
  243. package/esm/sdk/models/list-contracts-response.d.ts.map +1 -0
  244. package/esm/sdk/models/list-contracts-response.js +17 -0
  245. package/esm/sdk/models/list-contracts-response.js.map +1 -0
  246. package/esm/sdk/models/list-journal-entries-response.d.ts +13 -0
  247. package/esm/sdk/models/list-journal-entries-response.d.ts.map +1 -0
  248. package/esm/sdk/models/list-journal-entries-response.js +17 -0
  249. package/esm/sdk/models/list-journal-entries-response.js.map +1 -0
  250. package/esm/sdk/models/list-payments-op.d.ts +5 -0
  251. package/esm/sdk/models/list-payments-op.d.ts.map +1 -1
  252. package/esm/sdk/models/list-payments-op.js +2 -0
  253. package/esm/sdk/models/list-payments-op.js.map +1 -1
  254. package/esm/sdk/models/list-performance-obligations-response.d.ts +13 -0
  255. package/esm/sdk/models/list-performance-obligations-response.d.ts.map +1 -0
  256. package/esm/sdk/models/list-performance-obligations-response.js +17 -0
  257. package/esm/sdk/models/list-performance-obligations-response.js.map +1 -0
  258. package/esm/sdk/models/list-products-op.d.ts +44 -0
  259. package/esm/sdk/models/list-products-op.d.ts.map +1 -0
  260. package/esm/sdk/models/list-products-op.js +41 -0
  261. package/esm/sdk/models/list-products-op.js.map +1 -0
  262. package/esm/sdk/models/list-products-response.d.ts +13 -0
  263. package/esm/sdk/models/list-products-response.d.ts.map +1 -0
  264. package/esm/sdk/models/list-products-response.js +17 -0
  265. package/esm/sdk/models/list-products-response.js.map +1 -0
  266. package/esm/sdk/models/performance-obligation-association-response.d.ts +14 -0
  267. package/esm/sdk/models/performance-obligation-association-response.d.ts.map +1 -0
  268. package/esm/sdk/models/performance-obligation-association-response.js +25 -0
  269. package/esm/sdk/models/performance-obligation-association-response.js.map +1 -0
  270. package/esm/sdk/models/performance-obligation-response.d.ts +26 -0
  271. package/esm/sdk/models/performance-obligation-response.d.ts.map +1 -0
  272. package/esm/sdk/models/performance-obligation-response.js +42 -0
  273. package/esm/sdk/models/performance-obligation-response.js.map +1 -0
  274. package/esm/sdk/models/performance-obligation-status.d.ts +14 -0
  275. package/esm/sdk/models/performance-obligation-status.d.ts.map +1 -0
  276. package/esm/sdk/models/performance-obligation-status.js +15 -0
  277. package/esm/sdk/models/performance-obligation-status.js.map +1 -0
  278. package/esm/sdk/models/pob-filter.d.ts +51 -0
  279. package/esm/sdk/models/pob-filter.d.ts.map +1 -0
  280. package/esm/sdk/models/pob-filter.js +47 -0
  281. package/esm/sdk/models/pob-filter.js.map +1 -0
  282. package/esm/sdk/models/price-filter.d.ts +2 -0
  283. package/esm/sdk/models/price-filter.d.ts.map +1 -1
  284. package/esm/sdk/models/price-filter.js +2 -0
  285. package/esm/sdk/models/price-filter.js.map +1 -1
  286. package/esm/sdk/models/price-price.d.ts +1 -0
  287. package/esm/sdk/models/price-price.d.ts.map +1 -1
  288. package/esm/sdk/models/price-price.js +2 -0
  289. package/esm/sdk/models/price-price.js.map +1 -1
  290. package/esm/sdk/models/price-response.d.ts +1 -0
  291. package/esm/sdk/models/price-response.d.ts.map +1 -1
  292. package/esm/sdk/models/price-response.js +2 -0
  293. package/esm/sdk/models/price-response.js.map +1 -1
  294. package/esm/sdk/models/product-filter.d.ts +43 -0
  295. package/esm/sdk/models/product-filter.d.ts.map +1 -0
  296. package/esm/sdk/models/product-filter.js +39 -0
  297. package/esm/sdk/models/product-filter.js.map +1 -0
  298. package/esm/sdk/models/product-response.d.ts +17 -0
  299. package/esm/sdk/models/product-response.d.ts.map +1 -0
  300. package/esm/sdk/models/product-response.js +28 -0
  301. package/esm/sdk/models/product-response.js.map +1 -0
  302. package/esm/sdk/models/recognition-method.d.ts +13 -0
  303. package/esm/sdk/models/recognition-method.d.ts.map +1 -0
  304. package/esm/sdk/models/recognition-method.js +14 -0
  305. package/esm/sdk/models/recognition-method.js.map +1 -0
  306. package/esm/sdk/models/rev-rec-entity-type.d.ts +17 -0
  307. package/esm/sdk/models/rev-rec-entity-type.d.ts.map +1 -0
  308. package/esm/sdk/models/rev-rec-entity-type.js +18 -0
  309. package/esm/sdk/models/rev-rec-entity-type.js.map +1 -0
  310. package/esm/sdk/models/revenue-breakdown.d.ts +16 -0
  311. package/esm/sdk/models/revenue-breakdown.d.ts.map +1 -0
  312. package/esm/sdk/models/revenue-breakdown.js +17 -0
  313. package/esm/sdk/models/revenue-breakdown.js.map +1 -0
  314. package/esm/sdk/models/revenue-report-group-by.d.ts +11 -0
  315. package/esm/sdk/models/revenue-report-group-by.d.ts.map +1 -0
  316. package/esm/sdk/models/revenue-report-group-by.js +12 -0
  317. package/esm/sdk/models/revenue-report-group-by.js.map +1 -0
  318. package/esm/sdk/models/rollforward-request.d.ts +49 -0
  319. package/esm/sdk/models/rollforward-request.d.ts.map +1 -0
  320. package/esm/sdk/models/rollforward-request.js +35 -0
  321. package/esm/sdk/models/rollforward-request.js.map +1 -0
  322. package/esm/sdk/models/rollforward-response.d.ts +20 -0
  323. package/esm/sdk/models/rollforward-response.d.ts.map +1 -0
  324. package/esm/sdk/models/rollforward-response.js +18 -0
  325. package/esm/sdk/models/rollforward-response.js.map +1 -0
  326. package/esm/sdk/models/rollforward-row.d.ts +26 -0
  327. package/esm/sdk/models/rollforward-row.d.ts.map +1 -0
  328. package/esm/sdk/models/rollforward-row.js +29 -0
  329. package/esm/sdk/models/rollforward-row.js.map +1 -0
  330. package/esm/sdk/models/update-price-request.d.ts +5 -0
  331. package/esm/sdk/models/update-price-request.d.ts.map +1 -1
  332. package/esm/sdk/models/update-price-request.js +2 -0
  333. package/esm/sdk/models/update-price-request.js.map +1 -1
  334. package/esm/sdk/models/update-product-op.d.ts +21 -0
  335. package/esm/sdk/models/update-product-op.d.ts.map +1 -0
  336. package/esm/sdk/models/update-product-op.js +14 -0
  337. package/esm/sdk/models/update-product-op.js.map +1 -0
  338. package/esm/sdk/models/update-product-request.d.ts +14 -0
  339. package/esm/sdk/models/update-product-request.d.ts.map +1 -0
  340. package/esm/sdk/models/update-product-request.js +13 -0
  341. package/esm/sdk/models/update-product-request.js.map +1 -0
  342. package/esm/sdk/models/waterfall-cell.d.ts +23 -0
  343. package/esm/sdk/models/waterfall-cell.d.ts.map +1 -0
  344. package/esm/sdk/models/waterfall-cell.js +18 -0
  345. package/esm/sdk/models/waterfall-cell.js.map +1 -0
  346. package/esm/sdk/models/waterfall-request.d.ts +48 -0
  347. package/esm/sdk/models/waterfall-request.d.ts.map +1 -0
  348. package/esm/sdk/models/waterfall-request.js +34 -0
  349. package/esm/sdk/models/waterfall-request.js.map +1 -0
  350. package/esm/sdk/models/waterfall-response.d.ts +18 -0
  351. package/esm/sdk/models/waterfall-response.d.ts.map +1 -0
  352. package/esm/sdk/models/waterfall-response.js +19 -0
  353. package/esm/sdk/models/waterfall-response.js.map +1 -0
  354. package/esm/sdk/models/waterfall-row.d.ts +17 -0
  355. package/esm/sdk/models/waterfall-row.d.ts.map +1 -0
  356. package/esm/sdk/models/waterfall-row.js +25 -0
  357. package/esm/sdk/models/waterfall-row.js.map +1 -0
  358. package/esm/sdk/performance-obligations.d.ts +19 -0
  359. package/esm/sdk/performance-obligations.d.ts.map +1 -0
  360. package/esm/sdk/performance-obligations.js +28 -0
  361. package/esm/sdk/performance-obligations.js.map +1 -0
  362. package/esm/sdk/products.d.ts +47 -0
  363. package/esm/sdk/products.d.ts.map +1 -0
  364. package/esm/sdk/products.js +68 -0
  365. package/esm/sdk/products.js.map +1 -0
  366. package/esm/sdk/revenue-reports.d.ts +19 -0
  367. package/esm/sdk/revenue-reports.d.ts.map +1 -0
  368. package/esm/sdk/revenue-reports.js +28 -0
  369. package/esm/sdk/revenue-reports.js.map +1 -0
  370. package/esm/sdk/sdk.d.ts +18 -0
  371. package/esm/sdk/sdk.d.ts.map +1 -1
  372. package/esm/sdk/sdk.js +30 -0
  373. package/esm/sdk/sdk.js.map +1 -1
  374. package/examples/{activityListActivity.example.ts → accountingPeriodsQueryAccountingPeriod.example.ts} +2 -2
  375. package/jsr.json +1 -1
  376. package/package.json +1 -1
  377. package/src/funcs/accounting-periods-query-accounting-period.ts +172 -0
  378. package/src/funcs/contracts-get-contract.ts +181 -0
  379. package/src/funcs/contracts-query-contract.ts +172 -0
  380. package/src/funcs/journal-entries-get-journal-entry.ts +181 -0
  381. package/src/funcs/journal-entries-query-journal-entry.ts +172 -0
  382. package/src/funcs/payments-list-payments.ts +1 -0
  383. package/src/funcs/performance-obligations-get-performance-obligation.ts +182 -0
  384. package/src/funcs/performance-obligations-query-performance-obligation.ts +172 -0
  385. package/src/funcs/products-create-product.ts +172 -0
  386. package/src/funcs/products-delete-product.ts +181 -0
  387. package/src/funcs/products-get-product.ts +181 -0
  388. package/src/funcs/products-list-products.ts +189 -0
  389. package/src/funcs/products-query-product.ts +172 -0
  390. package/src/funcs/products-update-product.ts +187 -0
  391. package/src/funcs/revenue-reports-get-revenue-rollforward.ts +172 -0
  392. package/src/funcs/revenue-reports-get-revenue-waterfall.ts +172 -0
  393. package/src/lib/config.ts +3 -2
  394. package/src/sdk/accounting-periods.ts +27 -0
  395. package/src/sdk/contracts.ts +45 -0
  396. package/src/sdk/journal-entries.ts +45 -0
  397. package/src/sdk/models/accounting-period-response.ts +60 -0
  398. package/src/sdk/models/accounting-period-status.ts +24 -0
  399. package/src/sdk/models/accountingperiod-filter.ts +100 -0
  400. package/src/sdk/models/amortization-method.ts +20 -0
  401. package/src/sdk/models/contract-association-response.ts +51 -0
  402. package/src/sdk/models/contract-filter.ts +106 -0
  403. package/src/sdk/models/contract-response.ts +76 -0
  404. package/src/sdk/models/contract-status.ts +26 -0
  405. package/src/sdk/models/create-price-request.ts +4 -0
  406. package/src/sdk/models/create-product-request.ts +44 -0
  407. package/src/sdk/models/delete-product-op.ts +33 -0
  408. package/src/sdk/models/get-contract-op.ts +33 -0
  409. package/src/sdk/models/get-journal-entry-op.ts +33 -0
  410. package/src/sdk/models/get-performance-obligation-op.ts +35 -0
  411. package/src/sdk/models/get-product-op.ts +33 -0
  412. package/src/sdk/models/index.ts +45 -0
  413. package/src/sdk/models/invoice-filter.ts +9 -0
  414. package/src/sdk/models/journal-direction.ts +19 -0
  415. package/src/sdk/models/journal-entry-response.ts +81 -0
  416. package/src/sdk/models/journal-event-type.ts +31 -0
  417. package/src/sdk/models/journal-filter.ts +129 -0
  418. package/src/sdk/models/journal-line-response.ts +55 -0
  419. package/src/sdk/models/ledger-account-key.ts +30 -0
  420. package/src/sdk/models/list-accounting-periods-response.ts +41 -0
  421. package/src/sdk/models/list-contracts-response.ts +41 -0
  422. package/src/sdk/models/list-journal-entries-response.ts +41 -0
  423. package/src/sdk/models/list-payments-op.ts +7 -0
  424. package/src/sdk/models/list-performance-obligations-response.ts +42 -0
  425. package/src/sdk/models/list-products-op.ts +89 -0
  426. package/src/sdk/models/list-products-response.ts +41 -0
  427. package/src/sdk/models/performance-obligation-association-response.ts +55 -0
  428. package/src/sdk/models/performance-obligation-response.ts +87 -0
  429. package/src/sdk/models/performance-obligation-status.ts +28 -0
  430. package/src/sdk/models/pob-filter.ts +112 -0
  431. package/src/sdk/models/price-filter.ts +4 -0
  432. package/src/sdk/models/price-price.ts +3 -0
  433. package/src/sdk/models/price-response.ts +3 -0
  434. package/src/sdk/models/product-filter.ts +90 -0
  435. package/src/sdk/models/product-response.ts +54 -0
  436. package/src/sdk/models/recognition-method.ts +25 -0
  437. package/src/sdk/models/rev-rec-entity-type.ts +29 -0
  438. package/src/sdk/models/revenue-breakdown.ts +40 -0
  439. package/src/sdk/models/revenue-report-group-by.ts +18 -0
  440. package/src/sdk/models/rollforward-request.ts +97 -0
  441. package/src/sdk/models/rollforward-response.ts +49 -0
  442. package/src/sdk/models/rollforward-row.ts +65 -0
  443. package/src/sdk/models/update-price-request.ts +7 -0
  444. package/src/sdk/models/update-product-op.ts +46 -0
  445. package/src/sdk/models/update-product-request.ts +33 -0
  446. package/src/sdk/models/waterfall-cell.ts +50 -0
  447. package/src/sdk/models/waterfall-request.ts +93 -0
  448. package/src/sdk/models/waterfall-response.ts +47 -0
  449. package/src/sdk/models/waterfall-row.ts +52 -0
  450. package/src/sdk/performance-obligations.ts +45 -0
  451. package/src/sdk/products.ts +119 -0
  452. package/src/sdk/revenue-reports.ts +45 -0
  453. package/src/sdk/sdk.ts +38 -0
@@ -0,0 +1,19 @@
1
+ # UpdateProductRequestRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UpdateProductRequestRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UpdateProductRequestRequest = {
9
+ id: "<id>",
10
+ body: {},
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
18
+ | `id` | *string* | :heavy_check_mark: | Product ID |
19
+ | `body` | [models.UpdateProductRequest](../../sdk/models/update-product-request.md) | :heavy_check_mark: | Update Product Request |
@@ -0,0 +1,16 @@
1
+ # UpdateProductRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UpdateProductRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UpdateProductRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `description` | *string* | :heavy_minus_sign: | N/A |
16
+ | `name` | *string* | :heavy_minus_sign: | N/A |
@@ -0,0 +1,18 @@
1
+ # WaterfallCell
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WaterfallCell } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WaterfallCell = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
15
+ | `deferred` | *string* | :heavy_minus_sign: | details: closing deferred_revenue, ended months only |
16
+ | `period` | *string* | :heavy_minus_sign: | YYYY-MM |
17
+ | `revenue` | [models.RevenueBreakdown](../../sdk/models/revenue-breakdown.md) | :heavy_minus_sign: | N/A |
18
+ | `unbilled` | *string* | :heavy_minus_sign: | details: closing unbilled_receivable, ended months only |
@@ -0,0 +1,29 @@
1
+ # WaterfallRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WaterfallRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WaterfallRequest = {
9
+ currency: "Swiss Franc",
10
+ periodEnd: new Date("2026-06-12T15:56:05.804Z"),
11
+ periodStart: new Date("2024-05-28T02:35:46.087Z"),
12
+ };
13
+ ```
14
+
15
+ ## Fields
16
+
17
+ | Field | Type | Required | Description |
18
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
19
+ | `asOf` | *string* | :heavy_minus_sign: | report date: pending and scheduled split here; defaults to now |
20
+ | `contractIds` | *string*[] | :heavy_minus_sign: | N/A |
21
+ | `currency` | *string* | :heavy_check_mark: | N/A |
22
+ | `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
23
+ | `details` | *boolean* | :heavy_minus_sign: | month-end deferred and unbilled balances |
24
+ | `groupBy` | [models.RevenueReportGroupBy](../../sdk/models/revenue-report-group-by.md) | :heavy_minus_sign: | N/A |
25
+ | `limit` | *number* | :heavy_minus_sign: | rows per page; totals are never paged |
26
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
27
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | YYYY-MM, at most 36 months from period_start |
28
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | YYYY-MM |
29
+ | `pobIds` | *string*[] | :heavy_minus_sign: | N/A |
@@ -0,0 +1,17 @@
1
+ # WaterfallResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WaterfallResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WaterfallResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `items` | [models.WaterfallRow](../../sdk/models/waterfall-row.md)[] | :heavy_minus_sign: | N/A |
16
+ | `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
17
+ | `totals` | [models.WaterfallCell](../../sdk/models/waterfall-cell.md)[] | :heavy_minus_sign: | per period over all rows, never paged |
@@ -0,0 +1,18 @@
1
+ # WaterfallRow
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WaterfallRow } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WaterfallRow = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
+ | `cells` | [models.WaterfallCell](../../sdk/models/waterfall-cell.md)[] | :heavy_minus_sign: | one per requested period, in order |
16
+ | `contractId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
18
+ | `pobId` | *string* | :heavy_minus_sign: | N/A |
@@ -0,0 +1,78 @@
1
+ # AccountingPeriods
2
+
3
+ ## Overview
4
+
5
+ ### Available Operations
6
+
7
+ * [queryAccountingPeriod](#queryaccountingperiod) - Query accounting periods
8
+
9
+ ## queryAccountingPeriod
10
+
11
+ Use when listing the monthly accounting periods revenue recognition posts to, by period status or a period start range. Returns a paginated list.
12
+
13
+ ### Example Usage
14
+
15
+ <!-- UsageSnippet language="typescript" operationID="queryAccountingPeriod" method="post" path="/accounting_periods/search" -->
16
+ ```typescript
17
+ import { Flexprice } from "@flexprice/sdk";
18
+
19
+ const flexprice = new Flexprice({
20
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
21
+ });
22
+
23
+ async function run() {
24
+ const result = await flexprice.accountingPeriods.queryAccountingPeriod({});
25
+
26
+ console.log(result);
27
+ }
28
+
29
+ run();
30
+ ```
31
+
32
+ ### Standalone function
33
+
34
+ The standalone function version of this method:
35
+
36
+ ```typescript
37
+ import { FlexpriceCore } from "@flexprice/sdk/core.js";
38
+ import { accountingPeriodsQueryAccountingPeriod } from "@flexprice/sdk/funcs/accounting-periods-query-accounting-period.js";
39
+
40
+ // Use `FlexpriceCore` for best tree-shaking performance.
41
+ // You can create one instance of it to use across an application.
42
+ const flexprice = new FlexpriceCore({
43
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
44
+ });
45
+
46
+ async function run() {
47
+ const res = await accountingPeriodsQueryAccountingPeriod(flexprice, {});
48
+ if (res.ok) {
49
+ const { value: result } = res;
50
+ console.log(result);
51
+ } else {
52
+ console.log("accountingPeriodsQueryAccountingPeriod failed:", res.error);
53
+ }
54
+ }
55
+
56
+ run();
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ | Parameter | Type | Required | Description |
62
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
63
+ | `request` | [models.AccountingperiodFilter](../../sdk/models/accountingperiod-filter.md) | :heavy_check_mark: | The request object to use for the request. |
64
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
65
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
66
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
67
+
68
+ ### Response
69
+
70
+ **Promise\<[models.ListAccountingPeriodsResponse](../../sdk/models/list-accounting-periods-response.md)\>**
71
+
72
+ ### Errors
73
+
74
+ | Error Type | Status Code | Content Type |
75
+ | -------------------------- | -------------------------- | -------------------------- |
76
+ | models.ErrorsErrorResponse | 400 | application/json |
77
+ | models.ErrorsErrorResponse | 500 | application/json |
78
+ | models.SDKError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,150 @@
1
+ # Contracts
2
+
3
+ ## Overview
4
+
5
+ ### Available Operations
6
+
7
+ * [queryContract](#querycontract) - Query contracts
8
+ * [getContract](#getcontract) - Get contract
9
+
10
+ ## queryContract
11
+
12
+ Use when searching revenue recognition contracts by customer, subscription or contract status. Returns a paginated list.
13
+
14
+ ### Example Usage
15
+
16
+ <!-- UsageSnippet language="typescript" operationID="queryContract" method="post" path="/contracts/search" -->
17
+ ```typescript
18
+ import { Flexprice } from "@flexprice/sdk";
19
+
20
+ const flexprice = new Flexprice({
21
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
22
+ });
23
+
24
+ async function run() {
25
+ const result = await flexprice.contracts.queryContract({});
26
+
27
+ console.log(result);
28
+ }
29
+
30
+ run();
31
+ ```
32
+
33
+ ### Standalone function
34
+
35
+ The standalone function version of this method:
36
+
37
+ ```typescript
38
+ import { FlexpriceCore } from "@flexprice/sdk/core.js";
39
+ import { contractsQueryContract } from "@flexprice/sdk/funcs/contracts-query-contract.js";
40
+
41
+ // Use `FlexpriceCore` for best tree-shaking performance.
42
+ // You can create one instance of it to use across an application.
43
+ const flexprice = new FlexpriceCore({
44
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
45
+ });
46
+
47
+ async function run() {
48
+ const res = await contractsQueryContract(flexprice, {});
49
+ if (res.ok) {
50
+ const { value: result } = res;
51
+ console.log(result);
52
+ } else {
53
+ console.log("contractsQueryContract failed:", res.error);
54
+ }
55
+ }
56
+
57
+ run();
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Parameter | Type | Required | Description |
63
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
64
+ | `request` | [models.ContractFilter](../../sdk/models/contract-filter.md) | :heavy_check_mark: | The request object to use for the request. |
65
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
66
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
67
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
68
+
69
+ ### Response
70
+
71
+ **Promise\<[models.ListContractsResponse](../../sdk/models/list-contracts-response.md)\>**
72
+
73
+ ### Errors
74
+
75
+ | Error Type | Status Code | Content Type |
76
+ | -------------------------- | -------------------------- | -------------------------- |
77
+ | models.ErrorsErrorResponse | 400 | application/json |
78
+ | models.ErrorsErrorResponse | 500 | application/json |
79
+ | models.SDKError | 4XX, 5XX | \*/\* |
80
+
81
+ ## getContract
82
+
83
+ Use when you need to load a single revenue recognition contract with the subscriptions it covers. Contracts are derived from subscriptions and are read-only.
84
+
85
+ ### Example Usage
86
+
87
+ <!-- UsageSnippet language="typescript" operationID="getContract" method="get" path="/contracts/{id}" -->
88
+ ```typescript
89
+ import { Flexprice } from "@flexprice/sdk";
90
+
91
+ const flexprice = new Flexprice({
92
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
93
+ });
94
+
95
+ async function run() {
96
+ const result = await flexprice.contracts.getContract("<id>");
97
+
98
+ console.log(result);
99
+ }
100
+
101
+ run();
102
+ ```
103
+
104
+ ### Standalone function
105
+
106
+ The standalone function version of this method:
107
+
108
+ ```typescript
109
+ import { FlexpriceCore } from "@flexprice/sdk/core.js";
110
+ import { contractsGetContract } from "@flexprice/sdk/funcs/contracts-get-contract.js";
111
+
112
+ // Use `FlexpriceCore` for best tree-shaking performance.
113
+ // You can create one instance of it to use across an application.
114
+ const flexprice = new FlexpriceCore({
115
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
116
+ });
117
+
118
+ async function run() {
119
+ const res = await contractsGetContract(flexprice, "<id>");
120
+ if (res.ok) {
121
+ const { value: result } = res;
122
+ console.log(result);
123
+ } else {
124
+ console.log("contractsGetContract failed:", res.error);
125
+ }
126
+ }
127
+
128
+ run();
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ | Parameter | Type | Required | Description |
134
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
135
+ | `id` | *string* | :heavy_check_mark: | Contract ID |
136
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
137
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
138
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
139
+
140
+ ### Response
141
+
142
+ **Promise\<[models.ContractResponse](../../sdk/models/contract-response.md)\>**
143
+
144
+ ### Errors
145
+
146
+ | Error Type | Status Code | Content Type |
147
+ | -------------------------- | -------------------------- | -------------------------- |
148
+ | models.ErrorsErrorResponse | 400, 404 | application/json |
149
+ | models.ErrorsErrorResponse | 500 | application/json |
150
+ | models.SDKError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,150 @@
1
+ # JournalEntries
2
+
3
+ ## Overview
4
+
5
+ ### Available Operations
6
+
7
+ * [queryJournalEntry](#queryjournalentry) - Query journal entries
8
+ * [getJournalEntry](#getjournalentry) - Get journal entry
9
+
10
+ ## queryJournalEntry
11
+
12
+ Use when listing journal entries by period, event type, account, customer, contract, performance obligation or source. Returns a paginated list with lines.
13
+
14
+ ### Example Usage
15
+
16
+ <!-- UsageSnippet language="typescript" operationID="queryJournalEntry" method="post" path="/journal_entries/search" -->
17
+ ```typescript
18
+ import { Flexprice } from "@flexprice/sdk";
19
+
20
+ const flexprice = new Flexprice({
21
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
22
+ });
23
+
24
+ async function run() {
25
+ const result = await flexprice.journalEntries.queryJournalEntry({});
26
+
27
+ console.log(result);
28
+ }
29
+
30
+ run();
31
+ ```
32
+
33
+ ### Standalone function
34
+
35
+ The standalone function version of this method:
36
+
37
+ ```typescript
38
+ import { FlexpriceCore } from "@flexprice/sdk/core.js";
39
+ import { journalEntriesQueryJournalEntry } from "@flexprice/sdk/funcs/journal-entries-query-journal-entry.js";
40
+
41
+ // Use `FlexpriceCore` for best tree-shaking performance.
42
+ // You can create one instance of it to use across an application.
43
+ const flexprice = new FlexpriceCore({
44
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
45
+ });
46
+
47
+ async function run() {
48
+ const res = await journalEntriesQueryJournalEntry(flexprice, {});
49
+ if (res.ok) {
50
+ const { value: result } = res;
51
+ console.log(result);
52
+ } else {
53
+ console.log("journalEntriesQueryJournalEntry failed:", res.error);
54
+ }
55
+ }
56
+
57
+ run();
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Parameter | Type | Required | Description |
63
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
64
+ | `request` | [models.JournalFilter](../../sdk/models/journal-filter.md) | :heavy_check_mark: | The request object to use for the request. |
65
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
66
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
67
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
68
+
69
+ ### Response
70
+
71
+ **Promise\<[models.ListJournalEntriesResponse](../../sdk/models/list-journal-entries-response.md)\>**
72
+
73
+ ### Errors
74
+
75
+ | Error Type | Status Code | Content Type |
76
+ | -------------------------- | -------------------------- | -------------------------- |
77
+ | models.ErrorsErrorResponse | 400 | application/json |
78
+ | models.ErrorsErrorResponse | 500 | application/json |
79
+ | models.SDKError | 4XX, 5XX | \*/\* |
80
+
81
+ ## getJournalEntry
82
+
83
+ Use when you need one revenue recognition journal entry with its debit and credit lines. The journal is derived from billing and recognition and is read-only.
84
+
85
+ ### Example Usage
86
+
87
+ <!-- UsageSnippet language="typescript" operationID="getJournalEntry" method="get" path="/journal_entries/{id}" -->
88
+ ```typescript
89
+ import { Flexprice } from "@flexprice/sdk";
90
+
91
+ const flexprice = new Flexprice({
92
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
93
+ });
94
+
95
+ async function run() {
96
+ const result = await flexprice.journalEntries.getJournalEntry("<id>");
97
+
98
+ console.log(result);
99
+ }
100
+
101
+ run();
102
+ ```
103
+
104
+ ### Standalone function
105
+
106
+ The standalone function version of this method:
107
+
108
+ ```typescript
109
+ import { FlexpriceCore } from "@flexprice/sdk/core.js";
110
+ import { journalEntriesGetJournalEntry } from "@flexprice/sdk/funcs/journal-entries-get-journal-entry.js";
111
+
112
+ // Use `FlexpriceCore` for best tree-shaking performance.
113
+ // You can create one instance of it to use across an application.
114
+ const flexprice = new FlexpriceCore({
115
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
116
+ });
117
+
118
+ async function run() {
119
+ const res = await journalEntriesGetJournalEntry(flexprice, "<id>");
120
+ if (res.ok) {
121
+ const { value: result } = res;
122
+ console.log(result);
123
+ } else {
124
+ console.log("journalEntriesGetJournalEntry failed:", res.error);
125
+ }
126
+ }
127
+
128
+ run();
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ | Parameter | Type | Required | Description |
134
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
135
+ | `id` | *string* | :heavy_check_mark: | Journal entry ID |
136
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
137
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
138
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
139
+
140
+ ### Response
141
+
142
+ **Promise\<[models.JournalEntryResponse](../../sdk/models/journal-entry-response.md)\>**
143
+
144
+ ### Errors
145
+
146
+ | Error Type | Status Code | Content Type |
147
+ | -------------------------- | -------------------------- | -------------------------- |
148
+ | models.ErrorsErrorResponse | 400, 404 | application/json |
149
+ | models.ErrorsErrorResponse | 500 | application/json |
150
+ | models.SDKError | 4XX, 5XX | \*/\* |