orb-billing 1.19.5 → 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/sdk/coupon.d.ts +4 -4
  3. package/dist/sdk/coupon.js +25 -20
  4. package/dist/sdk/credit.d.ts +4 -4
  5. package/dist/sdk/credit.js +26 -20
  6. package/dist/sdk/creditnote.d.ts +2 -2
  7. package/dist/sdk/creditnote.js +11 -10
  8. package/dist/sdk/customer.d.ts +8 -8
  9. package/dist/sdk/customer.js +49 -40
  10. package/dist/sdk/event.d.ts +7 -7
  11. package/dist/sdk/event.js +39 -35
  12. package/dist/sdk/invoice.d.ts +5 -5
  13. package/dist/sdk/invoice.js +26 -25
  14. package/dist/sdk/item.d.ts +2 -2
  15. package/dist/sdk/item.js +11 -10
  16. package/dist/sdk/metric.d.ts +1 -1
  17. package/dist/sdk/metric.js +5 -5
  18. package/dist/sdk/models/operations/addeditpriceintervals.d.ts +1 -1
  19. package/dist/sdk/models/operations/addeditpriceintervals.js +4 -4
  20. package/dist/sdk/models/operations/amendevent.d.ts +1 -1
  21. package/dist/sdk/models/operations/amendevent.js +4 -4
  22. package/dist/sdk/models/operations/amendusage.d.ts +1 -1
  23. package/dist/sdk/models/operations/amendusage.js +4 -4
  24. package/dist/sdk/models/operations/amendusageexternalcustomerid.d.ts +1 -1
  25. package/dist/sdk/models/operations/amendusageexternalcustomerid.js +4 -4
  26. package/dist/sdk/models/operations/cancelsubscription.d.ts +1 -1
  27. package/dist/sdk/models/operations/cancelsubscription.js +4 -4
  28. package/dist/sdk/models/operations/createcustomerbalancetransaction.d.ts +1 -1
  29. package/dist/sdk/models/operations/createcustomerbalancetransaction.js +4 -4
  30. package/dist/sdk/models/operations/createledgerentry.d.ts +1 -1
  31. package/dist/sdk/models/operations/createledgerentry.js +4 -4
  32. package/dist/sdk/models/operations/createledgerentryexternalid.d.ts +1 -1
  33. package/dist/sdk/models/operations/createledgerentryexternalid.js +4 -4
  34. package/dist/sdk/models/operations/fetchcustomercredits.d.ts +1 -1
  35. package/dist/sdk/models/operations/fetchcustomercredits.js +4 -4
  36. package/dist/sdk/models/operations/fetchcustomercreditsexternalid.d.ts +1 -1
  37. package/dist/sdk/models/operations/fetchcustomercreditsexternalid.js +4 -4
  38. package/dist/sdk/models/operations/markinvoiceaspaid.d.ts +1 -1
  39. package/dist/sdk/models/operations/markinvoiceaspaid.js +4 -4
  40. package/dist/sdk/models/operations/scheduleplanchange.d.ts +1 -1
  41. package/dist/sdk/models/operations/scheduleplanchange.js +4 -4
  42. package/dist/sdk/models/operations/triggerphase.d.ts +1 -1
  43. package/dist/sdk/models/operations/triggerphase.js +4 -4
  44. package/dist/sdk/models/operations/unschedulefixedfeequantity.d.ts +1 -1
  45. package/dist/sdk/models/operations/unschedulefixedfeequantity.js +4 -4
  46. package/dist/sdk/models/operations/updatecustomer.d.ts +1 -1
  47. package/dist/sdk/models/operations/updatecustomer.js +4 -4
  48. package/dist/sdk/models/operations/updatecustomerexternalid.d.ts +1 -1
  49. package/dist/sdk/models/operations/updatecustomerexternalid.js +4 -4
  50. package/dist/sdk/models/operations/updatefixedfeequantity.d.ts +1 -1
  51. package/dist/sdk/models/operations/updatefixedfeequantity.js +4 -4
  52. package/dist/sdk/models/operations/updateplan.d.ts +1 -1
  53. package/dist/sdk/models/operations/updateplan.js +4 -4
  54. package/dist/sdk/models/operations/updateplanexternal.d.ts +1 -1
  55. package/dist/sdk/models/operations/updateplanexternal.js +4 -4
  56. package/dist/sdk/models/shared/addpriceintervalparams.d.ts +0 -14
  57. package/dist/sdk/models/shared/addpriceintervalparams.js +1 -17
  58. package/dist/sdk/models/shared/editpriceintervalparams.d.ts +0 -14
  59. package/dist/sdk/models/shared/editpriceintervalparams.js +1 -17
  60. package/dist/sdk/models/shared/index.d.ts +0 -103
  61. package/dist/sdk/models/shared/index.js +0 -103
  62. package/dist/sdk/models/shared/invoicelineitemparams.d.ts +1 -2
  63. package/dist/sdk/models/shared/invoicelineitemparams.js +1 -3
  64. package/dist/sdk/models/shared/itemexternalconnection.d.ts +0 -11
  65. package/dist/sdk/models/shared/itemexternalconnection.js +1 -14
  66. package/dist/sdk/models/shared/plan.d.ts +1 -3
  67. package/dist/sdk/models/shared/plan.js +2 -11
  68. package/dist/sdk/plan.d.ts +4 -4
  69. package/dist/sdk/plan.js +22 -20
  70. package/dist/sdk/price.d.ts +3 -3
  71. package/dist/sdk/price.js +16 -15
  72. package/dist/sdk/priceinterval.d.ts +2 -1
  73. package/dist/sdk/priceinterval.js +6 -5
  74. package/dist/sdk/sdk.js +3 -3
  75. package/dist/sdk/subscription.d.ts +8 -8
  76. package/dist/sdk/subscription.js +45 -40
  77. package/docs/models/operations/addeditpriceintervalsrequest.md +2 -2
  78. package/docs/models/operations/amendeventrequest.md +2 -2
  79. package/docs/models/operations/amendusageexternalcustomeridrequest.md +1 -1
  80. package/docs/models/operations/amendusagerequest.md +1 -1
  81. package/docs/models/operations/cancelsubscriptionrequest.md +2 -2
  82. package/docs/models/operations/createcustomerbalancetransactionrequest.md +2 -2
  83. package/docs/models/operations/createledgerentryexternalidrequest.md +2 -2
  84. package/docs/models/operations/createledgerentryrequest.md +2 -2
  85. package/docs/models/operations/fetchcustomercreditsexternalidrequest.md +1 -1
  86. package/docs/models/operations/fetchcustomercreditsrequest.md +1 -1
  87. package/docs/models/operations/markinvoiceaspaidrequest.md +2 -2
  88. package/docs/models/operations/scheduleplanchangerequest.md +2 -2
  89. package/docs/models/operations/triggerphaserequest.md +2 -2
  90. package/docs/models/operations/unschedulefixedfeequantityrequest.md +2 -2
  91. package/docs/models/operations/updatecustomerexternalidrequest.md +2 -2
  92. package/docs/models/operations/updatecustomerrequest.md +2 -2
  93. package/docs/models/operations/updatefixedfeequantityrequest.md +2 -2
  94. package/docs/models/operations/updateplanexternalrequest.md +2 -2
  95. package/docs/models/operations/updateplanrequest.md +2 -2
  96. package/docs/models/shared/addpriceintervalparams.md +2 -2
  97. package/docs/models/shared/createinvoicelineitemparams.md +1 -1
  98. package/docs/models/shared/discount.md +8 -8
  99. package/docs/models/shared/editpriceintervalparams.md +2 -2
  100. package/docs/models/shared/invoicelineitem.md +1 -1
  101. package/docs/models/shared/invoicelineitemparams.md +2 -2
  102. package/docs/models/shared/plan.md +1 -1
  103. package/docs/sdks/availability/README.md +9 -8
  104. package/docs/sdks/coupon/README.md +89 -80
  105. package/docs/sdks/credit/README.md +104 -144
  106. package/docs/sdks/creditnote/README.md +34 -31
  107. package/docs/sdks/customer/README.md +303 -352
  108. package/docs/sdks/event/README.md +162 -162
  109. package/docs/sdks/invoice/README.md +145 -159
  110. package/docs/sdks/item/README.md +34 -31
  111. package/docs/sdks/metric/README.md +43 -47
  112. package/docs/sdks/plan/README.md +100 -102
  113. package/docs/sdks/price/README.md +60 -96
  114. package/docs/sdks/priceinterval/README.md +55 -98
  115. package/docs/sdks/subscription/README.md +278 -384
  116. package/package.json +1 -1
  117. package/dist/sdk/models/shared/addamendmentcreditledgerentryrequestparams.d.ts +0 -28
  118. package/dist/sdk/models/shared/addamendmentcreditledgerentryrequestparams.js +0 -81
  119. package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.d.ts +0 -24
  120. package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.js +0 -76
  121. package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.d.ts +0 -37
  122. package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.js +0 -102
  123. package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.d.ts +0 -42
  124. package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.js +0 -109
  125. package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.d.ts +0 -38
  126. package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.js +0 -93
  127. package/dist/sdk/models/shared/affectedblock.d.ts +0 -6
  128. package/dist/sdk/models/shared/affectedblock.js +0 -59
  129. package/dist/sdk/models/shared/amendmentledgerentry.d.ts +0 -27
  130. package/dist/sdk/models/shared/amendmentledgerentry.js +0 -120
  131. package/dist/sdk/models/shared/amountdiscount.d.ts +0 -15
  132. package/dist/sdk/models/shared/amountdiscount.js +0 -59
  133. package/dist/sdk/models/shared/amountdiscountcreationparams.d.ts +0 -11
  134. package/dist/sdk/models/shared/amountdiscountcreationparams.js +0 -54
  135. package/dist/sdk/models/shared/amountdiscountinterval.d.ts +0 -27
  136. package/dist/sdk/models/shared/amountdiscountinterval.js +0 -82
  137. package/dist/sdk/models/shared/billablemetricsimple.d.ts +0 -5
  138. package/dist/sdk/models/shared/billablemetricsimple.js +0 -50
  139. package/dist/sdk/models/shared/billablemetrictiny.d.ts +0 -4
  140. package/dist/sdk/models/shared/billablemetrictiny.js +0 -45
  141. package/dist/sdk/models/shared/bpsconfig.d.ts +0 -11
  142. package/dist/sdk/models/shared/bpsconfig.js +0 -50
  143. package/dist/sdk/models/shared/bpsprice.d.ts +0 -242
  144. package/dist/sdk/models/shared/bpsprice.js +0 -363
  145. package/dist/sdk/models/shared/bpstier.d.ts +0 -19
  146. package/dist/sdk/models/shared/bpstier.js +0 -60
  147. package/dist/sdk/models/shared/bulkbpsconfig.d.ts +0 -8
  148. package/dist/sdk/models/shared/bulkbpsconfig.js +0 -47
  149. package/dist/sdk/models/shared/bulkbpsprice.d.ts +0 -242
  150. package/dist/sdk/models/shared/bulkbpsprice.js +0 -363
  151. package/dist/sdk/models/shared/bulkbpstier.d.ts +0 -15
  152. package/dist/sdk/models/shared/bulkbpstier.js +0 -55
  153. package/dist/sdk/models/shared/bulkconfig.d.ts +0 -8
  154. package/dist/sdk/models/shared/bulkconfig.js +0 -47
  155. package/dist/sdk/models/shared/bulkprice.d.ts +0 -242
  156. package/dist/sdk/models/shared/bulkprice.js +0 -363
  157. package/dist/sdk/models/shared/bulktier.d.ts +0 -11
  158. package/dist/sdk/models/shared/bulktier.js +0 -50
  159. package/dist/sdk/models/shared/creditblockexpiryledgerentry.d.ts +0 -27
  160. package/dist/sdk/models/shared/creditblockexpiryledgerentry.js +0 -120
  161. package/dist/sdk/models/shared/decrementledgerentry.d.ts +0 -30
  162. package/dist/sdk/models/shared/decrementledgerentry.js +0 -135
  163. package/dist/sdk/models/shared/duplicateconstraintviolationerror.d.ts +0 -16
  164. package/dist/sdk/models/shared/duplicateconstraintviolationerror.js +0 -82
  165. package/dist/sdk/models/shared/duplicateresourcecreationerror.d.ts +0 -16
  166. package/dist/sdk/models/shared/duplicateresourcecreationerror.js +0 -82
  167. package/dist/sdk/models/shared/expirationchangeledgerentry.d.ts +0 -28
  168. package/dist/sdk/models/shared/expirationchangeledgerentry.js +0 -129
  169. package/dist/sdk/models/shared/featurenotavailableerror.d.ts +0 -16
  170. package/dist/sdk/models/shared/featurenotavailableerror.js +0 -82
  171. package/dist/sdk/models/shared/fivetranexampleprice.d.ts +0 -241
  172. package/dist/sdk/models/shared/fivetranexampleprice.js +0 -361
  173. package/dist/sdk/models/shared/groupedsubscriptionusage.d.ts +0 -7
  174. package/dist/sdk/models/shared/groupedsubscriptionusage.js +0 -54
  175. package/dist/sdk/models/shared/groupedsubscriptionusagerecord.d.ts +0 -14
  176. package/dist/sdk/models/shared/groupedsubscriptionusagerecord.js +0 -71
  177. package/dist/sdk/models/shared/idempotencyconflict.d.ts +0 -16
  178. package/dist/sdk/models/shared/idempotencyconflict.js +0 -82
  179. package/dist/sdk/models/shared/idempotencykeyvalidationerror.d.ts +0 -17
  180. package/dist/sdk/models/shared/idempotencykeyvalidationerror.js +0 -87
  181. package/dist/sdk/models/shared/idempotencyrequestmismatch.d.ts +0 -16
  182. package/dist/sdk/models/shared/idempotencyrequestmismatch.js +0 -82
  183. package/dist/sdk/models/shared/incrementcreditledgerentryinvoicesettings.d.ts +0 -18
  184. package/dist/sdk/models/shared/incrementcreditledgerentryinvoicesettings.js +0 -58
  185. package/dist/sdk/models/shared/incrementledgerentry.d.ts +0 -27
  186. package/dist/sdk/models/shared/incrementledgerentry.js +0 -120
  187. package/dist/sdk/models/shared/itemslim.d.ts +0 -5
  188. package/dist/sdk/models/shared/itemslim.js +0 -50
  189. package/dist/sdk/models/shared/matrixconfig.d.ts +0 -20
  190. package/dist/sdk/models/shared/matrixconfig.js +0 -62
  191. package/dist/sdk/models/shared/matrixprice.d.ts +0 -242
  192. package/dist/sdk/models/shared/matrixprice.js +0 -363
  193. package/dist/sdk/models/shared/matrixsublineitem.d.ts +0 -17
  194. package/dist/sdk/models/shared/matrixsublineitem.js +0 -78
  195. package/dist/sdk/models/shared/matrixvalue.d.ts +0 -15
  196. package/dist/sdk/models/shared/matrixvalue.js +0 -55
  197. package/dist/sdk/models/shared/metricgroup.d.ts +0 -5
  198. package/dist/sdk/models/shared/metricgroup.js +0 -50
  199. package/dist/sdk/models/shared/newbpsprice.d.ts +0 -53
  200. package/dist/sdk/models/shared/newbpsprice.js +0 -110
  201. package/dist/sdk/models/shared/newbulkbpsprice.d.ts +0 -53
  202. package/dist/sdk/models/shared/newbulkbpsprice.js +0 -110
  203. package/dist/sdk/models/shared/newbulkprice.d.ts +0 -53
  204. package/dist/sdk/models/shared/newbulkprice.js +0 -110
  205. package/dist/sdk/models/shared/newmatrixprice.d.ts +0 -53
  206. package/dist/sdk/models/shared/newmatrixprice.js +0 -110
  207. package/dist/sdk/models/shared/newpackageprice.d.ts +0 -53
  208. package/dist/sdk/models/shared/newpackageprice.js +0 -110
  209. package/dist/sdk/models/shared/newpackagewithallocationprice.d.ts +0 -52
  210. package/dist/sdk/models/shared/newpackagewithallocationprice.js +0 -108
  211. package/dist/sdk/models/shared/newthresholdtotalamountprice.d.ts +0 -52
  212. package/dist/sdk/models/shared/newthresholdtotalamountprice.js +0 -108
  213. package/dist/sdk/models/shared/newtieredbpsprice.d.ts +0 -53
  214. package/dist/sdk/models/shared/newtieredbpsprice.js +0 -110
  215. package/dist/sdk/models/shared/newtieredpackageprice.d.ts +0 -52
  216. package/dist/sdk/models/shared/newtieredpackageprice.js +0 -108
  217. package/dist/sdk/models/shared/newtieredprice.d.ts +0 -53
  218. package/dist/sdk/models/shared/newtieredprice.js +0 -110
  219. package/dist/sdk/models/shared/newtieredwithminimumprice.d.ts +0 -52
  220. package/dist/sdk/models/shared/newtieredwithminimumprice.js +0 -108
  221. package/dist/sdk/models/shared/newunitprice.d.ts +0 -53
  222. package/dist/sdk/models/shared/newunitprice.js +0 -110
  223. package/dist/sdk/models/shared/othersublineitem.d.ts +0 -15
  224. package/dist/sdk/models/shared/othersublineitem.js +0 -71
  225. package/dist/sdk/models/shared/overridebpsprice.d.ts +0 -27
  226. package/dist/sdk/models/shared/overridebpsprice.js +0 -83
  227. package/dist/sdk/models/shared/overridebulkbpsprice.d.ts +0 -27
  228. package/dist/sdk/models/shared/overridebulkbpsprice.js +0 -83
  229. package/dist/sdk/models/shared/overridebulkprice.d.ts +0 -27
  230. package/dist/sdk/models/shared/overridebulkprice.js +0 -83
  231. package/dist/sdk/models/shared/overridefivetranexampleprice.d.ts +0 -26
  232. package/dist/sdk/models/shared/overridefivetranexampleprice.js +0 -81
  233. package/dist/sdk/models/shared/overridematrixprice.d.ts +0 -27
  234. package/dist/sdk/models/shared/overridematrixprice.js +0 -83
  235. package/dist/sdk/models/shared/overridepackageprice.d.ts +0 -27
  236. package/dist/sdk/models/shared/overridepackageprice.js +0 -83
  237. package/dist/sdk/models/shared/overridepackagewithallocationprice.d.ts +0 -26
  238. package/dist/sdk/models/shared/overridepackagewithallocationprice.js +0 -81
  239. package/dist/sdk/models/shared/overridetestratingfunctionprice.d.ts +0 -26
  240. package/dist/sdk/models/shared/overridetestratingfunctionprice.js +0 -81
  241. package/dist/sdk/models/shared/overridethresholdtotalamountprice.d.ts +0 -26
  242. package/dist/sdk/models/shared/overridethresholdtotalamountprice.js +0 -81
  243. package/dist/sdk/models/shared/overridetieredbpsprice.d.ts +0 -27
  244. package/dist/sdk/models/shared/overridetieredbpsprice.js +0 -83
  245. package/dist/sdk/models/shared/overridetieredpackageprice.d.ts +0 -26
  246. package/dist/sdk/models/shared/overridetieredpackageprice.js +0 -81
  247. package/dist/sdk/models/shared/overridetieredprice.d.ts +0 -27
  248. package/dist/sdk/models/shared/overridetieredprice.js +0 -83
  249. package/dist/sdk/models/shared/overridetieredwithminimumprice.d.ts +0 -26
  250. package/dist/sdk/models/shared/overridetieredwithminimumprice.js +0 -81
  251. package/dist/sdk/models/shared/overrideunitprice.d.ts +0 -27
  252. package/dist/sdk/models/shared/overrideunitprice.js +0 -83
  253. package/dist/sdk/models/shared/packageconfig.d.ts +0 -11
  254. package/dist/sdk/models/shared/packageconfig.js +0 -50
  255. package/dist/sdk/models/shared/packageprice.d.ts +0 -242
  256. package/dist/sdk/models/shared/packageprice.js +0 -363
  257. package/dist/sdk/models/shared/packagewithallocationprice.d.ts +0 -241
  258. package/dist/sdk/models/shared/packagewithallocationprice.js +0 -361
  259. package/dist/sdk/models/shared/percentagediscount.d.ts +0 -15
  260. package/dist/sdk/models/shared/percentagediscount.js +0 -59
  261. package/dist/sdk/models/shared/percentagediscountcreationparams.d.ts +0 -11
  262. package/dist/sdk/models/shared/percentagediscountcreationparams.js +0 -54
  263. package/dist/sdk/models/shared/percentagediscountinterval.d.ts +0 -27
  264. package/dist/sdk/models/shared/percentagediscountinterval.js +0 -82
  265. package/dist/sdk/models/shared/requesttoolargeerror.d.ts +0 -16
  266. package/dist/sdk/models/shared/requesttoolargeerror.js +0 -82
  267. package/dist/sdk/models/shared/requestvalidationerror.d.ts +0 -17
  268. package/dist/sdk/models/shared/requestvalidationerror.js +0 -87
  269. package/dist/sdk/models/shared/resourcenotfounderror.d.ts +0 -16
  270. package/dist/sdk/models/shared/resourcenotfounderror.js +0 -82
  271. package/dist/sdk/models/shared/resourcetoolargeerror.d.ts +0 -16
  272. package/dist/sdk/models/shared/resourcetoolargeerror.js +0 -82
  273. package/dist/sdk/models/shared/sublineitemgrouping.d.ts +0 -8
  274. package/dist/sdk/models/shared/sublineitemgrouping.js +0 -50
  275. package/dist/sdk/models/shared/sublineitemmatrixconfig.d.ts +0 -7
  276. package/dist/sdk/models/shared/sublineitemmatrixconfig.js +0 -45
  277. package/dist/sdk/models/shared/testratingfunctionprice.d.ts +0 -241
  278. package/dist/sdk/models/shared/testratingfunctionprice.js +0 -361
  279. package/dist/sdk/models/shared/thresholdtotalamountprice.d.ts +0 -241
  280. package/dist/sdk/models/shared/thresholdtotalamountprice.js +0 -361
  281. package/dist/sdk/models/shared/tier.d.ts +0 -15
  282. package/dist/sdk/models/shared/tier.js +0 -55
  283. package/dist/sdk/models/shared/tierconfig.d.ts +0 -6
  284. package/dist/sdk/models/shared/tierconfig.js +0 -55
  285. package/dist/sdk/models/shared/tieredbpsconfig.d.ts +0 -8
  286. package/dist/sdk/models/shared/tieredbpsconfig.js +0 -47
  287. package/dist/sdk/models/shared/tieredbpsprice.d.ts +0 -242
  288. package/dist/sdk/models/shared/tieredbpsprice.js +0 -363
  289. package/dist/sdk/models/shared/tieredconfig.d.ts +0 -8
  290. package/dist/sdk/models/shared/tieredconfig.js +0 -47
  291. package/dist/sdk/models/shared/tieredpackageprice.d.ts +0 -241
  292. package/dist/sdk/models/shared/tieredpackageprice.js +0 -361
  293. package/dist/sdk/models/shared/tieredprice.d.ts +0 -242
  294. package/dist/sdk/models/shared/tieredprice.js +0 -363
  295. package/dist/sdk/models/shared/tieredwithminimumprice.d.ts +0 -241
  296. package/dist/sdk/models/shared/tieredwithminimumprice.js +0 -361
  297. package/dist/sdk/models/shared/tiersublineitem.d.ts +0 -17
  298. package/dist/sdk/models/shared/tiersublineitem.js +0 -78
  299. package/dist/sdk/models/shared/trialdiscount.d.ts +0 -19
  300. package/dist/sdk/models/shared/trialdiscount.js +0 -64
  301. package/dist/sdk/models/shared/ungroupedsubscriptionusage.d.ts +0 -5
  302. package/dist/sdk/models/shared/ungroupedsubscriptionusage.js +0 -47
  303. package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.d.ts +0 -12
  304. package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.js +0 -64
  305. package/dist/sdk/models/shared/unitconfig.d.ts +0 -11
  306. package/dist/sdk/models/shared/unitconfig.js +0 -50
  307. package/dist/sdk/models/shared/unitprice.d.ts +0 -242
  308. package/dist/sdk/models/shared/unitprice.js +0 -363
  309. package/dist/sdk/models/shared/urlnotfound.d.ts +0 -16
  310. package/dist/sdk/models/shared/urlnotfound.js +0 -82
  311. package/dist/sdk/models/shared/usage.d.ts +0 -6
  312. package/dist/sdk/models/shared/usage.js +0 -63
  313. package/dist/sdk/models/shared/usagediscount.d.ts +0 -15
  314. package/dist/sdk/models/shared/usagediscount.js +0 -59
  315. package/dist/sdk/models/shared/usagediscountcreationparams.d.ts +0 -11
  316. package/dist/sdk/models/shared/usagediscountcreationparams.js +0 -54
  317. package/dist/sdk/models/shared/usagediscountinterval.d.ts +0 -27
  318. package/dist/sdk/models/shared/usagediscountinterval.js +0 -82
  319. package/dist/sdk/models/shared/voidinitiatedledgerentry.d.ts +0 -30
  320. package/dist/sdk/models/shared/voidinitiatedledgerentry.js +0 -139
  321. package/dist/sdk/models/shared/voidledgerentry.d.ts +0 -29
  322. package/dist/sdk/models/shared/voidledgerentry.js +0 -130
  323. package/docs/models/shared/addamendmentcreditledgerentryrequestparams.md +0 -12
  324. package/docs/models/shared/addamendmentcreditledgerentryrequestparamsentrytype.md +0 -8
  325. package/docs/models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md +0 -9
  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 -13
  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/README.md CHANGED
