orb-billing 1.19.2 → 1.20.0

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 (585) hide show
  1. package/README.md +66 -23
  2. package/dist/internal/utils/utils.js +1 -1
  3. package/dist/sdk/coupon.d.ts +4 -4
  4. package/dist/sdk/coupon.js +25 -20
  5. package/dist/sdk/credit.d.ts +186 -4
  6. package/dist/sdk/credit.js +208 -20
  7. package/dist/sdk/creditnote.d.ts +2 -2
  8. package/dist/sdk/creditnote.js +11 -10
  9. package/dist/sdk/customer.d.ts +8 -8
  10. package/dist/sdk/customer.js +49 -40
  11. package/dist/sdk/event.d.ts +7 -7
  12. package/dist/sdk/event.js +39 -35
  13. package/dist/sdk/invoice.d.ts +5 -5
  14. package/dist/sdk/invoice.js +26 -25
  15. package/dist/sdk/item.d.ts +2 -2
  16. package/dist/sdk/item.js +11 -10
  17. package/dist/sdk/metric.d.ts +1 -1
  18. package/dist/sdk/metric.js +5 -5
  19. package/dist/sdk/models/operations/addeditpriceintervals.d.ts +1 -1
  20. package/dist/sdk/models/operations/addeditpriceintervals.js +4 -4
  21. package/dist/sdk/models/operations/amendevent.d.ts +1 -1
  22. package/dist/sdk/models/operations/amendevent.js +4 -4
  23. package/dist/sdk/models/operations/amendusage.d.ts +1 -1
  24. package/dist/sdk/models/operations/amendusage.js +4 -4
  25. package/dist/sdk/models/operations/amendusageexternalcustomerid.d.ts +1 -1
  26. package/dist/sdk/models/operations/amendusageexternalcustomerid.js +4 -4
  27. package/dist/sdk/models/operations/cancelsubscription.d.ts +1 -1
  28. package/dist/sdk/models/operations/cancelsubscription.js +4 -4
  29. package/dist/sdk/models/operations/createcustomerbalancetransaction.d.ts +1 -1
  30. package/dist/sdk/models/operations/createcustomerbalancetransaction.js +4 -4
  31. package/dist/sdk/models/operations/createledgerentry.d.ts +1 -1
  32. package/dist/sdk/models/operations/createledgerentry.js +4 -4
  33. package/dist/sdk/models/operations/createledgerentryexternalid.d.ts +1 -1
  34. package/dist/sdk/models/operations/createledgerentryexternalid.js +4 -4
  35. package/dist/sdk/models/operations/fetchcustomercredits.d.ts +1 -1
  36. package/dist/sdk/models/operations/fetchcustomercredits.js +4 -4
  37. package/dist/sdk/models/operations/fetchcustomercreditsexternalid.d.ts +1 -1
  38. package/dist/sdk/models/operations/fetchcustomercreditsexternalid.js +4 -4
  39. package/dist/sdk/models/operations/markinvoiceaspaid.d.ts +1 -1
  40. package/dist/sdk/models/operations/markinvoiceaspaid.js +4 -4
  41. package/dist/sdk/models/operations/scheduleplanchange.d.ts +1 -1
  42. package/dist/sdk/models/operations/scheduleplanchange.js +4 -4
  43. package/dist/sdk/models/operations/triggerphase.d.ts +1 -1
  44. package/dist/sdk/models/operations/triggerphase.js +4 -4
  45. package/dist/sdk/models/operations/unschedulefixedfeequantity.d.ts +1 -1
  46. package/dist/sdk/models/operations/unschedulefixedfeequantity.js +4 -4
  47. package/dist/sdk/models/operations/updatecustomer.d.ts +1 -1
  48. package/dist/sdk/models/operations/updatecustomer.js +4 -4
  49. package/dist/sdk/models/operations/updatecustomerexternalid.d.ts +1 -1
  50. package/dist/sdk/models/operations/updatecustomerexternalid.js +4 -4
  51. package/dist/sdk/models/operations/updatefixedfeequantity.d.ts +1 -1
  52. package/dist/sdk/models/operations/updatefixedfeequantity.js +4 -4
  53. package/dist/sdk/models/operations/updateplan.d.ts +1 -1
  54. package/dist/sdk/models/operations/updateplan.js +4 -4
  55. package/dist/sdk/models/operations/updateplanexternal.d.ts +1 -1
  56. package/dist/sdk/models/operations/updateplanexternal.js +4 -4
  57. package/dist/sdk/models/shared/addpriceintervalparams.d.ts +0 -14
  58. package/dist/sdk/models/shared/addpriceintervalparams.js +1 -17
  59. package/dist/sdk/models/shared/createinvoicelineitemparams.js +2 -0
  60. package/dist/sdk/models/shared/editpriceintervalparams.d.ts +0 -14
  61. package/dist/sdk/models/shared/editpriceintervalparams.js +1 -17
  62. package/dist/sdk/models/shared/fixedfeequantitychange.js +1 -0
  63. package/dist/sdk/models/shared/index.d.ts +0 -102
  64. package/dist/sdk/models/shared/index.js +0 -102
  65. package/dist/sdk/models/shared/invoicelineitemparams.d.ts +1 -2
  66. package/dist/sdk/models/shared/invoicelineitemparams.js +3 -3
  67. package/dist/sdk/models/shared/itemexternalconnection.d.ts +0 -11
  68. package/dist/sdk/models/shared/itemexternalconnection.js +1 -14
  69. package/dist/sdk/models/shared/markaspaidrequestparams.js +1 -0
  70. package/dist/sdk/models/shared/plan.d.ts +1 -3
  71. package/dist/sdk/models/shared/plan.js +2 -11
  72. package/dist/sdk/models/shared/triggersubscriptionphaseparams.js +1 -0
  73. package/dist/sdk/plan.d.ts +4 -4
  74. package/dist/sdk/plan.js +22 -20
  75. package/dist/sdk/price.d.ts +3 -3
  76. package/dist/sdk/price.js +16 -15
  77. package/dist/sdk/priceinterval.d.ts +2 -1
  78. package/dist/sdk/priceinterval.js +6 -5
  79. package/dist/sdk/sdk.js +3 -3
  80. package/dist/sdk/subscription.d.ts +8 -8
  81. package/dist/sdk/subscription.js +45 -40
  82. package/docs/models/operations/addeditpriceintervalsrequest.md +2 -2
  83. package/docs/models/operations/amendeventrequest.md +2 -2
  84. package/docs/models/operations/amendusageexternalcustomeridrequest.md +1 -1
  85. package/docs/models/operations/amendusagerequest.md +1 -1
  86. package/docs/models/operations/cancelsubscriptionrequest.md +2 -2
  87. package/docs/models/operations/createcustomerbalancetransactionrequest.md +2 -2
  88. package/docs/models/operations/createledgerentryexternalidrequest.md +2 -2
  89. package/docs/models/operations/createledgerentryrequest.md +2 -2
  90. package/docs/models/operations/fetchcustomercreditsexternalidrequest.md +1 -1
  91. package/docs/models/operations/fetchcustomercreditsrequest.md +1 -1
  92. package/docs/models/operations/markinvoiceaspaidrequest.md +2 -2
  93. package/docs/models/operations/scheduleplanchangerequest.md +2 -2
  94. package/docs/models/operations/triggerphaserequest.md +2 -2
  95. package/docs/models/operations/unschedulefixedfeequantityrequest.md +2 -2
  96. package/docs/models/operations/updatecustomerexternalidrequest.md +2 -2
  97. package/docs/models/operations/updatecustomerrequest.md +2 -2
  98. package/docs/models/operations/updatefixedfeequantityrequest.md +2 -2
  99. package/docs/models/operations/updateplanexternalrequest.md +2 -2
  100. package/docs/models/operations/updateplanrequest.md +2 -2
  101. package/docs/models/shared/addpriceintervalparams.md +2 -2
  102. package/docs/models/shared/createinvoicelineitemparams.md +1 -1
  103. package/docs/models/shared/discount.md +8 -8
  104. package/docs/models/shared/editpriceintervalparams.md +2 -2
  105. package/docs/models/shared/invoicelineitem.md +1 -1
  106. package/docs/models/shared/invoicelineitemparams.md +2 -2
  107. package/docs/models/shared/plan.md +1 -1
  108. package/docs/sdks/availability/README.md +9 -8
  109. package/docs/sdks/coupon/README.md +89 -80
  110. package/docs/sdks/credit/README.md +282 -141
  111. package/docs/sdks/creditnote/README.md +34 -31
  112. package/docs/sdks/customer/README.md +303 -352
  113. package/docs/sdks/event/README.md +162 -162
  114. package/docs/sdks/invoice/README.md +145 -159
  115. package/docs/sdks/item/README.md +34 -31
  116. package/docs/sdks/metric/README.md +43 -47
  117. package/docs/sdks/plan/README.md +100 -102
  118. package/docs/sdks/price/README.md +60 -96
  119. package/docs/sdks/priceinterval/README.md +55 -98
  120. package/docs/sdks/subscription/README.md +278 -384
  121. package/package.json +1 -1
  122. package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.d.ts +0 -24
  123. package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.js +0 -76
  124. package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.d.ts +0 -37
  125. package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.js +0 -100
  126. package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.d.ts +0 -42
  127. package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.js +0 -107
  128. package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.d.ts +0 -34
  129. package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.js +0 -88
  130. package/dist/sdk/models/shared/affectedblock.d.ts +0 -6
  131. package/dist/sdk/models/shared/affectedblock.js +0 -59
  132. package/dist/sdk/models/shared/amendmentledgerentry.d.ts +0 -27
  133. package/dist/sdk/models/shared/amendmentledgerentry.js +0 -120
  134. package/dist/sdk/models/shared/amountdiscount.d.ts +0 -15
  135. package/dist/sdk/models/shared/amountdiscount.js +0 -59
  136. package/dist/sdk/models/shared/amountdiscountcreationparams.d.ts +0 -11
  137. package/dist/sdk/models/shared/amountdiscountcreationparams.js +0 -54
  138. package/dist/sdk/models/shared/amountdiscountinterval.d.ts +0 -27
  139. package/dist/sdk/models/shared/amountdiscountinterval.js +0 -82
  140. package/dist/sdk/models/shared/billablemetricsimple.d.ts +0 -5
  141. package/dist/sdk/models/shared/billablemetricsimple.js +0 -50
  142. package/dist/sdk/models/shared/billablemetrictiny.d.ts +0 -4
  143. package/dist/sdk/models/shared/billablemetrictiny.js +0 -45
  144. package/dist/sdk/models/shared/bpsconfig.d.ts +0 -11
  145. package/dist/sdk/models/shared/bpsconfig.js +0 -50
  146. package/dist/sdk/models/shared/bpsprice.d.ts +0 -242
  147. package/dist/sdk/models/shared/bpsprice.js +0 -363
  148. package/dist/sdk/models/shared/bpstier.d.ts +0 -19
  149. package/dist/sdk/models/shared/bpstier.js +0 -60
  150. package/dist/sdk/models/shared/bulkbpsconfig.d.ts +0 -8
  151. package/dist/sdk/models/shared/bulkbpsconfig.js +0 -47
  152. package/dist/sdk/models/shared/bulkbpsprice.d.ts +0 -242
  153. package/dist/sdk/models/shared/bulkbpsprice.js +0 -363
  154. package/dist/sdk/models/shared/bulkbpstier.d.ts +0 -15
  155. package/dist/sdk/models/shared/bulkbpstier.js +0 -55
  156. package/dist/sdk/models/shared/bulkconfig.d.ts +0 -8
  157. package/dist/sdk/models/shared/bulkconfig.js +0 -47
  158. package/dist/sdk/models/shared/bulkprice.d.ts +0 -242
  159. package/dist/sdk/models/shared/bulkprice.js +0 -363
  160. package/dist/sdk/models/shared/bulktier.d.ts +0 -11
  161. package/dist/sdk/models/shared/bulktier.js +0 -50
  162. package/dist/sdk/models/shared/creditblockexpiryledgerentry.d.ts +0 -27
  163. package/dist/sdk/models/shared/creditblockexpiryledgerentry.js +0 -120
  164. package/dist/sdk/models/shared/decrementledgerentry.d.ts +0 -30
  165. package/dist/sdk/models/shared/decrementledgerentry.js +0 -135
  166. package/dist/sdk/models/shared/duplicateconstraintviolationerror.d.ts +0 -16
  167. package/dist/sdk/models/shared/duplicateconstraintviolationerror.js +0 -82
  168. package/dist/sdk/models/shared/duplicateresourcecreationerror.d.ts +0 -16
  169. package/dist/sdk/models/shared/duplicateresourcecreationerror.js +0 -82
  170. package/dist/sdk/models/shared/expirationchangeledgerentry.d.ts +0 -28
  171. package/dist/sdk/models/shared/expirationchangeledgerentry.js +0 -129
  172. package/dist/sdk/models/shared/featurenotavailableerror.d.ts +0 -16
  173. package/dist/sdk/models/shared/featurenotavailableerror.js +0 -82
  174. package/dist/sdk/models/shared/fivetranexampleprice.d.ts +0 -241
  175. package/dist/sdk/models/shared/fivetranexampleprice.js +0 -361
  176. package/dist/sdk/models/shared/groupedsubscriptionusage.d.ts +0 -7
  177. package/dist/sdk/models/shared/groupedsubscriptionusage.js +0 -54
  178. package/dist/sdk/models/shared/groupedsubscriptionusagerecord.d.ts +0 -14
  179. package/dist/sdk/models/shared/groupedsubscriptionusagerecord.js +0 -71
  180. package/dist/sdk/models/shared/idempotencyconflict.d.ts +0 -16
  181. package/dist/sdk/models/shared/idempotencyconflict.js +0 -82
  182. package/dist/sdk/models/shared/idempotencykeyvalidationerror.d.ts +0 -17
  183. package/dist/sdk/models/shared/idempotencykeyvalidationerror.js +0 -87
  184. package/dist/sdk/models/shared/idempotencyrequestmismatch.d.ts +0 -16
  185. package/dist/sdk/models/shared/idempotencyrequestmismatch.js +0 -82
  186. package/dist/sdk/models/shared/incrementcreditledgerentryinvoicesettings.d.ts +0 -18
  187. package/dist/sdk/models/shared/incrementcreditledgerentryinvoicesettings.js +0 -58
  188. package/dist/sdk/models/shared/incrementledgerentry.d.ts +0 -27
  189. package/dist/sdk/models/shared/incrementledgerentry.js +0 -120
  190. package/dist/sdk/models/shared/itemslim.d.ts +0 -5
  191. package/dist/sdk/models/shared/itemslim.js +0 -50
  192. package/dist/sdk/models/shared/matrixconfig.d.ts +0 -20
  193. package/dist/sdk/models/shared/matrixconfig.js +0 -62
  194. package/dist/sdk/models/shared/matrixprice.d.ts +0 -242
  195. package/dist/sdk/models/shared/matrixprice.js +0 -363
  196. package/dist/sdk/models/shared/matrixsublineitem.d.ts +0 -17
  197. package/dist/sdk/models/shared/matrixsublineitem.js +0 -78
  198. package/dist/sdk/models/shared/matrixvalue.d.ts +0 -15
  199. package/dist/sdk/models/shared/matrixvalue.js +0 -55
  200. package/dist/sdk/models/shared/metricgroup.d.ts +0 -5
  201. package/dist/sdk/models/shared/metricgroup.js +0 -50
  202. package/dist/sdk/models/shared/newbpsprice.d.ts +0 -53
  203. package/dist/sdk/models/shared/newbpsprice.js +0 -110
  204. package/dist/sdk/models/shared/newbulkbpsprice.d.ts +0 -53
  205. package/dist/sdk/models/shared/newbulkbpsprice.js +0 -110
  206. package/dist/sdk/models/shared/newbulkprice.d.ts +0 -53
  207. package/dist/sdk/models/shared/newbulkprice.js +0 -110
  208. package/dist/sdk/models/shared/newmatrixprice.d.ts +0 -53
  209. package/dist/sdk/models/shared/newmatrixprice.js +0 -110
  210. package/dist/sdk/models/shared/newpackageprice.d.ts +0 -53
  211. package/dist/sdk/models/shared/newpackageprice.js +0 -110
  212. package/dist/sdk/models/shared/newpackagewithallocationprice.d.ts +0 -52
  213. package/dist/sdk/models/shared/newpackagewithallocationprice.js +0 -108
  214. package/dist/sdk/models/shared/newthresholdtotalamountprice.d.ts +0 -52
  215. package/dist/sdk/models/shared/newthresholdtotalamountprice.js +0 -108
  216. package/dist/sdk/models/shared/newtieredbpsprice.d.ts +0 -53
  217. package/dist/sdk/models/shared/newtieredbpsprice.js +0 -110
  218. package/dist/sdk/models/shared/newtieredpackageprice.d.ts +0 -52
  219. package/dist/sdk/models/shared/newtieredpackageprice.js +0 -108
  220. package/dist/sdk/models/shared/newtieredprice.d.ts +0 -53
  221. package/dist/sdk/models/shared/newtieredprice.js +0 -110
  222. package/dist/sdk/models/shared/newtieredwithminimumprice.d.ts +0 -52
  223. package/dist/sdk/models/shared/newtieredwithminimumprice.js +0 -108
  224. package/dist/sdk/models/shared/newunitprice.d.ts +0 -53
  225. package/dist/sdk/models/shared/newunitprice.js +0 -110
  226. package/dist/sdk/models/shared/othersublineitem.d.ts +0 -15
  227. package/dist/sdk/models/shared/othersublineitem.js +0 -71
  228. package/dist/sdk/models/shared/overridebpsprice.d.ts +0 -27
  229. package/dist/sdk/models/shared/overridebpsprice.js +0 -83
  230. package/dist/sdk/models/shared/overridebulkbpsprice.d.ts +0 -27
  231. package/dist/sdk/models/shared/overridebulkbpsprice.js +0 -83
  232. package/dist/sdk/models/shared/overridebulkprice.d.ts +0 -27
  233. package/dist/sdk/models/shared/overridebulkprice.js +0 -83
  234. package/dist/sdk/models/shared/overridefivetranexampleprice.d.ts +0 -26
  235. package/dist/sdk/models/shared/overridefivetranexampleprice.js +0 -81
  236. package/dist/sdk/models/shared/overridematrixprice.d.ts +0 -27
  237. package/dist/sdk/models/shared/overridematrixprice.js +0 -83
  238. package/dist/sdk/models/shared/overridepackageprice.d.ts +0 -27
  239. package/dist/sdk/models/shared/overridepackageprice.js +0 -83
  240. package/dist/sdk/models/shared/overridepackagewithallocationprice.d.ts +0 -26
  241. package/dist/sdk/models/shared/overridepackagewithallocationprice.js +0 -81
  242. package/dist/sdk/models/shared/overridetestratingfunctionprice.d.ts +0 -26
  243. package/dist/sdk/models/shared/overridetestratingfunctionprice.js +0 -81
  244. package/dist/sdk/models/shared/overridethresholdtotalamountprice.d.ts +0 -26
  245. package/dist/sdk/models/shared/overridethresholdtotalamountprice.js +0 -81
  246. package/dist/sdk/models/shared/overridetieredbpsprice.d.ts +0 -27
  247. package/dist/sdk/models/shared/overridetieredbpsprice.js +0 -83
  248. package/dist/sdk/models/shared/overridetieredpackageprice.d.ts +0 -26
  249. package/dist/sdk/models/shared/overridetieredpackageprice.js +0 -81
  250. package/dist/sdk/models/shared/overridetieredprice.d.ts +0 -27
  251. package/dist/sdk/models/shared/overridetieredprice.js +0 -83
  252. package/dist/sdk/models/shared/overridetieredwithminimumprice.d.ts +0 -26
  253. package/dist/sdk/models/shared/overridetieredwithminimumprice.js +0 -81
  254. package/dist/sdk/models/shared/overrideunitprice.d.ts +0 -27
  255. package/dist/sdk/models/shared/overrideunitprice.js +0 -83
  256. package/dist/sdk/models/shared/packageconfig.d.ts +0 -11
  257. package/dist/sdk/models/shared/packageconfig.js +0 -50
  258. package/dist/sdk/models/shared/packageprice.d.ts +0 -242
  259. package/dist/sdk/models/shared/packageprice.js +0 -363
  260. package/dist/sdk/models/shared/packagewithallocationprice.d.ts +0 -241
  261. package/dist/sdk/models/shared/packagewithallocationprice.js +0 -361
  262. package/dist/sdk/models/shared/percentagediscount.d.ts +0 -15
  263. package/dist/sdk/models/shared/percentagediscount.js +0 -59
  264. package/dist/sdk/models/shared/percentagediscountcreationparams.d.ts +0 -11
  265. package/dist/sdk/models/shared/percentagediscountcreationparams.js +0 -54
  266. package/dist/sdk/models/shared/percentagediscountinterval.d.ts +0 -27
  267. package/dist/sdk/models/shared/percentagediscountinterval.js +0 -82
  268. package/dist/sdk/models/shared/requesttoolargeerror.d.ts +0 -16
  269. package/dist/sdk/models/shared/requesttoolargeerror.js +0 -82
  270. package/dist/sdk/models/shared/requestvalidationerror.d.ts +0 -17
  271. package/dist/sdk/models/shared/requestvalidationerror.js +0 -87
  272. package/dist/sdk/models/shared/resourcenotfounderror.d.ts +0 -16
  273. package/dist/sdk/models/shared/resourcenotfounderror.js +0 -82
  274. package/dist/sdk/models/shared/resourcetoolargeerror.d.ts +0 -16
  275. package/dist/sdk/models/shared/resourcetoolargeerror.js +0 -82
  276. package/dist/sdk/models/shared/sublineitemgrouping.d.ts +0 -8
  277. package/dist/sdk/models/shared/sublineitemgrouping.js +0 -50
  278. package/dist/sdk/models/shared/sublineitemmatrixconfig.d.ts +0 -7
  279. package/dist/sdk/models/shared/sublineitemmatrixconfig.js +0 -45
  280. package/dist/sdk/models/shared/testratingfunctionprice.d.ts +0 -241
  281. package/dist/sdk/models/shared/testratingfunctionprice.js +0 -361
  282. package/dist/sdk/models/shared/thresholdtotalamountprice.d.ts +0 -241
  283. package/dist/sdk/models/shared/thresholdtotalamountprice.js +0 -361
  284. package/dist/sdk/models/shared/tier.d.ts +0 -15
  285. package/dist/sdk/models/shared/tier.js +0 -55
  286. package/dist/sdk/models/shared/tierconfig.d.ts +0 -6
  287. package/dist/sdk/models/shared/tierconfig.js +0 -55
  288. package/dist/sdk/models/shared/tieredbpsconfig.d.ts +0 -8
  289. package/dist/sdk/models/shared/tieredbpsconfig.js +0 -47
  290. package/dist/sdk/models/shared/tieredbpsprice.d.ts +0 -242
  291. package/dist/sdk/models/shared/tieredbpsprice.js +0 -363
  292. package/dist/sdk/models/shared/tieredconfig.d.ts +0 -8
  293. package/dist/sdk/models/shared/tieredconfig.js +0 -47
  294. package/dist/sdk/models/shared/tieredpackageprice.d.ts +0 -241
  295. package/dist/sdk/models/shared/tieredpackageprice.js +0 -361
  296. package/dist/sdk/models/shared/tieredprice.d.ts +0 -242
  297. package/dist/sdk/models/shared/tieredprice.js +0 -363
  298. package/dist/sdk/models/shared/tieredwithminimumprice.d.ts +0 -241
  299. package/dist/sdk/models/shared/tieredwithminimumprice.js +0 -361
  300. package/dist/sdk/models/shared/tiersublineitem.d.ts +0 -17
  301. package/dist/sdk/models/shared/tiersublineitem.js +0 -78
  302. package/dist/sdk/models/shared/trialdiscount.d.ts +0 -19
  303. package/dist/sdk/models/shared/trialdiscount.js +0 -64
  304. package/dist/sdk/models/shared/ungroupedsubscriptionusage.d.ts +0 -5
  305. package/dist/sdk/models/shared/ungroupedsubscriptionusage.js +0 -47
  306. package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.d.ts +0 -12
  307. package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.js +0 -64
  308. package/dist/sdk/models/shared/unitconfig.d.ts +0 -11
  309. package/dist/sdk/models/shared/unitconfig.js +0 -50
  310. package/dist/sdk/models/shared/unitprice.d.ts +0 -242
  311. package/dist/sdk/models/shared/unitprice.js +0 -363
  312. package/dist/sdk/models/shared/urlnotfound.d.ts +0 -16
  313. package/dist/sdk/models/shared/urlnotfound.js +0 -82
  314. package/dist/sdk/models/shared/usage.d.ts +0 -6
  315. package/dist/sdk/models/shared/usage.js +0 -63
  316. package/dist/sdk/models/shared/usagediscount.d.ts +0 -15
  317. package/dist/sdk/models/shared/usagediscount.js +0 -59
  318. package/dist/sdk/models/shared/usagediscountcreationparams.d.ts +0 -11
  319. package/dist/sdk/models/shared/usagediscountcreationparams.js +0 -54
  320. package/dist/sdk/models/shared/usagediscountinterval.d.ts +0 -27
  321. package/dist/sdk/models/shared/usagediscountinterval.js +0 -82
  322. package/dist/sdk/models/shared/voidinitiatedledgerentry.d.ts +0 -30
  323. package/dist/sdk/models/shared/voidinitiatedledgerentry.js +0 -139
  324. package/dist/sdk/models/shared/voidledgerentry.d.ts +0 -29
  325. package/dist/sdk/models/shared/voidledgerentry.js +0 -130
  326. package/docs/models/shared/adddecrementcreditledgerentryrequestparams.md +0 -11
  327. package/docs/models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md +0 -8
  328. package/docs/models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md +0 -9
  329. package/docs/models/shared/addexpirationchangecreditledgerentryrequestparams.md +0 -14
  330. package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md +0 -8
  331. package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md +0 -9
  332. package/docs/models/shared/addincrementcreditledgerentryrequestparams.md +0 -15
  333. package/docs/models/shared/addincrementcreditledgerentryrequestparamsentrytype.md +0 -8
  334. package/docs/models/shared/addincrementcreditledgerentryrequestparamsmetadata.md +0 -9
  335. package/docs/models/shared/addpriceintervalparamsenddateenddate.md +0 -11
  336. package/docs/models/shared/addpriceintervalparamsstartdatestartdate.md +0 -11
  337. package/docs/models/shared/addvoidcreditledgerentryrequestparams.md +0 -12
  338. package/docs/models/shared/addvoidcreditledgerentryrequestparamsentrytype.md +0 -8
  339. package/docs/models/shared/addvoidcreditledgerentryrequestparamsmetadata.md +0 -9
  340. package/docs/models/shared/addvoidcreditledgerentryrequestparamsvoidreason.md +0 -10
  341. package/docs/models/shared/affectedblock.md +0 -10
  342. package/docs/models/shared/amendmentledgerentry.md +0 -21
  343. package/docs/models/shared/amendmentledgerentryentrystatus.md +0 -9
  344. package/docs/models/shared/amendmentledgerentryentrytype.md +0 -8
  345. package/docs/models/shared/amountdiscount.md +0 -10
  346. package/docs/models/shared/amountdiscountcreationparams.md +0 -9
  347. package/docs/models/shared/amountdiscountcreationparamsdiscounttype.md +0 -8
  348. package/docs/models/shared/amountdiscountdiscounttype.md +0 -8
  349. package/docs/models/shared/amountdiscountinterval.md +0 -13
  350. package/docs/models/shared/amountdiscountintervaldiscounttype.md +0 -8
  351. package/docs/models/shared/billablemetricsimple.md +0 -9
  352. package/docs/models/shared/billablemetrictiny.md +0 -8
  353. package/docs/models/shared/bpsconfig.md +0 -9
  354. package/docs/models/shared/bpsprice.md +0 -225
  355. package/docs/models/shared/bpspricecadence.md +0 -11
  356. package/docs/models/shared/bpspricemodeltype.md +0 -8
  357. package/docs/models/shared/bpspricepricetype.md +0 -9
  358. package/docs/models/shared/bpstier.md +0 -11
  359. package/docs/models/shared/bulkbpsconfig.md +0 -8
  360. package/docs/models/shared/bulkbpsprice.md +0 -225
  361. package/docs/models/shared/bulkbpspricecadence.md +0 -11
  362. package/docs/models/shared/bulkbpspricemodeltype.md +0 -8
  363. package/docs/models/shared/bulkbpspricepricetype.md +0 -9
  364. package/docs/models/shared/bulkbpstier.md +0 -10
  365. package/docs/models/shared/bulkconfig.md +0 -8
  366. package/docs/models/shared/bulkprice.md +0 -225
  367. package/docs/models/shared/bulkpricecadence.md +0 -11
  368. package/docs/models/shared/bulkpricemodeltype.md +0 -8
  369. package/docs/models/shared/bulkpricepricetype.md +0 -9
  370. package/docs/models/shared/bulktier.md +0 -9
  371. package/docs/models/shared/creditblockexpiryledgerentry.md +0 -21
  372. package/docs/models/shared/creditblockexpiryledgerentryentrystatus.md +0 -9
  373. package/docs/models/shared/creditblockexpiryledgerentryentrytype.md +0 -8
  374. package/docs/models/shared/decrementledgerentry.md +0 -24
  375. package/docs/models/shared/decrementledgerentryentrystatus.md +0 -9
  376. package/docs/models/shared/decrementledgerentryentrytype.md +0 -8
  377. package/docs/models/shared/duplicateconstraintviolationerror.md +0 -12
  378. package/docs/models/shared/duplicateconstraintviolationerrorheaders.md +0 -7
  379. package/docs/models/shared/duplicateconstraintviolationerrorstatus.md +0 -8
  380. package/docs/models/shared/duplicateconstraintviolationerrortype.md +0 -8
  381. package/docs/models/shared/duplicateresourcecreationerror.md +0 -12
  382. package/docs/models/shared/duplicateresourcecreationerrorheaders.md +0 -7
  383. package/docs/models/shared/duplicateresourcecreationerrorstatus.md +0 -8
  384. package/docs/models/shared/duplicateresourcecreationerrortype.md +0 -8
  385. package/docs/models/shared/editpriceintervalparamsenddateenddate.md +0 -11
  386. package/docs/models/shared/editpriceintervalparamsstartdatestartdate.md +0 -11
  387. package/docs/models/shared/expirationchangeledgerentry.md +0 -22
  388. package/docs/models/shared/expirationchangeledgerentryentrystatus.md +0 -9
  389. package/docs/models/shared/expirationchangeledgerentryentrytype.md +0 -8
  390. package/docs/models/shared/featurenotavailableerror.md +0 -12
  391. package/docs/models/shared/featurenotavailableerrorheaders.md +0 -7
  392. package/docs/models/shared/featurenotavailableerrorstatus.md +0 -8
  393. package/docs/models/shared/featurenotavailableerrortype.md +0 -8
  394. package/docs/models/shared/fivetranexampleprice.md +0 -225
  395. package/docs/models/shared/fivetranexamplepricecadence.md +0 -11
  396. package/docs/models/shared/fivetranexamplepricemodeltype.md +0 -8
  397. package/docs/models/shared/fivetranexamplepricepricetype.md +0 -9
  398. package/docs/models/shared/groupedsubscriptionusage.md +0 -9
  399. package/docs/models/shared/groupedsubscriptionusagerecord.md +0 -11
  400. package/docs/models/shared/groupedsubscriptionusagerecordviewmode.md +0 -9
  401. package/docs/models/shared/idempotencyconflict.md +0 -12
  402. package/docs/models/shared/idempotencyconflictheaders.md +0 -7
  403. package/docs/models/shared/idempotencyconflictstatus.md +0 -8
  404. package/docs/models/shared/idempotencyconflicttype.md +0 -8
  405. package/docs/models/shared/idempotencykeyvalidationerror.md +0 -13
  406. package/docs/models/shared/idempotencykeyvalidationerrorheaders.md +0 -7
  407. package/docs/models/shared/idempotencykeyvalidationerrorstatus.md +0 -8
  408. package/docs/models/shared/idempotencykeyvalidationerrortype.md +0 -8
  409. package/docs/models/shared/idempotencyrequestmismatch.md +0 -12
  410. package/docs/models/shared/idempotencyrequestmismatchheaders.md +0 -7
  411. package/docs/models/shared/idempotencyrequestmismatchstatus.md +0 -8
  412. package/docs/models/shared/idempotencyrequestmismatchtype.md +0 -8
  413. package/docs/models/shared/incrementcreditledgerentryinvoicesettings.md +0 -12
  414. package/docs/models/shared/incrementledgerentry.md +0 -21
  415. package/docs/models/shared/incrementledgerentryentrystatus.md +0 -9
  416. package/docs/models/shared/incrementledgerentryentrytype.md +0 -8
  417. package/docs/models/shared/itemexternalconnectionexternalconnectionnameexternalconnectionname.md +0 -11
  418. package/docs/models/shared/itemexternalconnectionexternalconnectionnameexternalconnectionname1.md +0 -10
  419. package/docs/models/shared/itemslim.md +0 -9
  420. package/docs/models/shared/matrixconfig.md +0 -11
  421. package/docs/models/shared/matrixprice.md +0 -225
  422. package/docs/models/shared/matrixpricecadence.md +0 -11
  423. package/docs/models/shared/matrixpricemodeltype.md +0 -8
  424. package/docs/models/shared/matrixpricepricetype.md +0 -9
  425. package/docs/models/shared/matrixsublineitem.md +0 -13
  426. package/docs/models/shared/matrixsublineitemtype.md +0 -8
  427. package/docs/models/shared/matrixvalue.md +0 -10
  428. package/docs/models/shared/metricgroup.md +0 -9
  429. package/docs/models/shared/newbpsprice.md +0 -18
  430. package/docs/models/shared/newbpspricecadence.md +0 -12
  431. package/docs/models/shared/newbpspricemodeltype.md +0 -8
  432. package/docs/models/shared/newbulkbpsprice.md +0 -18
  433. package/docs/models/shared/newbulkbpspricecadence.md +0 -12
  434. package/docs/models/shared/newbulkbpspricemodeltype.md +0 -8
  435. package/docs/models/shared/newbulkprice.md +0 -18
  436. package/docs/models/shared/newbulkpricecadence.md +0 -12
  437. package/docs/models/shared/newbulkpricemodeltype.md +0 -8
  438. package/docs/models/shared/newmatrixprice.md +0 -18
  439. package/docs/models/shared/newmatrixpricecadence.md +0 -12
  440. package/docs/models/shared/newmatrixpricemodeltype.md +0 -8
  441. package/docs/models/shared/newpackageprice.md +0 -18
  442. package/docs/models/shared/newpackagepricecadence.md +0 -12
  443. package/docs/models/shared/newpackagepricemodeltype.md +0 -8
  444. package/docs/models/shared/newpackagewithallocationprice.md +0 -18
  445. package/docs/models/shared/newpackagewithallocationpricecadence.md +0 -12
  446. package/docs/models/shared/newpackagewithallocationpricemodeltype.md +0 -8
  447. package/docs/models/shared/newthresholdtotalamountprice.md +0 -18
  448. package/docs/models/shared/newthresholdtotalamountpricecadence.md +0 -12
  449. package/docs/models/shared/newthresholdtotalamountpricemodeltype.md +0 -8
  450. package/docs/models/shared/newtieredbpsprice.md +0 -18
  451. package/docs/models/shared/newtieredbpspricecadence.md +0 -12
  452. package/docs/models/shared/newtieredbpspricemodeltype.md +0 -8
  453. package/docs/models/shared/newtieredpackageprice.md +0 -18
  454. package/docs/models/shared/newtieredpackagepricecadence.md +0 -12
  455. package/docs/models/shared/newtieredpackagepricemodeltype.md +0 -8
  456. package/docs/models/shared/newtieredprice.md +0 -18
  457. package/docs/models/shared/newtieredpricecadence.md +0 -12
  458. package/docs/models/shared/newtieredpricemodeltype.md +0 -8
  459. package/docs/models/shared/newtieredwithminimumprice.md +0 -18
  460. package/docs/models/shared/newtieredwithminimumpricecadence.md +0 -12
  461. package/docs/models/shared/newtieredwithminimumpricemodeltype.md +0 -8
  462. package/docs/models/shared/newunitprice.md +0 -18
  463. package/docs/models/shared/newunitpricecadence.md +0 -12
  464. package/docs/models/shared/newunitpricemodeltype.md +0 -8
  465. package/docs/models/shared/othersublineitem.md +0 -12
  466. package/docs/models/shared/othersublineitemtype.md +0 -8
  467. package/docs/models/shared/overridebpsprice.md +0 -14
  468. package/docs/models/shared/overridebpspricemodeltype.md +0 -8
  469. package/docs/models/shared/overridebulkbpsprice.md +0 -14
  470. package/docs/models/shared/overridebulkbpspricemodeltype.md +0 -8
  471. package/docs/models/shared/overridebulkprice.md +0 -14
  472. package/docs/models/shared/overridebulkpricemodeltype.md +0 -8
  473. package/docs/models/shared/overridefivetranexampleprice.md +0 -14
  474. package/docs/models/shared/overridefivetranexamplepricemodeltype.md +0 -8
  475. package/docs/models/shared/overridematrixprice.md +0 -14
  476. package/docs/models/shared/overridematrixpricemodeltype.md +0 -8
  477. package/docs/models/shared/overridepackageprice.md +0 -14
  478. package/docs/models/shared/overridepackagepricemodeltype.md +0 -8
  479. package/docs/models/shared/overridepackagewithallocationprice.md +0 -14
  480. package/docs/models/shared/overridepackagewithallocationpricemodeltype.md +0 -8
  481. package/docs/models/shared/overridetestratingfunctionprice.md +0 -14
  482. package/docs/models/shared/overridetestratingfunctionpricemodeltype.md +0 -8
  483. package/docs/models/shared/overridethresholdtotalamountprice.md +0 -14
  484. package/docs/models/shared/overridethresholdtotalamountpricemodeltype.md +0 -8
  485. package/docs/models/shared/overridetieredbpsprice.md +0 -14
  486. package/docs/models/shared/overridetieredbpspricemodeltype.md +0 -8
  487. package/docs/models/shared/overridetieredpackageprice.md +0 -14
  488. package/docs/models/shared/overridetieredpackagepricemodeltype.md +0 -8
  489. package/docs/models/shared/overridetieredprice.md +0 -14
  490. package/docs/models/shared/overridetieredpricemodeltype.md +0 -8
  491. package/docs/models/shared/overridetieredwithminimumprice.md +0 -14
  492. package/docs/models/shared/overridetieredwithminimumpricemodeltype.md +0 -8
  493. package/docs/models/shared/overrideunitprice.md +0 -14
  494. package/docs/models/shared/overrideunitpricemodeltype.md +0 -8
  495. package/docs/models/shared/packageconfig.md +0 -9
  496. package/docs/models/shared/packageprice.md +0 -225
  497. package/docs/models/shared/packagepricecadence.md +0 -11
  498. package/docs/models/shared/packagepricemodeltype.md +0 -8
  499. package/docs/models/shared/packagepricepricetype.md +0 -9
  500. package/docs/models/shared/packagewithallocationprice.md +0 -225
  501. package/docs/models/shared/packagewithallocationpricecadence.md +0 -11
  502. package/docs/models/shared/packagewithallocationpricemodeltype.md +0 -8
  503. package/docs/models/shared/packagewithallocationpricepricetype.md +0 -9
  504. package/docs/models/shared/percentagediscount.md +0 -10
  505. package/docs/models/shared/percentagediscountcreationparams.md +0 -9
  506. package/docs/models/shared/percentagediscountcreationparamsdiscounttype.md +0 -8
  507. package/docs/models/shared/percentagediscountdiscounttype.md +0 -8
  508. package/docs/models/shared/percentagediscountinterval.md +0 -13
  509. package/docs/models/shared/percentagediscountintervaldiscounttype.md +0 -8
  510. package/docs/models/shared/planprices.md +0 -7
  511. package/docs/models/shared/requesttoolargeerror.md +0 -12
  512. package/docs/models/shared/requesttoolargeerrorheaders.md +0 -7
  513. package/docs/models/shared/requesttoolargeerrorstatus.md +0 -8
  514. package/docs/models/shared/requesttoolargeerrortype.md +0 -8
  515. package/docs/models/shared/requestvalidationerror.md +0 -13
  516. package/docs/models/shared/requestvalidationerrorheaders.md +0 -7
  517. package/docs/models/shared/requestvalidationerrorstatus.md +0 -8
  518. package/docs/models/shared/requestvalidationerrortype.md +0 -8
  519. package/docs/models/shared/resourcenotfounderror.md +0 -12
  520. package/docs/models/shared/resourcenotfounderrorheaders.md +0 -7
  521. package/docs/models/shared/resourcenotfounderrorstatus.md +0 -8
  522. package/docs/models/shared/resourcenotfounderrortype.md +0 -8
  523. package/docs/models/shared/resourcetoolargeerror.md +0 -12
  524. package/docs/models/shared/resourcetoolargeerrorheaders.md +0 -7
  525. package/docs/models/shared/resourcetoolargeerrorstatus.md +0 -8
  526. package/docs/models/shared/resourcetoolargeerrortype.md +0 -8
  527. package/docs/models/shared/sublineitemgrouping.md +0 -9
  528. package/docs/models/shared/sublineitemmatrixconfig.md +0 -8
  529. package/docs/models/shared/testratingfunctionprice.md +0 -225
  530. package/docs/models/shared/testratingfunctionpricecadence.md +0 -11
  531. package/docs/models/shared/testratingfunctionpricemodeltype.md +0 -8
  532. package/docs/models/shared/testratingfunctionpricepricetype.md +0 -9
  533. package/docs/models/shared/thresholdtotalamountprice.md +0 -225
  534. package/docs/models/shared/thresholdtotalamountpricecadence.md +0 -11
  535. package/docs/models/shared/thresholdtotalamountpricemodeltype.md +0 -8
  536. package/docs/models/shared/thresholdtotalamountpricepricetype.md +0 -9
  537. package/docs/models/shared/tier.md +0 -10
  538. package/docs/models/shared/tierconfig.md +0 -10
  539. package/docs/models/shared/tieredbpsconfig.md +0 -8
  540. package/docs/models/shared/tieredbpsprice.md +0 -225
  541. package/docs/models/shared/tieredbpspricecadence.md +0 -11
  542. package/docs/models/shared/tieredbpspricemodeltype.md +0 -8
  543. package/docs/models/shared/tieredbpspricepricetype.md +0 -9
  544. package/docs/models/shared/tieredconfig.md +0 -8
  545. package/docs/models/shared/tieredpackageprice.md +0 -225
  546. package/docs/models/shared/tieredpackagepricecadence.md +0 -11
  547. package/docs/models/shared/tieredpackagepricemodeltype.md +0 -8
  548. package/docs/models/shared/tieredpackagepricepricetype.md +0 -9
  549. package/docs/models/shared/tieredprice.md +0 -225
  550. package/docs/models/shared/tieredpricecadence.md +0 -11
  551. package/docs/models/shared/tieredpricemodeltype.md +0 -8
  552. package/docs/models/shared/tieredpricepricetype.md +0 -9
  553. package/docs/models/shared/tieredwithminimumprice.md +0 -225
  554. package/docs/models/shared/tieredwithminimumpricecadence.md +0 -11
  555. package/docs/models/shared/tieredwithminimumpricemodeltype.md +0 -8
  556. package/docs/models/shared/tieredwithminimumpricepricetype.md +0 -9
  557. package/docs/models/shared/tiersublineitem.md +0 -13
  558. package/docs/models/shared/tiersublineitemtype.md +0 -8
  559. package/docs/models/shared/trialdiscount.md +0 -11
  560. package/docs/models/shared/trialdiscountdiscounttype.md +0 -8
  561. package/docs/models/shared/ungroupedsubscriptionusage.md +0 -8
  562. package/docs/models/shared/ungroupedsubscriptionusagerecord.md +0 -10
  563. package/docs/models/shared/ungroupedsubscriptionusagerecordviewmode.md +0 -9
  564. package/docs/models/shared/unitconfig.md +0 -9
  565. package/docs/models/shared/unitprice.md +0 -225
  566. package/docs/models/shared/unitpricecadence.md +0 -11
  567. package/docs/models/shared/unitpricemodeltype.md +0 -8
  568. package/docs/models/shared/unitpricepricetype.md +0 -9
  569. package/docs/models/shared/urlnotfound.md +0 -12
  570. package/docs/models/shared/urlnotfoundheaders.md +0 -7
  571. package/docs/models/shared/urlnotfoundstatus.md +0 -8
  572. package/docs/models/shared/urlnotfoundtype.md +0 -8
  573. package/docs/models/shared/usage.md +0 -10
  574. package/docs/models/shared/usagediscount.md +0 -10
  575. package/docs/models/shared/usagediscountcreationparams.md +0 -9
  576. package/docs/models/shared/usagediscountcreationparamsdiscounttype.md +0 -8
  577. package/docs/models/shared/usagediscountdiscounttype.md +0 -8
  578. package/docs/models/shared/usagediscountinterval.md +0 -13
  579. package/docs/models/shared/usagediscountintervaldiscounttype.md +0 -8
  580. package/docs/models/shared/voidinitiatedledgerentry.md +0 -24
  581. package/docs/models/shared/voidinitiatedledgerentryentrystatus.md +0 -9
  582. package/docs/models/shared/voidinitiatedledgerentryentrytype.md +0 -8
  583. package/docs/models/shared/voidledgerentry.md +0 -23
  584. package/docs/models/shared/voidledgerentryentrystatus.md +0 -9
  585. package/docs/models/shared/voidledgerentryentrytype.md +0 -8
