orb-billing 1.0.1

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 (413) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +169 -0
  3. package/dist/index.d.ts +1 -0
  4. package/dist/index.js +20 -0
  5. package/dist/internal/utils/contenttype.d.ts +1 -0
  6. package/dist/internal/utils/contenttype.js +33 -0
  7. package/dist/internal/utils/headers.d.ts +4 -0
  8. package/dist/internal/utils/headers.js +92 -0
  9. package/dist/internal/utils/index.d.ts +8 -0
  10. package/dist/internal/utils/index.js +27 -0
  11. package/dist/internal/utils/pathparams.d.ts +2 -0
  12. package/dist/internal/utils/pathparams.js +53 -0
  13. package/dist/internal/utils/queryparams.d.ts +2 -0
  14. package/dist/internal/utils/queryparams.js +178 -0
  15. package/dist/internal/utils/requestbody.d.ts +2 -0
  16. package/dist/internal/utils/requestbody.js +318 -0
  17. package/dist/internal/utils/retries.d.ts +20 -0
  18. package/dist/internal/utils/retries.js +250 -0
  19. package/dist/internal/utils/security.d.ts +2 -0
  20. package/dist/internal/utils/security.js +188 -0
  21. package/dist/internal/utils/utils.d.ts +37 -0
  22. package/dist/internal/utils/utils.js +370 -0
  23. package/dist/sdk/availability.d.ts +19 -0
  24. package/dist/sdk/availability.js +135 -0
  25. package/dist/sdk/coupon.d.ts +53 -0
  26. package/dist/sdk/coupon.js +358 -0
  27. package/dist/sdk/credit.d.ts +142 -0
  28. package/dist/sdk/credit.js +501 -0
  29. package/dist/sdk/creditnote.d.ts +26 -0
  30. package/dist/sdk/creditnote.js +186 -0
  31. package/dist/sdk/customer.d.ts +264 -0
  32. package/dist/sdk/customer.js +958 -0
  33. package/dist/sdk/event.d.ts +258 -0
  34. package/dist/sdk/event.js +732 -0
  35. package/dist/sdk/index.d.ts +1 -0
  36. package/dist/sdk/index.js +20 -0
  37. package/dist/sdk/invoice.d.ts +60 -0
  38. package/dist/sdk/invoice.js +416 -0
  39. package/dist/sdk/models/operations/addledgerentryexternalid.d.ts +16 -0
  40. package/dist/sdk/models/operations/addledgerentryexternalid.js +95 -0
  41. package/dist/sdk/models/operations/amendevent.d.ts +23 -0
  42. package/dist/sdk/models/operations/amendevent.js +99 -0
  43. package/dist/sdk/models/operations/amendusage.d.ts +34 -0
  44. package/dist/sdk/models/operations/amendusage.js +122 -0
  45. package/dist/sdk/models/operations/amendusageexternalcustomerid.d.ts +34 -0
  46. package/dist/sdk/models/operations/amendusageexternalcustomerid.js +122 -0
  47. package/dist/sdk/models/operations/archivecoupon.d.ts +15 -0
  48. package/dist/sdk/models/operations/archivecoupon.js +91 -0
  49. package/dist/sdk/models/operations/cancelsubscription.d.ts +16 -0
  50. package/dist/sdk/models/operations/cancelsubscription.js +95 -0
  51. package/dist/sdk/models/operations/closebackfill.d.ts +15 -0
  52. package/dist/sdk/models/operations/closebackfill.js +91 -0
  53. package/dist/sdk/models/operations/createbackfill.d.ts +12 -0
  54. package/dist/sdk/models/operations/createbackfill.js +79 -0
  55. package/dist/sdk/models/operations/createcoupon.d.ts +12 -0
  56. package/dist/sdk/models/operations/createcoupon.js +79 -0
  57. package/dist/sdk/models/operations/createcustomer.d.ts +12 -0
  58. package/dist/sdk/models/operations/createcustomer.js +79 -0
  59. package/dist/sdk/models/operations/createcustomerbalancetransaction.d.ts +16 -0
  60. package/dist/sdk/models/operations/createcustomerbalancetransaction.js +95 -0
  61. package/dist/sdk/models/operations/createinvoicelineitem.d.ts +12 -0
  62. package/dist/sdk/models/operations/createinvoicelineitem.js +79 -0
  63. package/dist/sdk/models/operations/createledgerentry.d.ts +16 -0
  64. package/dist/sdk/models/operations/createledgerentry.js +95 -0
  65. package/dist/sdk/models/operations/createsubscription.d.ts +12 -0
  66. package/dist/sdk/models/operations/createsubscription.js +79 -0
  67. package/dist/sdk/models/operations/deletecustomer.d.ts +22 -0
  68. package/dist/sdk/models/operations/deletecustomer.js +78 -0
  69. package/dist/sdk/models/operations/deprecateevent.d.ts +22 -0
  70. package/dist/sdk/models/operations/deprecateevent.js +95 -0
  71. package/dist/sdk/models/operations/fetchcoupon.d.ts +15 -0
  72. package/dist/sdk/models/operations/fetchcoupon.js +91 -0
  73. package/dist/sdk/models/operations/fetchcreditnote.d.ts +18 -0
  74. package/dist/sdk/models/operations/fetchcreditnote.js +91 -0
  75. package/dist/sdk/models/operations/fetchcustomer.d.ts +18 -0
  76. package/dist/sdk/models/operations/fetchcustomer.js +91 -0
  77. package/dist/sdk/models/operations/fetchcustomercosts.d.ts +34 -0
  78. package/dist/sdk/models/operations/fetchcustomercosts.js +107 -0
  79. package/dist/sdk/models/operations/fetchcustomercostsexternalid.d.ts +31 -0
  80. package/dist/sdk/models/operations/fetchcustomercostsexternalid.js +107 -0
  81. package/dist/sdk/models/operations/fetchcustomercredits.d.ts +26 -0
  82. package/dist/sdk/models/operations/fetchcustomercredits.js +99 -0
  83. package/dist/sdk/models/operations/fetchcustomercreditsexternalid.d.ts +23 -0
  84. package/dist/sdk/models/operations/fetchcustomercreditsexternalid.js +99 -0
  85. package/dist/sdk/models/operations/fetchcustomercreditsledger.d.ts +35 -0
  86. package/dist/sdk/models/operations/fetchcustomercreditsledger.js +111 -0
  87. package/dist/sdk/models/operations/fetchcustomercreditsledgerexternalid.d.ts +35 -0
  88. package/dist/sdk/models/operations/fetchcustomercreditsledgerexternalid.js +111 -0
  89. package/dist/sdk/models/operations/fetchcustomerexternalid.d.ts +15 -0
  90. package/dist/sdk/models/operations/fetchcustomerexternalid.js +91 -0
  91. package/dist/sdk/models/operations/fetchinvoice.d.ts +15 -0
  92. package/dist/sdk/models/operations/fetchinvoice.js +91 -0
  93. package/dist/sdk/models/operations/fetchplan.d.ts +15 -0
  94. package/dist/sdk/models/operations/fetchplan.js +91 -0
  95. package/dist/sdk/models/operations/fetchplanexternalid.d.ts +15 -0
  96. package/dist/sdk/models/operations/fetchplanexternalid.js +91 -0
  97. package/dist/sdk/models/operations/fetchsubscription.d.ts +15 -0
  98. package/dist/sdk/models/operations/fetchsubscription.js +91 -0
  99. package/dist/sdk/models/operations/fetchsubscriptioncosts.d.ts +31 -0
  100. package/dist/sdk/models/operations/fetchsubscriptioncosts.js +107 -0
  101. package/dist/sdk/models/operations/fetchsubscriptionschedule.d.ts +23 -0
  102. package/dist/sdk/models/operations/fetchsubscriptionschedule.js +99 -0
  103. package/dist/sdk/models/operations/fetchsubscriptionusage.d.ts +39 -0
  104. package/dist/sdk/models/operations/fetchsubscriptionusage.js +115 -0
  105. package/dist/sdk/models/operations/fetchupcominginvoice.d.ts +15 -0
  106. package/dist/sdk/models/operations/fetchupcominginvoice.js +91 -0
  107. package/dist/sdk/models/operations/index.d.ts +55 -0
  108. package/dist/sdk/models/operations/index.js +74 -0
  109. package/dist/sdk/models/operations/ingest.d.ts +30 -0
  110. package/dist/sdk/models/operations/ingest.js +118 -0
  111. package/dist/sdk/models/operations/issueinvoice.d.ts +19 -0
  112. package/dist/sdk/models/operations/issueinvoice.js +95 -0
  113. package/dist/sdk/models/operations/listbackfills.d.ts +22 -0
  114. package/dist/sdk/models/operations/listbackfills.js +95 -0
  115. package/dist/sdk/models/operations/listbalancetransactions.d.ts +23 -0
  116. package/dist/sdk/models/operations/listbalancetransactions.js +99 -0
  117. package/dist/sdk/models/operations/listcoupons.d.ts +30 -0
  118. package/dist/sdk/models/operations/listcoupons.js +103 -0
  119. package/dist/sdk/models/operations/listcouponsubscriptions.d.ts +15 -0
  120. package/dist/sdk/models/operations/listcouponsubscriptions.js +91 -0
  121. package/dist/sdk/models/operations/listcreditnote.d.ts +34 -0
  122. package/dist/sdk/models/operations/listcreditnote.js +107 -0
  123. package/dist/sdk/models/operations/listcustomers.d.ts +22 -0
  124. package/dist/sdk/models/operations/listcustomers.js +95 -0
  125. package/dist/sdk/models/operations/listinvoices.d.ts +38 -0
  126. package/dist/sdk/models/operations/listinvoices.js +111 -0
  127. package/dist/sdk/models/operations/listplans.d.ts +22 -0
  128. package/dist/sdk/models/operations/listplans.js +95 -0
  129. package/dist/sdk/models/operations/listsubscriptions.d.ts +24 -0
  130. package/dist/sdk/models/operations/listsubscriptions.js +103 -0
  131. package/dist/sdk/models/operations/ping.d.ts +12 -0
  132. package/dist/sdk/models/operations/ping.js +79 -0
  133. package/dist/sdk/models/operations/revertbackfill.d.ts +15 -0
  134. package/dist/sdk/models/operations/revertbackfill.js +91 -0
  135. package/dist/sdk/models/operations/scheduleplanchange.d.ts +16 -0
  136. package/dist/sdk/models/operations/scheduleplanchange.js +95 -0
  137. package/dist/sdk/models/operations/searchevents.d.ts +23 -0
  138. package/dist/sdk/models/operations/searchevents.js +99 -0
  139. package/dist/sdk/models/operations/unschedulecancellation.d.ts +15 -0
  140. package/dist/sdk/models/operations/unschedulecancellation.js +91 -0
  141. package/dist/sdk/models/operations/unscheduleplanchange.d.ts +15 -0
  142. package/dist/sdk/models/operations/unscheduleplanchange.js +91 -0
  143. package/dist/sdk/models/operations/updatecustomer.d.ts +19 -0
  144. package/dist/sdk/models/operations/updatecustomer.js +95 -0
  145. package/dist/sdk/models/operations/updatecustomerexternalid.d.ts +16 -0
  146. package/dist/sdk/models/operations/updatecustomerexternalid.js +95 -0
  147. package/dist/sdk/models/operations/updatefixedfeequantity.d.ts +16 -0
  148. package/dist/sdk/models/operations/updatefixedfeequantity.js +95 -0
  149. package/dist/sdk/models/operations/voidinvoice.d.ts +19 -0
  150. package/dist/sdk/models/operations/voidinvoice.js +95 -0
  151. package/dist/sdk/models/shared/action.d.ts +8 -0
  152. package/dist/sdk/models/shared/action.js +15 -0
  153. package/dist/sdk/models/shared/amendedevent.d.ts +28 -0
  154. package/dist/sdk/models/shared/amendedevent.js +81 -0
  155. package/dist/sdk/models/shared/amendedusage.d.ts +16 -0
  156. package/dist/sdk/models/shared/amendedusage.js +62 -0
  157. package/dist/sdk/models/shared/amendeventresult.d.ts +10 -0
  158. package/dist/sdk/models/shared/amendeventresult.js +48 -0
  159. package/dist/sdk/models/shared/autocollection.d.ts +18 -0
  160. package/dist/sdk/models/shared/autocollection.js +66 -0
  161. package/dist/sdk/models/shared/availability.d.ts +7 -0
  162. package/dist/sdk/models/shared/availability.js +48 -0
  163. package/dist/sdk/models/shared/backfill.d.ts +27 -0
  164. package/dist/sdk/models/shared/backfill.js +104 -0
  165. package/dist/sdk/models/shared/backfills.d.ts +10 -0
  166. package/dist/sdk/models/shared/backfills.js +57 -0
  167. package/dist/sdk/models/shared/backfillstatus.d.ts +9 -0
  168. package/dist/sdk/models/shared/backfillstatus.js +16 -0
  169. package/dist/sdk/models/shared/billablemetric.d.ts +4 -0
  170. package/dist/sdk/models/shared/billablemetric.js +45 -0
  171. package/dist/sdk/models/shared/billablemetricminified.d.ts +5 -0
  172. package/dist/sdk/models/shared/billablemetricminified.js +50 -0
  173. package/dist/sdk/models/shared/bpsconfig.d.ts +8 -0
  174. package/dist/sdk/models/shared/bpsconfig.js +53 -0
  175. package/dist/sdk/models/shared/bpspriceoverride.d.ts +24 -0
  176. package/dist/sdk/models/shared/bpspriceoverride.js +74 -0
  177. package/dist/sdk/models/shared/bpstier.d.ts +7 -0
  178. package/dist/sdk/models/shared/bpstier.js +60 -0
  179. package/dist/sdk/models/shared/bulkbpsconfig.d.ts +8 -0
  180. package/dist/sdk/models/shared/bulkbpsconfig.js +50 -0
  181. package/dist/sdk/models/shared/bulkbpspriceoverride.d.ts +24 -0
  182. package/dist/sdk/models/shared/bulkbpspriceoverride.js +74 -0
  183. package/dist/sdk/models/shared/bulkbpstier.d.ts +6 -0
  184. package/dist/sdk/models/shared/bulkbpstier.js +55 -0
  185. package/dist/sdk/models/shared/bulkconfig.d.ts +8 -0
  186. package/dist/sdk/models/shared/bulkconfig.js +50 -0
  187. package/dist/sdk/models/shared/bulkpriceoverride.d.ts +24 -0
  188. package/dist/sdk/models/shared/bulkpriceoverride.js +74 -0
  189. package/dist/sdk/models/shared/bulktier.d.ts +5 -0
  190. package/dist/sdk/models/shared/bulktier.js +50 -0
  191. package/dist/sdk/models/shared/cadence.d.ts +5 -0
  192. package/dist/sdk/models/shared/cadence.js +12 -0
  193. package/dist/sdk/models/shared/canceloption.d.ts +8 -0
  194. package/dist/sdk/models/shared/canceloption.js +15 -0
  195. package/dist/sdk/models/shared/changeoption.d.ts +8 -0
  196. package/dist/sdk/models/shared/changeoption.js +15 -0
  197. package/dist/sdk/models/shared/changeoption1.d.ts +8 -0
  198. package/dist/sdk/models/shared/changeoption1.js +15 -0
  199. package/dist/sdk/models/shared/coupon.d.ts +36 -0
  200. package/dist/sdk/models/shared/coupon.js +88 -0
  201. package/dist/sdk/models/shared/coupons.d.ts +10 -0
  202. package/dist/sdk/models/shared/coupons.js +57 -0
  203. package/dist/sdk/models/shared/credit.d.ts +16 -0
  204. package/dist/sdk/models/shared/credit.js +64 -0
  205. package/dist/sdk/models/shared/creditblock.d.ts +15 -0
  206. package/dist/sdk/models/shared/creditblock.js +58 -0
  207. package/dist/sdk/models/shared/creditledgerentries.d.ts +10 -0
  208. package/dist/sdk/models/shared/creditledgerentries.js +57 -0
  209. package/dist/sdk/models/shared/creditledgerentry.d.ts +58 -0
  210. package/dist/sdk/models/shared/creditledgerentry.js +144 -0
  211. package/dist/sdk/models/shared/creditnote.d.ts +71 -0
  212. package/dist/sdk/models/shared/creditnote.js +134 -0
  213. package/dist/sdk/models/shared/creditnotelineitem.d.ts +38 -0
  214. package/dist/sdk/models/shared/creditnotelineitem.js +86 -0
  215. package/dist/sdk/models/shared/creditnotes.d.ts +10 -0
  216. package/dist/sdk/models/shared/creditnotes.js +57 -0
  217. package/dist/sdk/models/shared/creditnotesummary.d.ts +9 -0
  218. package/dist/sdk/models/shared/creditnotesummary.js +74 -0
  219. package/dist/sdk/models/shared/creditnotetype.d.ts +7 -0
  220. package/dist/sdk/models/shared/creditnotetype.js +14 -0
  221. package/dist/sdk/models/shared/credits.d.ts +10 -0
  222. package/dist/sdk/models/shared/credits.js +57 -0
  223. package/dist/sdk/models/shared/customer.d.ts +227 -0
  224. package/dist/sdk/models/shared/customer.js +364 -0
  225. package/dist/sdk/models/shared/customerbalancetransaction.d.ts +57 -0
  226. package/dist/sdk/models/shared/customerbalancetransaction.js +133 -0
  227. package/dist/sdk/models/shared/customercost.d.ts +15 -0
  228. package/dist/sdk/models/shared/customercost.js +75 -0
  229. package/dist/sdk/models/shared/customercosts.d.ts +8 -0
  230. package/dist/sdk/models/shared/customercosts.js +50 -0
  231. package/dist/sdk/models/shared/customerminified.d.ts +8 -0
  232. package/dist/sdk/models/shared/customerminified.js +53 -0
  233. package/dist/sdk/models/shared/customers.d.ts +10 -0
  234. package/dist/sdk/models/shared/customers.js +57 -0
  235. package/dist/sdk/models/shared/debug.d.ts +8 -0
  236. package/dist/sdk/models/shared/debug.js +53 -0
  237. package/dist/sdk/models/shared/deprecatedeventresult.d.ts +10 -0
  238. package/dist/sdk/models/shared/deprecatedeventresult.js +48 -0
  239. package/dist/sdk/models/shared/discount.d.ts +25 -0
  240. package/dist/sdk/models/shared/discount.js +71 -0
  241. package/dist/sdk/models/shared/discounttype.d.ts +6 -0
  242. package/dist/sdk/models/shared/discounttype.js +13 -0
  243. package/dist/sdk/models/shared/durationunit.d.ts +8 -0
  244. package/dist/sdk/models/shared/durationunit.js +15 -0
  245. package/dist/sdk/models/shared/entrystatus.d.ts +7 -0
  246. package/dist/sdk/models/shared/entrystatus.js +14 -0
  247. package/dist/sdk/models/shared/entrytype.d.ts +9 -0
  248. package/dist/sdk/models/shared/entrytype.js +16 -0
  249. package/dist/sdk/models/shared/event.d.ts +32 -0
  250. package/dist/sdk/models/shared/event.js +82 -0
  251. package/dist/sdk/models/shared/eventsearchcriteria.d.ts +11 -0
  252. package/dist/sdk/models/shared/eventsearchcriteria.js +50 -0
  253. package/dist/sdk/models/shared/eventsearchresults.d.ts +10 -0
  254. package/dist/sdk/models/shared/eventsearchresults.js +57 -0
  255. package/dist/sdk/models/shared/externalmarketplace.d.ts +8 -0
  256. package/dist/sdk/models/shared/externalmarketplace.js +15 -0
  257. package/dist/sdk/models/shared/fixedfeequantitychange.d.ts +18 -0
  258. package/dist/sdk/models/shared/fixedfeequantitychange.js +66 -0
  259. package/dist/sdk/models/shared/fixedfeequantityschedule.d.ts +7 -0
  260. package/dist/sdk/models/shared/fixedfeequantityschedule.js +68 -0
  261. package/dist/sdk/models/shared/granularity.d.ts +6 -0
  262. package/dist/sdk/models/shared/granularity.js +13 -0
  263. package/dist/sdk/models/shared/grouping.d.ts +8 -0
  264. package/dist/sdk/models/shared/grouping.js +53 -0
  265. package/dist/sdk/models/shared/index.d.ts +125 -0
  266. package/dist/sdk/models/shared/index.js +144 -0
  267. package/dist/sdk/models/shared/ingestionresponse.d.ts +13 -0
  268. package/dist/sdk/models/shared/ingestionresponse.js +57 -0
  269. package/dist/sdk/models/shared/invoice.d.ts +274 -0
  270. package/dist/sdk/models/shared/invoice.js +460 -0
  271. package/dist/sdk/models/shared/invoicelineitem.d.ts +207 -0
  272. package/dist/sdk/models/shared/invoicelineitem.js +416 -0
  273. package/dist/sdk/models/shared/invoices.d.ts +10 -0
  274. package/dist/sdk/models/shared/invoices.js +57 -0
  275. package/dist/sdk/models/shared/invoicesettings.d.ts +18 -0
  276. package/dist/sdk/models/shared/invoicesettings.js +58 -0
  277. package/dist/sdk/models/shared/invoicestatus.d.ts +10 -0
  278. package/dist/sdk/models/shared/invoicestatus.js +17 -0
  279. package/dist/sdk/models/shared/lineitem.d.ts +58 -0
  280. package/dist/sdk/models/shared/lineitem.js +147 -0
  281. package/dist/sdk/models/shared/matrixconfig.d.ts +13 -0
  282. package/dist/sdk/models/shared/matrixconfig.js +60 -0
  283. package/dist/sdk/models/shared/matrixconfig1.d.ts +10 -0
  284. package/dist/sdk/models/shared/matrixconfig1.js +48 -0
  285. package/dist/sdk/models/shared/matrixvalue.d.ts +8 -0
  286. package/dist/sdk/models/shared/matrixvalue.js +50 -0
  287. package/dist/sdk/models/shared/modeltype.d.ts +10 -0
  288. package/dist/sdk/models/shared/modeltype.js +17 -0
  289. package/dist/sdk/models/shared/newbackfill.d.ts +27 -0
  290. package/dist/sdk/models/shared/newbackfill.js +82 -0
  291. package/dist/sdk/models/shared/newcoupon.d.ts +24 -0
  292. package/dist/sdk/models/shared/newcoupon.js +69 -0
  293. package/dist/sdk/models/shared/newcreditledgerentry.d.ts +44 -0
  294. package/dist/sdk/models/shared/newcreditledgerentry.js +109 -0
  295. package/dist/sdk/models/shared/newcustomer.d.ts +202 -0
  296. package/dist/sdk/models/shared/newcustomer.js +324 -0
  297. package/dist/sdk/models/shared/newinvoicelineitem.d.ts +28 -0
  298. package/dist/sdk/models/shared/newinvoicelineitem.js +79 -0
  299. package/dist/sdk/models/shared/newsubscription.d.ts +79 -0
  300. package/dist/sdk/models/shared/newsubscription.js +145 -0
  301. package/dist/sdk/models/shared/newtransaction.d.ts +10 -0
  302. package/dist/sdk/models/shared/newtransaction.js +56 -0
  303. package/dist/sdk/models/shared/packageconfig.d.ts +8 -0
  304. package/dist/sdk/models/shared/packageconfig.js +53 -0
  305. package/dist/sdk/models/shared/packagepriceoverride.d.ts +24 -0
  306. package/dist/sdk/models/shared/packagepriceoverride.js +74 -0
  307. package/dist/sdk/models/shared/paginationmetadata.d.ts +5 -0
  308. package/dist/sdk/models/shared/paginationmetadata.js +50 -0
  309. package/dist/sdk/models/shared/perpricecost.d.ts +24 -0
  310. package/dist/sdk/models/shared/perpricecost.js +67 -0
  311. package/dist/sdk/models/shared/phaseoverride.d.ts +40 -0
  312. package/dist/sdk/models/shared/phaseoverride.js +100 -0
  313. package/dist/sdk/models/shared/plan.d.ts +101 -0
  314. package/dist/sdk/models/shared/plan.js +250 -0
  315. package/dist/sdk/models/shared/planminified.d.ts +5 -0
  316. package/dist/sdk/models/shared/planminified.js +50 -0
  317. package/dist/sdk/models/shared/planphase.d.ts +68 -0
  318. package/dist/sdk/models/shared/planphase.js +162 -0
  319. package/dist/sdk/models/shared/plans.d.ts +10 -0
  320. package/dist/sdk/models/shared/plans.js +57 -0
  321. package/dist/sdk/models/shared/price.d.ts +114 -0
  322. package/dist/sdk/models/shared/price.js +245 -0
  323. package/dist/sdk/models/shared/pricegroup.d.ts +17 -0
  324. package/dist/sdk/models/shared/pricegroup.js +65 -0
  325. package/dist/sdk/models/shared/product.d.ts +6 -0
  326. package/dist/sdk/models/shared/product.js +59 -0
  327. package/dist/sdk/models/shared/reason.d.ts +9 -0
  328. package/dist/sdk/models/shared/reason.js +16 -0
  329. package/dist/sdk/models/shared/requestvalidationerror.d.ts +20 -0
  330. package/dist/sdk/models/shared/requestvalidationerror.js +65 -0
  331. package/dist/sdk/models/shared/security.d.ts +4 -0
  332. package/dist/sdk/models/shared/security.js +45 -0
  333. package/dist/sdk/models/shared/sublineitem.d.ts +32 -0
  334. package/dist/sdk/models/shared/sublineitem.js +102 -0
  335. package/dist/sdk/models/shared/sublineitem1.d.ts +24 -0
  336. package/dist/sdk/models/shared/sublineitem1.js +75 -0
  337. package/dist/sdk/models/shared/sublineitem2.d.ts +6 -0
  338. package/dist/sdk/models/shared/sublineitem2.js +55 -0
  339. package/dist/sdk/models/shared/subscription.d.ts +95 -0
  340. package/dist/sdk/models/shared/subscription.js +207 -0
  341. package/dist/sdk/models/shared/subscriptioncancellation.d.ts +12 -0
  342. package/dist/sdk/models/shared/subscriptioncancellation.js +55 -0
  343. package/dist/sdk/models/shared/subscriptioncost.d.ts +15 -0
  344. package/dist/sdk/models/shared/subscriptioncost.js +75 -0
  345. package/dist/sdk/models/shared/subscriptioncosts.d.ts +8 -0
  346. package/dist/sdk/models/shared/subscriptioncosts.js +50 -0
  347. package/dist/sdk/models/shared/subscriptionminified.d.ts +7 -0
  348. package/dist/sdk/models/shared/subscriptionminified.js +48 -0
  349. package/dist/sdk/models/shared/subscriptionplanchange.d.ts +54 -0
  350. package/dist/sdk/models/shared/subscriptionplanchange.js +104 -0
  351. package/dist/sdk/models/shared/subscriptions.d.ts +10 -0
  352. package/dist/sdk/models/shared/subscriptions.js +57 -0
  353. package/dist/sdk/models/shared/subscriptionschedule.d.ts +10 -0
  354. package/dist/sdk/models/shared/subscriptionschedule.js +57 -0
  355. package/dist/sdk/models/shared/subscriptionscheduleitem.d.ts +7 -0
  356. package/dist/sdk/models/shared/subscriptionscheduleitem.js +65 -0
  357. package/dist/sdk/models/shared/subscriptionstatus.d.ts +5 -0
  358. package/dist/sdk/models/shared/subscriptionstatus.js +12 -0
  359. package/dist/sdk/models/shared/subscriptionusage.d.ts +8 -0
  360. package/dist/sdk/models/shared/subscriptionusage.js +50 -0
  361. package/dist/sdk/models/shared/taxamount.d.ts +15 -0
  362. package/dist/sdk/models/shared/taxamount.js +55 -0
  363. package/dist/sdk/models/shared/tier.d.ts +6 -0
  364. package/dist/sdk/models/shared/tier.js +55 -0
  365. package/dist/sdk/models/shared/tier7.d.ts +7 -0
  366. package/dist/sdk/models/shared/tier7.js +60 -0
  367. package/dist/sdk/models/shared/tierconfig.d.ts +9 -0
  368. package/dist/sdk/models/shared/tierconfig.js +58 -0
  369. package/dist/sdk/models/shared/tieredbpsconfig.d.ts +8 -0
  370. package/dist/sdk/models/shared/tieredbpsconfig.js +50 -0
  371. package/dist/sdk/models/shared/tieredbpsconfig1.d.ts +5 -0
  372. package/dist/sdk/models/shared/tieredbpsconfig1.js +47 -0
  373. package/dist/sdk/models/shared/tieredbpspriceoverride.d.ts +21 -0
  374. package/dist/sdk/models/shared/tieredbpspriceoverride.js +74 -0
  375. package/dist/sdk/models/shared/tieredconfig.d.ts +8 -0
  376. package/dist/sdk/models/shared/tieredconfig.js +50 -0
  377. package/dist/sdk/models/shared/tieredpriceoverride.d.ts +27 -0
  378. package/dist/sdk/models/shared/tieredpriceoverride.js +74 -0
  379. package/dist/sdk/models/shared/transactions.d.ts +10 -0
  380. package/dist/sdk/models/shared/transactions.js +57 -0
  381. package/dist/sdk/models/shared/transactiontype.d.ts +4 -0
  382. package/dist/sdk/models/shared/transactiontype.js +11 -0
  383. package/dist/sdk/models/shared/trialconfig.d.ts +8 -0
  384. package/dist/sdk/models/shared/trialconfig.js +54 -0
  385. package/dist/sdk/models/shared/type.d.ts +7 -0
  386. package/dist/sdk/models/shared/type.js +14 -0
  387. package/dist/sdk/models/shared/unitconfig.d.ts +7 -0
  388. package/dist/sdk/models/shared/unitconfig.js +48 -0
  389. package/dist/sdk/models/shared/unitpriceoverride.d.ts +24 -0
  390. package/dist/sdk/models/shared/unitpriceoverride.js +74 -0
  391. package/dist/sdk/models/shared/upcominginvoice.d.ts +95 -0
  392. package/dist/sdk/models/shared/upcominginvoice.js +193 -0
  393. package/dist/sdk/models/shared/updateevent.d.ts +28 -0
  394. package/dist/sdk/models/shared/updateevent.js +77 -0
  395. package/dist/sdk/models/shared/usage.d.ts +13 -0
  396. package/dist/sdk/models/shared/usage.js +69 -0
  397. package/dist/sdk/models/shared/usageitem.d.ts +6 -0
  398. package/dist/sdk/models/shared/usageitem.js +63 -0
  399. package/dist/sdk/models/shared/validationerrors.d.ts +13 -0
  400. package/dist/sdk/models/shared/validationerrors.js +59 -0
  401. package/dist/sdk/models/shared/viewmode.d.ts +7 -0
  402. package/dist/sdk/models/shared/viewmode.js +14 -0
  403. package/dist/sdk/plan.d.ts +222 -0
  404. package/dist/sdk/plan.js +422 -0
  405. package/dist/sdk/sdk.d.ts +298 -0
  406. package/dist/sdk/sdk.js +110 -0
  407. package/dist/sdk/subscription.d.ts +614 -0
  408. package/dist/sdk/subscription.js +1192 -0
  409. package/dist/sdk/types/index.d.ts +1 -0
  410. package/dist/sdk/types/index.js +20 -0
  411. package/dist/sdk/types/rfcdate.d.ts +9 -0
  412. package/dist/sdk/types/rfcdate.js +59 -0
  413. package/package.json +33 -0
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
4
+ */
5
+ var __extends = (this && this.__extends) || (function () {
6
+ var extendStatics = function (d, b) {
7
+ extendStatics = Object.setPrototypeOf ||
8
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
9
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
10
+ return extendStatics(d, b);
11
+ };
12
+ return function (d, b) {
13
+ if (typeof b !== "function" && b !== null)
14
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
15
+ extendStatics(d, b);
16
+ function __() { this.constructor = d; }
17
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
18
+ };
19
+ })();
20
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
21
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
22
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
23
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
24
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
25
+ };
26
+ var __metadata = (this && this.__metadata) || function (k, v) {
27
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
28
+ };
29
+ Object.defineProperty(exports, "__esModule", { value: true });
30
+ exports.UnitConfig = void 0;
31
+ var utils_1 = require("../../../internal/utils");
32
+ var class_transformer_1 = require("class-transformer");
33
+ /**
34
+ * Provided when model_type is `unit`
35
+ */
36
+ var UnitConfig = /** @class */ (function (_super) {
37
+ __extends(UnitConfig, _super);
38
+ function UnitConfig() {
39
+ return _super !== null && _super.apply(this, arguments) || this;
40
+ }
41
+ __decorate([
42
+ (0, utils_1.SpeakeasyMetadata)(),
43
+ (0, class_transformer_1.Expose)({ name: "unit_amount" }),
44
+ __metadata("design:type", String)
45
+ ], UnitConfig.prototype, "unitAmount", void 0);
46
+ return UnitConfig;
47
+ }(utils_1.SpeakeasyBase));
48
+ exports.UnitConfig = UnitConfig;
@@ -0,0 +1,24 @@
1
+ import { SpeakeasyBase } from "../../../internal/utils";
2
+ import { UnitConfig } from "./unitconfig";
3
+ export declare enum UnitPriceOverrideModelType {
4
+ Unit = "unit"
5
+ }
6
+ /**
7
+ * Unit price override
8
+ */
9
+ export declare class UnitPriceOverride extends SpeakeasyBase {
10
+ id: string;
11
+ /**
12
+ * The subscription's override maximum amount for this price.
13
+ */
14
+ maximumAmount?: string;
15
+ /**
16
+ * The subscription's override minimum amount for this price.
17
+ */
18
+ minimumAmount?: string;
19
+ modelType: UnitPriceOverrideModelType;
20
+ /**
21
+ * Provided when model_type is `unit`
22
+ */
23
+ unitConfig: UnitConfig;
24
+ }
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
4
+ */
5
+ var __extends = (this && this.__extends) || (function () {
6
+ var extendStatics = function (d, b) {
7
+ extendStatics = Object.setPrototypeOf ||
8
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
9
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
10
+ return extendStatics(d, b);
11
+ };
12
+ return function (d, b) {
13
+ if (typeof b !== "function" && b !== null)
14
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
15
+ extendStatics(d, b);
16
+ function __() { this.constructor = d; }
17
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
18
+ };
19
+ })();
20
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
21
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
22
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
23
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
24
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
25
+ };
26
+ var __metadata = (this && this.__metadata) || function (k, v) {
27
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
28
+ };
29
+ Object.defineProperty(exports, "__esModule", { value: true });
30
+ exports.UnitPriceOverride = exports.UnitPriceOverrideModelType = void 0;
31
+ var utils_1 = require("../../../internal/utils");
32
+ var unitconfig_1 = require("./unitconfig");
33
+ var class_transformer_1 = require("class-transformer");
34
+ var UnitPriceOverrideModelType;
35
+ (function (UnitPriceOverrideModelType) {
36
+ UnitPriceOverrideModelType["Unit"] = "unit";
37
+ })(UnitPriceOverrideModelType = exports.UnitPriceOverrideModelType || (exports.UnitPriceOverrideModelType = {}));
38
+ /**
39
+ * Unit price override
40
+ */
41
+ var UnitPriceOverride = /** @class */ (function (_super) {
42
+ __extends(UnitPriceOverride, _super);
43
+ function UnitPriceOverride() {
44
+ return _super !== null && _super.apply(this, arguments) || this;
45
+ }
46
+ __decorate([
47
+ (0, utils_1.SpeakeasyMetadata)(),
48
+ (0, class_transformer_1.Expose)({ name: "id" }),
49
+ __metadata("design:type", String)
50
+ ], UnitPriceOverride.prototype, "id", void 0);
51
+ __decorate([
52
+ (0, utils_1.SpeakeasyMetadata)(),
53
+ (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
54
+ __metadata("design:type", String)
55
+ ], UnitPriceOverride.prototype, "maximumAmount", void 0);
56
+ __decorate([
57
+ (0, utils_1.SpeakeasyMetadata)(),
58
+ (0, class_transformer_1.Expose)({ name: "minimum_amount" }),
59
+ __metadata("design:type", String)
60
+ ], UnitPriceOverride.prototype, "minimumAmount", void 0);
61
+ __decorate([
62
+ (0, utils_1.SpeakeasyMetadata)(),
63
+ (0, class_transformer_1.Expose)({ name: "model_type" }),
64
+ __metadata("design:type", String)
65
+ ], UnitPriceOverride.prototype, "modelType", void 0);
66
+ __decorate([
67
+ (0, utils_1.SpeakeasyMetadata)(),
68
+ (0, class_transformer_1.Expose)({ name: "unit_config" }),
69
+ (0, class_transformer_1.Type)(function () { return unitconfig_1.UnitConfig; }),
70
+ __metadata("design:type", unitconfig_1.UnitConfig)
71
+ ], UnitPriceOverride.prototype, "unitConfig", void 0);
72
+ return UnitPriceOverride;
73
+ }(utils_1.SpeakeasyBase));
74
+ exports.UnitPriceOverride = UnitPriceOverride;
@@ -0,0 +1,95 @@
1
+ import { SpeakeasyBase } from "../../../internal/utils";
2
+ import { RFCDate } from "../../types";
3
+ import { CustomerMinified } from "./customerminified";
4
+ import { DiscountType } from "./discounttype";
5
+ import { LineItem } from "./lineitem";
6
+ import { SubscriptionMinified } from "./subscriptionminified";
7
+ export declare class UpcomingInvoiceDiscount extends SpeakeasyBase {
8
+ /**
9
+ * Only available if discount_type is `amount`.
10
+ */
11
+ amountDiscount?: string;
12
+ /**
13
+ * List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
14
+ */
15
+ appliesToPriceIds?: string[];
16
+ discountType: DiscountType;
17
+ /**
18
+ * Only available if discount_type is `percentage`.This is a number between 0 and 1.
19
+ */
20
+ percentageDiscount?: number;
21
+ /**
22
+ * Only available if discount_type is `trial`
23
+ */
24
+ trialAmountDiscount?: string;
25
+ /**
26
+ * Only available if discount_type is `usage`. Number of usage units that this discount is for
27
+ */
28
+ usageDiscount?: number;
29
+ }
30
+ export declare class UpcomingInvoiceMaximumAmount extends SpeakeasyBase {
31
+ /**
32
+ * List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
33
+ */
34
+ appliesToPriceIds: string[];
35
+ /**
36
+ * Maximum amount applied
37
+ */
38
+ maximumAmount: string;
39
+ }
40
+ export declare class UpcomingInvoiceMinimumAmount extends SpeakeasyBase {
41
+ /**
42
+ * List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
43
+ */
44
+ appliesToPriceIds: string[];
45
+ /**
46
+ * Minimum amount applied
47
+ */
48
+ minimumAmount: string;
49
+ }
50
+ /**
51
+ * Upcoming invoices contain a line-by-line breakdown of an upcoming amount due for a subscription, including incurred usage in the billing period as well as any recurring fees.
52
+ *
53
+ * @remarks
54
+ *
55
+ * Although each line item will be invoiced on the `target_date`, each invoice line item may have distinct date ranges (e.g. for usage billed in arrears, the range may specify the current month whereas an in-advance recurring fees will be for the following month).
56
+ *
57
+ * Since an invoice resource has not been created for this upcoming invoice, this endpoint intentionally does not return an `id` field.
58
+ */
59
+ export declare class UpcomingInvoice extends SpeakeasyBase {
60
+ /**
61
+ * The final amount to be charged to the customer after all minimums and discounts have been applied. Only populated for non-pre-paid plans.
62
+ */
63
+ amountDue: string;
64
+ /**
65
+ * An ISO 4217 currency string or `credits`
66
+ */
67
+ currency: string;
68
+ /**
69
+ * The customer receiving this invoice.
70
+ */
71
+ customer: CustomerMinified;
72
+ discount: UpcomingInvoiceDiscount;
73
+ /**
74
+ * A URL for the invoice portal.
75
+ */
76
+ hostedInvoiceUrl: string;
77
+ /**
78
+ * The breakdown of prices in this invoice.
79
+ */
80
+ lineItems: LineItem[];
81
+ maximum?: UpcomingInvoiceMaximumAmount;
82
+ minimum: UpcomingInvoiceMinimumAmount;
83
+ /**
84
+ * The associated subscription for this invoice.
85
+ */
86
+ subscription: SubscriptionMinified;
87
+ /**
88
+ * The total before any discounts and minimums are applied.
89
+ */
90
+ subtotal: string;
91
+ /**
92
+ * The expected issue date of the invoice.
93
+ */
94
+ targetDate: RFCDate;
95
+ }
@@ -0,0 +1,193 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
4
+ */
5
+ var __extends = (this && this.__extends) || (function () {
6
+ var extendStatics = function (d, b) {
7
+ extendStatics = Object.setPrototypeOf ||
8
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
9
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
10
+ return extendStatics(d, b);
11
+ };
12
+ return function (d, b) {
13
+ if (typeof b !== "function" && b !== null)
14
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
15
+ extendStatics(d, b);
16
+ function __() { this.constructor = d; }
17
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
18
+ };
19
+ })();
20
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
21
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
22
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
23
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
24
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
25
+ };
26
+ var __metadata = (this && this.__metadata) || function (k, v) {
27
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
28
+ };
29
+ Object.defineProperty(exports, "__esModule", { value: true });
30
+ exports.UpcomingInvoice = exports.UpcomingInvoiceMinimumAmount = exports.UpcomingInvoiceMaximumAmount = exports.UpcomingInvoiceDiscount = void 0;
31
+ var utils_1 = require("../../../internal/utils");
32
+ var types_1 = require("../../types");
33
+ var customerminified_1 = require("./customerminified");
34
+ var discounttype_1 = require("./discounttype");
35
+ var lineitem_1 = require("./lineitem");
36
+ var subscriptionminified_1 = require("./subscriptionminified");
37
+ var class_transformer_1 = require("class-transformer");
38
+ var UpcomingInvoiceDiscount = /** @class */ (function (_super) {
39
+ __extends(UpcomingInvoiceDiscount, _super);
40
+ function UpcomingInvoiceDiscount() {
41
+ return _super !== null && _super.apply(this, arguments) || this;
42
+ }
43
+ __decorate([
44
+ (0, utils_1.SpeakeasyMetadata)(),
45
+ (0, class_transformer_1.Expose)({ name: "amount_discount" }),
46
+ __metadata("design:type", String)
47
+ ], UpcomingInvoiceDiscount.prototype, "amountDiscount", void 0);
48
+ __decorate([
49
+ (0, utils_1.SpeakeasyMetadata)(),
50
+ (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
51
+ __metadata("design:type", Array)
52
+ ], UpcomingInvoiceDiscount.prototype, "appliesToPriceIds", void 0);
53
+ __decorate([
54
+ (0, utils_1.SpeakeasyMetadata)(),
55
+ (0, class_transformer_1.Expose)({ name: "discount_type" }),
56
+ __metadata("design:type", String)
57
+ ], UpcomingInvoiceDiscount.prototype, "discountType", void 0);
58
+ __decorate([
59
+ (0, utils_1.SpeakeasyMetadata)(),
60
+ (0, class_transformer_1.Expose)({ name: "percentage_discount" }),
61
+ __metadata("design:type", Number)
62
+ ], UpcomingInvoiceDiscount.prototype, "percentageDiscount", void 0);
63
+ __decorate([
64
+ (0, utils_1.SpeakeasyMetadata)(),
65
+ (0, class_transformer_1.Expose)({ name: "trial_amount_discount" }),
66
+ __metadata("design:type", String)
67
+ ], UpcomingInvoiceDiscount.prototype, "trialAmountDiscount", void 0);
68
+ __decorate([
69
+ (0, utils_1.SpeakeasyMetadata)(),
70
+ (0, class_transformer_1.Expose)({ name: "usage_discount" }),
71
+ __metadata("design:type", Number)
72
+ ], UpcomingInvoiceDiscount.prototype, "usageDiscount", void 0);
73
+ return UpcomingInvoiceDiscount;
74
+ }(utils_1.SpeakeasyBase));
75
+ exports.UpcomingInvoiceDiscount = UpcomingInvoiceDiscount;
76
+ var UpcomingInvoiceMaximumAmount = /** @class */ (function (_super) {
77
+ __extends(UpcomingInvoiceMaximumAmount, _super);
78
+ function UpcomingInvoiceMaximumAmount() {
79
+ return _super !== null && _super.apply(this, arguments) || this;
80
+ }
81
+ __decorate([
82
+ (0, utils_1.SpeakeasyMetadata)(),
83
+ (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
84
+ __metadata("design:type", Array)
85
+ ], UpcomingInvoiceMaximumAmount.prototype, "appliesToPriceIds", void 0);
86
+ __decorate([
87
+ (0, utils_1.SpeakeasyMetadata)(),
88
+ (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
89
+ __metadata("design:type", String)
90
+ ], UpcomingInvoiceMaximumAmount.prototype, "maximumAmount", void 0);
91
+ return UpcomingInvoiceMaximumAmount;
92
+ }(utils_1.SpeakeasyBase));
93
+ exports.UpcomingInvoiceMaximumAmount = UpcomingInvoiceMaximumAmount;
94
+ var UpcomingInvoiceMinimumAmount = /** @class */ (function (_super) {
95
+ __extends(UpcomingInvoiceMinimumAmount, _super);
96
+ function UpcomingInvoiceMinimumAmount() {
97
+ return _super !== null && _super.apply(this, arguments) || this;
98
+ }
99
+ __decorate([
100
+ (0, utils_1.SpeakeasyMetadata)(),
101
+ (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
102
+ __metadata("design:type", Array)
103
+ ], UpcomingInvoiceMinimumAmount.prototype, "appliesToPriceIds", void 0);
104
+ __decorate([
105
+ (0, utils_1.SpeakeasyMetadata)(),
106
+ (0, class_transformer_1.Expose)({ name: "minimum_amount" }),
107
+ __metadata("design:type", String)
108
+ ], UpcomingInvoiceMinimumAmount.prototype, "minimumAmount", void 0);
109
+ return UpcomingInvoiceMinimumAmount;
110
+ }(utils_1.SpeakeasyBase));
111
+ exports.UpcomingInvoiceMinimumAmount = UpcomingInvoiceMinimumAmount;
112
+ /**
113
+ * Upcoming invoices contain a line-by-line breakdown of an upcoming amount due for a subscription, including incurred usage in the billing period as well as any recurring fees.
114
+ *
115
+ * @remarks
116
+ *
117
+ * Although each line item will be invoiced on the `target_date`, each invoice line item may have distinct date ranges (e.g. for usage billed in arrears, the range may specify the current month whereas an in-advance recurring fees will be for the following month).
118
+ *
119
+ * Since an invoice resource has not been created for this upcoming invoice, this endpoint intentionally does not return an `id` field.
120
+ */
121
+ var UpcomingInvoice = /** @class */ (function (_super) {
122
+ __extends(UpcomingInvoice, _super);
123
+ function UpcomingInvoice() {
124
+ return _super !== null && _super.apply(this, arguments) || this;
125
+ }
126
+ __decorate([
127
+ (0, utils_1.SpeakeasyMetadata)(),
128
+ (0, class_transformer_1.Expose)({ name: "amount_due" }),
129
+ __metadata("design:type", String)
130
+ ], UpcomingInvoice.prototype, "amountDue", void 0);
131
+ __decorate([
132
+ (0, utils_1.SpeakeasyMetadata)(),
133
+ (0, class_transformer_1.Expose)({ name: "currency" }),
134
+ __metadata("design:type", String)
135
+ ], UpcomingInvoice.prototype, "currency", void 0);
136
+ __decorate([
137
+ (0, utils_1.SpeakeasyMetadata)(),
138
+ (0, class_transformer_1.Expose)({ name: "customer" }),
139
+ (0, class_transformer_1.Type)(function () { return customerminified_1.CustomerMinified; }),
140
+ __metadata("design:type", customerminified_1.CustomerMinified)
141
+ ], UpcomingInvoice.prototype, "customer", void 0);
142
+ __decorate([
143
+ (0, utils_1.SpeakeasyMetadata)(),
144
+ (0, class_transformer_1.Expose)({ name: "discount" }),
145
+ (0, class_transformer_1.Type)(function () { return UpcomingInvoiceDiscount; }),
146
+ __metadata("design:type", UpcomingInvoiceDiscount)
147
+ ], UpcomingInvoice.prototype, "discount", void 0);
148
+ __decorate([
149
+ (0, utils_1.SpeakeasyMetadata)(),
150
+ (0, class_transformer_1.Expose)({ name: "hosted_invoice_url" }),
151
+ __metadata("design:type", String)
152
+ ], UpcomingInvoice.prototype, "hostedInvoiceUrl", void 0);
153
+ __decorate([
154
+ (0, utils_1.SpeakeasyMetadata)({ elemType: lineitem_1.LineItem }),
155
+ (0, class_transformer_1.Expose)({ name: "line_items" }),
156
+ (0, class_transformer_1.Type)(function () { return lineitem_1.LineItem; }),
157
+ __metadata("design:type", Array)
158
+ ], UpcomingInvoice.prototype, "lineItems", void 0);
159
+ __decorate([
160
+ (0, utils_1.SpeakeasyMetadata)(),
161
+ (0, class_transformer_1.Expose)({ name: "maximum" }),
162
+ (0, class_transformer_1.Type)(function () { return UpcomingInvoiceMaximumAmount; }),
163
+ __metadata("design:type", UpcomingInvoiceMaximumAmount)
164
+ ], UpcomingInvoice.prototype, "maximum", void 0);
165
+ __decorate([
166
+ (0, utils_1.SpeakeasyMetadata)(),
167
+ (0, class_transformer_1.Expose)({ name: "minimum" }),
168
+ (0, class_transformer_1.Type)(function () { return UpcomingInvoiceMinimumAmount; }),
169
+ __metadata("design:type", UpcomingInvoiceMinimumAmount)
170
+ ], UpcomingInvoice.prototype, "minimum", void 0);
171
+ __decorate([
172
+ (0, utils_1.SpeakeasyMetadata)(),
173
+ (0, class_transformer_1.Expose)({ name: "subscription" }),
174
+ (0, class_transformer_1.Type)(function () { return subscriptionminified_1.SubscriptionMinified; }),
175
+ __metadata("design:type", subscriptionminified_1.SubscriptionMinified)
176
+ ], UpcomingInvoice.prototype, "subscription", void 0);
177
+ __decorate([
178
+ (0, utils_1.SpeakeasyMetadata)(),
179
+ (0, class_transformer_1.Expose)({ name: "subtotal" }),
180
+ __metadata("design:type", String)
181
+ ], UpcomingInvoice.prototype, "subtotal", void 0);
182
+ __decorate([
183
+ (0, utils_1.SpeakeasyMetadata)(),
184
+ (0, class_transformer_1.Expose)({ name: "target_date" }),
185
+ (0, class_transformer_1.Transform)(function (_a) {
186
+ var value = _a.value;
187
+ return new types_1.RFCDate(value);
188
+ }, { toClassOnly: true }),
189
+ __metadata("design:type", types_1.RFCDate)
190
+ ], UpcomingInvoice.prototype, "targetDate", void 0);
191
+ return UpcomingInvoice;
192
+ }(utils_1.SpeakeasyBase));
193
+ exports.UpcomingInvoice = UpcomingInvoice;
@@ -0,0 +1,28 @@
1
+ import { SpeakeasyBase } from "../../../internal/utils";
2
+ /**
3
+ * A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.
4
+ */
5
+ export declare class UpdateEventProperties extends SpeakeasyBase {
6
+ }
7
+ export declare class UpdateEvent extends SpeakeasyBase {
8
+ /**
9
+ * The Orb Customer identifier
10
+ */
11
+ customerId?: string;
12
+ /**
13
+ * A name to meaningfully identify the action or event type.
14
+ */
15
+ eventName: string;
16
+ /**
17
+ * An alias for the Orb customer, whose mapping is specified when creating the customer
18
+ */
19
+ externalCustomerId?: string;
20
+ /**
21
+ * A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.
22
+ */
23
+ properties: UpdateEventProperties;
24
+ /**
25
+ * An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.
26
+ */
27
+ timestamp: string;
28
+ }
@@ -0,0 +1,77 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
4
+ */
5
+ var __extends = (this && this.__extends) || (function () {
6
+ var extendStatics = function (d, b) {
7
+ extendStatics = Object.setPrototypeOf ||
8
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
9
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
10
+ return extendStatics(d, b);
11
+ };
12
+ return function (d, b) {
13
+ if (typeof b !== "function" && b !== null)
14
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
15
+ extendStatics(d, b);
16
+ function __() { this.constructor = d; }
17
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
18
+ };
19
+ })();
20
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
21
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
22
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
23
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
24
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
25
+ };
26
+ var __metadata = (this && this.__metadata) || function (k, v) {
27
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
28
+ };
29
+ Object.defineProperty(exports, "__esModule", { value: true });
30
+ exports.UpdateEvent = exports.UpdateEventProperties = void 0;
31
+ var utils_1 = require("../../../internal/utils");
32
+ var class_transformer_1 = require("class-transformer");
33
+ /**
34
+ * A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.
35
+ */
36
+ var UpdateEventProperties = /** @class */ (function (_super) {
37
+ __extends(UpdateEventProperties, _super);
38
+ function UpdateEventProperties() {
39
+ return _super !== null && _super.apply(this, arguments) || this;
40
+ }
41
+ return UpdateEventProperties;
42
+ }(utils_1.SpeakeasyBase));
43
+ exports.UpdateEventProperties = UpdateEventProperties;
44
+ var UpdateEvent = /** @class */ (function (_super) {
45
+ __extends(UpdateEvent, _super);
46
+ function UpdateEvent() {
47
+ return _super !== null && _super.apply(this, arguments) || this;
48
+ }
49
+ __decorate([
50
+ (0, utils_1.SpeakeasyMetadata)(),
51
+ (0, class_transformer_1.Expose)({ name: "customer_id" }),
52
+ __metadata("design:type", String)
53
+ ], UpdateEvent.prototype, "customerId", void 0);
54
+ __decorate([
55
+ (0, utils_1.SpeakeasyMetadata)(),
56
+ (0, class_transformer_1.Expose)({ name: "event_name" }),
57
+ __metadata("design:type", String)
58
+ ], UpdateEvent.prototype, "eventName", void 0);
59
+ __decorate([
60
+ (0, utils_1.SpeakeasyMetadata)(),
61
+ (0, class_transformer_1.Expose)({ name: "external_customer_id" }),
62
+ __metadata("design:type", String)
63
+ ], UpdateEvent.prototype, "externalCustomerId", void 0);
64
+ __decorate([
65
+ (0, utils_1.SpeakeasyMetadata)(),
66
+ (0, class_transformer_1.Expose)({ name: "properties" }),
67
+ (0, class_transformer_1.Type)(function () { return UpdateEventProperties; }),
68
+ __metadata("design:type", UpdateEventProperties)
69
+ ], UpdateEvent.prototype, "properties", void 0);
70
+ __decorate([
71
+ (0, utils_1.SpeakeasyMetadata)(),
72
+ (0, class_transformer_1.Expose)({ name: "timestamp" }),
73
+ __metadata("design:type", String)
74
+ ], UpdateEvent.prototype, "timestamp", void 0);
75
+ return UpdateEvent;
76
+ }(utils_1.SpeakeasyBase));
77
+ exports.UpdateEvent = UpdateEvent;
@@ -0,0 +1,13 @@
1
+ import { SpeakeasyBase } from "../../../internal/utils";
2
+ import { BillableMetricMinified } from "./billablemetricminified";
3
+ import { UsageItem } from "./usageitem";
4
+ export declare enum UsageViewMode {
5
+ Periodic = "periodic",
6
+ Cumulative = "cumulative"
7
+ }
8
+ export declare class Usage extends SpeakeasyBase {
9
+ billableMetric?: BillableMetricMinified;
10
+ id: string;
11
+ usage: UsageItem[];
12
+ viewMode?: UsageViewMode;
13
+ }
@@ -0,0 +1,69 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
4
+ */
5
+ var __extends = (this && this.__extends) || (function () {
6
+ var extendStatics = function (d, b) {
7
+ extendStatics = Object.setPrototypeOf ||
8
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
9
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
10
+ return extendStatics(d, b);
11
+ };
12
+ return function (d, b) {
13
+ if (typeof b !== "function" && b !== null)
14
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
15
+ extendStatics(d, b);
16
+ function __() { this.constructor = d; }
17
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
18
+ };
19
+ })();
20
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
21
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
22
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
23
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
24
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
25
+ };
26
+ var __metadata = (this && this.__metadata) || function (k, v) {
27
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
28
+ };
29
+ Object.defineProperty(exports, "__esModule", { value: true });
30
+ exports.Usage = exports.UsageViewMode = void 0;
31
+ var utils_1 = require("../../../internal/utils");
32
+ var billablemetricminified_1 = require("./billablemetricminified");
33
+ var usageitem_1 = require("./usageitem");
34
+ var class_transformer_1 = require("class-transformer");
35
+ var UsageViewMode;
36
+ (function (UsageViewMode) {
37
+ UsageViewMode["Periodic"] = "periodic";
38
+ UsageViewMode["Cumulative"] = "cumulative";
39
+ })(UsageViewMode = exports.UsageViewMode || (exports.UsageViewMode = {}));
40
+ var Usage = /** @class */ (function (_super) {
41
+ __extends(Usage, _super);
42
+ function Usage() {
43
+ return _super !== null && _super.apply(this, arguments) || this;
44
+ }
45
+ __decorate([
46
+ (0, utils_1.SpeakeasyMetadata)(),
47
+ (0, class_transformer_1.Expose)({ name: "billable_metric" }),
48
+ (0, class_transformer_1.Type)(function () { return billablemetricminified_1.BillableMetricMinified; }),
49
+ __metadata("design:type", billablemetricminified_1.BillableMetricMinified)
50
+ ], Usage.prototype, "billableMetric", void 0);
51
+ __decorate([
52
+ (0, utils_1.SpeakeasyMetadata)(),
53
+ (0, class_transformer_1.Expose)({ name: "id" }),
54
+ __metadata("design:type", String)
55
+ ], Usage.prototype, "id", void 0);
56
+ __decorate([
57
+ (0, utils_1.SpeakeasyMetadata)({ elemType: usageitem_1.UsageItem }),
58
+ (0, class_transformer_1.Expose)({ name: "usage" }),
59
+ (0, class_transformer_1.Type)(function () { return usageitem_1.UsageItem; }),
60
+ __metadata("design:type", Array)
61
+ ], Usage.prototype, "usage", void 0);
62
+ __decorate([
63
+ (0, utils_1.SpeakeasyMetadata)(),
64
+ (0, class_transformer_1.Expose)({ name: "view_mode" }),
65
+ __metadata("design:type", String)
66
+ ], Usage.prototype, "viewMode", void 0);
67
+ return Usage;
68
+ }(utils_1.SpeakeasyBase));
69
+ exports.Usage = Usage;
@@ -0,0 +1,6 @@
1
+ import { SpeakeasyBase } from "../../../internal/utils";
2
+ export declare class UsageItem extends SpeakeasyBase {
3
+ quantity: string;
4
+ timeframeEnd: Date;
5
+ timeframeStart: Date;
6
+ }