@@ -20,21 +20,80 @@ yarn add orb-billing
20
20
  <!-- Start SDK Example Usage -->
21
21
  ```typescript
22
22
  import { Orb } from "orb-billing";
23
- import { PingResponse } from "orb-billing/dist/sdk/models/operations";
24
23
 
24
+ (async() => {
25
+ const sdk = new Orb({
26
+ security: {
27
+ apiKeyAuth: "",
28
+ },
29
+ });
30
+
31
+ const res = await sdk.availability.ping();
32
+
33
+ if (res.statusCode == 200) {
34
+ // handle response
35
+ }
36
+ })();
37
+ ```
38
+ <!-- End SDK Example Usage -->
39
+
40
+ <!-- Start Pagination -->
41
+ # Pagination
42
+
43
+ Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
44
+ returned response object will have a `next` method that can be called to pull down the next group of results. If the
45
+ return value of `next` is `null`, then there are no more pages to be fetched.
46
+
47
+ Here's an example of one such pagination call:
48
+ <!-- End Pagination -->
49
+
50
+ ```ts
51
+ /* eslint-disable prefer-const */
52
+ import { Orb } from "orb-billing";
53
+
54
+ // Initialize the SDK with an API key.
25
55
  const sdk = new Orb({
26
56
  security: {
27
57
  apiKeyAuth: "",
28
58
  },
29
59
  });
30
60
 
31
- sdk.availability.ping().then((res: PingResponse) => {
32
- if (res.statusCode == 200) {
33
- // handle response
34
- }
35
- });
61
+ async function paginationDemo() {
62
+ let cursor: string | undefined;
63
+
64
+ // We start by attempting to fetch at least one page of results.
65
+ do {
66
+ // The SDK call takes the cursor and any additional arguments to filter the
67
+ // coupon data.
68
+ const response = await sdk.coupon.list({ cursor, showArchived: false });
69
+ const { statusCode } = response;
70
+ if (statusCode !== 200) {
71
+ throw new Error(`Unexpected status code sent from server: ${statusCode}`);
72
+ }
73
+
74
+ // We capture the cursor for the next iteration but we also check if we
75
+ // received an empty page of results as a signal to stop making additional
76
+ // requests.
77
+ cursor = response.coupons?.paginationMetadata.nextCursor;
78
+ const page = response.coupons?.data;
79
+ if (!page?.length) {
80
+ break;
81
+ }
82
+
83
+ // At this point we have a page of coupon entries that we can collect or
84
+ // iterate through as shown below.
85
+ page.forEach((coupon) => {
86
+ const { redemptionCode: code, timesRedeemed } = coupon;
87
+ console.log(`Coupon ${code} was redeemed ${timesRedeemed} times.`);
88
+ });
89
+
90
+ // The loop will continue if we received a cursor for additional results.
91
+ } while (cursor);
92
+ }
93
+
94
+ // Run the demo function.
95
+ paginationDemo();
36
96
  ```
