orb-billing 1.0.1 → 1.19.5
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.
- package/README.md +61 -41
- package/dist/internal/utils/requestbody.d.ts +1 -1
- package/dist/internal/utils/requestbody.js +1 -1
- package/dist/internal/utils/retries.d.ts +2 -2
- package/dist/internal/utils/security.d.ts +5 -2
- package/dist/internal/utils/security.js +28 -28
- package/dist/internal/utils/utils.js +1 -1
- package/dist/sdk/availability.d.ts +3 -4
- package/dist/sdk/availability.js +80 -10
- package/dist/sdk/coupon.d.ts +16 -7
- package/dist/sdk/coupon.js +396 -35
- package/dist/sdk/credit.d.ts +242 -36
- package/dist/sdk/credit.js +704 -77
- package/dist/sdk/creditnote.d.ts +8 -5
- package/dist/sdk/creditnote.js +160 -16
- package/dist/sdk/customer.d.ts +358 -93
- package/dist/sdk/customer.js +1351 -189
- package/dist/sdk/event.d.ts +198 -103
- package/dist/sdk/event.js +906 -157
- package/dist/sdk/invoice.d.ts +39 -10
- package/dist/sdk/invoice.js +727 -47
- package/dist/sdk/item.d.ts +27 -0
- package/dist/sdk/item.js +328 -0
- package/dist/sdk/metric.d.ts +39 -0
- package/dist/sdk/metric.js +475 -0
- package/dist/sdk/models/errors/index.d.ts +1 -0
- package/dist/sdk/models/errors/index.js +20 -0
- package/dist/sdk/models/errors/sdkerror.d.ts +7 -0
- package/dist/sdk/models/errors/sdkerror.js +40 -0
- package/dist/sdk/models/operations/addeditpriceintervals.d.ts +53 -0
- package/dist/sdk/models/operations/addeditpriceintervals.js +123 -0
- package/dist/sdk/models/operations/amendevent.d.ts +35 -5
- package/dist/sdk/models/operations/amendevent.js +28 -4
- package/dist/sdk/models/operations/amendusage.d.ts +36 -15
- package/dist/sdk/models/operations/amendusage.js +31 -22
- package/dist/sdk/models/operations/amendusageexternalcustomerid.d.ts +36 -15
- package/dist/sdk/models/operations/amendusageexternalcustomerid.js +31 -22
- package/dist/sdk/models/operations/archivecoupon.d.ts +37 -0
- package/dist/sdk/models/operations/archivecoupon.js +28 -0
- package/dist/sdk/models/operations/cancelsubscription.d.ts +38 -1
- package/dist/sdk/models/operations/cancelsubscription.js +30 -2
- package/dist/sdk/models/operations/closebackfill.d.ts +37 -0
- package/dist/sdk/models/operations/closebackfill.js +28 -0
- package/dist/sdk/models/operations/createbackfill.d.ts +37 -0
- package/dist/sdk/models/operations/createbackfill.js +28 -0
- package/dist/sdk/models/operations/createcoupon.d.ts +38 -1
- package/dist/sdk/models/operations/createcoupon.js +28 -0
- package/dist/sdk/models/operations/createcustomer.d.ts +37 -0
- package/dist/sdk/models/operations/createcustomer.js +28 -0
- package/dist/sdk/models/operations/createcustomerbalancetransaction.d.ts +38 -1
- package/dist/sdk/models/operations/createcustomerbalancetransaction.js +30 -2
- package/dist/sdk/models/operations/createinvoice.d.ts +49 -0
- package/dist/sdk/models/operations/createinvoice.js +107 -0
- package/dist/sdk/models/operations/createinvoicelineitem.d.ts +37 -0
- package/dist/sdk/models/operations/createinvoicelineitem.js +28 -0
- package/dist/sdk/models/operations/createledgerentry.d.ts +40 -3
- package/dist/sdk/models/operations/createledgerentry.js +31 -3
- package/dist/sdk/models/operations/createledgerentryexternalid.d.ts +53 -0
- package/dist/sdk/models/operations/createledgerentryexternalid.js +123 -0
- package/dist/sdk/models/operations/createmetric.d.ts +49 -0
- package/dist/sdk/models/operations/createmetric.js +107 -0
- package/dist/sdk/models/operations/createplan.d.ts +49 -0
- package/dist/sdk/models/operations/createplan.js +107 -0
- package/dist/sdk/models/operations/createprice.d.ts +49 -0
- package/dist/sdk/models/operations/{addledgerentryexternalid.js → createprice.js} +37 -25
- package/dist/sdk/models/operations/createsubscription.d.ts +38 -1
- package/dist/sdk/models/operations/createsubscription.js +28 -0
- package/dist/sdk/models/operations/deletecustomer.d.ts +41 -11
- package/dist/sdk/models/operations/deletecustomer.js +57 -16
- package/dist/sdk/models/operations/deprecateevent.d.ts +35 -5
- package/dist/sdk/models/operations/deprecateevent.js +28 -4
- package/dist/sdk/models/operations/fetchbackfill.d.ts +52 -0
- package/dist/sdk/models/operations/fetchbackfill.js +119 -0
- package/dist/sdk/models/operations/fetchcoupon.d.ts +37 -0
- package/dist/sdk/models/operations/fetchcoupon.js +28 -0
- package/dist/sdk/models/operations/fetchcreditnote.d.ts +37 -3
- package/dist/sdk/models/operations/fetchcreditnote.js +28 -0
- package/dist/sdk/models/operations/fetchcustomer.d.ts +38 -4
- package/dist/sdk/models/operations/fetchcustomer.js +28 -0
- package/dist/sdk/models/operations/fetchcustomercosts.d.ts +44 -12
- package/dist/sdk/models/operations/fetchcustomercosts.js +37 -1
- package/dist/sdk/models/operations/fetchcustomercostsexternalid.d.ts +45 -10
- package/dist/sdk/models/operations/fetchcustomercostsexternalid.js +37 -1
- package/dist/sdk/models/operations/fetchcustomercredits.d.ts +37 -9
- package/dist/sdk/models/operations/fetchcustomercredits.js +31 -3
- package/dist/sdk/models/operations/fetchcustomercreditsexternalid.d.ts +39 -8
- package/dist/sdk/models/operations/fetchcustomercreditsexternalid.js +31 -3
- package/dist/sdk/models/operations/fetchcustomercreditsledger.d.ts +53 -13
- package/dist/sdk/models/operations/fetchcustomercreditsledger.js +66 -3
- package/dist/sdk/models/operations/fetchcustomercreditsledgerexternalid.d.ts +53 -13
- package/dist/sdk/models/operations/fetchcustomercreditsledgerexternalid.js +66 -3
- package/dist/sdk/models/operations/fetchcustomerexternalid.d.ts +37 -0
- package/dist/sdk/models/operations/fetchcustomerexternalid.js +28 -0
- package/dist/sdk/models/operations/fetchinvoice.d.ts +37 -0
- package/dist/sdk/models/operations/fetchinvoice.js +28 -0
- package/dist/sdk/models/operations/fetchitem.d.ts +52 -0
- package/dist/sdk/models/operations/fetchitem.js +119 -0
- package/dist/sdk/models/operations/fetchmetric.d.ts +52 -0
- package/dist/sdk/models/operations/fetchmetric.js +119 -0
- package/dist/sdk/models/operations/fetchplan.d.ts +37 -0
- package/dist/sdk/models/operations/fetchplan.js +28 -0
- package/dist/sdk/models/operations/fetchplanexternalid.d.ts +37 -0
- package/dist/sdk/models/operations/fetchplanexternalid.js +28 -0
- package/dist/sdk/models/operations/fetchprice.d.ts +52 -0
- package/dist/sdk/models/operations/fetchprice.js +119 -0
- package/dist/sdk/models/operations/fetchpriceexternalid.d.ts +52 -0
- package/dist/sdk/models/operations/fetchpriceexternalid.js +119 -0
- package/dist/sdk/models/operations/fetchsubscription.d.ts +37 -0
- package/dist/sdk/models/operations/fetchsubscription.js +28 -0
- package/dist/sdk/models/operations/fetchsubscriptioncosts.d.ts +45 -10
- package/dist/sdk/models/operations/fetchsubscriptioncosts.js +37 -1
- package/dist/sdk/models/operations/fetchsubscriptionschedule.d.ts +43 -8
- package/dist/sdk/models/operations/fetchsubscriptionschedule.js +47 -3
- package/dist/sdk/models/operations/fetchsubscriptionusage.d.ts +60 -16
- package/dist/sdk/models/operations/fetchsubscriptionusage.js +69 -2
- package/dist/sdk/models/operations/fetchupcominginvoice.d.ts +38 -1
- package/dist/sdk/models/operations/fetchupcominginvoice.js +28 -0
- package/dist/sdk/models/operations/index.d.ts +20 -2
- package/dist/sdk/models/operations/index.js +20 -2
- package/dist/sdk/models/operations/ingest.d.ts +36 -12
- package/dist/sdk/models/operations/ingest.js +31 -22
- package/dist/sdk/models/operations/issueinvoice.d.ts +35 -2
- package/dist/sdk/models/operations/issueinvoice.js +28 -4
- package/dist/sdk/models/operations/listbackfills.d.ts +37 -6
- package/dist/sdk/models/operations/listbackfills.js +29 -1
- package/dist/sdk/models/operations/listbalancetransactions.d.ts +45 -10
- package/dist/sdk/models/operations/listbalancetransactions.js +49 -5
- package/dist/sdk/models/operations/listcoupons.d.ts +35 -10
- package/dist/sdk/models/operations/listcoupons.js +29 -1
- package/dist/sdk/models/operations/listcouponsubscriptions.d.ts +39 -0
- package/dist/sdk/models/operations/listcouponsubscriptions.js +36 -0
- package/dist/sdk/models/operations/listcreditnotes.d.ts +53 -0
- package/dist/sdk/models/operations/listcreditnotes.js +123 -0
- package/dist/sdk/models/operations/listcustomers.d.ts +41 -6
- package/dist/sdk/models/operations/listcustomers.js +45 -1
- package/dist/sdk/models/operations/listinvoices.d.ts +66 -14
- package/dist/sdk/models/operations/listinvoices.js +109 -3
- package/dist/sdk/models/operations/listitems.d.ts +53 -0
- package/dist/sdk/models/operations/{listcreditnote.js → listitems.js} +46 -30
- package/dist/sdk/models/operations/listmetrics.d.ts +57 -0
- package/dist/sdk/models/operations/listmetrics.js +139 -0
- package/dist/sdk/models/operations/listplans.d.ts +53 -6
- package/dist/sdk/models/operations/listplans.js +59 -2
- package/dist/sdk/models/operations/listprices.d.ts +53 -0
- package/dist/sdk/models/operations/listprices.js +123 -0
- package/dist/sdk/models/operations/listsubscriptions.d.ts +48 -7
- package/dist/sdk/models/operations/listsubscriptions.js +56 -2
- package/dist/sdk/models/operations/markinvoiceaspaid.d.ts +53 -0
- package/dist/sdk/models/operations/markinvoiceaspaid.js +123 -0
- package/dist/sdk/models/operations/ping.d.ts +39 -2
- package/dist/sdk/models/operations/ping.js +30 -2
- package/dist/sdk/models/operations/revertbackfill.d.ts +37 -0
- package/dist/sdk/models/operations/revertbackfill.js +28 -0
- package/dist/sdk/models/operations/scheduleplanchange.d.ts +37 -0
- package/dist/sdk/models/operations/scheduleplanchange.js +28 -0
- package/dist/sdk/models/operations/searchevents.d.ts +42 -7
- package/dist/sdk/models/operations/searchevents.js +47 -3
- package/dist/sdk/models/operations/triggerphase.d.ts +53 -0
- package/dist/sdk/models/operations/triggerphase.js +123 -0
- package/dist/sdk/models/operations/unschedulecancellation.d.ts +37 -0
- package/dist/sdk/models/operations/unschedulecancellation.js +28 -0
- package/dist/sdk/models/operations/unschedulefixedfeequantity.d.ts +53 -0
- package/dist/sdk/models/operations/unschedulefixedfeequantity.js +123 -0
- package/dist/sdk/models/operations/unscheduleplanchange.d.ts +37 -0
- package/dist/sdk/models/operations/unscheduleplanchange.js +28 -0
- package/dist/sdk/models/operations/updatecustomer.d.ts +38 -4
- package/dist/sdk/models/operations/updatecustomer.js +30 -2
- package/dist/sdk/models/operations/updatecustomerexternalid.d.ts +38 -1
- package/dist/sdk/models/operations/updatecustomerexternalid.js +30 -2
- package/dist/sdk/models/operations/updatefixedfeequantity.d.ts +37 -0
- package/dist/sdk/models/operations/updatefixedfeequantity.js +28 -0
- package/dist/sdk/models/operations/updateplan.d.ts +53 -0
- package/dist/sdk/models/operations/updateplan.js +123 -0
- package/dist/sdk/models/operations/updateplanexternal.d.ts +53 -0
- package/dist/sdk/models/operations/updateplanexternal.js +123 -0
- package/dist/sdk/models/operations/voidinvoice.d.ts +36 -3
- package/dist/sdk/models/operations/voidinvoice.js +28 -4
- package/dist/sdk/models/shared/accountingprovider.d.ts +9 -0
- package/dist/sdk/models/shared/accountingprovider.js +55 -0
- package/dist/sdk/models/shared/accountingproviderconfig.d.ts +5 -0
- package/dist/sdk/models/shared/{creditblock.js → accountingproviderconfig.js} +10 -18
- package/dist/sdk/models/shared/accountingsyncconfiguration.d.ts +6 -0
- package/dist/sdk/models/shared/accountingsyncconfiguration.js +52 -0
- package/dist/sdk/models/shared/addamendmentcreditledgerentryrequestparams.d.ts +28 -0
- package/dist/sdk/models/shared/addamendmentcreditledgerentryrequestparams.js +81 -0
- package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.d.ts +24 -0
- package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.js +76 -0
- package/dist/sdk/models/shared/addeditpriceintervalparams.d.ts +13 -0
- package/dist/sdk/models/shared/addeditpriceintervalparams.js +54 -0
- package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.d.ts +37 -0
- package/dist/sdk/models/shared/{newcreditledgerentry.js → addexpirationchangecreditledgerentryrequestparams.js} +27 -34
- package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.d.ts +42 -0
- package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.js +109 -0
- package/dist/sdk/models/shared/addpriceintervalparams.d.ts +54 -0
- package/dist/sdk/models/shared/addpriceintervalparams.js +103 -0
- package/dist/sdk/models/shared/address.d.ts +9 -0
- package/dist/sdk/models/shared/address.js +70 -0
- package/dist/sdk/models/shared/addressinput.d.ts +9 -0
- package/dist/sdk/models/shared/addressinput.js +70 -0
- package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.d.ts +38 -0
- package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.js +93 -0
- package/dist/sdk/models/shared/affectedblock.d.ts +6 -0
- package/dist/sdk/models/shared/{credit.js → affectedblock.js} +9 -14
- package/dist/sdk/models/shared/{subscriptioncost.d.ts → aggregatedcost.d.ts} +1 -1
- package/dist/sdk/models/shared/{customercost.js → aggregatedcost.js} +11 -11
- package/dist/sdk/models/shared/amendedusage.d.ts +2 -7
- package/dist/sdk/models/shared/amendedusage.js +2 -14
- package/dist/sdk/models/shared/amendeventresult.d.ts +1 -4
- package/dist/sdk/models/shared/amendeventresult.js +0 -3
- package/dist/sdk/models/shared/amendmentledgerentry.d.ts +27 -0
- package/dist/sdk/models/shared/amendmentledgerentry.js +120 -0
- package/dist/sdk/models/shared/amountdiscount.d.ts +15 -0
- package/dist/sdk/models/shared/amountdiscount.js +59 -0
- package/dist/sdk/models/shared/amountdiscountcreationparams.d.ts +11 -0
- package/dist/sdk/models/shared/amountdiscountcreationparams.js +54 -0
- package/dist/sdk/models/shared/amountdiscountinterval.d.ts +27 -0
- package/dist/sdk/models/shared/amountdiscountinterval.js +82 -0
- package/dist/sdk/models/shared/autocollection.d.ts +3 -6
- package/dist/sdk/models/shared/autocollection.js +0 -3
- package/dist/sdk/models/shared/backfill.d.ts +2 -2
- package/dist/sdk/models/shared/backfills.d.ts +2 -5
- package/dist/sdk/models/shared/backfills.js +0 -3
- package/dist/sdk/models/shared/billablemetric.d.ts +24 -1
- package/dist/sdk/models/shared/billablemetric.js +40 -1
- package/dist/sdk/models/shared/billablemetrics.d.ts +7 -0
- package/dist/sdk/models/shared/billablemetrics.js +54 -0
- package/dist/sdk/models/shared/billablemetricsimple.d.ts +5 -0
- package/dist/sdk/models/shared/{billablemetricminified.js → billablemetricsimple.js} +8 -8
- package/dist/sdk/models/shared/billablemetrictiny.d.ts +4 -0
- package/dist/sdk/models/shared/billablemetrictiny.js +45 -0
- package/dist/sdk/models/shared/billingcyclealignment.d.ts +8 -0
- package/dist/sdk/models/shared/billingcyclealignment.js +15 -0
- package/dist/sdk/models/shared/bpsconfig.d.ts +7 -4
- package/dist/sdk/models/shared/bpsconfig.js +1 -4
- package/dist/sdk/models/shared/bpsprice.d.ts +242 -0
- package/dist/sdk/models/shared/bpsprice.js +363 -0
- package/dist/sdk/models/shared/bpstier.d.ts +15 -3
- package/dist/sdk/models/shared/bpstier.js +1 -1
- package/dist/sdk/models/shared/bulkbpsconfig.d.ts +4 -4
- package/dist/sdk/models/shared/bulkbpsconfig.js +0 -3
- package/dist/sdk/models/shared/bulkbpsprice.d.ts +242 -0
- package/dist/sdk/models/shared/bulkbpsprice.js +363 -0
- package/dist/sdk/models/shared/bulkbpstier.d.ts +10 -1
- package/dist/sdk/models/shared/bulkbpstier.js +1 -1
- package/dist/sdk/models/shared/bulkconfig.d.ts +4 -4
- package/dist/sdk/models/shared/bulkconfig.js +0 -3
- package/dist/sdk/models/shared/bulkprice.d.ts +242 -0
- package/dist/sdk/models/shared/bulkprice.js +363 -0
- package/dist/sdk/models/shared/bulktier.d.ts +7 -1
- package/dist/sdk/models/shared/bulktier.js +1 -1
- package/dist/sdk/models/shared/cancelsubscriptionparams.d.ts +19 -0
- package/dist/sdk/models/shared/cancelsubscriptionparams.js +63 -0
- package/dist/sdk/models/shared/changeoption.d.ts +0 -3
- package/dist/sdk/models/shared/changeoption.js +0 -3
- package/dist/sdk/models/shared/coupon.d.ts +14 -10
- package/dist/sdk/models/shared/coupon.js +16 -6
- package/dist/sdk/models/shared/couponredemption.d.ts +6 -0
- package/dist/sdk/models/shared/{usageitem.js → couponredemption.js} +12 -12
- package/dist/sdk/models/shared/coupons.d.ts +2 -5
- package/dist/sdk/models/shared/coupons.js +0 -3
- package/dist/sdk/models/shared/{newinvoicelineitem.d.ts → createinvoicelineitemparams.d.ts} +5 -5
- package/dist/sdk/models/shared/{newinvoicelineitem.js → createinvoicelineitemparams.js} +15 -13
- package/dist/sdk/models/shared/createoneoffinvoiceparams.d.ts +33 -0
- package/dist/sdk/models/shared/createoneoffinvoiceparams.js +86 -0
- package/dist/sdk/models/shared/creditblockexpiryledgerentry.d.ts +27 -0
- package/dist/sdk/models/shared/creditblockexpiryledgerentry.js +120 -0
- package/dist/sdk/models/shared/creditledgerentries.d.ts +1 -5
- package/dist/sdk/models/shared/creditledgerentries.js +1 -6
- package/dist/sdk/models/shared/creditnote.d.ts +34 -22
- package/dist/sdk/models/shared/creditnote.js +44 -7
- package/dist/sdk/models/shared/creditnotelineitem.d.ts +12 -10
- package/dist/sdk/models/shared/creditnotelineitem.js +24 -10
- package/dist/sdk/models/shared/creditnoteminified.d.ts +7 -0
- package/dist/sdk/models/shared/creditnoteminified.js +45 -0
- package/dist/sdk/models/shared/creditnotes.d.ts +2 -5
- package/dist/sdk/models/shared/creditnotes.js +0 -3
- package/dist/sdk/models/shared/{sublineitem2.d.ts → creditnotesublineitem.d.ts} +1 -1
- package/dist/sdk/models/shared/{sublineitem2.js → creditnotesublineitem.js} +9 -9
- package/dist/sdk/models/shared/creditnotesummary.d.ts +9 -6
- package/dist/sdk/models/shared/customer.d.ts +30 -181
- package/dist/sdk/models/shared/customer.js +41 -223
- package/dist/sdk/models/shared/customerbalancetransaction.d.ts +13 -28
- package/dist/sdk/models/shared/customerbalancetransaction.js +18 -42
- package/dist/sdk/models/shared/{transactions.d.ts → customerbalancetransactions.d.ts} +3 -6
- package/dist/sdk/models/shared/{transactions.js → customerbalancetransactions.js} +8 -11
- package/dist/sdk/models/shared/customercosts.d.ts +2 -5
- package/dist/sdk/models/shared/customercosts.js +3 -6
- package/dist/sdk/models/shared/customercreditbalance.d.ts +7 -0
- package/dist/sdk/models/shared/customercreditbalance.js +64 -0
- package/dist/sdk/models/shared/customercreditbalances.d.ts +7 -0
- package/dist/sdk/models/shared/customercreditbalances.js +54 -0
- package/dist/sdk/models/shared/customerminified.d.ts +0 -3
- package/dist/sdk/models/shared/customerminified.js +0 -3
- package/dist/sdk/models/shared/customers.d.ts +0 -3
- package/dist/sdk/models/shared/customers.js +0 -3
- package/dist/sdk/models/shared/customertaxid.d.ts +6 -0
- package/dist/sdk/models/shared/{newtransaction.js → customertaxid.js} +12 -13
- package/dist/sdk/models/shared/debug.d.ts +2 -2
- package/dist/sdk/models/shared/decrementledgerentry.d.ts +30 -0
- package/dist/sdk/models/shared/{creditledgerentry.js → decrementledgerentry.js} +42 -51
- package/dist/sdk/models/shared/deletecustomerresponse.d.ts +3 -0
- package/dist/sdk/models/shared/deletecustomerresponse.js +30 -0
- package/dist/sdk/models/shared/deprecatedeventresult.d.ts +1 -4
- package/dist/sdk/models/shared/deprecatedeventresult.js +0 -3
- package/dist/sdk/models/shared/discount.d.ts +13 -5
- package/dist/sdk/models/shared/discount.js +13 -4
- package/dist/sdk/models/shared/duplicateconstraintviolationerror.d.ts +16 -0
- package/dist/sdk/models/shared/duplicateconstraintviolationerror.js +82 -0
- package/dist/sdk/models/shared/duplicateresourcecreationerror.d.ts +16 -0
- package/dist/sdk/models/shared/duplicateresourcecreationerror.js +82 -0
- package/dist/sdk/models/shared/editcustomer.d.ts +72 -0
- package/dist/sdk/models/shared/editcustomer.js +151 -0
- package/dist/sdk/models/shared/editplan.d.ts +10 -0
- package/dist/sdk/models/shared/editplan.js +59 -0
- package/dist/sdk/models/shared/editpriceintervalparams.d.ts +34 -0
- package/dist/sdk/models/shared/editpriceintervalparams.js +78 -0
- package/dist/sdk/models/shared/event.d.ts +11 -4
- package/dist/sdk/models/shared/event.js +14 -3
- package/dist/sdk/models/shared/{credits.d.ts → events.d.ts} +3 -6
- package/dist/sdk/models/shared/{eventsearchresults.js → events.js} +8 -11
- package/dist/sdk/models/shared/expirationchangeledgerentry.d.ts +28 -0
- package/dist/sdk/models/shared/expirationchangeledgerentry.js +129 -0
- package/dist/sdk/models/shared/featurenotavailableerror.d.ts +16 -0
- package/dist/sdk/models/shared/featurenotavailableerror.js +82 -0
- package/dist/sdk/models/shared/fivehundrederror.d.ts +13 -0
- package/dist/sdk/models/shared/fivehundrederror.js +78 -0
- package/dist/sdk/models/shared/fivetranexampleprice.d.ts +241 -0
- package/dist/sdk/models/shared/fivetranexampleprice.js +361 -0
- package/dist/sdk/models/shared/fixedfeequantitychange.d.ts +12 -5
- package/dist/sdk/models/shared/fixedfeequantitychange.js +12 -3
- package/dist/sdk/models/shared/fixedfeequantityscheduleentry.d.ts +7 -0
- package/dist/sdk/models/shared/{fixedfeequantityschedule.js → fixedfeequantityscheduleentry.js} +10 -10
- package/dist/sdk/models/shared/fixedfeequantitytransition.d.ts +6 -0
- package/dist/sdk/models/shared/fixedfeequantitytransition.js +59 -0
- package/dist/sdk/models/shared/fourhundredandoneerror.d.ts +16 -0
- package/dist/sdk/models/shared/fourhundredandoneerror.js +82 -0
- package/dist/sdk/models/shared/fourhundredandtwentynineerror.d.ts +16 -0
- package/dist/sdk/models/shared/fourhundredandtwentynineerror.js +82 -0
- package/dist/sdk/models/shared/groupedsubscriptionusage.d.ts +7 -0
- package/dist/sdk/models/shared/groupedsubscriptionusage.js +54 -0
- package/dist/sdk/models/shared/groupedsubscriptionusagerecord.d.ts +14 -0
- package/dist/sdk/models/shared/groupedsubscriptionusagerecord.js +71 -0
- package/dist/sdk/models/shared/idempotencyconflict.d.ts +16 -0
- package/dist/sdk/models/shared/idempotencyconflict.js +82 -0
- package/dist/sdk/models/shared/idempotencykeyvalidationerror.d.ts +17 -0
- package/dist/sdk/models/shared/idempotencykeyvalidationerror.js +87 -0
- package/dist/sdk/models/shared/idempotencyrequestmismatch.d.ts +16 -0
- package/dist/sdk/models/shared/idempotencyrequestmismatch.js +82 -0
- package/dist/sdk/models/shared/{invoicesettings.d.ts → incrementcreditledgerentryinvoicesettings.d.ts} +2 -2
- package/dist/sdk/models/shared/{invoicesettings.js → incrementcreditledgerentryinvoicesettings.js} +10 -10
- package/dist/sdk/models/shared/incrementledgerentry.d.ts +27 -0
- package/dist/sdk/models/shared/incrementledgerentry.js +120 -0
- package/dist/sdk/models/shared/index.d.ts +144 -54
- package/dist/sdk/models/shared/index.js +144 -54
- package/dist/sdk/models/shared/ingestevent.d.ts +32 -0
- package/dist/sdk/models/shared/ingestevent.js +86 -0
- package/dist/sdk/models/shared/ingestionresponse.d.ts +5 -5
- package/dist/sdk/models/shared/ingestionresponse.js +3 -6
- package/dist/sdk/models/shared/ingestrequestbody.d.ts +5 -0
- package/dist/sdk/models/shared/{tieredbpsconfig1.js → ingestrequestbody.js} +11 -11
- package/dist/sdk/models/shared/invoice.d.ts +46 -182
- package/dist/sdk/models/shared/invoice.js +70 -201
- package/dist/sdk/models/shared/invoicelineitem.d.ts +10 -168
- package/dist/sdk/models/shared/invoicelineitem.js +21 -303
- package/dist/sdk/models/shared/invoicelineitemparams.d.ts +27 -0
- package/dist/sdk/models/shared/invoicelineitemparams.js +92 -0
- package/dist/sdk/models/shared/invoiceminified.d.ts +7 -0
- package/dist/sdk/models/shared/invoiceminified.js +45 -0
- package/dist/sdk/models/shared/invoices.d.ts +2 -5
- package/dist/sdk/models/shared/invoices.js +0 -3
- package/dist/sdk/models/shared/item.d.ts +14 -0
- package/dist/sdk/models/shared/item.js +72 -0
- package/dist/sdk/models/shared/itemexternalconnection.d.ts +16 -0
- package/dist/sdk/models/shared/itemexternalconnection.js +63 -0
- package/dist/sdk/models/shared/items.d.ts +7 -0
- package/dist/sdk/models/shared/{credits.js → items.js} +11 -14
- package/dist/sdk/models/shared/itemslim.d.ts +5 -0
- package/dist/sdk/models/shared/itemslim.js +50 -0
- package/dist/sdk/models/shared/markaspaidrequestparams.d.ts +16 -0
- package/dist/sdk/models/shared/markaspaidrequestparams.js +61 -0
- package/dist/sdk/models/shared/matrixconfig.d.ts +12 -5
- package/dist/sdk/models/shared/matrixconfig.js +5 -3
- package/dist/sdk/models/shared/matrixprice.d.ts +242 -0
- package/dist/sdk/models/shared/matrixprice.js +363 -0
- package/dist/sdk/models/shared/matrixsublineitem.d.ts +17 -0
- package/dist/sdk/models/shared/matrixsublineitem.js +78 -0
- package/dist/sdk/models/shared/matrixvalue.d.ts +8 -1
- package/dist/sdk/models/shared/matrixvalue.js +5 -0
- package/dist/sdk/models/shared/maximum.d.ts +11 -0
- package/dist/sdk/models/shared/{subscriptionusage.js → maximum.js} +14 -14
- package/dist/sdk/models/shared/maximuminterval.d.ts +23 -0
- package/dist/sdk/models/shared/{subscriptioncost.js → maximuminterval.js} +21 -23
- package/dist/sdk/models/shared/metricgroup.d.ts +5 -0
- package/dist/sdk/models/shared/metricgroup.js +50 -0
- package/dist/sdk/models/shared/minimum.d.ts +11 -0
- package/dist/sdk/models/shared/minimum.js +50 -0
- package/dist/sdk/models/shared/minimuminterval.d.ts +23 -0
- package/dist/sdk/models/shared/minimuminterval.js +73 -0
- package/dist/sdk/models/shared/newaccountingsyncconfiguration.d.ts +6 -0
- package/dist/sdk/models/shared/newaccountingsyncconfiguration.js +52 -0
- package/dist/sdk/models/shared/newbackfill.d.ts +1 -1
- package/dist/sdk/models/shared/newbillablemetric.d.ts +28 -0
- package/dist/sdk/models/shared/newbillablemetric.js +77 -0
- package/dist/sdk/models/shared/newbpsprice.d.ts +53 -0
- package/dist/sdk/models/shared/newbpsprice.js +110 -0
- package/dist/sdk/models/shared/newbulkbpsprice.d.ts +53 -0
- package/dist/sdk/models/shared/newbulkbpsprice.js +110 -0
- package/dist/sdk/models/shared/newbulkprice.d.ts +53 -0
- package/dist/sdk/models/shared/newbulkprice.js +110 -0
- package/dist/sdk/models/shared/newcoupon.d.ts +4 -10
- package/dist/sdk/models/shared/newcoupon.js +11 -11
- package/dist/sdk/models/shared/newcustomer.d.ts +20 -154
- package/dist/sdk/models/shared/newcustomer.js +34 -206
- package/dist/sdk/models/shared/newcustomerbalancetransaction.d.ts +13 -0
- package/dist/sdk/models/shared/newcustomerbalancetransaction.js +60 -0
- package/dist/sdk/models/shared/newmatrixprice.d.ts +53 -0
- package/dist/sdk/models/shared/{sublineitem.js → newmatrixprice.js} +51 -43
- package/dist/sdk/models/shared/newpackageprice.d.ts +53 -0
- package/dist/sdk/models/shared/newpackageprice.js +110 -0
- package/dist/sdk/models/shared/newpackagewithallocationprice.d.ts +52 -0
- package/dist/sdk/models/shared/newpackagewithallocationprice.js +108 -0
- package/dist/sdk/models/shared/newplan.d.ts +26 -0
- package/dist/sdk/models/shared/newplan.js +93 -0
- package/dist/sdk/models/shared/newreportingconfiguration.d.ts +4 -0
- package/dist/sdk/models/shared/newreportingconfiguration.js +45 -0
- package/dist/sdk/models/shared/newsubscription.d.ts +18 -43
- package/dist/sdk/models/shared/newsubscription.js +50 -8
- package/dist/sdk/models/shared/newthresholdtotalamountprice.d.ts +52 -0
- package/dist/sdk/models/shared/newthresholdtotalamountprice.js +108 -0
- package/dist/sdk/models/shared/newtieredbpsprice.d.ts +53 -0
- package/dist/sdk/models/shared/newtieredbpsprice.js +110 -0
- package/dist/sdk/models/shared/newtieredpackageprice.d.ts +52 -0
- package/dist/sdk/models/shared/newtieredpackageprice.js +108 -0
- package/dist/sdk/models/shared/newtieredprice.d.ts +53 -0
- package/dist/sdk/models/shared/newtieredprice.js +110 -0
- package/dist/sdk/models/shared/newtieredwithminimumprice.d.ts +52 -0
- package/dist/sdk/models/shared/newtieredwithminimumprice.js +108 -0
- package/dist/sdk/models/shared/newunitprice.d.ts +53 -0
- package/dist/sdk/models/shared/newunitprice.js +110 -0
- package/dist/sdk/models/shared/othersublineitem.d.ts +15 -0
- package/dist/sdk/models/shared/othersublineitem.js +71 -0
- package/dist/sdk/models/shared/overridebpsprice.d.ts +27 -0
- package/dist/sdk/models/shared/{bpspriceoverride.js → overridebpsprice.js} +27 -18
- package/dist/sdk/models/shared/overridebulkbpsprice.d.ts +27 -0
- package/dist/sdk/models/shared/{bulkbpspriceoverride.js → overridebulkbpsprice.js} +27 -18
- package/dist/sdk/models/shared/overridebulkprice.d.ts +27 -0
- package/dist/sdk/models/shared/{bulkpriceoverride.js → overridebulkprice.js} +27 -18
- package/dist/sdk/models/shared/overridefivetranexampleprice.d.ts +26 -0
- package/dist/sdk/models/shared/overridefivetranexampleprice.js +81 -0
- package/dist/sdk/models/shared/overridematrixprice.d.ts +27 -0
- package/dist/sdk/models/shared/overridematrixprice.js +83 -0
- package/dist/sdk/models/shared/overridepackageprice.d.ts +27 -0
- package/dist/sdk/models/shared/{packagepriceoverride.js → overridepackageprice.js} +27 -18
- package/dist/sdk/models/shared/overridepackagewithallocationprice.d.ts +26 -0
- package/dist/sdk/models/shared/overridepackagewithallocationprice.js +81 -0
- package/dist/sdk/models/shared/overridetestratingfunctionprice.d.ts +26 -0
- package/dist/sdk/models/shared/overridetestratingfunctionprice.js +81 -0
- package/dist/sdk/models/shared/overridethresholdtotalamountprice.d.ts +26 -0
- package/dist/sdk/models/shared/overridethresholdtotalamountprice.js +81 -0
- package/dist/sdk/models/shared/overridetieredbpsprice.d.ts +27 -0
- package/dist/sdk/models/shared/{tieredbpspriceoverride.js → overridetieredbpsprice.js} +30 -21
- package/dist/sdk/models/shared/overridetieredpackageprice.d.ts +26 -0
- package/dist/sdk/models/shared/overridetieredpackageprice.js +81 -0
- package/dist/sdk/models/shared/overridetieredprice.d.ts +27 -0
- package/dist/sdk/models/shared/{tieredpriceoverride.js → overridetieredprice.js} +27 -18
- package/dist/sdk/models/shared/overridetieredwithminimumprice.d.ts +26 -0
- package/dist/sdk/models/shared/overridetieredwithminimumprice.js +81 -0
- package/dist/sdk/models/shared/overrideunitprice.d.ts +27 -0
- package/dist/sdk/models/shared/{unitpriceoverride.js → overrideunitprice.js} +27 -18
- package/dist/sdk/models/shared/packageconfig.d.ts +7 -4
- package/dist/sdk/models/shared/packageconfig.js +0 -3
- package/dist/sdk/models/shared/packageprice.d.ts +242 -0
- package/dist/sdk/models/shared/packageprice.js +363 -0
- package/dist/sdk/models/shared/packagewithallocationprice.d.ts +241 -0
- package/dist/sdk/models/shared/packagewithallocationprice.js +361 -0
- package/dist/sdk/models/shared/percentagediscount.d.ts +15 -0
- package/dist/sdk/models/shared/percentagediscount.js +59 -0
- package/dist/sdk/models/shared/percentagediscountcreationparams.d.ts +11 -0
- package/dist/sdk/models/shared/percentagediscountcreationparams.js +54 -0
- package/dist/sdk/models/shared/percentagediscountinterval.d.ts +27 -0
- package/dist/sdk/models/shared/percentagediscountinterval.js +82 -0
- package/dist/sdk/models/shared/perpricecost.d.ts +206 -6
- package/dist/sdk/models/shared/perpricecost.js +6 -6
- package/dist/sdk/models/shared/phaseoverride.d.ts +7 -30
- package/dist/sdk/models/shared/phaseoverride.js +4 -42
- package/dist/sdk/models/shared/{availability.d.ts → pingresponse.d.ts} +1 -4
- package/dist/sdk/models/shared/{availability.js → pingresponse.js} +7 -10
- package/dist/sdk/models/shared/plan.d.ts +29 -62
- package/dist/sdk/models/shared/plan.js +55 -108
- package/dist/sdk/models/shared/planminified.d.ts +6 -2
- package/dist/sdk/models/shared/planminified.js +5 -0
- package/dist/sdk/models/shared/planphase.d.ts +18 -58
- package/dist/sdk/models/shared/planphase.js +30 -86
- package/dist/sdk/models/shared/plans.d.ts +2 -5
- package/dist/sdk/models/shared/plans.js +0 -3
- package/dist/sdk/models/shared/pricegroup.d.ts +2 -2
- package/dist/sdk/models/shared/priceinterval.d.ts +239 -0
- package/dist/sdk/models/shared/priceinterval.js +104 -0
- package/dist/sdk/models/shared/priceintervalfixedfeequantitytransitionparams.d.ts +11 -0
- package/dist/sdk/models/shared/priceintervalfixedfeequantitytransitionparams.js +54 -0
- package/dist/sdk/models/shared/prices.d.ts +6 -0
- package/dist/sdk/models/shared/prices.js +52 -0
- package/dist/sdk/models/shared/reportingconfiguration.d.ts +4 -0
- package/dist/sdk/models/shared/reportingconfiguration.js +45 -0
- package/dist/sdk/models/shared/requesttoolargeerror.d.ts +16 -0
- package/dist/sdk/models/shared/requesttoolargeerror.js +82 -0
- package/dist/sdk/models/shared/requestvalidationerror.d.ts +14 -17
- package/dist/sdk/models/shared/requestvalidationerror.js +29 -7
- package/dist/sdk/models/shared/resourcenotfounderror.d.ts +16 -0
- package/dist/sdk/models/shared/resourcenotfounderror.js +82 -0
- package/dist/sdk/models/shared/resourcetoolargeerror.d.ts +16 -0
- package/dist/sdk/models/shared/resourcetoolargeerror.js +82 -0
- package/dist/sdk/models/shared/sublineitemgrouping.d.ts +8 -0
- package/dist/sdk/models/shared/{grouping.js → sublineitemgrouping.js} +8 -11
- package/dist/sdk/models/shared/sublineitemmatrixconfig.d.ts +7 -0
- package/dist/sdk/models/shared/{matrixconfig1.js → sublineitemmatrixconfig.js} +7 -10
- package/dist/sdk/models/shared/subscription.d.ts +64 -31
- package/dist/sdk/models/shared/subscription.js +61 -42
- package/dist/sdk/models/shared/subscriptioncosts.d.ts +2 -5
- package/dist/sdk/models/shared/subscriptioncosts.js +3 -6
- package/dist/sdk/models/shared/subscriptionminified.d.ts +0 -3
- package/dist/sdk/models/shared/subscriptionminified.js +0 -3
- package/dist/sdk/models/shared/subscriptionplanchange.d.ts +20 -15
- package/dist/sdk/models/shared/subscriptionplanchange.js +37 -15
- package/dist/sdk/models/shared/subscriptions.d.ts +2 -5
- package/dist/sdk/models/shared/subscriptions.js +0 -3
- package/dist/sdk/models/shared/subscriptionscheduleitem.d.ts +3 -3
- package/dist/sdk/models/shared/{subscriptionschedule.d.ts → subscriptionscheduleitems.d.ts} +3 -6
- package/dist/sdk/models/shared/{subscriptionschedule.js → subscriptionscheduleitems.js} +8 -11
- package/dist/sdk/models/shared/subscriptiontrialinfo.d.ts +4 -0
- package/dist/sdk/models/shared/{subscriptioncancellation.js → subscriptiontrialinfo.js} +8 -14
- package/dist/sdk/models/shared/testratingfunctionprice.d.ts +241 -0
- package/dist/sdk/models/shared/testratingfunctionprice.js +361 -0
- package/dist/sdk/models/shared/thresholdtotalamountprice.d.ts +241 -0
- package/dist/sdk/models/shared/thresholdtotalamountprice.js +361 -0
- package/dist/sdk/models/shared/tier.d.ts +11 -2
- package/dist/sdk/models/shared/tier.js +2 -2
- package/dist/sdk/models/shared/tierconfig.d.ts +2 -5
- package/dist/sdk/models/shared/tierconfig.js +2 -5
- package/dist/sdk/models/shared/tieredbpsconfig.d.ts +4 -4
- package/dist/sdk/models/shared/tieredbpsconfig.js +0 -3
- package/dist/sdk/models/shared/tieredbpsprice.d.ts +242 -0
- package/dist/sdk/models/shared/tieredbpsprice.js +363 -0
- package/dist/sdk/models/shared/tieredconfig.d.ts +4 -4
- package/dist/sdk/models/shared/tieredconfig.js +0 -3
- package/dist/sdk/models/shared/tieredpackageprice.d.ts +241 -0
- package/dist/sdk/models/shared/tieredpackageprice.js +361 -0
- package/dist/sdk/models/shared/tieredprice.d.ts +242 -0
- package/dist/sdk/models/shared/tieredprice.js +363 -0
- package/dist/sdk/models/shared/tieredwithminimumprice.d.ts +241 -0
- package/dist/sdk/models/shared/tieredwithminimumprice.js +361 -0
- package/dist/sdk/models/shared/tiersublineitem.d.ts +17 -0
- package/dist/sdk/models/shared/{sublineitem1.js → tiersublineitem.js} +21 -18
- package/dist/sdk/models/shared/trialconfig.d.ts +1 -1
- package/dist/sdk/models/shared/trialdiscount.d.ts +19 -0
- package/dist/sdk/models/shared/trialdiscount.js +64 -0
- package/dist/sdk/models/shared/triggersubscriptionphaseparams.d.ts +8 -0
- package/dist/sdk/models/shared/triggersubscriptionphaseparams.js +51 -0
- package/dist/sdk/models/shared/ungroupedsubscriptionusage.d.ts +5 -0
- package/dist/sdk/models/shared/ungroupedsubscriptionusage.js +47 -0
- package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.d.ts +12 -0
- package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.js +64 -0
- package/dist/sdk/models/shared/unitconfig.d.ts +8 -4
- package/dist/sdk/models/shared/unitconfig.js +5 -3
- package/dist/sdk/models/shared/unitprice.d.ts +242 -0
- package/dist/sdk/models/shared/unitprice.js +363 -0
- package/dist/sdk/models/shared/unschedulefixedfeequantitychangeparams.d.ts +7 -0
- package/dist/sdk/models/shared/unschedulefixedfeequantitychangeparams.js +45 -0
- package/dist/sdk/models/shared/upcominginvoice.d.ts +89 -54
- package/dist/sdk/models/shared/upcominginvoice.js +216 -88
- package/dist/sdk/models/shared/updateevent.d.ts +1 -1
- package/dist/sdk/models/shared/updateevent.js +5 -1
- package/dist/sdk/models/shared/urlnotfound.d.ts +16 -0
- package/dist/sdk/models/shared/urlnotfound.js +82 -0
- package/dist/sdk/models/shared/usage.d.ts +3 -10
- package/dist/sdk/models/shared/usage.js +18 -24
- package/dist/sdk/models/shared/usagediscount.d.ts +15 -0
- package/dist/sdk/models/shared/{tier7.js → usagediscount.js} +18 -19
- package/dist/sdk/models/shared/usagediscountcreationparams.d.ts +11 -0
- package/dist/sdk/models/shared/usagediscountcreationparams.js +54 -0
- package/dist/sdk/models/shared/usagediscountinterval.d.ts +27 -0
- package/dist/sdk/models/shared/usagediscountinterval.js +82 -0
- package/dist/sdk/models/shared/validationerror.d.ts +11 -0
- package/dist/sdk/models/shared/validationerror.js +50 -0
- package/dist/sdk/models/shared/voidinitiatedledgerentry.d.ts +30 -0
- package/dist/sdk/models/shared/voidinitiatedledgerentry.js +139 -0
- package/dist/sdk/models/shared/voidledgerentry.d.ts +29 -0
- package/dist/sdk/models/shared/voidledgerentry.js +130 -0
- package/dist/sdk/plan.d.ts +54 -186
- package/dist/sdk/plan.js +656 -202
- package/dist/sdk/price.d.ts +246 -0
- package/dist/sdk/price.js +790 -0
- package/dist/sdk/priceinterval.d.ts +65 -0
- package/dist/sdk/priceinterval.js +281 -0
- package/dist/sdk/sdk.d.ts +149 -58
- package/dist/sdk/sdk.js +23 -40
- package/dist/sdk/subscription.d.ts +435 -280
- package/dist/sdk/subscription.js +1516 -350
- package/docs/models/operations/addeditpriceintervalsrequest.md +9 -0
- package/docs/models/operations/addeditpriceintervalsresponse.md +18 -0
- package/docs/models/operations/amendeventrequest.md +9 -0
- package/docs/models/operations/amendeventresponse.md +18 -0
- package/docs/models/operations/amendusageexternalcustomeridrequest.md +11 -0
- package/docs/models/operations/amendusageexternalcustomeridresponse.md +18 -0
- package/docs/models/operations/amendusagerequest.md +11 -0
- package/docs/models/operations/amendusageresponse.md +18 -0
- package/docs/models/operations/archivecouponrequest.md +8 -0
- package/docs/models/operations/archivecouponresponse.md +18 -0
- package/docs/models/operations/cancelsubscriptionrequest.md +9 -0
- package/docs/models/operations/cancelsubscriptionresponse.md +18 -0
- package/docs/models/operations/closebackfillrequest.md +8 -0
- package/docs/models/operations/closebackfillresponse.md +18 -0
- package/docs/models/operations/createbackfillresponse.md +18 -0
- package/docs/models/operations/createcouponresponse.md +18 -0
- package/docs/models/operations/createcustomerbalancetransactionrequest.md +9 -0
- package/docs/models/operations/createcustomerbalancetransactionresponse.md +18 -0
- package/docs/models/operations/createcustomerresponse.md +18 -0
- package/docs/models/operations/createinvoicelineitemresponse.md +18 -0
- package/docs/models/operations/createinvoiceresponse.md +18 -0
- package/docs/models/operations/createledgerentryexternalidrequest.md +9 -0
- package/docs/models/operations/createledgerentryexternalidresponse.md +18 -0
- package/docs/models/operations/createledgerentryrequest.md +9 -0
- package/docs/models/operations/createledgerentryresponse.md +18 -0
- package/docs/models/operations/createmetricresponse.md +18 -0
- package/docs/models/operations/createplanresponse.md +18 -0
- package/docs/models/operations/createpriceresponse.md +18 -0
- package/docs/models/operations/createsubscriptionresponse.md +18 -0
- package/docs/models/operations/deletecustomerrequest.md +8 -0
- package/docs/models/operations/deletecustomerresponse.md +18 -0
- package/docs/models/operations/deprecateeventrequest.md +8 -0
- package/docs/models/operations/deprecateeventresponse.md +18 -0
- package/docs/models/operations/fetchbackfillrequest.md +8 -0
- package/docs/models/operations/fetchbackfillresponse.md +18 -0
- package/docs/models/operations/fetchcouponrequest.md +8 -0
- package/docs/models/operations/fetchcouponresponse.md +18 -0
- package/docs/models/operations/fetchcreditnoterequest.md +8 -0
- package/docs/models/operations/fetchcreditnoteresponse.md +18 -0
- package/docs/models/operations/fetchcustomercostsexternalidrequest.md +12 -0
- package/docs/models/operations/fetchcustomercostsexternalidresponse.md +18 -0
- package/docs/models/operations/fetchcustomercostsexternalidviewmodeviewmode.md +11 -0
- package/docs/models/operations/fetchcustomercostsrequest.md +12 -0
- package/docs/models/operations/fetchcustomercostsresponse.md +18 -0
- package/docs/models/operations/fetchcustomercostsviewmodeviewmode.md +11 -0
- package/docs/models/operations/fetchcustomercreditsexternalidrequest.md +10 -0
- package/docs/models/operations/fetchcustomercreditsexternalidresponse.md +18 -0
- package/docs/models/operations/fetchcustomercreditsledgerentrystatusentrystatus.md +9 -0
- package/docs/models/operations/fetchcustomercreditsledgerentrytypeentrytype.md +14 -0
- package/docs/models/operations/fetchcustomercreditsledgerexternalidentrystatusentrystatus.md +9 -0
- package/docs/models/operations/fetchcustomercreditsledgerexternalidentrytypeentrytype.md +14 -0
- package/docs/models/operations/fetchcustomercreditsledgerexternalidrequest.md +18 -0
- package/docs/models/operations/fetchcustomercreditsledgerexternalidresponse.md +18 -0
- package/docs/models/operations/fetchcustomercreditsledgerrequest.md +18 -0
- package/docs/models/operations/fetchcustomercreditsledgerresponse.md +18 -0
- package/docs/models/operations/fetchcustomercreditsrequest.md +10 -0
- package/docs/models/operations/fetchcustomercreditsresponse.md +18 -0
- package/docs/models/operations/fetchcustomerexternalidrequest.md +8 -0
- package/docs/models/operations/fetchcustomerexternalidresponse.md +18 -0
- package/docs/models/operations/fetchcustomerrequest.md +8 -0
- package/docs/models/operations/fetchcustomerresponse.md +18 -0
- package/docs/models/operations/fetchinvoicerequest.md +8 -0
- package/docs/models/operations/fetchinvoiceresponse.md +18 -0
- package/docs/models/operations/fetchitemrequest.md +8 -0
- package/docs/models/operations/fetchitemresponse.md +18 -0
- package/docs/models/operations/fetchmetricrequest.md +8 -0
- package/docs/models/operations/fetchmetricresponse.md +18 -0
- package/docs/models/operations/fetchplanexternalidrequest.md +8 -0
- package/docs/models/operations/fetchplanexternalidresponse.md +18 -0
- package/docs/models/operations/fetchplanrequest.md +8 -0
- package/docs/models/operations/fetchplanresponse.md +18 -0
- package/docs/models/operations/fetchpriceexternalidrequest.md +8 -0
- package/docs/models/operations/fetchpriceexternalidresponse.md +18 -0
- package/docs/models/operations/fetchpricerequest.md +8 -0
- package/docs/models/operations/fetchpriceresponse.md +18 -0
- package/docs/models/operations/fetchsubscriptioncostsrequest.md +12 -0
- package/docs/models/operations/fetchsubscriptioncostsresponse.md +18 -0
- package/docs/models/operations/fetchsubscriptioncostsviewmodeviewmode.md +11 -0
- package/docs/models/operations/fetchsubscriptionrequest.md +8 -0
- package/docs/models/operations/fetchsubscriptionresponse.md +18 -0
- package/docs/models/operations/fetchsubscriptionschedulerequest.md +14 -0
- package/docs/models/operations/fetchsubscriptionscheduleresponse.md +18 -0
- package/docs/models/operations/fetchsubscriptionusagegranularitygranularity.md +10 -0
- package/docs/models/operations/fetchsubscriptionusagerequest.md +20 -0
- package/docs/models/operations/fetchsubscriptionusageresponse.md +18 -0
- package/docs/models/operations/fetchsubscriptionusageviewmodeviewmode.md +11 -0
- package/docs/models/operations/fetchupcominginvoicerequest.md +8 -0
- package/docs/models/operations/fetchupcominginvoiceresponse.md +18 -0
- package/docs/models/operations/ingestrequest.md +10 -0
- package/docs/models/operations/ingestresponse.md +18 -0
- package/docs/models/operations/issueinvoicerequest.md +8 -0
- package/docs/models/operations/issueinvoiceresponse.md +18 -0
- package/docs/models/operations/listbackfillsrequest.md +9 -0
- package/docs/models/operations/listbackfillsresponse.md +18 -0
- package/docs/models/operations/listbalancetransactionsrequest.md +14 -0
- package/docs/models/operations/listbalancetransactionsresponse.md +18 -0
- package/docs/models/operations/listcouponsrequest.md +11 -0
- package/docs/models/operations/listcouponsresponse.md +18 -0
- package/docs/models/operations/listcouponsubscriptionsrequest.md +10 -0
- package/docs/models/operations/listcouponsubscriptionsresponse.md +18 -0
- package/docs/models/operations/listcreditnotesrequest.md +9 -0
- package/docs/models/operations/listcreditnotesresponse.md +18 -0
- package/docs/models/operations/listcustomersrequest.md +13 -0
- package/docs/models/operations/listcustomersresponse.md +18 -0
- package/docs/models/operations/listinvoicesdatetypedatetype.md +9 -0
- package/docs/models/operations/listinvoicesrequest.md +27 -0
- package/docs/models/operations/listinvoicesresponse.md +18 -0
- package/docs/models/operations/listinvoicesstatus.md +12 -0
- package/docs/models/operations/listinvoicesstatusstatus.md +12 -0
- package/docs/models/operations/listitemsrequest.md +9 -0
- package/docs/models/operations/listitemsresponse.md +18 -0
- package/docs/models/operations/listmetricsrequest.md +13 -0
- package/docs/models/operations/listmetricsresponse.md +18 -0
- package/docs/models/operations/listplansrequest.md +14 -0
- package/docs/models/operations/listplansresponse.md +18 -0
- package/docs/models/operations/listplansstatusstatus.md +12 -0
- package/docs/models/operations/listpricesrequest.md +9 -0
- package/docs/models/operations/listpricesresponse.md +18 -0
- package/docs/models/operations/listsubscriptionsrequest.md +16 -0
- package/docs/models/operations/listsubscriptionsresponse.md +18 -0
- package/docs/models/operations/listsubscriptionsstatusstatus.md +10 -0
- package/docs/models/operations/markinvoiceaspaidrequest.md +9 -0
- package/docs/models/operations/markinvoiceaspaidresponse.md +18 -0
- package/docs/models/operations/pingresponse.md +18 -0
- package/docs/models/operations/revertbackfillrequest.md +8 -0
- package/docs/models/operations/revertbackfillresponse.md +18 -0
- package/docs/models/operations/scheduleplanchangerequest.md +9 -0
- package/docs/models/operations/scheduleplanchangeresponse.md +18 -0
- package/docs/models/operations/searcheventsrequest.md +14 -0
- package/docs/models/operations/searcheventsresponse.md +18 -0
- package/docs/models/operations/triggerphaserequest.md +9 -0
- package/docs/models/operations/triggerphaseresponse.md +18 -0
- package/docs/models/operations/unschedulecancellationrequest.md +8 -0
- package/docs/models/operations/unschedulecancellationresponse.md +18 -0
- package/docs/models/operations/unschedulefixedfeequantityrequest.md +9 -0
- package/docs/models/operations/unschedulefixedfeequantityresponse.md +18 -0
- package/docs/models/operations/unscheduleplanchangerequest.md +8 -0
- package/docs/models/operations/unscheduleplanchangeresponse.md +18 -0
- package/docs/models/operations/updatecustomerexternalidrequest.md +9 -0
- package/docs/models/operations/updatecustomerexternalidresponse.md +18 -0
- package/docs/models/operations/updatecustomerrequest.md +9 -0
- package/docs/models/operations/updatecustomerresponse.md +18 -0
- package/docs/models/operations/updatefixedfeequantityrequest.md +9 -0
- package/docs/models/operations/updatefixedfeequantityresponse.md +18 -0
- package/docs/models/operations/updateplanexternalrequest.md +9 -0
- package/docs/models/operations/updateplanexternalresponse.md +18 -0
- package/docs/models/operations/updateplanrequest.md +9 -0
- package/docs/models/operations/updateplanresponse.md +18 -0
- package/docs/models/operations/voidinvoicerequest.md +8 -0
- package/docs/models/operations/voidinvoiceresponse.md +18 -0
- package/docs/models/shared/accountingprovider.md +9 -0
- package/docs/models/shared/accountingproviderconfig.md +9 -0
- package/docs/models/shared/accountingproviderprovidertype.md +9 -0
- package/docs/models/shared/accountingsyncconfiguration.md +9 -0
- package/docs/models/shared/addamendmentcreditledgerentryrequestparams.md +12 -0
- package/docs/models/shared/addamendmentcreditledgerentryrequestparamsentrytype.md +8 -0
- package/docs/models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md +9 -0
- package/docs/models/shared/adddecrementcreditledgerentryrequestparams.md +11 -0
- package/docs/models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md +8 -0
- package/docs/models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md +9 -0
- package/docs/models/shared/addeditpriceintervalparams.md +9 -0
- package/docs/models/shared/addexpirationchangecreditledgerentryrequestparams.md +14 -0
- package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md +8 -0
- package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md +9 -0
- package/docs/models/shared/addincrementcreditledgerentryrequestparams.md +15 -0
- package/docs/models/shared/addincrementcreditledgerentryrequestparamsentrytype.md +8 -0
- package/docs/models/shared/addincrementcreditledgerentryrequestparamsmetadata.md +9 -0
- package/docs/models/shared/addpriceintervalparams.md +16 -0
- package/docs/models/shared/addpriceintervalparamsenddateenddate.md +11 -0
- package/docs/models/shared/addpriceintervalparamsstartdatestartdate.md +11 -0
- package/docs/models/shared/address.md +13 -0
- package/docs/models/shared/addressinput.md +13 -0
- package/docs/models/shared/addvoidcreditledgerentryrequestparams.md +13 -0
- package/docs/models/shared/addvoidcreditledgerentryrequestparamsentrytype.md +8 -0
- package/docs/models/shared/addvoidcreditledgerentryrequestparamsmetadata.md +9 -0
- package/docs/models/shared/addvoidcreditledgerentryrequestparamsvoidreason.md +10 -0
- package/docs/models/shared/affectedblock.md +10 -0
- package/docs/models/shared/aggregatedcost.md +12 -0
- package/docs/models/shared/amendedevent.md +12 -0
- package/docs/models/shared/amendedeventproperties.md +9 -0
- package/docs/models/shared/amendedusage.md +9 -0
- package/docs/models/shared/amendeventresult.md +8 -0
- package/docs/models/shared/amendmentledgerentry.md +21 -0
- package/docs/models/shared/amendmentledgerentryentrystatus.md +9 -0
- package/docs/models/shared/amendmentledgerentryentrytype.md +8 -0
- package/docs/models/shared/amountdiscount.md +10 -0
- package/docs/models/shared/amountdiscountcreationparams.md +9 -0
- package/docs/models/shared/amountdiscountcreationparamsdiscounttype.md +8 -0
- package/docs/models/shared/amountdiscountdiscounttype.md +8 -0
- package/docs/models/shared/amountdiscountinterval.md +13 -0
- package/docs/models/shared/amountdiscountintervaldiscounttype.md +8 -0
- package/docs/models/shared/autocollection.md +10 -0
- package/docs/models/shared/backfill.md +17 -0
- package/docs/models/shared/backfills.md +9 -0
- package/docs/models/shared/backfillstatus.md +13 -0
- package/docs/models/shared/billablemetric.md +16 -0
- package/docs/models/shared/billablemetrics.md +9 -0
- package/docs/models/shared/billablemetricsimple.md +9 -0
- package/docs/models/shared/billablemetricstatus.md +10 -0
- package/docs/models/shared/billablemetrictiny.md +8 -0
- package/docs/models/shared/billingcyclealignment.md +12 -0
- package/docs/models/shared/bpsconfig.md +9 -0
- package/docs/models/shared/bpsprice.md +225 -0
- package/docs/models/shared/bpspricecadence.md +11 -0
- package/docs/models/shared/bpspricemodeltype.md +8 -0
- package/docs/models/shared/bpspricepricetype.md +9 -0
- package/docs/models/shared/bpstier.md +11 -0
- package/docs/models/shared/bulkbpsconfig.md +8 -0
- package/docs/models/shared/bulkbpsprice.md +225 -0
- package/docs/models/shared/bulkbpspricecadence.md +11 -0
- package/docs/models/shared/bulkbpspricemodeltype.md +8 -0
- package/docs/models/shared/bulkbpspricepricetype.md +9 -0
- package/docs/models/shared/bulkbpstier.md +10 -0
- package/docs/models/shared/bulkconfig.md +8 -0
- package/docs/models/shared/bulkprice.md +225 -0
- package/docs/models/shared/bulkpricecadence.md +11 -0
- package/docs/models/shared/bulkpricemodeltype.md +8 -0
- package/docs/models/shared/bulkpricepricetype.md +9 -0
- package/docs/models/shared/bulktier.md +9 -0
- package/docs/models/shared/cancelsubscriptionparams.md +9 -0
- package/docs/models/shared/cancelsubscriptionparamscanceloption.md +12 -0
- package/docs/models/shared/changeoption.md +10 -0
- package/docs/models/shared/coupon.md +21 -0
- package/docs/models/shared/coupondiscount.md +7 -0
- package/docs/models/shared/couponredemption.md +10 -0
- package/docs/models/shared/coupons.md +9 -0
- package/docs/models/shared/createinvoicelineitemparams.md +13 -0
- package/docs/models/shared/createoneoffinvoiceparams.md +15 -0
- package/docs/models/shared/creditblockexpiryledgerentry.md +21 -0
- package/docs/models/shared/creditblockexpiryledgerentryentrystatus.md +9 -0
- package/docs/models/shared/creditblockexpiryledgerentryentrytype.md +8 -0
- package/docs/models/shared/creditledgerentries.md +9 -0
- package/docs/models/shared/creditnote.md +26 -0
- package/docs/models/shared/creditnotediscounts.md +7 -0
- package/docs/models/shared/creditnotelineitem.md +15 -0
- package/docs/models/shared/creditnotelineitemdiscounts.md +7 -0
- package/docs/models/shared/creditnotelineitemtaxamounts.md +7 -0
- package/docs/models/shared/creditnotemaximumamountadjustment.md +9 -0
- package/docs/models/shared/creditnoteminified.md +8 -0
- package/docs/models/shared/creditnotereason.md +11 -0
- package/docs/models/shared/creditnotes.md +9 -0
- package/docs/models/shared/creditnotesublineitem.md +10 -0
- package/docs/models/shared/creditnotesummary.md +13 -0
- package/docs/models/shared/creditnotetype.md +9 -0
- package/docs/models/shared/customer.md +42 -0
- package/docs/models/shared/customerbalancetransaction.md +17 -0
- package/docs/models/shared/customerbalancetransactionaction.md +10 -0
- package/docs/models/shared/customerbalancetransactions.md +9 -0
- package/docs/models/shared/customerbalancetransactiontype.md +9 -0
- package/docs/models/shared/customercosts.md +8 -0
- package/docs/models/shared/customercreditbalance.md +11 -0
- package/docs/models/shared/customercreditbalances.md +9 -0
- package/docs/models/shared/customerminified.md +9 -0
- package/docs/models/shared/customerpaymentprovider.md +14 -0
- package/docs/models/shared/customers.md +9 -0
- package/docs/models/shared/customertaxid.md +10 -0
- package/docs/models/shared/debug.md +11 -0
- package/docs/models/shared/decrementledgerentry.md +24 -0
- package/docs/models/shared/decrementledgerentryentrystatus.md +9 -0
- package/docs/models/shared/decrementledgerentryentrytype.md +8 -0
- package/docs/models/shared/deletecustomerresponse.md +7 -0
- package/docs/models/shared/deprecatedeventresult.md +8 -0
- package/docs/models/shared/discount.md +15 -0
- package/docs/models/shared/discountdiscounttype.md +11 -0
- package/docs/models/shared/duplicateconstraintviolationerror.md +12 -0
- package/docs/models/shared/duplicateconstraintviolationerrorheaders.md +7 -0
- package/docs/models/shared/duplicateconstraintviolationerrorstatus.md +8 -0
- package/docs/models/shared/duplicateconstraintviolationerrortype.md +8 -0
- package/docs/models/shared/duplicateresourcecreationerror.md +12 -0
- package/docs/models/shared/duplicateresourcecreationerrorheaders.md +7 -0
- package/docs/models/shared/duplicateresourcecreationerrorstatus.md +8 -0
- package/docs/models/shared/duplicateresourcecreationerrortype.md +8 -0
- package/docs/models/shared/editcustomer.md +22 -0
- package/docs/models/shared/editcustomermetadata.md +9 -0
- package/docs/models/shared/editcustomerpaymentprovider.md +16 -0
- package/docs/models/shared/editplan.md +9 -0
- package/docs/models/shared/editplanmetadata.md +7 -0
- package/docs/models/shared/editpriceintervalparams.md +11 -0
- package/docs/models/shared/editpriceintervalparamsenddateenddate.md +11 -0
- package/docs/models/shared/editpriceintervalparamsstartdatestartdate.md +11 -0
- package/docs/models/shared/event.md +17 -0
- package/docs/models/shared/eventproperties.md +9 -0
- package/docs/models/shared/events.md +9 -0
- package/docs/models/shared/eventsearchcriteria.md +9 -0
- package/docs/models/shared/expirationchangeledgerentry.md +22 -0
- package/docs/models/shared/expirationchangeledgerentryentrystatus.md +9 -0
- package/docs/models/shared/expirationchangeledgerentryentrytype.md +8 -0
- package/docs/models/shared/featurenotavailableerror.md +12 -0
- package/docs/models/shared/featurenotavailableerrorheaders.md +7 -0
- package/docs/models/shared/featurenotavailableerrorstatus.md +8 -0
- package/docs/models/shared/featurenotavailableerrortype.md +8 -0
- package/docs/models/shared/fivehundrederror.md +12 -0
- package/docs/models/shared/fivehundrederrorheaders.md +7 -0
- package/docs/models/shared/fivehundrederrortype.md +8 -0
- package/docs/models/shared/fivetranexampleprice.md +225 -0
- package/docs/models/shared/fivetranexamplepricecadence.md +11 -0
- package/docs/models/shared/fivetranexamplepricemodeltype.md +8 -0
- package/docs/models/shared/fivetranexamplepricepricetype.md +9 -0
- package/docs/models/shared/fixedfeequantitychange.md +11 -0
- package/docs/models/shared/fixedfeequantitychangechangeoption.md +12 -0
- package/docs/models/shared/fixedfeequantityscheduleentry.md +11 -0
- package/docs/models/shared/fixedfeequantitytransition.md +10 -0
- package/docs/models/shared/fourhundredandoneerror.md +12 -0
- package/docs/models/shared/fourhundredandoneerrorheaders.md +7 -0
- package/docs/models/shared/fourhundredandoneerrorstatus.md +8 -0
- package/docs/models/shared/fourhundredandoneerrortype.md +8 -0
- package/docs/models/shared/fourhundredandtwentynineerror.md +12 -0
- package/docs/models/shared/fourhundredandtwentynineerrorheaders.md +7 -0
- package/docs/models/shared/fourhundredandtwentynineerrorstatus.md +8 -0
- package/docs/models/shared/fourhundredandtwentynineerrortype.md +8 -0
- package/docs/models/shared/groupedsubscriptionusage.md +9 -0
- package/docs/models/shared/groupedsubscriptionusagerecord.md +11 -0
- package/docs/models/shared/groupedsubscriptionusagerecordviewmode.md +9 -0
- package/docs/models/shared/idempotencyconflict.md +12 -0
- package/docs/models/shared/idempotencyconflictheaders.md +7 -0
- package/docs/models/shared/idempotencyconflictstatus.md +8 -0
- package/docs/models/shared/idempotencyconflicttype.md +8 -0
- package/docs/models/shared/idempotencykeyvalidationerror.md +13 -0
- package/docs/models/shared/idempotencykeyvalidationerrorheaders.md +7 -0
- package/docs/models/shared/idempotencykeyvalidationerrorstatus.md +8 -0
- package/docs/models/shared/idempotencykeyvalidationerrortype.md +8 -0
- package/docs/models/shared/idempotencyrequestmismatch.md +12 -0
- package/docs/models/shared/idempotencyrequestmismatchheaders.md +7 -0
- package/docs/models/shared/idempotencyrequestmismatchstatus.md +8 -0
- package/docs/models/shared/idempotencyrequestmismatchtype.md +8 -0
- package/docs/models/shared/incrementcreditledgerentryinvoicesettings.md +12 -0
- package/docs/models/shared/incrementledgerentry.md +21 -0
- package/docs/models/shared/incrementledgerentryentrystatus.md +9 -0
- package/docs/models/shared/incrementledgerentryentrytype.md +8 -0
- package/docs/models/shared/ingestevent.md +13 -0
- package/docs/models/shared/ingesteventproperties.md +9 -0
- package/docs/models/shared/ingestionresponse.md +9 -0
- package/docs/models/shared/ingestrequestbody.md +8 -0
- package/docs/models/shared/invoice.md +51 -0
- package/docs/models/shared/invoicelineitem.md +23 -0
- package/docs/models/shared/invoicelineitemparams.md +14 -0
- package/docs/models/shared/invoicelineitemparamsmodeltype.md +8 -0
- package/docs/models/shared/invoicemetadata.md +7 -0
- package/docs/models/shared/invoiceminified.md +8 -0
- package/docs/models/shared/invoices.md +9 -0
- package/docs/models/shared/invoicestatus.md +12 -0
- package/docs/models/shared/item.md +14 -0
- package/docs/models/shared/itemexternalconnection.md +9 -0
- package/docs/models/shared/itemexternalconnectionexternalconnectionnameexternalconnectionname.md +11 -0
- package/docs/models/shared/itemexternalconnectionexternalconnectionnameexternalconnectionname1.md +10 -0
- package/docs/models/shared/items.md +9 -0
- package/docs/models/shared/itemslim.md +9 -0
- package/docs/models/shared/markaspaidrequestparams.md +10 -0
- package/docs/models/shared/matrixconfig.md +11 -0
- package/docs/models/shared/matrixprice.md +225 -0
- package/docs/models/shared/matrixpricecadence.md +11 -0
- package/docs/models/shared/matrixpricemodeltype.md +8 -0
- package/docs/models/shared/matrixpricepricetype.md +9 -0
- package/docs/models/shared/matrixsublineitem.md +13 -0
- package/docs/models/shared/matrixsublineitemtype.md +8 -0
- package/docs/models/shared/matrixvalue.md +10 -0
- package/docs/models/shared/maximum.md +9 -0
- package/docs/models/shared/maximuminterval.md +12 -0
- package/docs/models/shared/metricgroup.md +9 -0
- package/docs/models/shared/minimum.md +9 -0
- package/docs/models/shared/minimuminterval.md +12 -0
- package/docs/models/shared/newaccountingsyncconfiguration.md +9 -0
- package/docs/models/shared/newbackfill.md +13 -0
- package/docs/models/shared/newbillablemetric.md +12 -0
- package/docs/models/shared/newbillablemetricmetadata.md +9 -0
- package/docs/models/shared/newbpsprice.md +18 -0
- package/docs/models/shared/newbpspricecadence.md +12 -0
- package/docs/models/shared/newbpspricemodeltype.md +8 -0
- package/docs/models/shared/newbulkbpsprice.md +18 -0
- package/docs/models/shared/newbulkbpspricecadence.md +12 -0
- package/docs/models/shared/newbulkbpspricemodeltype.md +8 -0
- package/docs/models/shared/newbulkprice.md +18 -0
- package/docs/models/shared/newbulkpricecadence.md +12 -0
- package/docs/models/shared/newbulkpricemodeltype.md +8 -0
- package/docs/models/shared/newcoupon.md +11 -0
- package/docs/models/shared/newcoupondiscount.md +7 -0
- package/docs/models/shared/newcustomer.md +23 -0
- package/docs/models/shared/newcustomerbalancetransaction.md +10 -0
- package/docs/models/shared/newcustomerbalancetransactiontype.md +9 -0
- package/docs/models/shared/newcustomermetadata.md +9 -0
- package/docs/models/shared/newcustomerpaymentprovider.md +14 -0
- package/docs/models/shared/newmatrixprice.md +18 -0
- package/docs/models/shared/newmatrixpricecadence.md +12 -0
- package/docs/models/shared/newmatrixpricemodeltype.md +8 -0
- package/docs/models/shared/newpackageprice.md +18 -0
- package/docs/models/shared/newpackagepricecadence.md +12 -0
- package/docs/models/shared/newpackagepricemodeltype.md +8 -0
- package/docs/models/shared/newpackagewithallocationprice.md +18 -0
- package/docs/models/shared/newpackagewithallocationpricecadence.md +12 -0
- package/docs/models/shared/newpackagewithallocationpricemodeltype.md +8 -0
- package/docs/models/shared/newplan.md +14 -0
- package/docs/models/shared/newplanmetadata.md +7 -0
- package/docs/models/shared/newplanprices.md +7 -0
- package/docs/models/shared/newreportingconfiguration.md +8 -0
- package/docs/models/shared/newsubscription.md +31 -0
- package/docs/models/shared/newsubscriptionexternalmarketplace.md +10 -0
- package/docs/models/shared/newsubscriptionmetadata.md +7 -0
- package/docs/models/shared/newthresholdtotalamountprice.md +18 -0
- package/docs/models/shared/newthresholdtotalamountpricecadence.md +12 -0
- package/docs/models/shared/newthresholdtotalamountpricemodeltype.md +8 -0
- package/docs/models/shared/newtieredbpsprice.md +18 -0
- package/docs/models/shared/newtieredbpspricecadence.md +12 -0
- package/docs/models/shared/newtieredbpspricemodeltype.md +8 -0
- package/docs/models/shared/newtieredpackageprice.md +18 -0
- package/docs/models/shared/newtieredpackagepricecadence.md +12 -0
- package/docs/models/shared/newtieredpackagepricemodeltype.md +8 -0
- package/docs/models/shared/newtieredprice.md +18 -0
- package/docs/models/shared/newtieredpricecadence.md +12 -0
- package/docs/models/shared/newtieredpricemodeltype.md +8 -0
- package/docs/models/shared/newtieredwithminimumprice.md +18 -0
- package/docs/models/shared/newtieredwithminimumpricecadence.md +12 -0
- package/docs/models/shared/newtieredwithminimumpricemodeltype.md +8 -0
- package/docs/models/shared/newunitprice.md +18 -0
- package/docs/models/shared/newunitpricecadence.md +12 -0
- package/docs/models/shared/newunitpricemodeltype.md +8 -0
- package/docs/models/shared/othersublineitem.md +12 -0
- package/docs/models/shared/othersublineitemtype.md +8 -0
- package/docs/models/shared/overridebpsprice.md +14 -0
- package/docs/models/shared/overridebpspricemodeltype.md +8 -0
- package/docs/models/shared/overridebulkbpsprice.md +14 -0
- package/docs/models/shared/overridebulkbpspricemodeltype.md +8 -0
- package/docs/models/shared/overridebulkprice.md +14 -0
- package/docs/models/shared/overridebulkpricemodeltype.md +8 -0
- package/docs/models/shared/overridefivetranexampleprice.md +14 -0
- package/docs/models/shared/overridefivetranexamplepricemodeltype.md +8 -0
- package/docs/models/shared/overridematrixprice.md +14 -0
- package/docs/models/shared/overridematrixpricemodeltype.md +8 -0
- package/docs/models/shared/overridepackageprice.md +14 -0
- package/docs/models/shared/overridepackagepricemodeltype.md +8 -0
- package/docs/models/shared/overridepackagewithallocationprice.md +14 -0
- package/docs/models/shared/overridepackagewithallocationpricemodeltype.md +8 -0
- package/docs/models/shared/overridetestratingfunctionprice.md +14 -0
- package/docs/models/shared/overridetestratingfunctionpricemodeltype.md +8 -0
- package/docs/models/shared/overridethresholdtotalamountprice.md +14 -0
- package/docs/models/shared/overridethresholdtotalamountpricemodeltype.md +8 -0
- package/docs/models/shared/overridetieredbpsprice.md +14 -0
- package/docs/models/shared/overridetieredbpspricemodeltype.md +8 -0
- package/docs/models/shared/overridetieredpackageprice.md +14 -0
- package/docs/models/shared/overridetieredpackagepricemodeltype.md +8 -0
- package/docs/models/shared/overridetieredprice.md +14 -0
- package/docs/models/shared/overridetieredpricemodeltype.md +8 -0
- package/docs/models/shared/overridetieredwithminimumprice.md +14 -0
- package/docs/models/shared/overridetieredwithminimumpricemodeltype.md +8 -0
- package/docs/models/shared/overrideunitprice.md +14 -0
- package/docs/models/shared/overrideunitpricemodeltype.md +8 -0
- package/docs/models/shared/packageconfig.md +9 -0
- package/docs/models/shared/packageprice.md +225 -0
- package/docs/models/shared/packagepricecadence.md +11 -0
- package/docs/models/shared/packagepricemodeltype.md +8 -0
- package/docs/models/shared/packagepricepricetype.md +9 -0
- package/docs/models/shared/packagewithallocationprice.md +225 -0
- package/docs/models/shared/packagewithallocationpricecadence.md +11 -0
- package/docs/models/shared/packagewithallocationpricemodeltype.md +8 -0
- package/docs/models/shared/packagewithallocationpricepricetype.md +9 -0
- package/docs/models/shared/paginationmetadata.md +9 -0
- package/docs/models/shared/percentagediscount.md +10 -0
- package/docs/models/shared/percentagediscountcreationparams.md +9 -0
- package/docs/models/shared/percentagediscountcreationparamsdiscounttype.md +8 -0
- package/docs/models/shared/percentagediscountdiscounttype.md +8 -0
- package/docs/models/shared/percentagediscountinterval.md +13 -0
- package/docs/models/shared/percentagediscountintervaldiscounttype.md +8 -0
- package/docs/models/shared/perpricecost.md +12 -0
- package/docs/models/shared/phaseoverride.md +11 -0
- package/docs/models/shared/pingresponse.md +8 -0
- package/docs/models/shared/plan.md +33 -0
- package/docs/models/shared/planmetadata.md +7 -0
- package/docs/models/shared/planminified.md +10 -0
- package/docs/models/shared/planphase.md +18 -0
- package/docs/models/shared/planphasedurationunit.md +11 -0
- package/docs/models/shared/planprices.md +7 -0
- package/docs/models/shared/plans.md +9 -0
- package/docs/models/shared/planstatus.md +10 -0
- package/docs/models/shared/pricegroup.md +12 -0
- package/docs/models/shared/priceinterval.md +18 -0
- package/docs/models/shared/priceintervalfixedfeequantitytransitionparams.md +9 -0
- package/docs/models/shared/prices.md +9 -0
- package/docs/models/shared/product.md +10 -0
- package/docs/models/shared/reportingconfiguration.md +8 -0
- package/docs/models/shared/requesttoolargeerror.md +12 -0
- package/docs/models/shared/requesttoolargeerrorheaders.md +7 -0
- package/docs/models/shared/requesttoolargeerrorstatus.md +8 -0
- package/docs/models/shared/requesttoolargeerrortype.md +8 -0
- package/docs/models/shared/requestvalidationerror.md +13 -0
- package/docs/models/shared/requestvalidationerrorheaders.md +7 -0
- package/docs/models/shared/requestvalidationerrorstatus.md +8 -0
- package/docs/models/shared/requestvalidationerrortype.md +8 -0
- package/docs/models/shared/resourcenotfounderror.md +12 -0
- package/docs/models/shared/resourcenotfounderrorheaders.md +7 -0
- package/docs/models/shared/resourcenotfounderrorstatus.md +8 -0
- package/docs/models/shared/resourcenotfounderrortype.md +8 -0
- package/docs/models/shared/resourcetoolargeerror.md +12 -0
- package/docs/models/shared/resourcetoolargeerrorheaders.md +7 -0
- package/docs/models/shared/resourcetoolargeerrorstatus.md +8 -0
- package/docs/models/shared/resourcetoolargeerrortype.md +8 -0
- package/docs/models/shared/security.md +8 -0
- package/docs/models/shared/sublineitemgrouping.md +9 -0
- package/docs/models/shared/sublineitemmatrixconfig.md +8 -0
- package/docs/models/shared/subscription.md +44 -0
- package/docs/models/shared/subscriptioncosts.md +8 -0
- package/docs/models/shared/subscriptionmetadata.md +9 -0
- package/docs/models/shared/subscriptionminified.md +8 -0
- package/docs/models/shared/subscriptionplanchange.md +23 -0
- package/docs/models/shared/subscriptions.md +9 -0
- package/docs/models/shared/subscriptionscheduleitem.md +10 -0
- package/docs/models/shared/subscriptionscheduleitems.md +9 -0
- package/docs/models/shared/subscriptionstatus.md +10 -0
- package/docs/models/shared/subscriptiontrialinfo.md +8 -0
- package/docs/models/shared/taxamount.md +10 -0
- package/docs/models/shared/testratingfunctionprice.md +225 -0
- package/docs/models/shared/testratingfunctionpricecadence.md +11 -0
- package/docs/models/shared/testratingfunctionpricemodeltype.md +8 -0
- package/docs/models/shared/testratingfunctionpricepricetype.md +9 -0
- package/docs/models/shared/thresholdtotalamountprice.md +225 -0
- package/docs/models/shared/thresholdtotalamountpricecadence.md +11 -0
- package/docs/models/shared/thresholdtotalamountpricemodeltype.md +8 -0
- package/docs/models/shared/thresholdtotalamountpricepricetype.md +9 -0
- package/docs/models/shared/tier.md +10 -0
- package/docs/models/shared/tierconfig.md +10 -0
- package/docs/models/shared/tieredbpsconfig.md +8 -0
- package/docs/models/shared/tieredbpsprice.md +225 -0
- package/docs/models/shared/tieredbpspricecadence.md +11 -0
- package/docs/models/shared/tieredbpspricemodeltype.md +8 -0
- package/docs/models/shared/tieredbpspricepricetype.md +9 -0
- package/docs/models/shared/tieredconfig.md +8 -0
- package/docs/models/shared/tieredpackageprice.md +225 -0
- package/docs/models/shared/tieredpackagepricecadence.md +11 -0
- package/docs/models/shared/tieredpackagepricemodeltype.md +8 -0
- package/docs/models/shared/tieredpackagepricepricetype.md +9 -0
- package/docs/models/shared/tieredprice.md +225 -0
- package/docs/models/shared/tieredpricecadence.md +11 -0
- package/docs/models/shared/tieredpricemodeltype.md +8 -0
- package/docs/models/shared/tieredpricepricetype.md +9 -0
- package/docs/models/shared/tieredwithminimumprice.md +225 -0
- package/docs/models/shared/tieredwithminimumpricecadence.md +11 -0
- package/docs/models/shared/tieredwithminimumpricemodeltype.md +8 -0
- package/docs/models/shared/tieredwithminimumpricepricetype.md +9 -0
- package/docs/models/shared/tiersublineitem.md +13 -0
- package/docs/models/shared/tiersublineitemtype.md +8 -0
- package/docs/models/shared/trialconfig.md +9 -0
- package/docs/models/shared/trialconfigtrialperiodunit.md +8 -0
- package/docs/models/shared/trialdiscount.md +11 -0
- package/docs/models/shared/trialdiscountdiscounttype.md +8 -0
- package/docs/models/shared/triggersubscriptionphaseparams.md +8 -0
- package/docs/models/shared/ungroupedsubscriptionusage.md +8 -0
- package/docs/models/shared/ungroupedsubscriptionusagerecord.md +10 -0
- package/docs/models/shared/ungroupedsubscriptionusagerecordviewmode.md +9 -0
- package/docs/models/shared/unitconfig.md +9 -0
- package/docs/models/shared/unitprice.md +225 -0
- package/docs/models/shared/unitpricecadence.md +11 -0
- package/docs/models/shared/unitpricemodeltype.md +8 -0
- package/docs/models/shared/unitpricepricetype.md +9 -0
- package/docs/models/shared/unschedulefixedfeequantitychangeparams.md +8 -0
- package/docs/models/shared/upcominginvoice.md +46 -0
- package/docs/models/shared/upcominginvoicemetadata.md +7 -0
- package/docs/models/shared/upcominginvoicestatus.md +12 -0
- package/docs/models/shared/updateevent.md +12 -0
- package/docs/models/shared/updateeventproperties.md +9 -0
- package/docs/models/shared/urlnotfound.md +12 -0
- package/docs/models/shared/urlnotfoundheaders.md +7 -0
- package/docs/models/shared/urlnotfoundstatus.md +8 -0
- package/docs/models/shared/urlnotfoundtype.md +8 -0
- package/docs/models/shared/usage.md +10 -0
- package/docs/models/shared/usagediscount.md +10 -0
- package/docs/models/shared/usagediscountcreationparams.md +9 -0
- package/docs/models/shared/usagediscountcreationparamsdiscounttype.md +8 -0
- package/docs/models/shared/usagediscountdiscounttype.md +8 -0
- package/docs/models/shared/usagediscountinterval.md +13 -0
- package/docs/models/shared/usagediscountintervaldiscounttype.md +8 -0
- package/docs/models/shared/validationerror.md +9 -0
- package/docs/models/shared/voidinitiatedledgerentry.md +24 -0
- package/docs/models/shared/voidinitiatedledgerentryentrystatus.md +9 -0
- package/docs/models/shared/voidinitiatedledgerentryentrytype.md +8 -0
- package/docs/models/shared/voidledgerentry.md +23 -0
- package/docs/models/shared/voidledgerentryentrystatus.md +9 -0
- package/docs/models/shared/voidledgerentryentrytype.md +8 -0
- package/docs/sdks/availability/README.md +45 -0
- package/docs/sdks/coupon/README.md +226 -0
- package/docs/sdks/credit/README.md +605 -0
- package/docs/sdks/creditnote/README.md +91 -0
- package/docs/sdks/customer/README.md +1129 -0
- package/docs/sdks/event/README.md +674 -0
- package/docs/sdks/invoice/README.md +402 -0
- package/docs/sdks/item/README.md +89 -0
- package/docs/sdks/metric/README.md +140 -0
- package/docs/sdks/orb/README.md +21 -0
- package/docs/sdks/plan/README.md +300 -0
- package/docs/sdks/price/README.md +411 -0
- package/docs/sdks/priceinterval/README.md +180 -0
- package/docs/sdks/subscription/README.md +1412 -0
- package/docs/types/rfcdate.md +11 -0
- package/package.json +2 -1
- package/dist/sdk/models/operations/addledgerentryexternalid.d.ts +0 -16
- package/dist/sdk/models/operations/listcreditnote.d.ts +0 -34
- package/dist/sdk/models/shared/action.d.ts +0 -8
- package/dist/sdk/models/shared/action.js +0 -15
- package/dist/sdk/models/shared/billablemetricminified.d.ts +0 -5
- package/dist/sdk/models/shared/bpspriceoverride.d.ts +0 -24
- package/dist/sdk/models/shared/bulkbpspriceoverride.d.ts +0 -24
- package/dist/sdk/models/shared/bulkpriceoverride.d.ts +0 -24
- package/dist/sdk/models/shared/cadence.d.ts +0 -5
- package/dist/sdk/models/shared/cadence.js +0 -12
- package/dist/sdk/models/shared/canceloption.d.ts +0 -8
- package/dist/sdk/models/shared/canceloption.js +0 -15
- package/dist/sdk/models/shared/changeoption1.d.ts +0 -8
- package/dist/sdk/models/shared/changeoption1.js +0 -15
- package/dist/sdk/models/shared/credit.d.ts +0 -16
- package/dist/sdk/models/shared/creditblock.d.ts +0 -15
- package/dist/sdk/models/shared/creditledgerentry.d.ts +0 -58
- package/dist/sdk/models/shared/creditnotetype.d.ts +0 -7
- package/dist/sdk/models/shared/creditnotetype.js +0 -14
- package/dist/sdk/models/shared/customercost.d.ts +0 -15
- package/dist/sdk/models/shared/discounttype.d.ts +0 -6
- package/dist/sdk/models/shared/discounttype.js +0 -13
- package/dist/sdk/models/shared/durationunit.d.ts +0 -8
- package/dist/sdk/models/shared/durationunit.js +0 -15
- package/dist/sdk/models/shared/entrystatus.d.ts +0 -7
- package/dist/sdk/models/shared/entrystatus.js +0 -14
- package/dist/sdk/models/shared/entrytype.d.ts +0 -9
- package/dist/sdk/models/shared/entrytype.js +0 -16
- package/dist/sdk/models/shared/eventsearchresults.d.ts +0 -10
- package/dist/sdk/models/shared/externalmarketplace.d.ts +0 -8
- package/dist/sdk/models/shared/externalmarketplace.js +0 -15
- package/dist/sdk/models/shared/fixedfeequantityschedule.d.ts +0 -7
- package/dist/sdk/models/shared/granularity.d.ts +0 -6
- package/dist/sdk/models/shared/granularity.js +0 -13
- package/dist/sdk/models/shared/grouping.d.ts +0 -8
- package/dist/sdk/models/shared/invoicestatus.d.ts +0 -10
- package/dist/sdk/models/shared/invoicestatus.js +0 -17
- package/dist/sdk/models/shared/lineitem.d.ts +0 -58
- package/dist/sdk/models/shared/lineitem.js +0 -147
- package/dist/sdk/models/shared/matrixconfig1.d.ts +0 -10
- package/dist/sdk/models/shared/modeltype.d.ts +0 -10
- package/dist/sdk/models/shared/modeltype.js +0 -17
- package/dist/sdk/models/shared/newcreditledgerentry.d.ts +0 -44
- package/dist/sdk/models/shared/newtransaction.d.ts +0 -10
- package/dist/sdk/models/shared/packagepriceoverride.d.ts +0 -24
- package/dist/sdk/models/shared/price.d.ts +0 -114
- package/dist/sdk/models/shared/price.js +0 -245
- package/dist/sdk/models/shared/reason.d.ts +0 -9
- package/dist/sdk/models/shared/reason.js +0 -16
- package/dist/sdk/models/shared/sublineitem.d.ts +0 -32
- package/dist/sdk/models/shared/sublineitem1.d.ts +0 -24
- package/dist/sdk/models/shared/subscriptioncancellation.d.ts +0 -12
- package/dist/sdk/models/shared/subscriptionstatus.d.ts +0 -5
- package/dist/sdk/models/shared/subscriptionstatus.js +0 -12
- package/dist/sdk/models/shared/subscriptionusage.d.ts +0 -8
- package/dist/sdk/models/shared/tier7.d.ts +0 -7
- package/dist/sdk/models/shared/tieredbpsconfig1.d.ts +0 -5
- package/dist/sdk/models/shared/tieredbpspriceoverride.d.ts +0 -21
- package/dist/sdk/models/shared/tieredpriceoverride.d.ts +0 -27
- package/dist/sdk/models/shared/transactiontype.d.ts +0 -4
- package/dist/sdk/models/shared/transactiontype.js +0 -11
- package/dist/sdk/models/shared/type.d.ts +0 -7
- package/dist/sdk/models/shared/type.js +0 -14
- package/dist/sdk/models/shared/unitpriceoverride.d.ts +0 -24
- package/dist/sdk/models/shared/usageitem.d.ts +0 -6
- package/dist/sdk/models/shared/validationerrors.d.ts +0 -13
- package/dist/sdk/models/shared/validationerrors.js +0 -59
- package/dist/sdk/models/shared/viewmode.d.ts +0 -7
- package/dist/sdk/models/shared/viewmode.js +0 -14
package/dist/sdk/sdk.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import * as utils from "../internal/utils";
|
|
1
2
|
import { Availability } from "./availability";
|
|
2
3
|
import { Coupon } from "./coupon";
|
|
3
4
|
import { Credit } from "./credit";
|
|
@@ -5,8 +6,12 @@ import { CreditNote } from "./creditnote";
|
|
|
5
6
|
import { Customer } from "./customer";
|
|
6
7
|
import { Event } from "./event";
|
|
7
8
|
import { Invoice } from "./invoice";
|
|
9
|
+
import { Item } from "./item";
|
|
10
|
+
import { Metric } from "./metric";
|
|
8
11
|
import * as shared from "./models/shared";
|
|
9
12
|
import { Plan } from "./plan";
|
|
13
|
+
import { Price } from "./price";
|
|
14
|
+
import { PriceInterval } from "./priceinterval";
|
|
10
15
|
import { Subscription } from "./subscription";
|
|
11
16
|
import { AxiosInstance } from "axios";
|
|
12
17
|
/**
|
|
@@ -20,7 +25,7 @@ export type SDKProps = {
|
|
|
20
25
|
/**
|
|
21
26
|
* The security details required to authenticate the SDK
|
|
22
27
|
*/
|
|
23
|
-
security?: shared.Security;
|
|
28
|
+
security?: shared.Security | (() => Promise<shared.Security>);
|
|
24
29
|
/**
|
|
25
30
|
* Allows overriding the default axios client used by the SDK
|
|
26
31
|
*/
|
|
@@ -33,16 +38,22 @@ export type SDKProps = {
|
|
|
33
38
|
* Allows overriding the default server URL used by the SDK
|
|
34
39
|
*/
|
|
35
40
|
serverURL?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Allows overriding the default retry config used by the SDK
|
|
43
|
+
*/
|
|
44
|
+
retryConfig?: utils.RetryConfig;
|
|
36
45
|
};
|
|
37
46
|
export declare class SDKConfiguration {
|
|
38
47
|
defaultClient: AxiosInstance;
|
|
39
|
-
|
|
48
|
+
security?: shared.Security | (() => Promise<shared.Security>);
|
|
40
49
|
serverURL: string;
|
|
41
50
|
serverDefaults: any;
|
|
42
51
|
language: string;
|
|
43
52
|
openapiDocVersion: string;
|
|
44
53
|
sdkVersion: string;
|
|
45
54
|
genVersion: string;
|
|
55
|
+
userAgent: string;
|
|
56
|
+
retryConfig?: utils.RetryConfig;
|
|
46
57
|
constructor(init?: Partial<SDKConfiguration>);
|
|
47
58
|
}
|
|
48
59
|
/**
|
|
@@ -50,32 +61,40 @@ export declare class SDKConfiguration {
|
|
|
50
61
|
*
|
|
51
62
|
* @remarks
|
|
52
63
|
*
|
|
53
|
-
* 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
|
|
54
|
-
*
|
|
55
|
-
*
|
|
64
|
+
* 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
|
|
65
|
+
* cursor-based pagination and standardized error output. To help with debugging in critical API
|
|
66
|
+
* actions, the API always strives to provide detailed and actionable error messages. Aliases
|
|
67
|
+
* such as external customer IDs aid in fast integration times.
|
|
68
|
+
* 2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high
|
|
69
|
+
* throughput and scale with concurrent load. Orb also provides a real-time event-level credits
|
|
70
|
+
* ledger and a highly performant webhooks architecture.
|
|
71
|
+
* 3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage
|
|
72
|
+
* show the flexible nature of the platform.
|
|
56
73
|
*
|
|
57
|
-
* You can download the latest OpenAPI spec [here](
|
|
74
|
+
* You can download the latest OpenAPI spec [here](pathname:///spec.json).
|
|
58
75
|
*/
|
|
59
76
|
export declare class Orb {
|
|
60
|
-
/**
|
|
61
|
-
* The Availability resource represents a customer's availability. Availability is created when a customer's invoice is paid, and is updated when a customer's transaction is refunded.
|
|
62
|
-
*/
|
|
63
77
|
availability: Availability;
|
|
64
78
|
/**
|
|
65
|
-
* A coupon represents a reusable discount configuration, and have an attached redemption code that can be issued to
|
|
79
|
+
* A coupon represents a reusable discount configuration, and have an attached redemption code that can be issued to
|
|
66
80
|
*
|
|
67
81
|
* @remarks
|
|
82
|
+
* your end users. Coupons are most often used in self-serve signup or upgrade flows in your checkout experience or
|
|
83
|
+
* billing portal.
|
|
68
84
|
*
|
|
69
|
-
* To redeem a coupon, pass the `redemption_code` property in the [create subscription](create-subscription.api.mdx)
|
|
70
|
-
*
|
|
85
|
+
* To redeem a coupon, pass the `redemption_code` property in the [create subscription](create-subscription.api.mdx)
|
|
86
|
+
* or [schedule plan change](schedule-plan-change.api.mdx) request.
|
|
71
87
|
*/
|
|
72
88
|
coupon: Coupon;
|
|
73
89
|
/**
|
|
74
|
-
* The
|
|
90
|
+
* The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
75
91
|
*/
|
|
76
92
|
credit: Credit;
|
|
77
93
|
/**
|
|
78
|
-
* The Credit Note resource represents a credit
|
|
94
|
+
* The [Credit Note](/guides/invoicing/credit-notes) resource represents a credit that has been applied to a
|
|
95
|
+
*
|
|
96
|
+
* @remarks
|
|
97
|
+
* particular invoice.
|
|
79
98
|
*/
|
|
80
99
|
creditNote: CreditNote;
|
|
81
100
|
/**
|
|
@@ -83,26 +102,67 @@ export declare class Orb {
|
|
|
83
102
|
*
|
|
84
103
|
* @remarks
|
|
85
104
|
*
|
|
86
|
-
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
105
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
106
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
107
|
+
* `external_customer_id` with your own identifier. See
|
|
108
|
+
* [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further information about how these
|
|
109
|
+
* aliases work in Orb.
|
|
87
110
|
*
|
|
88
|
-
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
111
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
112
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
89
113
|
*
|
|
90
|
-
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
114
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
115
|
+
* defaults to your account's timezone. See [Timezone localization](../guides/product-catalog/timezones.md) for
|
|
116
|
+
* information on what this timezone parameter influences within Orb.
|
|
91
117
|
*/
|
|
92
118
|
customer: Customer;
|
|
93
119
|
/**
|
|
94
|
-
* The [Event](../guides/core-concepts.mdx#event) resource represents
|
|
120
|
+
* The [Event](../guides/core-concepts.mdx#event) resource represents a usage event that has been created for a
|
|
121
|
+
*
|
|
122
|
+
* @remarks
|
|
123
|
+
* customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
|
|
124
|
+
* a given billing period.
|
|
95
125
|
*/
|
|
96
126
|
event: Event;
|
|
97
127
|
/**
|
|
98
|
-
* An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for
|
|
128
|
+
* An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for
|
|
129
|
+
*
|
|
130
|
+
* @remarks
|
|
131
|
+
* a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and
|
|
132
|
+
* can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as
|
|
133
|
+
* the result of an action, such as a cancellation.
|
|
99
134
|
*/
|
|
100
135
|
invoice: Invoice;
|
|
101
136
|
/**
|
|
102
|
-
* The
|
|
137
|
+
* The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics,
|
|
138
|
+
*
|
|
139
|
+
* @remarks
|
|
140
|
+
* and prices and are used for defining external sync behavior for invoices and tax calculation purposes.
|
|
141
|
+
*/
|
|
142
|
+
item: Item;
|
|
143
|
+
/**
|
|
144
|
+
* The Metric resource represents a calculation of a quantity based on events.
|
|
145
|
+
*
|
|
146
|
+
* @remarks
|
|
147
|
+
* Metrics are defined by the query that transforms raw usage events into meaningful values for your customers.
|
|
148
|
+
*/
|
|
149
|
+
metric: Metric;
|
|
150
|
+
/**
|
|
151
|
+
* The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a plan that can be subscribed to by a
|
|
152
|
+
*
|
|
153
|
+
* @remarks
|
|
154
|
+
* customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices
|
|
155
|
+
* in the [Price resource](/reference/price).
|
|
156
|
+
*/
|
|
157
|
+
plan: Plan;
|
|
158
|
+
/**
|
|
159
|
+
* The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
|
|
103
160
|
*
|
|
104
161
|
* @remarks
|
|
105
|
-
*
|
|
162
|
+
* the form of an invoice line item. Prices take a quantity and determine an amount to bill.
|
|
163
|
+
*
|
|
164
|
+
* Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
|
|
165
|
+
* given Price object. The model_type field determines the key for the configuration object that is present.
|
|
106
166
|
*
|
|
107
167
|
* ## Unit pricing
|
|
108
168
|
* With unit pricing, each unit costs a fixed amount.
|
|
@@ -118,14 +178,16 @@ export declare class Orb {
|
|
|
118
178
|
* ```
|
|
119
179
|
*
|
|
120
180
|
* ## Tiered pricing
|
|
121
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
|
|
181
|
+
* In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
|
|
182
|
+
* defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter
|
|
183
|
+
* may cost $0.10 each.
|
|
122
184
|
* ```json
|
|
123
185
|
* {
|
|
124
186
|
* ...
|
|
125
187
|
* "model_type": "tiered",
|
|
126
188
|
* "tiered_config": {
|
|
127
189
|
* "tiers": [
|
|
128
|
-
*
|
|
190
|
+
* {
|
|
129
191
|
* "first_unit": 1,
|
|
130
192
|
* "last_unit": 10,
|
|
131
193
|
* "unit_amount": "0.50"
|
|
@@ -138,11 +200,12 @@ export declare class Orb {
|
|
|
138
200
|
* ]
|
|
139
201
|
* }
|
|
140
202
|
* ...
|
|
141
|
-
* }
|
|
142
203
|
* ```
|
|
143
204
|
*
|
|
144
205
|
* ## Bulk pricing
|
|
145
|
-
* Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
|
|
206
|
+
* Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
|
|
207
|
+
* than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may
|
|
208
|
+
* now be priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
146
209
|
* ```json
|
|
147
210
|
* {
|
|
148
211
|
* ...
|
|
@@ -157,28 +220,31 @@ export declare class Orb {
|
|
|
157
220
|
* "maximum_units": 1000,
|
|
158
221
|
* "unit_amount": "0.40"
|
|
159
222
|
* }
|
|
160
|
-
*
|
|
223
|
+
* ]
|
|
161
224
|
* }
|
|
162
225
|
* ...
|
|
163
226
|
* }
|
|
164
227
|
* ```
|
|
165
228
|
*
|
|
166
229
|
* ## Package pricing
|
|
167
|
-
* Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
|
|
230
|
+
* Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
|
|
231
|
+
* set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
|
|
168
232
|
* ```json
|
|
169
233
|
* {
|
|
170
234
|
* ...
|
|
171
235
|
* "model_type": "package",
|
|
172
236
|
* "package_config": {
|
|
173
|
-
*
|
|
174
|
-
*
|
|
237
|
+
* "package_amount": "0.80",
|
|
238
|
+
* "package_size": 10
|
|
175
239
|
* }
|
|
176
240
|
* ...
|
|
177
|
-
*
|
|
241
|
+
* }
|
|
178
242
|
* ```
|
|
179
243
|
*
|
|
180
244
|
* ## BPS pricing
|
|
181
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
|
|
245
|
+
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
|
|
246
|
+
* to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on
|
|
247
|
+
* every payment you process, with a maximum charge of $25 per payment.
|
|
182
248
|
* ```json
|
|
183
249
|
* {
|
|
184
250
|
* ...
|
|
@@ -192,7 +258,10 @@ export declare class Orb {
|
|
|
192
258
|
* ```
|
|
193
259
|
*
|
|
194
260
|
* ## Bulk BPS pricing
|
|
195
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
|
|
261
|
+
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
|
|
262
|
+
* Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period
|
|
263
|
+
* falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached,
|
|
264
|
+
* each individual payment may have a lower cap or a smaller take-rate.
|
|
196
265
|
* ```json
|
|
197
266
|
* ...
|
|
198
267
|
* "model_type": "bulk_bps",
|
|
@@ -215,7 +284,11 @@ export declare class Orb {
|
|
|
215
284
|
* ```
|
|
216
285
|
*
|
|
217
286
|
* ## Tiered BPS pricing
|
|
218
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
|
|
287
|
+
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
|
|
288
|
+
* function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given
|
|
289
|
+
* event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound.
|
|
290
|
+
* For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may
|
|
291
|
+
* incur a take-rate of 0.5 BPS each.
|
|
219
292
|
* ```json
|
|
220
293
|
* ...
|
|
221
294
|
* "model_type": "tiered_bps",
|
|
@@ -240,32 +313,38 @@ export declare class Orb {
|
|
|
240
313
|
* ```
|
|
241
314
|
*
|
|
242
315
|
* ## Matrix pricing
|
|
243
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
|
|
316
|
+
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
|
|
317
|
+
* property values evaluated in this pricing model. In a one-dimensional matrix, the second value is `null`. Every
|
|
318
|
+
* configuration has a list of `matrix_values` which give the unit prices for specified property values. In a
|
|
319
|
+
* one-dimensional matrix, the matrix values will have `dimension_values` where the second value of the pair is null.
|
|
320
|
+
* If an event does not match any of the dimension values in the matrix, it will resort to the `default_unit_amount`.
|
|
244
321
|
* ```json
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
*
|
|
322
|
+
* {
|
|
323
|
+
* "model_type": "matrix"
|
|
324
|
+
* "matrix_config": {
|
|
325
|
+
* "default_unit_amount": "3.00",
|
|
326
|
+
* "dimensions": [
|
|
327
|
+
* "cluster_name",
|
|
328
|
+
* "region"
|
|
329
|
+
* ],
|
|
330
|
+
* "matrix_values": [
|
|
331
|
+
* {
|
|
332
|
+
* "dimension_values": [
|
|
333
|
+
* "alpha",
|
|
334
|
+
* "west"
|
|
335
|
+
* ],
|
|
336
|
+
* "unit_amount": "2.00"
|
|
337
|
+
* },
|
|
338
|
+
* ...
|
|
339
|
+
* ]
|
|
340
|
+
* }
|
|
263
341
|
* }
|
|
264
|
-
* ...
|
|
265
342
|
* ```
|
|
266
343
|
*
|
|
267
344
|
* ### Fixed fees
|
|
268
|
-
* Fixed fees are prices that are applied independent of usage
|
|
345
|
+
* Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an
|
|
346
|
+
* additional parameter `fixed_price_quantity`. If the Price represents a fixed cost, this represents the quantity of
|
|
347
|
+
* units applied.
|
|
269
348
|
* ```json
|
|
270
349
|
* {
|
|
271
350
|
* ...
|
|
@@ -278,19 +357,31 @@ export declare class Orb {
|
|
|
278
357
|
* ...
|
|
279
358
|
* }
|
|
280
359
|
* ```
|
|
360
|
+
*/
|
|
361
|
+
price: Price;
|
|
362
|
+
/**
|
|
363
|
+
* The Price Interval resource represents a period of time for which a price will bill on a subscription. A
|
|
281
364
|
*
|
|
365
|
+
* @remarks
|
|
366
|
+
* subscription’s price intervals define its billing behavior.
|
|
282
367
|
*/
|
|
283
|
-
|
|
368
|
+
priceInterval: PriceInterval;
|
|
284
369
|
/**
|
|
285
370
|
* A [subscription](../guides/core-concepts.mdx#subscription) represents the purchase of a plan by a customer.
|
|
286
371
|
*
|
|
287
372
|
* @remarks
|
|
288
373
|
*
|
|
289
|
-
* By default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at
|
|
374
|
+
* By default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at
|
|
375
|
+
* the cadence that's configured in the plan definition.
|
|
290
376
|
*
|
|
291
|
-
* Subscriptions also default to **beginning of month alignment**, which means the first invoice issued for the
|
|
377
|
+
* Subscriptions also default to **beginning of month alignment**, which means the first invoice issued for the
|
|
378
|
+
* subscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent
|
|
379
|
+
* billing periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing).
|
|
292
380
|
*
|
|
293
|
-
* Depending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance)
|
|
381
|
+
* Depending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance)
|
|
382
|
+
* or end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in
|
|
383
|
+
* arrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based
|
|
384
|
+
* charges for the previous period, and a recurring fee for the following period.
|
|
294
385
|
*/
|
|
295
386
|
subscription: Subscription;
|
|
296
387
|
private sdkConfiguration;
|
package/dist/sdk/sdk.js
CHANGED
|
@@ -2,35 +2,11 @@
|
|
|
2
2
|
/*
|
|
3
3
|
* Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
4
4
|
*/
|
|
5
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
-
if (k2 === undefined) k2 = k;
|
|
7
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
-
}
|
|
11
|
-
Object.defineProperty(o, k2, desc);
|
|
12
|
-
}) : (function(o, m, k, k2) {
|
|
13
|
-
if (k2 === undefined) k2 = k;
|
|
14
|
-
o[k2] = m[k];
|
|
15
|
-
}));
|
|
16
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
-
}) : function(o, v) {
|
|
19
|
-
o["default"] = v;
|
|
20
|
-
});
|
|
21
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
22
|
-
if (mod && mod.__esModule) return mod;
|
|
23
|
-
var result = {};
|
|
24
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
25
|
-
__setModuleDefault(result, mod);
|
|
26
|
-
return result;
|
|
27
|
-
};
|
|
28
5
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
29
6
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
30
7
|
};
|
|
31
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
32
9
|
exports.Orb = exports.SDKConfiguration = exports.ServerList = void 0;
|
|
33
|
-
var utils = __importStar(require("../internal/utils"));
|
|
34
10
|
var availability_1 = require("./availability");
|
|
35
11
|
var coupon_1 = require("./coupon");
|
|
36
12
|
var credit_1 = require("./credit");
|
|
@@ -38,8 +14,11 @@ var creditnote_1 = require("./creditnote");
|
|
|
38
14
|
var customer_1 = require("./customer");
|
|
39
15
|
var event_1 = require("./event");
|
|
40
16
|
var invoice_1 = require("./invoice");
|
|
41
|
-
var
|
|
17
|
+
var item_1 = require("./item");
|
|
18
|
+
var metric_1 = require("./metric");
|
|
42
19
|
var plan_1 = require("./plan");
|
|
20
|
+
var price_1 = require("./price");
|
|
21
|
+
var priceinterval_1 = require("./priceinterval");
|
|
43
22
|
var subscription_1 = require("./subscription");
|
|
44
23
|
var axios_1 = __importDefault(require("axios"));
|
|
45
24
|
/**
|
|
@@ -55,8 +34,9 @@ var SDKConfiguration = /** @class */ (function () {
|
|
|
55
34
|
function SDKConfiguration(init) {
|
|
56
35
|
this.language = "typescript";
|
|
57
36
|
this.openapiDocVersion = "1.0";
|
|
58
|
-
this.sdkVersion = "1.
|
|
59
|
-
this.genVersion = "2.
|
|
37
|
+
this.sdkVersion = "1.19.5";
|
|
38
|
+
this.genVersion = "2.147.0";
|
|
39
|
+
this.userAgent = "speakeasy-sdk/typescript 1.19.5 2.147.0 1.0 orb-billing";
|
|
60
40
|
Object.assign(this, init);
|
|
61
41
|
}
|
|
62
42
|
return SDKConfiguration;
|
|
@@ -67,11 +47,17 @@ exports.SDKConfiguration = SDKConfiguration;
|
|
|
67
47
|
*
|
|
68
48
|
* @remarks
|
|
69
49
|
*
|
|
70
|
-
* 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
|
|
71
|
-
*
|
|
72
|
-
*
|
|
50
|
+
* 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
|
|
51
|
+
* cursor-based pagination and standardized error output. To help with debugging in critical API
|
|
52
|
+
* actions, the API always strives to provide detailed and actionable error messages. Aliases
|
|
53
|
+
* such as external customer IDs aid in fast integration times.
|
|
54
|
+
* 2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high
|
|
55
|
+
* throughput and scale with concurrent load. Orb also provides a real-time event-level credits
|
|
56
|
+
* ledger and a highly performant webhooks architecture.
|
|
57
|
+
* 3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage
|
|
58
|
+
* show the flexible nature of the platform.
|
|
73
59
|
*
|
|
74
|
-
* You can download the latest OpenAPI spec [here](
|
|
60
|
+
* You can download the latest OpenAPI spec [here](pathname:///spec.json).
|
|
75
61
|
*/
|
|
76
62
|
var Orb = /** @class */ (function () {
|
|
77
63
|
function Orb(props) {
|
|
@@ -82,18 +68,11 @@ var Orb = /** @class */ (function () {
|
|
|
82
68
|
serverURL = exports.ServerList[serverIdx];
|
|
83
69
|
}
|
|
84
70
|
var defaultClient = (_b = props === null || props === void 0 ? void 0 : props.defaultClient) !== null && _b !== void 0 ? _b : axios_1.default.create({ baseURL: serverURL });
|
|
85
|
-
var securityClient = defaultClient;
|
|
86
|
-
if (props === null || props === void 0 ? void 0 : props.security) {
|
|
87
|
-
var security = props.security;
|
|
88
|
-
if (!(props.security instanceof utils.SpeakeasyBase)) {
|
|
89
|
-
security = new shared.Security(props.security);
|
|
90
|
-
}
|
|
91
|
-
securityClient = utils.createSecurityClient(defaultClient, security);
|
|
92
|
-
}
|
|
93
71
|
this.sdkConfiguration = new SDKConfiguration({
|
|
94
72
|
defaultClient: defaultClient,
|
|
95
|
-
|
|
73
|
+
security: props === null || props === void 0 ? void 0 : props.security,
|
|
96
74
|
serverURL: serverURL,
|
|
75
|
+
retryConfig: props === null || props === void 0 ? void 0 : props.retryConfig,
|
|
97
76
|
});
|
|
98
77
|
this.availability = new availability_1.Availability(this.sdkConfiguration);
|
|
99
78
|
this.coupon = new coupon_1.Coupon(this.sdkConfiguration);
|
|
@@ -102,7 +81,11 @@ var Orb = /** @class */ (function () {
|
|
|
102
81
|
this.customer = new customer_1.Customer(this.sdkConfiguration);
|
|
103
82
|
this.event = new event_1.Event(this.sdkConfiguration);
|
|
104
83
|
this.invoice = new invoice_1.Invoice(this.sdkConfiguration);
|
|
84
|
+
this.item = new item_1.Item(this.sdkConfiguration);
|
|
85
|
+
this.metric = new metric_1.Metric(this.sdkConfiguration);
|
|
105
86
|
this.plan = new plan_1.Plan(this.sdkConfiguration);
|
|
87
|
+
this.price = new price_1.Price(this.sdkConfiguration);
|
|
88
|
+
this.priceInterval = new priceinterval_1.PriceInterval(this.sdkConfiguration);
|
|
106
89
|
this.subscription = new subscription_1.Subscription(this.sdkConfiguration);
|
|
107
90
|
}
|
|
108
91
|
return Orb;
|