package/docs/models/operations/markinvoiceaspaidrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
8
- | `markAsPaidRequestParams` | [shared.MarkAsPaidRequestParams](../../models/shared/markaspaidrequestparams.md) | :heavy_minus_sign: | N/A |
9
- | `invoiceId` | *string* | :heavy_check_mark: | N/A |
8
+ | `invoiceId` | *string* | :heavy_check_mark: | N/A |
9
+ | `markAsPaidRequestParams` | [shared.MarkAsPaidRequestParams](../../models/shared/markaspaidrequestparams.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/scheduleplanchangerequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
8
- | `subscriptionPlanChange` | [shared.SubscriptionPlanChange](../../models/shared/subscriptionplanchange.md) | :heavy_minus_sign: | N/A |
9
- | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
8
+ | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
9
+ | `subscriptionPlanChange` | [shared.SubscriptionPlanChange](../../models/shared/subscriptionplanchange.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/triggerphaserequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
8
- | `triggerSubscriptionPhaseParams` | [shared.TriggerSubscriptionPhaseParams](../../models/shared/triggersubscriptionphaseparams.md) | :heavy_minus_sign: | N/A |
9
- | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
8
+ | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
9
+ | `triggerSubscriptionPhaseParams` | [shared.TriggerSubscriptionPhaseParams](../../models/shared/triggersubscriptionphaseparams.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/unschedulefixedfeequantityrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
8
- | `unscheduleFixedFeeQuantityChangeParams` | [shared.UnscheduleFixedFeeQuantityChangeParams](../../models/shared/unschedulefixedfeequantitychangeparams.md) | :heavy_minus_sign: | N/A |
9
- | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
8
+ | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
9
+ | `unscheduleFixedFeeQuantityChangeParams` | [shared.UnscheduleFixedFeeQuantityChangeParams](../../models/shared/unschedulefixedfeequantitychangeparams.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/updatecustomerexternalidrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8
- | `editCustomer` | [shared.EditCustomer](../../models/shared/editcustomer.md) | :heavy_minus_sign: | N/A |
9
- | `externalCustomerId` | *string* | :heavy_check_mark: | N/A |
8
+ | `externalCustomerId` | *string* | :heavy_check_mark: | N/A |
9
+ | `editCustomer` | [shared.EditCustomer](../../models/shared/editcustomer.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/updatecustomerrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8
- | `editCustomer` | [shared.EditCustomer](../../models/shared/editcustomer.md) | :heavy_minus_sign: | N/A |
9
- | `customerId` | *string* | :heavy_check_mark: | N/A |
8
+ | `customerId` | *string* | :heavy_check_mark: | N/A |
9
+ | `editCustomer` | [shared.EditCustomer](../../models/shared/editcustomer.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/updatefixedfeequantityrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
8
- | `fixedFeeQuantityChange` | [shared.FixedFeeQuantityChange](../../models/shared/fixedfeequantitychange.md) | :heavy_minus_sign: | N/A |
9
- | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
8
+ | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
9
+ | `fixedFeeQuantityChange` | [shared.FixedFeeQuantityChange](../../models/shared/fixedfeequantitychange.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/updateplanexternalrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
8
- | `editPlan` | [shared.EditPlan](../../models/shared/editplan.md) | :heavy_minus_sign: | N/A |
9
- | `externalPlanId` | *string* | :heavy_check_mark: | N/A |
8
+ | `externalPlanId` | *string* | :heavy_check_mark: | N/A |
9
+ | `editPlan` | [shared.EditPlan](../../models/shared/editplan.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/updateplanrequest.md CHANGED
@@ -5,5 +5,5 @@
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
8
- | `editPlan` | [shared.EditPlan](../../models/shared/editplan.md) | :heavy_minus_sign: | N/A |
9
- | `planId` | *string* | :heavy_check_mark: | N/A |
8
+ | `planId` | *string* | :heavy_check_mark: | N/A |
9
+ | `editPlan` | [shared.EditPlan](../../models/shared/editplan.md) | :heavy_minus_sign: | N/A |
package/docs/models/shared/addpriceintervalparams.md CHANGED
@@ -6,11 +6,11 @@
6
6
  | Field | Type | Required | Description | Example |
7
7
  | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
8
8
  | `discounts` | *any*[] | :heavy_minus_sign: | A list of discounts to initialize on the price interval. | |
9
- | `endDate` | *any* | :heavy_minus_sign: | The end date of the price interval. This is the date that the price will stop billing on the subscription. | |
9
+ | `endDate` | *any* | :heavy_minus_sign: | The end date of the price interval. This is the date that the price will stop billing on the subscription. | 2023-07-10 |
10
10
  | `externalPriceId` | *string* | :heavy_minus_sign: | The external price id of the price to add to the subscription. | external_price_id |
11
11
  | `fixedFeeQuantityTransitions` | [PriceIntervalFixedFeeQuantityTransitionParams](../../models/shared/priceintervalfixedfeequantitytransitionparams.md)[] | :heavy_minus_sign: | A list of fixed fee quantity transitions to initialize on the price interval. | |
12
12
  | `maximumAmount` | *number* | :heavy_minus_sign: | The maximum amount that will be billed for this price interval for a given billing period. | 1.23 |
13
13
  | `minimumAmount` | *number* | :heavy_minus_sign: | The minimum amount that will be billed for this price interval for a given billing period. | 1.23 |
14
14
  | `price` | *any* | :heavy_minus_sign: | The definition of a new price to create and add to the subscription. | |
15
15
  | `priceId` | *string* | :heavy_minus_sign: | The id of the price to add to the subscription. | h74gfhdjvn7ujokd |
16
- | `startDate` | *any* | :heavy_check_mark: | The start date of the price interval. This is the date that the price will start billing on the subscription. | |
16
+ | `startDate` | *any* | :heavy_check_mark: | The start date of the price interval. This is the date that the price will start billing on the subscription. | 2023-05-01 |
package/docs/models/shared/createinvoicelineitemparams.md CHANGED
@@ -9,5 +9,5 @@
9
9
  | `endDate` | [RFCDate](../../types/rfcdate.md) | :heavy_check_mark: | A date string to specify the line item's end date in the customer's timezone. | 2023-09-22 |
10
10
  | `invoiceId` | *string* | :heavy_check_mark: | The id of the Invoice to add this line item. | 4khy3nwzktxv7 |
11
11
  | `name` | *string* | :heavy_check_mark: | The item name associated with this line item. If an item with the same name exists in Orb, that item will be associated with the line item. | Item Name |
12
- | `quantity` | *any* | :heavy_check_mark: | The number of units on the line item | |
12
+ | `quantity` | *any* | :heavy_check_mark: | The number of units on the line item | 1 |
13
13
  | `startDate` | [RFCDate](../../types/rfcdate.md) | :heavy_check_mark: | A date string to specify the line item's start date in the customer's timezone. | 2023-09-22 |
package/docs/models/shared/discount.md CHANGED
@@ -5,11 +5,11 @@ The subscription's override discount for the plan.
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
10
- | `amountDiscount` | *string* | :heavy_minus_sign: | Only available if discount_type is `amount`. |
11
- | `appliesToPriceIds` | *string*[] | :heavy_minus_sign: | List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. |
12
- | `discountType` | [DiscountDiscountType](../../models/shared/discountdiscounttype.md) | :heavy_check_mark: | N/A |
13
- | `percentageDiscount` | *any* | :heavy_minus_sign: | Only available if discount_type is `percentage`. This is a number between 0 and 1. |
14
- | `trialAmountDiscount` | *string* | :heavy_minus_sign: | Only available if discount_type is `trial` |
15
- | `usageDiscount` | *any* | :heavy_minus_sign: | Only available if discount_type is `usage`. Number of usage units that this discount is for |
8
+ | Field | Type | Required | Description | Example |
9
+ | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
10
+ | `amountDiscount` | *string* | :heavy_minus_sign: | Only available if discount_type is `amount`. | |
11
+ | `appliesToPriceIds` | *string*[] | :heavy_minus_sign: | List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. | h74gfhdjvn7ujokd,7hfgtgjnbvc3ujkl |
12
+ | `discountType` | [DiscountDiscountType](../../models/shared/discountdiscounttype.md) | :heavy_check_mark: | N/A | |
13
+ | `percentageDiscount` | *any* | :heavy_minus_sign: | Only available if discount_type is `percentage`. This is a number between 0 and 1. | 0.15 |
14
+ | `trialAmountDiscount` | *string* | :heavy_minus_sign: | Only available if discount_type is `trial` | |
15
+ | `usageDiscount` | *any* | :heavy_minus_sign: | Only available if discount_type is `usage`. Number of usage units that this discount is for | |
package/docs/models/shared/editpriceintervalparams.md CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  | Field | Type | Required | Description | Example |
7
7
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
8
- | `endDate` | *any* | :heavy_minus_sign: | The updated end date of this price interval. If not specified, the start date will not be updated. | |
8
+ | `endDate` | *any* | :heavy_minus_sign: | The updated end date of this price interval. If not specified, the start date will not be updated. | 2023-07-10 |
9
9
  | `fixedFeeQuantityTransitions` | [PriceIntervalFixedFeeQuantityTransitionParams](../../models/shared/priceintervalfixedfeequantitytransitionparams.md)[] | :heavy_minus_sign: | A list of fixed fee quantity transitions to use for this price interval. Note that this list will overwrite all existing fixed fee quantity transitions on the price interval. | |
10
10
  | `priceIntervalId` | *string* | :heavy_check_mark: | The id of the price interval to edit. | sdfs6wdjvn7ujokd |
11
- | `startDate` | *any* | :heavy_minus_sign: | The updated start date of this price interval. If not specified, the start date will not be updated. | |
11
+ | `startDate` | *any* | :heavy_minus_sign: | The updated start date of this price interval. If not specified, the start date will not be updated. | 2023-05-01 |
package/docs/models/shared/invoicelineitem.md CHANGED
@@ -16,7 +16,7 @@
16
16
  | `minimumAmount` | *string* | :heavy_check_mark: | N/A | |
17
17
  | `name` | *string* | :heavy_check_mark: | The name of the price associated with this line item. | Fixed Fee |
18
18
  | `price` | *any* | :heavy_check_mark: | N/A | |
19
- | `quantity` | *any* | :heavy_check_mark: | N/A | |
19
+ | `quantity` | *any* | :heavy_check_mark: | N/A | 1 |
20
20
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The start date of the range of time applied for this line item's price. | 2022-02-01T08:00:00+00:00 |
21
21
  | `subLineItems` | *any*[] | :heavy_check_mark: | For complex pricing structures, the line item can be broken down further in `sub_line_items`. | |
22
22
  | `subtotal` | *string* | :heavy_check_mark: | The line amount before any line item-specific discounts or minimums. | 9.00 |
package/docs/models/shared/invoicelineitemparams.md CHANGED
@@ -9,6 +9,6 @@
9
9
  | `itemId` | *string* | :heavy_check_mark: | N/A | 4khy3nwzktxv7 |
10
10
  | `modelType` | [InvoiceLineItemParamsModelType](../../models/shared/invoicelineitemparamsmodeltype.md) | :heavy_check_mark: | N/A | unit |
11
11
  | `name` | *string* | :heavy_check_mark: | The name of the line item. | Line Item Name |
12
- | `quantity` | *any* | :heavy_check_mark: | The number of units on the line item | |
12
+ | `quantity` | *any* | :heavy_check_mark: | The number of units on the line item | 1 |
13
13
  | `startDate` | [RFCDate](../../types/rfcdate.md) | :heavy_check_mark: | A date string to specify the line item's start date in the customer's timezone. | 2023-09-22 |
14
- | `unitConfig` | [UnitConfig](../../models/shared/unitconfig.md) | :heavy_check_mark: | N/A | |
14
+ | `unitConfig` | Record<string, *any*> | :heavy_check_mark: | N/A | |
package/docs/models/shared/plan.md CHANGED
@@ -27,7 +27,7 @@ in the [Price resource](/reference/price).
27
27
  | `name` | *string* | :heavy_check_mark: | N/A |
28
28
  | `netTerms` | *number* | :heavy_check_mark: | Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration. |
29
29
  | `planPhases` | [PlanPhase](../../models/shared/planphase.md)[] | :heavy_check_mark: | N/A |
30
- | `prices` | [PlanPrices](../../models/shared/planprices.md)[] | :heavy_check_mark: | Prices for this plan. If the plan has phases, this includes prices across all phases of the plan. |
30
+ | `prices` | *any*[] | :heavy_check_mark: | Prices for this plan. If the plan has phases, this includes prices across all phases of the plan. |
31
31
  | `product` | [Product](../../models/shared/product.md) | :heavy_check_mark: | N/A |
32
32
  | `status` | [PlanStatus](../../models/shared/planstatus.md) | :heavy_check_mark: | N/A |
33
33
  | `trialConfig` | [TrialConfig](../../models/shared/trialconfig.md) | :heavy_check_mark: | N/A |
package/docs/sdks/availability/README.md CHANGED
@@ -17,19 +17,20 @@ This API does not have any side-effects or return any Orb resources.
17
17
 
18
18
  ```typescript
19
19
  import { Orb } from "orb-billing";
20
- import { PingResponse } from "orb-billing/dist/sdk/models/operations";
21
20
 
22
- const sdk = new Orb({
23
- security: {
24
- apiKeyAuth: "",
25
- },
26
- });
21
+ (async() => {
22
+ const sdk = new Orb({
23
+ security: {
24
+ apiKeyAuth: "",
25
+ },
26
+ });
27
+
28
+ const res = await sdk.availability.ping();
27
29
 
28
- sdk.availability.ping().then((res: PingResponse) => {
29
30
  if (res.statusCode == 200) {
30
31
  // handle response
31
32
  }
32
- });
33
+ })();
33
34
  ```
34
35
 
35
36
  ### Parameters
package/docs/sdks/coupon/README.md CHANGED
@@ -28,29 +28,30 @@ code can be reused for a different coupon.
28
28
 
29
29
  ```typescript
30
30
  import { Orb } from "orb-billing";
31
- import { ArchiveCouponResponse } from "orb-billing/dist/sdk/models/operations";
31
+ import { ArchiveCouponRequest } from "orb-billing/dist/sdk/models/operations";
32
32
 
33
- const sdk = new Orb({
34
- security: {
35
- apiKeyAuth: "",
36
- },
37
- });
33
+ (async() => {
34
+ const sdk = new Orb({
35
+ security: {
36
+ apiKeyAuth: "",
37
+ },
38
+ });
39
+ const couponId: string = "meek";
40
+
41
+ const res = await sdk.coupon.archive(couponId);
38
42
 
39
- sdk.coupon.archive({
40
- couponId: "system Israeli farad",
41
- }).then((res: ArchiveCouponResponse) => {
42
43
  if (res.statusCode == 200) {
43
44
  // handle response
44
45
  }
45
- });
46
+ })();
46
47
  ```
47
48
 
48
49
  ### Parameters
49
50
 
50
- | Parameter | Type | Required | Description |
51
- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
52
- | `request` | [operations.ArchiveCouponRequest](../../models/operations/archivecouponrequest.md) | :heavy_check_mark: | The request object to use for the request. |
53
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
51
+ | Parameter | Type | Required | Description |
52
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
53
+ | `couponId` | *string* | :heavy_check_mark: | N/A |
54
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
54
55
 
55
56
 
56
57
  ### Response
@@ -66,24 +67,24 @@ This endpoint allows the creation of coupons, which can then be redeemed at subs
66
67
 
67
68
  ```typescript
68
69
  import { Orb } from "orb-billing";
69
- import { CreateCouponResponse } from "orb-billing/dist/sdk/models/operations";
70
-
71
- const sdk = new Orb({
72
- security: {
73
- apiKeyAuth: "",
74
- },
75
- });
76
-
77
- sdk.coupon.create({
78
- discount: {},
79
- durationInMonths: 12,
80
- maxRedemptions: 486589,
81
- redemptionCode: "HALFOFF",
82
- }).then((res: CreateCouponResponse) => {
70
+
71
+ (async() => {
72
+ const sdk = new Orb({
73
+ security: {
74
+ apiKeyAuth: "",
75
+ },
76
+ });
77
+
78
+ const res = await sdk.coupon.create({
79
+ discount: {},
80
+ durationInMonths: 12,
81
+ redemptionCode: "HALFOFF",
82
+ });
83
+
83
84
  if (res.statusCode == 200) {
84
85
  // handle response
85
86
  }
86
- });
87
+ })();
87
88
  ```
88
89
 
89
90
  ### Parameters
@@ -108,29 +109,30 @@ This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption
108
109
 
109
110
  ```typescript
110
111
  import { Orb } from "orb-billing";
111
- import { FetchCouponResponse } from "orb-billing/dist/sdk/models/operations";
112
+ import { FetchCouponRequest } from "orb-billing/dist/sdk/models/operations";
113
+
114
+ (async() => {
115
+ const sdk = new Orb({
116
+ security: {
117
+ apiKeyAuth: "",
118
+ },
119
+ });
120
+ const couponId: string = "grateful";
112
121
 
113
- const sdk = new Orb({
114
- security: {
115
- apiKeyAuth: "",
116
- },
117
- });
122
+ const res = await sdk.coupon.fetch(couponId);
118
123
 
119
- sdk.coupon.fetch({
120
- couponId: "Total Honda Southeast",
121
- }).then((res: FetchCouponResponse) => {
122
124
  if (res.statusCode == 200) {
123
125
  // handle response
124
126
  }
125
- });
127
+ })();
126
128
  ```
127
129
 
128
130
  ### Parameters
129
131
 
130
- | Parameter | Type | Required | Description |
131
- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
132
- | `request` | [operations.FetchCouponRequest](../../models/operations/fetchcouponrequest.md) | :heavy_check_mark: | The request object to use for the request. |
133
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
132
+ | Parameter | Type | Required | Description |
133
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
134
+ | `couponId` | *string* | :heavy_check_mark: | N/A |
135
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
134
136
 
135
137
 
136
138
  ### Response
@@ -150,32 +152,36 @@ about pagination can be found in the Pagination-metadata schema.
150
152
 
151
153
  ```typescript
152
154
  import { Orb } from "orb-billing";
153
- import { ListCouponsResponse } from "orb-billing/dist/sdk/models/operations";
154
-
155
- const sdk = new Orb({
156
- security: {
157
- apiKeyAuth: "",
158
- },
159
- });
160
-
161
- sdk.coupon.list({
162
- cursor: "Northeast Metal Canada",
163
- limit: 917416,
164
- redemptionCode: "orchid Van",
165
- showArchived: false,
166
- }).then((res: ListCouponsResponse) => {
155
+ import { ListCouponsRequest } from "orb-billing/dist/sdk/models/operations";
156
+
157
+ (async() => {
158
+ const sdk = new Orb({
159
+ security: {
160
+ apiKeyAuth: "",
161
+ },
162
+ });
163
+ const cursor: string = "Bicycle";
164
+ const limit: number = 257649;
165
+ const redemptionCode: string = "Product";
166
+ const showArchived: boolean = false;
167
+
168
+ const res = await sdk.coupon.list(cursor, limit, redemptionCode, showArchived);
169
+
167
170
  if (res.statusCode == 200) {
168
171
  // handle response
169
172
  }
170
- });
173
+ })();
171
174
  ```
172
175
 
173
176
  ### Parameters
174
177
 
175
- | Parameter | Type | Required | Description |
176
- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
177
- | `request` | [operations.ListCouponsRequest](../../models/operations/listcouponsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
178
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
178
+ | Parameter | Type | Required | Description |
179
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
180
+ | `cursor` | *string* | :heavy_minus_sign: | N/A |
181
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
182
+ | `redemptionCode` | *string* | :heavy_minus_sign: | N/A |
183
+ | `showArchived` | *boolean* | :heavy_minus_sign: | N/A |
184
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
179
185
 
180
186
 
181
187
  ### Response
@@ -193,31 +199,34 @@ discussion of the subscription resource, see [Subscription](../guides/concepts#s
193
199
 
194
200
  ```typescript
195
201
  import { Orb } from "orb-billing";
196
- import { ListCouponSubscriptionsResponse } from "orb-billing/dist/sdk/models/operations";
197
-
198
- const sdk = new Orb({
199
- security: {
200
- apiKeyAuth: "",
201
- },
202
- });
203
-
204
- sdk.coupon.listSubscriptions({
205
- couponId: "Crossroad Bacon portal",
206
- cursor: "enzyme",
207
- limit: 231233,
208
- }).then((res: ListCouponSubscriptionsResponse) => {
202
+ import { ListCouponSubscriptionsRequest } from "orb-billing/dist/sdk/models/operations";
203
+
204
+ (async() => {
205
+ const sdk = new Orb({
206
+ security: {
207
+ apiKeyAuth: "",
208
+ },
209
+ });
210
+ const couponId: string = "Potassium";
211
+ const cursor: string = "Neptunium";
212
+ const limit: number = 166597;
213
+
214
+ const res = await sdk.coupon.listSubscriptions(couponId, cursor, limit);
215
+
209
216
  if (res.statusCode == 200) {
210
217
  // handle response
211
218
  }
212
- });
219
+ })();
213
220
  ```
214
221
 
215
222
  ### Parameters
216
223
 
217
- | Parameter | Type | Required | Description |
218
- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
219
- | `request` | [operations.ListCouponSubscriptionsRequest](../../models/operations/listcouponsubscriptionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
220
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
224
+ | Parameter | Type | Required | Description |
225
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
226
+ | `couponId` | *string* | :heavy_check_mark: | N/A |
227
+ | `cursor` | *string* | :heavy_minus_sign: | N/A |
228
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
229
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
221
230
 
222
231
 
223
232
  ### Response