37
- <!-- End SDK Example Usage -->
38
97
 
39
98
  <!-- Start SDK Available Operations -->
40
99
  ## Available Resources and Operations
@@ -153,28 +212,12 @@ sdk.availability.ping().then((res: PingResponse) => {
153
212
  * [updateFixedFeeQuantity](docs/sdks/subscription/README.md#updatefixedfeequantity) - Update price quantity
154
213
  <!-- End SDK Available Operations -->
155
214
 
156
-
157
-
158
215
  <!-- Start Dev Containers -->
159
216
 
160
217
  <!-- End Dev Containers -->
161
218
 
162
-
163
-
164
- <!-- Start Pagination -->
165
- # Pagination
166
-
167
- Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
168
- returned response object will have a `next` method that can be called to pull down the next group of results. If the
169
- return value of `next` is `null`, then there are no more pages to be fetched.
170
-
171
- Here's an example of one such pagination call:
172
- <!-- End Pagination -->
173
-
174
219
  <!-- Placeholder for Future Speakeasy SDK Sections -->
175
220
 
176
-
177
-
178
221
  ### Maturity
179
222
 
180
223
  This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
@@ -23,7 +23,7 @@ export declare class Coupon {
23
23
  * will be hidden from lists of active coupons. Additionally, once a coupon is archived, its redemption
24
24
  * code can be reused for a different coupon.
25
25
  */
26
- archive(req: operations.ArchiveCouponRequest, config?: AxiosRequestConfig): Promise<operations.ArchiveCouponResponse>;
26
+ archive(couponId: string, config?: AxiosRequestConfig): Promise<operations.ArchiveCouponResponse>;
27
27
  /**
28
28
  * Create coupon
29
29
  *
@@ -38,7 +38,7 @@ export declare class Coupon {
38
38
  * This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption code, use the
39
39
  * [List coupons](list-coupons) endpoint with the redemption_code parameter.
40
40
  */
41
- fetch(req: operations.FetchCouponRequest, config?: AxiosRequestConfig): Promise<operations.FetchCouponResponse>;
41
+ fetch(couponId: string, config?: AxiosRequestConfig): Promise<operations.FetchCouponResponse>;
42
42
  /**
43
43
  * List coupons
44
44
  *
@@ -49,7 +49,7 @@ export declare class Coupon {
49
49
  * `pagination_metadata`, which lets the caller retrieve the next page of results if they exist. More information
50
50
  * about pagination can be found in the Pagination-metadata schema.
51
51
  */
52
- list(req: operations.ListCouponsRequest, config?: AxiosRequestConfig): Promise<operations.ListCouponsResponse>;
52
+ list(cursor?: string, limit?: number, redemptionCode?: string, showArchived?: boolean, config?: AxiosRequestConfig): Promise<operations.ListCouponsResponse>;
53
53
  /**
54
54
  * List coupon subscriptions
55
55
  *
@@ -58,5 +58,5 @@ export declare class Coupon {
58
58
  * [paginated](../reference/pagination) list, ordered starting from the most recently created subscription. For a full
59
59
  * discussion of the subscription resource, see [Subscription](../guides/concepts#subscription).
60
60
  */
61
- listSubscriptions(req: operations.ListCouponSubscriptionsRequest, config?: AxiosRequestConfig): Promise<operations.ListCouponSubscriptionsResponse>;
61
+ listSubscriptions(couponId: string, cursor?: string, limit?: number, config?: AxiosRequestConfig): Promise<operations.ListCouponSubscriptionsResponse>;
62
62
  }
@@ -116,16 +116,16 @@ var Coupon = /** @class */ (function () {
116
116
  * will be hidden from lists of active coupons. Additionally, once a coupon is archived, its redemption
117
117
  * code can be reused for a different coupon.
118
118
  */
119
- Coupon.prototype.archive = function (req, config) {
119
+ Coupon.prototype.archive = function (couponId, config) {
120
120
  var _a, _b;
121
121
  return __awaiter(this, void 0, void 0, function () {
122
- var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
122
+ var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
123
123
  return __generator(this, function (_c) {
124
124
  switch (_c.label) {
125
125
  case 0:
126
- if (!(req instanceof utils.SpeakeasyBase)) {
127
- req = new operations.ArchiveCouponRequest(req);
128
- }
126
+ req = new operations.ArchiveCouponRequest({
127
+ couponId: couponId,
128
+ });
129
129
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
130
130
  url = utils.generateURL(baseURL, "/coupons/{coupon_id}/archive", req);
131
131
  client = this.sdkConfiguration.defaultClient;
@@ -361,16 +361,16 @@ var Coupon = /** @class */ (function () {
361
361
  * This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption code, use the
362
362
  * [List coupons](list-coupons) endpoint with the redemption_code parameter.
363
363
  */
364
- Coupon.prototype.fetch = function (req, config) {
364
+ Coupon.prototype.fetch = function (couponId, config) {
365
365
  var _a, _b;
366
366
  return __awaiter(this, void 0, void 0, function () {
367
- var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
367
+ var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
368
368
  return __generator(this, function (_c) {
369
369
  switch (_c.label) {
370
370
  case 0:
371
- if (!(req instanceof utils.SpeakeasyBase)) {
372
- req = new operations.FetchCouponRequest(req);
373
- }
371
+ req = new operations.FetchCouponRequest({
372
+ couponId: couponId,
373
+ });
374
374
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
375
375
  url = utils.generateURL(baseURL, "/coupons/{coupon_id}", req);
376
376
  client = this.sdkConfiguration.defaultClient;
@@ -482,16 +482,19 @@ var Coupon = /** @class */ (function () {
482
482
  * `pagination_metadata`, which lets the caller retrieve the next page of results if they exist. More information
483
483
  * about pagination can be found in the Pagination-metadata schema.
484
484
  */
485
- Coupon.prototype.list = function (req, config) {
485
+ Coupon.prototype.list = function (cursor, limit, redemptionCode, showArchived, config) {
486
486
  var _a, _b;
487
487
  return __awaiter(this, void 0, void 0, function () {
488
- var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
488
+ var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
489
489
  return __generator(this, function (_c) {
490
490
  switch (_c.label) {
491
491
  case 0:
492
- if (!(req instanceof utils.SpeakeasyBase)) {
493
- req = new operations.ListCouponsRequest(req);
494
- }
492
+ req = new operations.ListCouponsRequest({
493
+ cursor: cursor,
494
+ limit: limit,
495
+ redemptionCode: redemptionCode,
496
+ showArchived: showArchived,
497
+ });
495
498
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
496
499
  url = baseURL.replace(/\/$/, "") + "/coupons";
497
500
  client = this.sdkConfiguration.defaultClient;
@@ -602,16 +605,18 @@ var Coupon = /** @class */ (function () {
602
605
  * [paginated](../reference/pagination) list, ordered starting from the most recently created subscription. For a full
603
606
  * discussion of the subscription resource, see [Subscription](../guides/concepts#subscription).
604
607
  */
605
- Coupon.prototype.listSubscriptions = function (req, config) {
608
+ Coupon.prototype.listSubscriptions = function (couponId, cursor, limit, config) {
606
609
  var _a, _b;
607
610
  return __awaiter(this, void 0, void 0, function () {
608
- var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
611
+ var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
609
612
  return __generator(this, function (_c) {
610
613
  switch (_c.label) {
611
614
  case 0:
612
- if (!(req instanceof utils.SpeakeasyBase)) {
613
- req = new operations.ListCouponSubscriptionsRequest(req);
614
- }
615
+ req = new operations.ListCouponSubscriptionsRequest({
616
+ couponId: couponId,
617
+ cursor: cursor,
618
+ limit: limit,
619
+ });
615
620
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
616
621
  url = utils.generateURL(baseURL, "/coupons/{coupon_id}/subscriptions", req);
617
622
  client = this.sdkConfiguration.defaultClient;
@@ -101,7 +101,7 @@ export declare class Credit {
101
101
  * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
102
102
  * to the customer, up to the block's initial balance.
103
103
  */
104
- addByExternalId(req: operations.CreateLedgerEntryExternalIdRequest, config?: AxiosRequestConfig): Promise<operations.CreateLedgerEntryExternalIdResponse>;
104
+ addByExternalId(externalCustomerId: string, requestBody?: any, config?: AxiosRequestConfig): Promise<operations.CreateLedgerEntryExternalIdResponse>;
105
105
  /**
106
106
  * Create ledger entry
107
107
  *
@@ -196,21 +196,21 @@ export declare class Credit {
196
196
  * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
197
197
  * to the customer, up to the block's initial balance.
198
198
  */
199
- create(req: operations.CreateLedgerEntryRequest, config?: AxiosRequestConfig): Promise<operations.CreateLedgerEntryResponse>;
199
+ create(customerId: string, requestBody?: any, config?: AxiosRequestConfig): Promise<operations.CreateLedgerEntryResponse>;
200
200
  /**
201
201
  * Fetch customer credit balance
202
202
  *
203
203
  * @remarks
204
204
  * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
205
205
  */
206
- fetchBalance(req: operations.FetchCustomerCreditsRequest, config?: AxiosRequestConfig): Promise<operations.FetchCustomerCreditsResponse>;
206
+ fetchBalance(customerId: string, cursor?: string, limit?: number, config?: AxiosRequestConfig): Promise<operations.FetchCustomerCreditsResponse>;
207
207
  /**
208
208
  * Fetch customer credit balance by external customer id
209
209
  *
210
210
  * @remarks
211
211
  * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
212
212
  */
213
- fetchBalanceByExternalId(req: operations.FetchCustomerCreditsExternalIdRequest, config?: AxiosRequestConfig): Promise<operations.FetchCustomerCreditsExternalIdResponse>;
213
+ fetchBalanceByExternalId(externalCustomerId: string, cursor?: string, limit?: number, config?: AxiosRequestConfig): Promise<operations.FetchCustomerCreditsExternalIdResponse>;
214
214
  /**
215
215
  * Fetch customer credits ledger
216
216
  *
@@ -195,17 +195,18 @@ var Credit = /** @class */ (function () {
195
195
  * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
196
196
  * to the customer, up to the block's initial balance.
197
197
  */
198
- Credit.prototype.addByExternalId = function (req, config) {
198
+ Credit.prototype.addByExternalId = function (externalCustomerId, requestBody, config) {
199
199
  var _a, _b;
200
200
  return __awaiter(this, void 0, void 0, function () {
201
- var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
201
+ var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
202
202
  var _d;
203
203
  return __generator(this, function (_e) {
204
204
  switch (_e.label) {
205
205
  case 0:
206
- if (!(req instanceof utils.SpeakeasyBase)) {
207
- req = new operations.CreateLedgerEntryExternalIdRequest(req);
208
- }
206
+ req = new operations.CreateLedgerEntryExternalIdRequest({
207
+ externalCustomerId: externalCustomerId,
208
+ requestBody: requestBody,
209
+ });
209
210
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
210
211
  url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits/ledger_entry", req);
211
212
  _c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
@@ -410,17 +411,18 @@ var Credit = /** @class */ (function () {
410
411
  * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
411
412
  * to the customer, up to the block's initial balance.
412
413
  */
413
- Credit.prototype.create = function (req, config) {
414
+ Credit.prototype.create = function (customerId, requestBody, config) {
414
415
  var _a, _b;
415
416
  return __awaiter(this, void 0, void 0, function () {
416
- var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
417
+ var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
417
418
  var _d;
418
419
  return __generator(this, function (_e) {
419
420
  switch (_e.label) {
420
421
  case 0:
421
- if (!(req instanceof utils.SpeakeasyBase)) {
422
- req = new operations.CreateLedgerEntryRequest(req);
423
- }
422
+ req = new operations.CreateLedgerEntryRequest({
423
+ customerId: customerId,
424
+ requestBody: requestBody,
425
+ });
424
426
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
425
427
  url = utils.generateURL(baseURL, "/customers/{customer_id}/credits/ledger_entry", req);
426
428
  _c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
@@ -537,16 +539,18 @@ var Credit = /** @class */ (function () {
537
539
  * @remarks
538
540
  * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
539
541
  */
540
- Credit.prototype.fetchBalance = function (req, config) {
542
+ Credit.prototype.fetchBalance = function (customerId, cursor, limit, config) {
541
543
  var _a, _b;
542
544
  return __awaiter(this, void 0, void 0, function () {
543
- var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
545
+ var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
544
546
  return __generator(this, function (_c) {
545
547
  switch (_c.label) {
546
548
  case 0:
547
- if (!(req instanceof utils.SpeakeasyBase)) {
548
- req = new operations.FetchCustomerCreditsRequest(req);
549
- }
549
+ req = new operations.FetchCustomerCreditsRequest({
550
+ customerId: customerId,
551
+ cursor: cursor,
552
+ limit: limit,
553
+ });
550
554
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
551
555
  url = utils.generateURL(baseURL, "/customers/{customer_id}/credits", req);
552
556
  client = this.sdkConfiguration.defaultClient;
@@ -655,16 +659,18 @@ var Credit = /** @class */ (function () {
655
659
  * @remarks
656
660
  * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
657
661
  */
658
- Credit.prototype.fetchBalanceByExternalId = function (req, config) {
662
+ Credit.prototype.fetchBalanceByExternalId = function (externalCustomerId, cursor, limit, config) {
659
663
  var _a, _b;
660
664
  return __awaiter(this, void 0, void 0, function () {
661
- var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
665
+ var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
662
666
  return __generator(this, function (_c) {
663
667
  switch (_c.label) {
664
668
  case 0:
665
- if (!(req instanceof utils.SpeakeasyBase)) {
666
- req = new operations.FetchCustomerCreditsExternalIdRequest(req);
667
- }
669
+ req = new operations.FetchCustomerCreditsExternalIdRequest({
670
+ externalCustomerId: externalCustomerId,
671
+ cursor: cursor,
672
+ limit: limit,
673
+ });
668
674
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
669
675
  url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits", req);
670
676
  client = this.sdkConfiguration.defaultClient;
@@ -16,7 +16,7 @@ export declare class CreditNote {
16
16
  * @remarks
17
17
  * This endpoint is used to fetch a single [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
18
18
  */
19
- fetch(req: operations.FetchCreditNoteRequest, config?: AxiosRequestConfig): Promise<operations.FetchCreditNoteResponse>;
19
+ fetch(creditNoteId: string, config?: AxiosRequestConfig): Promise<operations.FetchCreditNoteResponse>;
20
20
  /**
21
21
  * List credit notes
22
22
  *
@@ -25,5 +25,5 @@ export declare class CreditNote {
25
25
  * customer_id, subscription_id, or external_customer_id. The credit notes will be returned
26
26
  * in reverse chronological order by `creation_time`.
27
27
  */
28
- list(req: operations.ListCreditNotesRequest, config?: AxiosRequestConfig): Promise<operations.ListCreditNotesResponse>;
28
+ list(cursor?: string, limit?: number, config?: AxiosRequestConfig): Promise<operations.ListCreditNotesResponse>;
29
29
  }
@@ -94,16 +94,16 @@ var CreditNote = /** @class */ (function () {
94
94
  * @remarks
95
95
  * This endpoint is used to fetch a single [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
96
96
  */
97
- CreditNote.prototype.fetch = function (req, config) {
97
+ CreditNote.prototype.fetch = function (creditNoteId, config) {
98
98
  var _a, _b;
99
99
  return __awaiter(this, void 0, void 0, function () {
100
- var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
100
+ var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
101
101
  return __generator(this, function (_c) {
102
102
  switch (_c.label) {
103
103
  case 0:
104
- if (!(req instanceof utils.SpeakeasyBase)) {
105
- req = new operations.FetchCreditNoteRequest(req);
106
- }
104
+ req = new operations.FetchCreditNoteRequest({
105
+ creditNoteId: creditNoteId,
106
+ });
107
107
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
108
108
  url = utils.generateURL(baseURL, "/credit_notes/{credit_note_id}", req);
109
109
  client = this.sdkConfiguration.defaultClient;
@@ -213,16 +213,17 @@ var CreditNote = /** @class */ (function () {
213
213
  * customer_id, subscription_id, or external_customer_id. The credit notes will be returned
214
214
  * in reverse chronological order by `creation_time`.
215
215
  */
216
- CreditNote.prototype.list = function (req, config) {
216
+ CreditNote.prototype.list = function (cursor, limit, config) {
217
217
  var _a, _b;
218
218
  return __awaiter(this, void 0, void 0, function () {
219
- var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
219
+ var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
220
220
  return __generator(this, function (_c) {
221
221
  switch (_c.label) {
222
222
  case 0:
223
- if (!(req instanceof utils.SpeakeasyBase)) {
224
- req = new operations.ListCreditNotesRequest(req);
225
- }
223
+ req = new operations.ListCreditNotesRequest({
224
+ cursor: cursor,
225
+ limit: limit,
226
+ });
226
227
  baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
227
228
  url = baseURL.replace(/\/$/, "") + "/credit_notes";
228
229
  client = this.sdkConfiguration.defaultClient;
@@ -104,7 +104,7 @@ export declare class Customer {
104
104
  * In order to overwrite timeframes with a very large number of events, we suggest using multiple calls with small adjacent
105
105
  * (e.g. every hour) timeframes.
106
106
  */
107
- amend(req: operations.AmendUsageRequest, config?: AxiosRequestConfig): Promise<operations.AmendUsageResponse>;
107
+ amend(customerId: string, updateEvent?: shared.UpdateEvent, timeframeEnd?: Date, timeframeStart?: Date, config?: AxiosRequestConfig): Promise<operations.AmendUsageResponse>;
108
108
  /**
109
109
  * Amend usage by external ID
110
110
  *
@@ -186,7 +186,7 @@ export declare class Customer {
186
186
  * In order to overwrite timeframes with a very large number of events, we suggest using multiple calls with small adjacent
187
187
  * (e.g. every hour) timeframes.
188
188
  */
189
- amendByExternalId(req: operations.AmendUsageExternalCustomerIdRequest, config?: AxiosRequestConfig): Promise<operations.AmendUsageExternalCustomerIdResponse>;
189
+ amendByExternalId(externalCustomerId: string, updateEvent?: shared.UpdateEvent, timeframeEnd?: Date, timeframeStart?: Date, config?: AxiosRequestConfig): Promise<operations.AmendUsageExternalCustomerIdResponse>;
190
190
  /**
191
191
  * Create customer
192
192
  *
@@ -210,7 +210,7 @@ export declare class Customer {
210
210
  * Creates an immutable balance transaction that updates the customer's balance and returns back the newly created
211
211
  * transaction.
212
212
  */
213
- createBalanceTransaction(req: operations.CreateCustomerBalanceTransactionRequest, config?: AxiosRequestConfig): Promise<operations.CreateCustomerBalanceTransactionResponse>;
213
+ createBalanceTransaction(customerId: string, newCustomerBalanceTransaction?: shared.NewCustomerBalanceTransaction, config?: AxiosRequestConfig): Promise<operations.CreateCustomerBalanceTransactionResponse>;
214
214
  /**
215
215
  * Delete customer
216
216
  *
@@ -229,7 +229,7 @@ export declare class Customer {
229
229
  *
230
230
  * On successful processing, this returns an empty dictionary (`{}`) in the API.
231
231
  */
232
- delete(req: operations.DeleteCustomerRequest, config?: AxiosRequestConfig): Promise<operations.DeleteCustomerResponse>;
232
+ delete(customerId: string, config?: AxiosRequestConfig): Promise<operations.DeleteCustomerResponse>;
233
233
  /**
234
234
  * Fetch customer
235
235
  *
@@ -239,7 +239,7 @@ export declare class Customer {
239
239
  *
240
240
  * See the [Customer resource](../guides/core-concepts.mdx#customer) for a full discussion of the Customer model.
241
241
  */
242
- fetch(req: operations.FetchCustomerRequest, config?: AxiosRequestConfig): Promise<operations.FetchCustomerResponse>;
242
+ fetch(customerId: string, config?: AxiosRequestConfig): Promise<operations.FetchCustomerResponse>;
243
243
  /**
244
244
  * Fetch customer by external ID
245
245
  *
@@ -249,7 +249,7 @@ export declare class Customer {
249
249
  *
250
250
  * Note that the resource and semantics of this endpoint exactly mirror [Get Customer](fetch-customer).
251
251
  */
252
- fetchByExternalId(req: operations.FetchCustomerExternalIdRequest, config?: AxiosRequestConfig): Promise<operations.FetchCustomerExternalIdResponse>;
252
+ fetchByExternalId(externalCustomerId: string, config?: AxiosRequestConfig): Promise<operations.FetchCustomerExternalIdResponse>;
253
253
  /**
254
254
  * Fetch customer costs
255
255
  *
@@ -516,7 +516,7 @@ export declare class Customer {
516
516
  * Note that the resource and semantics of this
517
517
  * endpoint exactly mirror [Update Customer](update-customer).
518
518
  */
519
- updateByExternalId(req: operations.UpdateCustomerExternalIdRequest, config?: AxiosRequestConfig): Promise<operations.UpdateCustomerExternalIdResponse>;
519
+ updateByExternalId(externalCustomerId: string, editCustomer?: shared.EditCustomer, config?: AxiosRequestConfig): Promise<operations.UpdateCustomerExternalIdResponse>;
520
520
  /**
521
521
  * Update customer
522
522
  *
@@ -525,5 +525,5 @@ export declare class Customer {
525
525
  * `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and `additional_emails` of an existing customer.
526
526
  * "Other fields on a customer are currently immutable.
527
527
  */
528
- updateCustomer(req: operations.UpdateCustomerRequest, config?: AxiosRequestConfig): Promise<operations.UpdateCustomerResponse>;
528
+ updateCustomer(customerId: string, editCustomer?: shared.EditCustomer, config?: AxiosRequestConfig): Promise<operations.UpdateCustomerResponse>;
529
529
  }