orb-billing 1.19.2 → 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -23
- package/dist/internal/utils/utils.js +1 -1
- package/dist/sdk/coupon.d.ts +4 -4
- package/dist/sdk/coupon.js +25 -20
- package/dist/sdk/credit.d.ts +186 -4
- package/dist/sdk/credit.js +208 -20
- package/dist/sdk/creditnote.d.ts +2 -2
- package/dist/sdk/creditnote.js +11 -10
- package/dist/sdk/customer.d.ts +8 -8
- package/dist/sdk/customer.js +49 -40
- package/dist/sdk/event.d.ts +7 -7
- package/dist/sdk/event.js +39 -35
- package/dist/sdk/invoice.d.ts +5 -5
- package/dist/sdk/invoice.js +26 -25
- package/dist/sdk/item.d.ts +2 -2
- package/dist/sdk/item.js +11 -10
- package/dist/sdk/metric.d.ts +1 -1
- package/dist/sdk/metric.js +5 -5
- package/dist/sdk/models/operations/addeditpriceintervals.d.ts +1 -1
- package/dist/sdk/models/operations/addeditpriceintervals.js +4 -4
- package/dist/sdk/models/operations/amendevent.d.ts +1 -1
- package/dist/sdk/models/operations/amendevent.js +4 -4
- package/dist/sdk/models/operations/amendusage.d.ts +1 -1
- package/dist/sdk/models/operations/amendusage.js +4 -4
- package/dist/sdk/models/operations/amendusageexternalcustomerid.d.ts +1 -1
- package/dist/sdk/models/operations/amendusageexternalcustomerid.js +4 -4
- package/dist/sdk/models/operations/cancelsubscription.d.ts +1 -1
- package/dist/sdk/models/operations/cancelsubscription.js +4 -4
- package/dist/sdk/models/operations/createcustomerbalancetransaction.d.ts +1 -1
- package/dist/sdk/models/operations/createcustomerbalancetransaction.js +4 -4
- package/dist/sdk/models/operations/createledgerentry.d.ts +1 -1
- package/dist/sdk/models/operations/createledgerentry.js +4 -4
- package/dist/sdk/models/operations/createledgerentryexternalid.d.ts +1 -1
- package/dist/sdk/models/operations/createledgerentryexternalid.js +4 -4
- package/dist/sdk/models/operations/fetchcustomercredits.d.ts +1 -1
- package/dist/sdk/models/operations/fetchcustomercredits.js +4 -4
- package/dist/sdk/models/operations/fetchcustomercreditsexternalid.d.ts +1 -1
- package/dist/sdk/models/operations/fetchcustomercreditsexternalid.js +4 -4
- package/dist/sdk/models/operations/markinvoiceaspaid.d.ts +1 -1
- package/dist/sdk/models/operations/markinvoiceaspaid.js +4 -4
- package/dist/sdk/models/operations/scheduleplanchange.d.ts +1 -1
- package/dist/sdk/models/operations/scheduleplanchange.js +4 -4
- package/dist/sdk/models/operations/triggerphase.d.ts +1 -1
- package/dist/sdk/models/operations/triggerphase.js +4 -4
- package/dist/sdk/models/operations/unschedulefixedfeequantity.d.ts +1 -1
- package/dist/sdk/models/operations/unschedulefixedfeequantity.js +4 -4
- package/dist/sdk/models/operations/updatecustomer.d.ts +1 -1
- package/dist/sdk/models/operations/updatecustomer.js +4 -4
- package/dist/sdk/models/operations/updatecustomerexternalid.d.ts +1 -1
- package/dist/sdk/models/operations/updatecustomerexternalid.js +4 -4
- package/dist/sdk/models/operations/updatefixedfeequantity.d.ts +1 -1
- package/dist/sdk/models/operations/updatefixedfeequantity.js +4 -4
- package/dist/sdk/models/operations/updateplan.d.ts +1 -1
- package/dist/sdk/models/operations/updateplan.js +4 -4
- package/dist/sdk/models/operations/updateplanexternal.d.ts +1 -1
- package/dist/sdk/models/operations/updateplanexternal.js +4 -4
- package/dist/sdk/models/shared/addpriceintervalparams.d.ts +0 -14
- package/dist/sdk/models/shared/addpriceintervalparams.js +1 -17
- package/dist/sdk/models/shared/createinvoicelineitemparams.js +2 -0
- package/dist/sdk/models/shared/editpriceintervalparams.d.ts +0 -14
- package/dist/sdk/models/shared/editpriceintervalparams.js +1 -17
- package/dist/sdk/models/shared/fixedfeequantitychange.js +1 -0
- package/dist/sdk/models/shared/index.d.ts +0 -102
- package/dist/sdk/models/shared/index.js +0 -102
- package/dist/sdk/models/shared/invoicelineitemparams.d.ts +1 -2
- package/dist/sdk/models/shared/invoicelineitemparams.js +3 -3
- package/dist/sdk/models/shared/itemexternalconnection.d.ts +0 -11
- package/dist/sdk/models/shared/itemexternalconnection.js +1 -14
- package/dist/sdk/models/shared/markaspaidrequestparams.js +1 -0
- package/dist/sdk/models/shared/plan.d.ts +1 -3
- package/dist/sdk/models/shared/plan.js +2 -11
- package/dist/sdk/models/shared/triggersubscriptionphaseparams.js +1 -0
- package/dist/sdk/plan.d.ts +4 -4
- package/dist/sdk/plan.js +22 -20
- package/dist/sdk/price.d.ts +3 -3
- package/dist/sdk/price.js +16 -15
- package/dist/sdk/priceinterval.d.ts +2 -1
- package/dist/sdk/priceinterval.js +6 -5
- package/dist/sdk/sdk.js +3 -3
- package/dist/sdk/subscription.d.ts +8 -8
- package/dist/sdk/subscription.js +45 -40
- package/docs/models/operations/addeditpriceintervalsrequest.md +2 -2
- package/docs/models/operations/amendeventrequest.md +2 -2
- package/docs/models/operations/amendusageexternalcustomeridrequest.md +1 -1
- package/docs/models/operations/amendusagerequest.md +1 -1
- package/docs/models/operations/cancelsubscriptionrequest.md +2 -2
- package/docs/models/operations/createcustomerbalancetransactionrequest.md +2 -2
- package/docs/models/operations/createledgerentryexternalidrequest.md +2 -2
- package/docs/models/operations/createledgerentryrequest.md +2 -2
- package/docs/models/operations/fetchcustomercreditsexternalidrequest.md +1 -1
- package/docs/models/operations/fetchcustomercreditsrequest.md +1 -1
- package/docs/models/operations/markinvoiceaspaidrequest.md +2 -2
- package/docs/models/operations/scheduleplanchangerequest.md +2 -2
- package/docs/models/operations/triggerphaserequest.md +2 -2
- package/docs/models/operations/unschedulefixedfeequantityrequest.md +2 -2
- package/docs/models/operations/updatecustomerexternalidrequest.md +2 -2
- package/docs/models/operations/updatecustomerrequest.md +2 -2
- package/docs/models/operations/updatefixedfeequantityrequest.md +2 -2
- package/docs/models/operations/updateplanexternalrequest.md +2 -2
- package/docs/models/operations/updateplanrequest.md +2 -2
- package/docs/models/shared/addpriceintervalparams.md +2 -2
- package/docs/models/shared/createinvoicelineitemparams.md +1 -1
- package/docs/models/shared/discount.md +8 -8
- package/docs/models/shared/editpriceintervalparams.md +2 -2
- package/docs/models/shared/invoicelineitem.md +1 -1
- package/docs/models/shared/invoicelineitemparams.md +2 -2
- package/docs/models/shared/plan.md +1 -1
- package/docs/sdks/availability/README.md +9 -8
- package/docs/sdks/coupon/README.md +89 -80
- package/docs/sdks/credit/README.md +282 -141
- package/docs/sdks/creditnote/README.md +34 -31
- package/docs/sdks/customer/README.md +303 -352
- package/docs/sdks/event/README.md +162 -162
- package/docs/sdks/invoice/README.md +145 -159
- package/docs/sdks/item/README.md +34 -31
- package/docs/sdks/metric/README.md +43 -47
- package/docs/sdks/plan/README.md +100 -102
- package/docs/sdks/price/README.md +60 -96
- package/docs/sdks/priceinterval/README.md +55 -98
- package/docs/sdks/subscription/README.md +278 -384
- package/package.json +1 -1
- package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.d.ts +0 -24
- package/dist/sdk/models/shared/adddecrementcreditledgerentryrequestparams.js +0 -76
- package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.d.ts +0 -37
- package/dist/sdk/models/shared/addexpirationchangecreditledgerentryrequestparams.js +0 -100
- package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.d.ts +0 -42
- package/dist/sdk/models/shared/addincrementcreditledgerentryrequestparams.js +0 -107
- package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.d.ts +0 -34
- package/dist/sdk/models/shared/addvoidcreditledgerentryrequestparams.js +0 -88
- package/dist/sdk/models/shared/affectedblock.d.ts +0 -6
- package/dist/sdk/models/shared/affectedblock.js +0 -59
- package/dist/sdk/models/shared/amendmentledgerentry.d.ts +0 -27
- package/dist/sdk/models/shared/amendmentledgerentry.js +0 -120
- package/dist/sdk/models/shared/amountdiscount.d.ts +0 -15
- package/dist/sdk/models/shared/amountdiscount.js +0 -59
- package/dist/sdk/models/shared/amountdiscountcreationparams.d.ts +0 -11
- package/dist/sdk/models/shared/amountdiscountcreationparams.js +0 -54
- package/dist/sdk/models/shared/amountdiscountinterval.d.ts +0 -27
- package/dist/sdk/models/shared/amountdiscountinterval.js +0 -82
- package/dist/sdk/models/shared/billablemetricsimple.d.ts +0 -5
- package/dist/sdk/models/shared/billablemetricsimple.js +0 -50
- package/dist/sdk/models/shared/billablemetrictiny.d.ts +0 -4
- package/dist/sdk/models/shared/billablemetrictiny.js +0 -45
- package/dist/sdk/models/shared/bpsconfig.d.ts +0 -11
- package/dist/sdk/models/shared/bpsconfig.js +0 -50
- package/dist/sdk/models/shared/bpsprice.d.ts +0 -242
- package/dist/sdk/models/shared/bpsprice.js +0 -363
- package/dist/sdk/models/shared/bpstier.d.ts +0 -19
- package/dist/sdk/models/shared/bpstier.js +0 -60
- package/dist/sdk/models/shared/bulkbpsconfig.d.ts +0 -8
- package/dist/sdk/models/shared/bulkbpsconfig.js +0 -47
- package/dist/sdk/models/shared/bulkbpsprice.d.ts +0 -242
- package/dist/sdk/models/shared/bulkbpsprice.js +0 -363
- package/dist/sdk/models/shared/bulkbpstier.d.ts +0 -15
- package/dist/sdk/models/shared/bulkbpstier.js +0 -55
- package/dist/sdk/models/shared/bulkconfig.d.ts +0 -8
- package/dist/sdk/models/shared/bulkconfig.js +0 -47
- package/dist/sdk/models/shared/bulkprice.d.ts +0 -242
- package/dist/sdk/models/shared/bulkprice.js +0 -363
- package/dist/sdk/models/shared/bulktier.d.ts +0 -11
- package/dist/sdk/models/shared/bulktier.js +0 -50
- package/dist/sdk/models/shared/creditblockexpiryledgerentry.d.ts +0 -27
- package/dist/sdk/models/shared/creditblockexpiryledgerentry.js +0 -120
- package/dist/sdk/models/shared/decrementledgerentry.d.ts +0 -30
- package/dist/sdk/models/shared/decrementledgerentry.js +0 -135
- package/dist/sdk/models/shared/duplicateconstraintviolationerror.d.ts +0 -16
- package/dist/sdk/models/shared/duplicateconstraintviolationerror.js +0 -82
- package/dist/sdk/models/shared/duplicateresourcecreationerror.d.ts +0 -16
- package/dist/sdk/models/shared/duplicateresourcecreationerror.js +0 -82
- package/dist/sdk/models/shared/expirationchangeledgerentry.d.ts +0 -28
- package/dist/sdk/models/shared/expirationchangeledgerentry.js +0 -129
- package/dist/sdk/models/shared/featurenotavailableerror.d.ts +0 -16
- package/dist/sdk/models/shared/featurenotavailableerror.js +0 -82
- package/dist/sdk/models/shared/fivetranexampleprice.d.ts +0 -241
- package/dist/sdk/models/shared/fivetranexampleprice.js +0 -361
- package/dist/sdk/models/shared/groupedsubscriptionusage.d.ts +0 -7
- package/dist/sdk/models/shared/groupedsubscriptionusage.js +0 -54
- package/dist/sdk/models/shared/groupedsubscriptionusagerecord.d.ts +0 -14
- package/dist/sdk/models/shared/groupedsubscriptionusagerecord.js +0 -71
- package/dist/sdk/models/shared/idempotencyconflict.d.ts +0 -16
- package/dist/sdk/models/shared/idempotencyconflict.js +0 -82
- package/dist/sdk/models/shared/idempotencykeyvalidationerror.d.ts +0 -17
- package/dist/sdk/models/shared/idempotencykeyvalidationerror.js +0 -87
- package/dist/sdk/models/shared/idempotencyrequestmismatch.d.ts +0 -16
- package/dist/sdk/models/shared/idempotencyrequestmismatch.js +0 -82
- package/dist/sdk/models/shared/incrementcreditledgerentryinvoicesettings.d.ts +0 -18
- package/dist/sdk/models/shared/incrementcreditledgerentryinvoicesettings.js +0 -58
- package/dist/sdk/models/shared/incrementledgerentry.d.ts +0 -27
- package/dist/sdk/models/shared/incrementledgerentry.js +0 -120
- package/dist/sdk/models/shared/itemslim.d.ts +0 -5
- package/dist/sdk/models/shared/itemslim.js +0 -50
- package/dist/sdk/models/shared/matrixconfig.d.ts +0 -20
- package/dist/sdk/models/shared/matrixconfig.js +0 -62
- package/dist/sdk/models/shared/matrixprice.d.ts +0 -242
- package/dist/sdk/models/shared/matrixprice.js +0 -363
- package/dist/sdk/models/shared/matrixsublineitem.d.ts +0 -17
- package/dist/sdk/models/shared/matrixsublineitem.js +0 -78
- package/dist/sdk/models/shared/matrixvalue.d.ts +0 -15
- package/dist/sdk/models/shared/matrixvalue.js +0 -55
- package/dist/sdk/models/shared/metricgroup.d.ts +0 -5
- package/dist/sdk/models/shared/metricgroup.js +0 -50
- package/dist/sdk/models/shared/newbpsprice.d.ts +0 -53
- package/dist/sdk/models/shared/newbpsprice.js +0 -110
- package/dist/sdk/models/shared/newbulkbpsprice.d.ts +0 -53
- package/dist/sdk/models/shared/newbulkbpsprice.js +0 -110
- package/dist/sdk/models/shared/newbulkprice.d.ts +0 -53
- package/dist/sdk/models/shared/newbulkprice.js +0 -110
- package/dist/sdk/models/shared/newmatrixprice.d.ts +0 -53
- package/dist/sdk/models/shared/newmatrixprice.js +0 -110
- package/dist/sdk/models/shared/newpackageprice.d.ts +0 -53
- package/dist/sdk/models/shared/newpackageprice.js +0 -110
- package/dist/sdk/models/shared/newpackagewithallocationprice.d.ts +0 -52
- package/dist/sdk/models/shared/newpackagewithallocationprice.js +0 -108
- package/dist/sdk/models/shared/newthresholdtotalamountprice.d.ts +0 -52
- package/dist/sdk/models/shared/newthresholdtotalamountprice.js +0 -108
- package/dist/sdk/models/shared/newtieredbpsprice.d.ts +0 -53
- package/dist/sdk/models/shared/newtieredbpsprice.js +0 -110
- package/dist/sdk/models/shared/newtieredpackageprice.d.ts +0 -52
- package/dist/sdk/models/shared/newtieredpackageprice.js +0 -108
- package/dist/sdk/models/shared/newtieredprice.d.ts +0 -53
- package/dist/sdk/models/shared/newtieredprice.js +0 -110
- package/dist/sdk/models/shared/newtieredwithminimumprice.d.ts +0 -52
- package/dist/sdk/models/shared/newtieredwithminimumprice.js +0 -108
- package/dist/sdk/models/shared/newunitprice.d.ts +0 -53
- package/dist/sdk/models/shared/newunitprice.js +0 -110
- package/dist/sdk/models/shared/othersublineitem.d.ts +0 -15
- package/dist/sdk/models/shared/othersublineitem.js +0 -71
- package/dist/sdk/models/shared/overridebpsprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridebpsprice.js +0 -83
- package/dist/sdk/models/shared/overridebulkbpsprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridebulkbpsprice.js +0 -83
- package/dist/sdk/models/shared/overridebulkprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridebulkprice.js +0 -83
- package/dist/sdk/models/shared/overridefivetranexampleprice.d.ts +0 -26
- package/dist/sdk/models/shared/overridefivetranexampleprice.js +0 -81
- package/dist/sdk/models/shared/overridematrixprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridematrixprice.js +0 -83
- package/dist/sdk/models/shared/overridepackageprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridepackageprice.js +0 -83
- package/dist/sdk/models/shared/overridepackagewithallocationprice.d.ts +0 -26
- package/dist/sdk/models/shared/overridepackagewithallocationprice.js +0 -81
- package/dist/sdk/models/shared/overridetestratingfunctionprice.d.ts +0 -26
- package/dist/sdk/models/shared/overridetestratingfunctionprice.js +0 -81
- package/dist/sdk/models/shared/overridethresholdtotalamountprice.d.ts +0 -26
- package/dist/sdk/models/shared/overridethresholdtotalamountprice.js +0 -81
- package/dist/sdk/models/shared/overridetieredbpsprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridetieredbpsprice.js +0 -83
- package/dist/sdk/models/shared/overridetieredpackageprice.d.ts +0 -26
- package/dist/sdk/models/shared/overridetieredpackageprice.js +0 -81
- package/dist/sdk/models/shared/overridetieredprice.d.ts +0 -27
- package/dist/sdk/models/shared/overridetieredprice.js +0 -83
- package/dist/sdk/models/shared/overridetieredwithminimumprice.d.ts +0 -26
- package/dist/sdk/models/shared/overridetieredwithminimumprice.js +0 -81
- package/dist/sdk/models/shared/overrideunitprice.d.ts +0 -27
- package/dist/sdk/models/shared/overrideunitprice.js +0 -83
- package/dist/sdk/models/shared/packageconfig.d.ts +0 -11
- package/dist/sdk/models/shared/packageconfig.js +0 -50
- package/dist/sdk/models/shared/packageprice.d.ts +0 -242
- package/dist/sdk/models/shared/packageprice.js +0 -363
- package/dist/sdk/models/shared/packagewithallocationprice.d.ts +0 -241
- package/dist/sdk/models/shared/packagewithallocationprice.js +0 -361
- package/dist/sdk/models/shared/percentagediscount.d.ts +0 -15
- package/dist/sdk/models/shared/percentagediscount.js +0 -59
- package/dist/sdk/models/shared/percentagediscountcreationparams.d.ts +0 -11
- package/dist/sdk/models/shared/percentagediscountcreationparams.js +0 -54
- package/dist/sdk/models/shared/percentagediscountinterval.d.ts +0 -27
- package/dist/sdk/models/shared/percentagediscountinterval.js +0 -82
- package/dist/sdk/models/shared/requesttoolargeerror.d.ts +0 -16
- package/dist/sdk/models/shared/requesttoolargeerror.js +0 -82
- package/dist/sdk/models/shared/requestvalidationerror.d.ts +0 -17
- package/dist/sdk/models/shared/requestvalidationerror.js +0 -87
- package/dist/sdk/models/shared/resourcenotfounderror.d.ts +0 -16
- package/dist/sdk/models/shared/resourcenotfounderror.js +0 -82
- package/dist/sdk/models/shared/resourcetoolargeerror.d.ts +0 -16
- package/dist/sdk/models/shared/resourcetoolargeerror.js +0 -82
- package/dist/sdk/models/shared/sublineitemgrouping.d.ts +0 -8
- package/dist/sdk/models/shared/sublineitemgrouping.js +0 -50
- package/dist/sdk/models/shared/sublineitemmatrixconfig.d.ts +0 -7
- package/dist/sdk/models/shared/sublineitemmatrixconfig.js +0 -45
- package/dist/sdk/models/shared/testratingfunctionprice.d.ts +0 -241
- package/dist/sdk/models/shared/testratingfunctionprice.js +0 -361
- package/dist/sdk/models/shared/thresholdtotalamountprice.d.ts +0 -241
- package/dist/sdk/models/shared/thresholdtotalamountprice.js +0 -361
- package/dist/sdk/models/shared/tier.d.ts +0 -15
- package/dist/sdk/models/shared/tier.js +0 -55
- package/dist/sdk/models/shared/tierconfig.d.ts +0 -6
- package/dist/sdk/models/shared/tierconfig.js +0 -55
- package/dist/sdk/models/shared/tieredbpsconfig.d.ts +0 -8
- package/dist/sdk/models/shared/tieredbpsconfig.js +0 -47
- package/dist/sdk/models/shared/tieredbpsprice.d.ts +0 -242
- package/dist/sdk/models/shared/tieredbpsprice.js +0 -363
- package/dist/sdk/models/shared/tieredconfig.d.ts +0 -8
- package/dist/sdk/models/shared/tieredconfig.js +0 -47
- package/dist/sdk/models/shared/tieredpackageprice.d.ts +0 -241
- package/dist/sdk/models/shared/tieredpackageprice.js +0 -361
- package/dist/sdk/models/shared/tieredprice.d.ts +0 -242
- package/dist/sdk/models/shared/tieredprice.js +0 -363
- package/dist/sdk/models/shared/tieredwithminimumprice.d.ts +0 -241
- package/dist/sdk/models/shared/tieredwithminimumprice.js +0 -361
- package/dist/sdk/models/shared/tiersublineitem.d.ts +0 -17
- package/dist/sdk/models/shared/tiersublineitem.js +0 -78
- package/dist/sdk/models/shared/trialdiscount.d.ts +0 -19
- package/dist/sdk/models/shared/trialdiscount.js +0 -64
- package/dist/sdk/models/shared/ungroupedsubscriptionusage.d.ts +0 -5
- package/dist/sdk/models/shared/ungroupedsubscriptionusage.js +0 -47
- package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.d.ts +0 -12
- package/dist/sdk/models/shared/ungroupedsubscriptionusagerecord.js +0 -64
- package/dist/sdk/models/shared/unitconfig.d.ts +0 -11
- package/dist/sdk/models/shared/unitconfig.js +0 -50
- package/dist/sdk/models/shared/unitprice.d.ts +0 -242
- package/dist/sdk/models/shared/unitprice.js +0 -363
- package/dist/sdk/models/shared/urlnotfound.d.ts +0 -16
- package/dist/sdk/models/shared/urlnotfound.js +0 -82
- package/dist/sdk/models/shared/usage.d.ts +0 -6
- package/dist/sdk/models/shared/usage.js +0 -63
- package/dist/sdk/models/shared/usagediscount.d.ts +0 -15
- package/dist/sdk/models/shared/usagediscount.js +0 -59
- package/dist/sdk/models/shared/usagediscountcreationparams.d.ts +0 -11
- package/dist/sdk/models/shared/usagediscountcreationparams.js +0 -54
- package/dist/sdk/models/shared/usagediscountinterval.d.ts +0 -27
- package/dist/sdk/models/shared/usagediscountinterval.js +0 -82
- package/dist/sdk/models/shared/voidinitiatedledgerentry.d.ts +0 -30
- package/dist/sdk/models/shared/voidinitiatedledgerentry.js +0 -139
- package/dist/sdk/models/shared/voidledgerentry.d.ts +0 -29
- package/dist/sdk/models/shared/voidledgerentry.js +0 -130
- package/docs/models/shared/adddecrementcreditledgerentryrequestparams.md +0 -11
- package/docs/models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md +0 -8
- package/docs/models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md +0 -9
- package/docs/models/shared/addexpirationchangecreditledgerentryrequestparams.md +0 -14
- package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md +0 -8
- package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md +0 -9
- package/docs/models/shared/addincrementcreditledgerentryrequestparams.md +0 -15
- package/docs/models/shared/addincrementcreditledgerentryrequestparamsentrytype.md +0 -8
- package/docs/models/shared/addincrementcreditledgerentryrequestparamsmetadata.md +0 -9
- package/docs/models/shared/addpriceintervalparamsenddateenddate.md +0 -11
- package/docs/models/shared/addpriceintervalparamsstartdatestartdate.md +0 -11
- package/docs/models/shared/addvoidcreditledgerentryrequestparams.md +0 -12
- package/docs/models/shared/addvoidcreditledgerentryrequestparamsentrytype.md +0 -8
- package/docs/models/shared/addvoidcreditledgerentryrequestparamsmetadata.md +0 -9
- package/docs/models/shared/addvoidcreditledgerentryrequestparamsvoidreason.md +0 -10
- package/docs/models/shared/affectedblock.md +0 -10
- package/docs/models/shared/amendmentledgerentry.md +0 -21
- package/docs/models/shared/amendmentledgerentryentrystatus.md +0 -9
- package/docs/models/shared/amendmentledgerentryentrytype.md +0 -8
- package/docs/models/shared/amountdiscount.md +0 -10
- package/docs/models/shared/amountdiscountcreationparams.md +0 -9
- package/docs/models/shared/amountdiscountcreationparamsdiscounttype.md +0 -8
- package/docs/models/shared/amountdiscountdiscounttype.md +0 -8
- package/docs/models/shared/amountdiscountinterval.md +0 -13
- package/docs/models/shared/amountdiscountintervaldiscounttype.md +0 -8
- package/docs/models/shared/billablemetricsimple.md +0 -9
- package/docs/models/shared/billablemetrictiny.md +0 -8
- package/docs/models/shared/bpsconfig.md +0 -9
- package/docs/models/shared/bpsprice.md +0 -225
- package/docs/models/shared/bpspricecadence.md +0 -11
- package/docs/models/shared/bpspricemodeltype.md +0 -8
- package/docs/models/shared/bpspricepricetype.md +0 -9
- package/docs/models/shared/bpstier.md +0 -11
- package/docs/models/shared/bulkbpsconfig.md +0 -8
- package/docs/models/shared/bulkbpsprice.md +0 -225
- package/docs/models/shared/bulkbpspricecadence.md +0 -11
- package/docs/models/shared/bulkbpspricemodeltype.md +0 -8
- package/docs/models/shared/bulkbpspricepricetype.md +0 -9
- package/docs/models/shared/bulkbpstier.md +0 -10
- package/docs/models/shared/bulkconfig.md +0 -8
- package/docs/models/shared/bulkprice.md +0 -225
- package/docs/models/shared/bulkpricecadence.md +0 -11
- package/docs/models/shared/bulkpricemodeltype.md +0 -8
- package/docs/models/shared/bulkpricepricetype.md +0 -9
- package/docs/models/shared/bulktier.md +0 -9
- package/docs/models/shared/creditblockexpiryledgerentry.md +0 -21
- package/docs/models/shared/creditblockexpiryledgerentryentrystatus.md +0 -9
- package/docs/models/shared/creditblockexpiryledgerentryentrytype.md +0 -8
- package/docs/models/shared/decrementledgerentry.md +0 -24
- package/docs/models/shared/decrementledgerentryentrystatus.md +0 -9
- package/docs/models/shared/decrementledgerentryentrytype.md +0 -8
- package/docs/models/shared/duplicateconstraintviolationerror.md +0 -12
- package/docs/models/shared/duplicateconstraintviolationerrorheaders.md +0 -7
- package/docs/models/shared/duplicateconstraintviolationerrorstatus.md +0 -8
- package/docs/models/shared/duplicateconstraintviolationerrortype.md +0 -8
- package/docs/models/shared/duplicateresourcecreationerror.md +0 -12
- package/docs/models/shared/duplicateresourcecreationerrorheaders.md +0 -7
- package/docs/models/shared/duplicateresourcecreationerrorstatus.md +0 -8
- package/docs/models/shared/duplicateresourcecreationerrortype.md +0 -8
- package/docs/models/shared/editpriceintervalparamsenddateenddate.md +0 -11
- package/docs/models/shared/editpriceintervalparamsstartdatestartdate.md +0 -11
- package/docs/models/shared/expirationchangeledgerentry.md +0 -22
- package/docs/models/shared/expirationchangeledgerentryentrystatus.md +0 -9
- package/docs/models/shared/expirationchangeledgerentryentrytype.md +0 -8
- package/docs/models/shared/featurenotavailableerror.md +0 -12
- package/docs/models/shared/featurenotavailableerrorheaders.md +0 -7
- package/docs/models/shared/featurenotavailableerrorstatus.md +0 -8
- package/docs/models/shared/featurenotavailableerrortype.md +0 -8
- package/docs/models/shared/fivetranexampleprice.md +0 -225
- package/docs/models/shared/fivetranexamplepricecadence.md +0 -11
- package/docs/models/shared/fivetranexamplepricemodeltype.md +0 -8
- package/docs/models/shared/fivetranexamplepricepricetype.md +0 -9
- package/docs/models/shared/groupedsubscriptionusage.md +0 -9
- package/docs/models/shared/groupedsubscriptionusagerecord.md +0 -11
- package/docs/models/shared/groupedsubscriptionusagerecordviewmode.md +0 -9
- package/docs/models/shared/idempotencyconflict.md +0 -12
- package/docs/models/shared/idempotencyconflictheaders.md +0 -7
- package/docs/models/shared/idempotencyconflictstatus.md +0 -8
- package/docs/models/shared/idempotencyconflicttype.md +0 -8
- package/docs/models/shared/idempotencykeyvalidationerror.md +0 -13
- package/docs/models/shared/idempotencykeyvalidationerrorheaders.md +0 -7
- package/docs/models/shared/idempotencykeyvalidationerrorstatus.md +0 -8
- package/docs/models/shared/idempotencykeyvalidationerrortype.md +0 -8
- package/docs/models/shared/idempotencyrequestmismatch.md +0 -12
- package/docs/models/shared/idempotencyrequestmismatchheaders.md +0 -7
- package/docs/models/shared/idempotencyrequestmismatchstatus.md +0 -8
- package/docs/models/shared/idempotencyrequestmismatchtype.md +0 -8
- package/docs/models/shared/incrementcreditledgerentryinvoicesettings.md +0 -12
- package/docs/models/shared/incrementledgerentry.md +0 -21
- package/docs/models/shared/incrementledgerentryentrystatus.md +0 -9
- package/docs/models/shared/incrementledgerentryentrytype.md +0 -8
- package/docs/models/shared/itemexternalconnectionexternalconnectionnameexternalconnectionname.md +0 -11
- package/docs/models/shared/itemexternalconnectionexternalconnectionnameexternalconnectionname1.md +0 -10
- package/docs/models/shared/itemslim.md +0 -9
- package/docs/models/shared/matrixconfig.md +0 -11
- package/docs/models/shared/matrixprice.md +0 -225
- package/docs/models/shared/matrixpricecadence.md +0 -11
- package/docs/models/shared/matrixpricemodeltype.md +0 -8
- package/docs/models/shared/matrixpricepricetype.md +0 -9
- package/docs/models/shared/matrixsublineitem.md +0 -13
- package/docs/models/shared/matrixsublineitemtype.md +0 -8
- package/docs/models/shared/matrixvalue.md +0 -10
- package/docs/models/shared/metricgroup.md +0 -9
- package/docs/models/shared/newbpsprice.md +0 -18
- package/docs/models/shared/newbpspricecadence.md +0 -12
- package/docs/models/shared/newbpspricemodeltype.md +0 -8
- package/docs/models/shared/newbulkbpsprice.md +0 -18
- package/docs/models/shared/newbulkbpspricecadence.md +0 -12
- package/docs/models/shared/newbulkbpspricemodeltype.md +0 -8
- package/docs/models/shared/newbulkprice.md +0 -18
- package/docs/models/shared/newbulkpricecadence.md +0 -12
- package/docs/models/shared/newbulkpricemodeltype.md +0 -8
- package/docs/models/shared/newmatrixprice.md +0 -18
- package/docs/models/shared/newmatrixpricecadence.md +0 -12
- package/docs/models/shared/newmatrixpricemodeltype.md +0 -8
- package/docs/models/shared/newpackageprice.md +0 -18
- package/docs/models/shared/newpackagepricecadence.md +0 -12
- package/docs/models/shared/newpackagepricemodeltype.md +0 -8
- package/docs/models/shared/newpackagewithallocationprice.md +0 -18
- package/docs/models/shared/newpackagewithallocationpricecadence.md +0 -12
- package/docs/models/shared/newpackagewithallocationpricemodeltype.md +0 -8
- package/docs/models/shared/newthresholdtotalamountprice.md +0 -18
- package/docs/models/shared/newthresholdtotalamountpricecadence.md +0 -12
- package/docs/models/shared/newthresholdtotalamountpricemodeltype.md +0 -8
- package/docs/models/shared/newtieredbpsprice.md +0 -18
- package/docs/models/shared/newtieredbpspricecadence.md +0 -12
- package/docs/models/shared/newtieredbpspricemodeltype.md +0 -8
- package/docs/models/shared/newtieredpackageprice.md +0 -18
- package/docs/models/shared/newtieredpackagepricecadence.md +0 -12
- package/docs/models/shared/newtieredpackagepricemodeltype.md +0 -8
- package/docs/models/shared/newtieredprice.md +0 -18
- package/docs/models/shared/newtieredpricecadence.md +0 -12
- package/docs/models/shared/newtieredpricemodeltype.md +0 -8
- package/docs/models/shared/newtieredwithminimumprice.md +0 -18
- package/docs/models/shared/newtieredwithminimumpricecadence.md +0 -12
- package/docs/models/shared/newtieredwithminimumpricemodeltype.md +0 -8
- package/docs/models/shared/newunitprice.md +0 -18
- package/docs/models/shared/newunitpricecadence.md +0 -12
- package/docs/models/shared/newunitpricemodeltype.md +0 -8
- package/docs/models/shared/othersublineitem.md +0 -12
- package/docs/models/shared/othersublineitemtype.md +0 -8
- package/docs/models/shared/overridebpsprice.md +0 -14
- package/docs/models/shared/overridebpspricemodeltype.md +0 -8
- package/docs/models/shared/overridebulkbpsprice.md +0 -14
- package/docs/models/shared/overridebulkbpspricemodeltype.md +0 -8
- package/docs/models/shared/overridebulkprice.md +0 -14
- package/docs/models/shared/overridebulkpricemodeltype.md +0 -8
- package/docs/models/shared/overridefivetranexampleprice.md +0 -14
- package/docs/models/shared/overridefivetranexamplepricemodeltype.md +0 -8
- package/docs/models/shared/overridematrixprice.md +0 -14
- package/docs/models/shared/overridematrixpricemodeltype.md +0 -8
- package/docs/models/shared/overridepackageprice.md +0 -14
- package/docs/models/shared/overridepackagepricemodeltype.md +0 -8
- package/docs/models/shared/overridepackagewithallocationprice.md +0 -14
- package/docs/models/shared/overridepackagewithallocationpricemodeltype.md +0 -8
- package/docs/models/shared/overridetestratingfunctionprice.md +0 -14
- package/docs/models/shared/overridetestratingfunctionpricemodeltype.md +0 -8
- package/docs/models/shared/overridethresholdtotalamountprice.md +0 -14
- package/docs/models/shared/overridethresholdtotalamountpricemodeltype.md +0 -8
- package/docs/models/shared/overridetieredbpsprice.md +0 -14
- package/docs/models/shared/overridetieredbpspricemodeltype.md +0 -8
- package/docs/models/shared/overridetieredpackageprice.md +0 -14
- package/docs/models/shared/overridetieredpackagepricemodeltype.md +0 -8
- package/docs/models/shared/overridetieredprice.md +0 -14
- package/docs/models/shared/overridetieredpricemodeltype.md +0 -8
- package/docs/models/shared/overridetieredwithminimumprice.md +0 -14
- package/docs/models/shared/overridetieredwithminimumpricemodeltype.md +0 -8
- package/docs/models/shared/overrideunitprice.md +0 -14
- package/docs/models/shared/overrideunitpricemodeltype.md +0 -8
- package/docs/models/shared/packageconfig.md +0 -9
- package/docs/models/shared/packageprice.md +0 -225
- package/docs/models/shared/packagepricecadence.md +0 -11
- package/docs/models/shared/packagepricemodeltype.md +0 -8
- package/docs/models/shared/packagepricepricetype.md +0 -9
- package/docs/models/shared/packagewithallocationprice.md +0 -225
- package/docs/models/shared/packagewithallocationpricecadence.md +0 -11
- package/docs/models/shared/packagewithallocationpricemodeltype.md +0 -8
- package/docs/models/shared/packagewithallocationpricepricetype.md +0 -9
- package/docs/models/shared/percentagediscount.md +0 -10
- package/docs/models/shared/percentagediscountcreationparams.md +0 -9
- package/docs/models/shared/percentagediscountcreationparamsdiscounttype.md +0 -8
- package/docs/models/shared/percentagediscountdiscounttype.md +0 -8
- package/docs/models/shared/percentagediscountinterval.md +0 -13
- package/docs/models/shared/percentagediscountintervaldiscounttype.md +0 -8
- package/docs/models/shared/planprices.md +0 -7
- package/docs/models/shared/requesttoolargeerror.md +0 -12
- package/docs/models/shared/requesttoolargeerrorheaders.md +0 -7
- package/docs/models/shared/requesttoolargeerrorstatus.md +0 -8
- package/docs/models/shared/requesttoolargeerrortype.md +0 -8
- package/docs/models/shared/requestvalidationerror.md +0 -13
- package/docs/models/shared/requestvalidationerrorheaders.md +0 -7
- package/docs/models/shared/requestvalidationerrorstatus.md +0 -8
- package/docs/models/shared/requestvalidationerrortype.md +0 -8
- package/docs/models/shared/resourcenotfounderror.md +0 -12
- package/docs/models/shared/resourcenotfounderrorheaders.md +0 -7
- package/docs/models/shared/resourcenotfounderrorstatus.md +0 -8
- package/docs/models/shared/resourcenotfounderrortype.md +0 -8
- package/docs/models/shared/resourcetoolargeerror.md +0 -12
- package/docs/models/shared/resourcetoolargeerrorheaders.md +0 -7
- package/docs/models/shared/resourcetoolargeerrorstatus.md +0 -8
- package/docs/models/shared/resourcetoolargeerrortype.md +0 -8
- package/docs/models/shared/sublineitemgrouping.md +0 -9
- package/docs/models/shared/sublineitemmatrixconfig.md +0 -8
- package/docs/models/shared/testratingfunctionprice.md +0 -225
- package/docs/models/shared/testratingfunctionpricecadence.md +0 -11
- package/docs/models/shared/testratingfunctionpricemodeltype.md +0 -8
- package/docs/models/shared/testratingfunctionpricepricetype.md +0 -9
- package/docs/models/shared/thresholdtotalamountprice.md +0 -225
- package/docs/models/shared/thresholdtotalamountpricecadence.md +0 -11
- package/docs/models/shared/thresholdtotalamountpricemodeltype.md +0 -8
- package/docs/models/shared/thresholdtotalamountpricepricetype.md +0 -9
- package/docs/models/shared/tier.md +0 -10
- package/docs/models/shared/tierconfig.md +0 -10
- package/docs/models/shared/tieredbpsconfig.md +0 -8
- package/docs/models/shared/tieredbpsprice.md +0 -225
- package/docs/models/shared/tieredbpspricecadence.md +0 -11
- package/docs/models/shared/tieredbpspricemodeltype.md +0 -8
- package/docs/models/shared/tieredbpspricepricetype.md +0 -9
- package/docs/models/shared/tieredconfig.md +0 -8
- package/docs/models/shared/tieredpackageprice.md +0 -225
- package/docs/models/shared/tieredpackagepricecadence.md +0 -11
- package/docs/models/shared/tieredpackagepricemodeltype.md +0 -8
- package/docs/models/shared/tieredpackagepricepricetype.md +0 -9
- package/docs/models/shared/tieredprice.md +0 -225
- package/docs/models/shared/tieredpricecadence.md +0 -11
- package/docs/models/shared/tieredpricemodeltype.md +0 -8
- package/docs/models/shared/tieredpricepricetype.md +0 -9
- package/docs/models/shared/tieredwithminimumprice.md +0 -225
- package/docs/models/shared/tieredwithminimumpricecadence.md +0 -11
- package/docs/models/shared/tieredwithminimumpricemodeltype.md +0 -8
- package/docs/models/shared/tieredwithminimumpricepricetype.md +0 -9
- package/docs/models/shared/tiersublineitem.md +0 -13
- package/docs/models/shared/tiersublineitemtype.md +0 -8
- package/docs/models/shared/trialdiscount.md +0 -11
- package/docs/models/shared/trialdiscountdiscounttype.md +0 -8
- package/docs/models/shared/ungroupedsubscriptionusage.md +0 -8
- package/docs/models/shared/ungroupedsubscriptionusagerecord.md +0 -10
- package/docs/models/shared/ungroupedsubscriptionusagerecordviewmode.md +0 -9
- package/docs/models/shared/unitconfig.md +0 -9
- package/docs/models/shared/unitprice.md +0 -225
- package/docs/models/shared/unitpricecadence.md +0 -11
- package/docs/models/shared/unitpricemodeltype.md +0 -8
- package/docs/models/shared/unitpricepricetype.md +0 -9
- package/docs/models/shared/urlnotfound.md +0 -12
- package/docs/models/shared/urlnotfoundheaders.md +0 -7
- package/docs/models/shared/urlnotfoundstatus.md +0 -8
- package/docs/models/shared/urlnotfoundtype.md +0 -8
- package/docs/models/shared/usage.md +0 -10
- package/docs/models/shared/usagediscount.md +0 -10
- package/docs/models/shared/usagediscountcreationparams.md +0 -9
- package/docs/models/shared/usagediscountcreationparamsdiscounttype.md +0 -8
- package/docs/models/shared/usagediscountdiscounttype.md +0 -8
- package/docs/models/shared/usagediscountinterval.md +0 -13
- package/docs/models/shared/usagediscountintervaldiscounttype.md +0 -8
- package/docs/models/shared/voidinitiatedledgerentry.md +0 -24
- package/docs/models/shared/voidinitiatedledgerentryentrystatus.md +0 -9
- package/docs/models/shared/voidinitiatedledgerentryentrytype.md +0 -8
- package/docs/models/shared/voidledgerentry.md +0 -23
- package/docs/models/shared/voidledgerentryentrystatus.md +0 -9
- package/docs/models/shared/voidledgerentryentrytype.md +0 -8
package/dist/sdk/credit.js
CHANGED
|
@@ -103,18 +103,110 @@ var Credit = /** @class */ (function () {
|
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
105
|
* Create ledger entry by external ID
|
|
106
|
+
*
|
|
107
|
+
* @remarks
|
|
108
|
+
* This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
|
|
109
|
+
* increment balance, deduct credits, and change the expiry date of existing credits.
|
|
110
|
+
*
|
|
111
|
+
* ## Effects of adding a ledger entry
|
|
112
|
+
* 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
|
|
113
|
+
* represents the changes (i.e. balance changes or transfers).
|
|
114
|
+
* 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
|
|
115
|
+
* [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
|
|
116
|
+
* the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
|
|
117
|
+
* credit blocks.
|
|
118
|
+
* 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
|
|
119
|
+
* `amount` and `per_unit_cost_basis`).
|
|
120
|
+
*
|
|
121
|
+
* ## Adding credits
|
|
122
|
+
* Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
|
|
123
|
+
* credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
|
|
124
|
+
* to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
|
|
125
|
+
* how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
|
|
126
|
+
*
|
|
127
|
+
* The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
|
|
128
|
+
*
|
|
129
|
+
* ```json
|
|
130
|
+
* {
|
|
131
|
+
* "entry_type": "increment",
|
|
132
|
+
* "amount": 100,
|
|
133
|
+
* "expiry_date": "2022-12-28",
|
|
134
|
+
* "per_unit_cost_basis": "0.20",
|
|
135
|
+
* "description": "Purchased 100 credits"
|
|
136
|
+
* }
|
|
137
|
+
* ```
|
|
138
|
+
*
|
|
139
|
+
* Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
|
|
140
|
+
* remaining amount to the desired credit block.
|
|
141
|
+
*
|
|
142
|
+
* ### Invoicing for credits
|
|
143
|
+
* By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
|
|
144
|
+
* `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
|
|
145
|
+
* credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
|
|
146
|
+
* invoice are calculated by multiplying the cost basis with the number of credit units added.
|
|
147
|
+
*
|
|
148
|
+
* ## Deducting Credits
|
|
149
|
+
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
|
|
150
|
+
* algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
|
|
151
|
+
* deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
|
|
152
|
+
* optionally allows specifying a description to assist with auditing.
|
|
153
|
+
*
|
|
154
|
+
* The following snippet illustrates a sample request body to decrement credits.
|
|
155
|
+
*
|
|
156
|
+
* ```json
|
|
157
|
+
* {
|
|
158
|
+
* "entry_type": "decrement",
|
|
159
|
+
* "amount": 20,
|
|
160
|
+
* "description": "Removing excess credits"
|
|
161
|
+
* }
|
|
162
|
+
* ```
|
|
163
|
+
*
|
|
164
|
+
* ## Changing credits expiry
|
|
165
|
+
* If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
|
|
166
|
+
* For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
|
|
167
|
+
* `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
|
|
168
|
+
* with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
|
|
169
|
+
*
|
|
170
|
+
* Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
|
|
171
|
+
* amount determined by the `amount` parameter.
|
|
172
|
+
*
|
|
173
|
+
* The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
|
|
174
|
+
*
|
|
175
|
+
* ```json
|
|
176
|
+
* {
|
|
177
|
+
* "entry_type": "expiration_change",
|
|
178
|
+
* "amount": 10,
|
|
179
|
+
* "expiry_date": "2022-12-28",
|
|
180
|
+
* "block_id": "UiUhFWeLHPrBY4Ad",
|
|
181
|
+
* "target_expiry_date": "2023-12-28",
|
|
182
|
+
* "description": "Extending credit validity"
|
|
183
|
+
* }
|
|
184
|
+
* ```
|
|
185
|
+
*
|
|
186
|
+
* ## Voiding credits
|
|
187
|
+
*
|
|
188
|
+
* If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
|
|
189
|
+
* to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
|
|
190
|
+
* in a `void_reason` of `refund` if the void is due to a refund.
|
|
191
|
+
*
|
|
192
|
+
* ## Amendment
|
|
193
|
+
*
|
|
194
|
+
* If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
|
|
195
|
+
* is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
|
|
196
|
+
* to the customer, up to the block's initial balance.
|
|
106
197
|
*/
|
|
107
|
-
Credit.prototype.addByExternalId = function (
|
|
198
|
+
Credit.prototype.addByExternalId = function (externalCustomerId, requestBody, config) {
|
|
108
199
|
var _a, _b;
|
|
109
200
|
return __awaiter(this, void 0, void 0, function () {
|
|
110
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
201
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
111
202
|
var _d;
|
|
112
203
|
return __generator(this, function (_e) {
|
|
113
204
|
switch (_e.label) {
|
|
114
205
|
case 0:
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
206
|
+
req = new operations.CreateLedgerEntryExternalIdRequest({
|
|
207
|
+
externalCustomerId: externalCustomerId,
|
|
208
|
+
requestBody: requestBody,
|
|
209
|
+
});
|
|
118
210
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
119
211
|
url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits/ledger_entry", req);
|
|
120
212
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|
|
@@ -227,18 +319,110 @@ var Credit = /** @class */ (function () {
|
|
|
227
319
|
};
|
|
228
320
|
/**
|
|
229
321
|
* Create ledger entry
|
|
322
|
+
*
|
|
323
|
+
* @remarks
|
|
324
|
+
* This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
|
|
325
|
+
* increment balance, deduct credits, and change the expiry date of existing credits.
|
|
326
|
+
*
|
|
327
|
+
* ## Effects of adding a ledger entry
|
|
328
|
+
* 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
|
|
329
|
+
* represents the changes (i.e. balance changes or transfers).
|
|
330
|
+
* 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
|
|
331
|
+
* [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
|
|
332
|
+
* the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
|
|
333
|
+
* credit blocks.
|
|
334
|
+
* 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
|
|
335
|
+
* `amount` and `per_unit_cost_basis`).
|
|
336
|
+
*
|
|
337
|
+
* ## Adding credits
|
|
338
|
+
* Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
|
|
339
|
+
* credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
|
|
340
|
+
* to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
|
|
341
|
+
* how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
|
|
342
|
+
*
|
|
343
|
+
* The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
|
|
344
|
+
*
|
|
345
|
+
* ```json
|
|
346
|
+
* {
|
|
347
|
+
* "entry_type": "increment",
|
|
348
|
+
* "amount": 100,
|
|
349
|
+
* "expiry_date": "2022-12-28",
|
|
350
|
+
* "per_unit_cost_basis": "0.20",
|
|
351
|
+
* "description": "Purchased 100 credits"
|
|
352
|
+
* }
|
|
353
|
+
* ```
|
|
354
|
+
*
|
|
355
|
+
* Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
|
|
356
|
+
* remaining amount to the desired credit block.
|
|
357
|
+
*
|
|
358
|
+
* ### Invoicing for credits
|
|
359
|
+
* By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
|
|
360
|
+
* `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
|
|
361
|
+
* credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
|
|
362
|
+
* invoice are calculated by multiplying the cost basis with the number of credit units added.
|
|
363
|
+
*
|
|
364
|
+
* ## Deducting Credits
|
|
365
|
+
* Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
|
|
366
|
+
* algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
|
|
367
|
+
* deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
|
|
368
|
+
* optionally allows specifying a description to assist with auditing.
|
|
369
|
+
*
|
|
370
|
+
* The following snippet illustrates a sample request body to decrement credits.
|
|
371
|
+
*
|
|
372
|
+
* ```json
|
|
373
|
+
* {
|
|
374
|
+
* "entry_type": "decrement",
|
|
375
|
+
* "amount": 20,
|
|
376
|
+
* "description": "Removing excess credits"
|
|
377
|
+
* }
|
|
378
|
+
* ```
|
|
379
|
+
*
|
|
380
|
+
* ## Changing credits expiry
|
|
381
|
+
* If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
|
|
382
|
+
* For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
|
|
383
|
+
* `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
|
|
384
|
+
* with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
|
|
385
|
+
*
|
|
386
|
+
* Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
|
|
387
|
+
* amount determined by the `amount` parameter.
|
|
388
|
+
*
|
|
389
|
+
* The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
|
|
390
|
+
*
|
|
391
|
+
* ```json
|
|
392
|
+
* {
|
|
393
|
+
* "entry_type": "expiration_change",
|
|
394
|
+
* "amount": 10,
|
|
395
|
+
* "expiry_date": "2022-12-28",
|
|
396
|
+
* "block_id": "UiUhFWeLHPrBY4Ad",
|
|
397
|
+
* "target_expiry_date": "2023-12-28",
|
|
398
|
+
* "description": "Extending credit validity"
|
|
399
|
+
* }
|
|
400
|
+
* ```
|
|
401
|
+
*
|
|
402
|
+
* ## Voiding credits
|
|
403
|
+
*
|
|
404
|
+
* If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
|
|
405
|
+
* to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
|
|
406
|
+
* in a `void_reason` of `refund` if the void is due to a refund.
|
|
407
|
+
*
|
|
408
|
+
* ## Amendment
|
|
409
|
+
*
|
|
410
|
+
* If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
|
|
411
|
+
* is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
|
|
412
|
+
* to the customer, up to the block's initial balance.
|
|
230
413
|
*/
|
|
231
|
-
Credit.prototype.create = function (
|
|
414
|
+
Credit.prototype.create = function (customerId, requestBody, config) {
|
|
232
415
|
var _a, _b;
|
|
233
416
|
return __awaiter(this, void 0, void 0, function () {
|
|
234
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
417
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
235
418
|
var _d;
|
|
236
419
|
return __generator(this, function (_e) {
|
|
237
420
|
switch (_e.label) {
|
|
238
421
|
case 0:
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
422
|
+
req = new operations.CreateLedgerEntryRequest({
|
|
423
|
+
customerId: customerId,
|
|
424
|
+
requestBody: requestBody,
|
|
425
|
+
});
|
|
242
426
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
243
427
|
url = utils.generateURL(baseURL, "/customers/{customer_id}/credits/ledger_entry", req);
|
|
244
428
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|
|
@@ -355,16 +539,18 @@ var Credit = /** @class */ (function () {
|
|
|
355
539
|
* @remarks
|
|
356
540
|
* Returns a paginated list of unexpired, non-zero credit blocks for a customer.
|
|
357
541
|
*/
|
|
358
|
-
Credit.prototype.fetchBalance = function (
|
|
542
|
+
Credit.prototype.fetchBalance = function (customerId, cursor, limit, config) {
|
|
359
543
|
var _a, _b;
|
|
360
544
|
return __awaiter(this, void 0, void 0, function () {
|
|
361
|
-
var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
545
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
362
546
|
return __generator(this, function (_c) {
|
|
363
547
|
switch (_c.label) {
|
|
364
548
|
case 0:
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
549
|
+
req = new operations.FetchCustomerCreditsRequest({
|
|
550
|
+
customerId: customerId,
|
|
551
|
+
cursor: cursor,
|
|
552
|
+
limit: limit,
|
|
553
|
+
});
|
|
368
554
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
369
555
|
url = utils.generateURL(baseURL, "/customers/{customer_id}/credits", req);
|
|
370
556
|
client = this.sdkConfiguration.defaultClient;
|
|
@@ -473,16 +659,18 @@ var Credit = /** @class */ (function () {
|
|
|
473
659
|
* @remarks
|
|
474
660
|
* Returns a paginated list of unexpired, non-zero credit blocks for a customer.
|
|
475
661
|
*/
|
|
476
|
-
Credit.prototype.fetchBalanceByExternalId = function (
|
|
662
|
+
Credit.prototype.fetchBalanceByExternalId = function (externalCustomerId, cursor, limit, config) {
|
|
477
663
|
var _a, _b;
|
|
478
664
|
return __awaiter(this, void 0, void 0, function () {
|
|
479
|
-
var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
665
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
480
666
|
return __generator(this, function (_c) {
|
|
481
667
|
switch (_c.label) {
|
|
482
668
|
case 0:
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
669
|
+
req = new operations.FetchCustomerCreditsExternalIdRequest({
|
|
670
|
+
externalCustomerId: externalCustomerId,
|
|
671
|
+
cursor: cursor,
|
|
672
|
+
limit: limit,
|
|
673
|
+
});
|
|
486
674
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
487
675
|
url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits", req);
|
|
488
676
|
client = this.sdkConfiguration.defaultClient;
|
package/dist/sdk/creditnote.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ export declare class CreditNote {
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* This endpoint is used to fetch a single [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
|
|
18
18
|
*/
|
|
19
|
-
fetch(
|
|
19
|
+
fetch(creditNoteId: string, config?: AxiosRequestConfig): Promise<operations.FetchCreditNoteResponse>;
|
|
20
20
|
/**
|
|
21
21
|
* List credit notes
|
|
22
22
|
*
|
|
@@ -25,5 +25,5 @@ export declare class CreditNote {
|
|
|
25
25
|
* customer_id, subscription_id, or external_customer_id. The credit notes will be returned
|
|
26
26
|
* in reverse chronological order by `creation_time`.
|
|
27
27
|
*/
|
|
28
|
-
list(
|
|
28
|
+
list(cursor?: string, limit?: number, config?: AxiosRequestConfig): Promise<operations.ListCreditNotesResponse>;
|
|
29
29
|
}
|
package/dist/sdk/creditnote.js
CHANGED
|
@@ -94,16 +94,16 @@ var CreditNote = /** @class */ (function () {
|
|
|
94
94
|
* @remarks
|
|
95
95
|
* This endpoint is used to fetch a single [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
|
|
96
96
|
*/
|
|
97
|
-
CreditNote.prototype.fetch = function (
|
|
97
|
+
CreditNote.prototype.fetch = function (creditNoteId, config) {
|
|
98
98
|
var _a, _b;
|
|
99
99
|
return __awaiter(this, void 0, void 0, function () {
|
|
100
|
-
var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
100
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
101
101
|
return __generator(this, function (_c) {
|
|
102
102
|
switch (_c.label) {
|
|
103
103
|
case 0:
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
}
|
|
104
|
+
req = new operations.FetchCreditNoteRequest({
|
|
105
|
+
creditNoteId: creditNoteId,
|
|
106
|
+
});
|
|
107
107
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
108
108
|
url = utils.generateURL(baseURL, "/credit_notes/{credit_note_id}", req);
|
|
109
109
|
client = this.sdkConfiguration.defaultClient;
|
|
@@ -213,16 +213,17 @@ var CreditNote = /** @class */ (function () {
|
|
|
213
213
|
* customer_id, subscription_id, or external_customer_id. The credit notes will be returned
|
|
214
214
|
* in reverse chronological order by `creation_time`.
|
|
215
215
|
*/
|
|
216
|
-
CreditNote.prototype.list = function (
|
|
216
|
+
CreditNote.prototype.list = function (cursor, limit, config) {
|
|
217
217
|
var _a, _b;
|
|
218
218
|
return __awaiter(this, void 0, void 0, function () {
|
|
219
|
-
var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
219
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
220
220
|
return __generator(this, function (_c) {
|
|
221
221
|
switch (_c.label) {
|
|
222
222
|
case 0:
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
223
|
+
req = new operations.ListCreditNotesRequest({
|
|
224
|
+
cursor: cursor,
|
|
225
|
+
limit: limit,
|
|
226
|
+
});
|
|
226
227
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
227
228
|
url = baseURL.replace(/\/$/, "") + "/credit_notes";
|
|
228
229
|
client = this.sdkConfiguration.defaultClient;
|
package/dist/sdk/customer.d.ts
CHANGED
|
@@ -104,7 +104,7 @@ export declare class Customer {
|
|
|
104
104
|
* In order to overwrite timeframes with a very large number of events, we suggest using multiple calls with small adjacent
|
|
105
105
|
* (e.g. every hour) timeframes.
|
|
106
106
|
*/
|
|
107
|
-
amend(
|
|
107
|
+
amend(customerId: string, updateEvent?: shared.UpdateEvent, timeframeEnd?: Date, timeframeStart?: Date, config?: AxiosRequestConfig): Promise<operations.AmendUsageResponse>;
|
|
108
108
|
/**
|
|
109
109
|
* Amend usage by external ID
|
|
110
110
|
*
|
|
@@ -186,7 +186,7 @@ export declare class Customer {
|
|
|
186
186
|
* In order to overwrite timeframes with a very large number of events, we suggest using multiple calls with small adjacent
|
|
187
187
|
* (e.g. every hour) timeframes.
|
|
188
188
|
*/
|
|
189
|
-
amendByExternalId(
|
|
189
|
+
amendByExternalId(externalCustomerId: string, updateEvent?: shared.UpdateEvent, timeframeEnd?: Date, timeframeStart?: Date, config?: AxiosRequestConfig): Promise<operations.AmendUsageExternalCustomerIdResponse>;
|
|
190
190
|
/**
|
|
191
191
|
* Create customer
|
|
192
192
|
*
|
|
@@ -210,7 +210,7 @@ export declare class Customer {
|
|
|
210
210
|
* Creates an immutable balance transaction that updates the customer's balance and returns back the newly created
|
|
211
211
|
* transaction.
|
|
212
212
|
*/
|
|
213
|
-
createBalanceTransaction(
|
|
213
|
+
createBalanceTransaction(customerId: string, newCustomerBalanceTransaction?: shared.NewCustomerBalanceTransaction, config?: AxiosRequestConfig): Promise<operations.CreateCustomerBalanceTransactionResponse>;
|
|
214
214
|
/**
|
|
215
215
|
* Delete customer
|
|
216
216
|
*
|
|
@@ -229,7 +229,7 @@ export declare class Customer {
|
|
|
229
229
|
*
|
|
230
230
|
* On successful processing, this returns an empty dictionary (`{}`) in the API.
|
|
231
231
|
*/
|
|
232
|
-
delete(
|
|
232
|
+
delete(customerId: string, config?: AxiosRequestConfig): Promise<operations.DeleteCustomerResponse>;
|
|
233
233
|
/**
|
|
234
234
|
* Fetch customer
|
|
235
235
|
*
|
|
@@ -239,7 +239,7 @@ export declare class Customer {
|
|
|
239
239
|
*
|
|
240
240
|
* See the [Customer resource](../guides/core-concepts.mdx#customer) for a full discussion of the Customer model.
|
|
241
241
|
*/
|
|
242
|
-
fetch(
|
|
242
|
+
fetch(customerId: string, config?: AxiosRequestConfig): Promise<operations.FetchCustomerResponse>;
|
|
243
243
|
/**
|
|
244
244
|
* Fetch customer by external ID
|
|
245
245
|
*
|
|
@@ -249,7 +249,7 @@ export declare class Customer {
|
|
|
249
249
|
*
|
|
250
250
|
* Note that the resource and semantics of this endpoint exactly mirror [Get Customer](fetch-customer).
|
|
251
251
|
*/
|
|
252
|
-
fetchByExternalId(
|
|
252
|
+
fetchByExternalId(externalCustomerId: string, config?: AxiosRequestConfig): Promise<operations.FetchCustomerExternalIdResponse>;
|
|
253
253
|
/**
|
|
254
254
|
* Fetch customer costs
|
|
255
255
|
*
|
|
@@ -516,7 +516,7 @@ export declare class Customer {
|
|
|
516
516
|
* Note that the resource and semantics of this
|
|
517
517
|
* endpoint exactly mirror [Update Customer](update-customer).
|
|
518
518
|
*/
|
|
519
|
-
updateByExternalId(
|
|
519
|
+
updateByExternalId(externalCustomerId: string, editCustomer?: shared.EditCustomer, config?: AxiosRequestConfig): Promise<operations.UpdateCustomerExternalIdResponse>;
|
|
520
520
|
/**
|
|
521
521
|
* Update customer
|
|
522
522
|
*
|
|
@@ -525,5 +525,5 @@ export declare class Customer {
|
|
|
525
525
|
* `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and `additional_emails` of an existing customer.
|
|
526
526
|
* "Other fields on a customer are currently immutable.
|
|
527
527
|
*/
|
|
528
|
-
updateCustomer(
|
|
528
|
+
updateCustomer(customerId: string, editCustomer?: shared.EditCustomer, config?: AxiosRequestConfig): Promise<operations.UpdateCustomerResponse>;
|
|
529
529
|
}
|
package/dist/sdk/customer.js
CHANGED
|
@@ -197,17 +197,20 @@ var Customer = /** @class */ (function () {
|
|
|
197
197
|
* In order to overwrite timeframes with a very large number of events, we suggest using multiple calls with small adjacent
|
|
198
198
|
* (e.g. every hour) timeframes.
|
|
199
199
|
*/
|
|
200
|
-
Customer.prototype.amend = function (
|
|
200
|
+
Customer.prototype.amend = function (customerId, updateEvent, timeframeEnd, timeframeStart, config) {
|
|
201
201
|
var _a, _b;
|
|
202
202
|
return __awaiter(this, void 0, void 0, function () {
|
|
203
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
203
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
204
204
|
var _d;
|
|
205
205
|
return __generator(this, function (_e) {
|
|
206
206
|
switch (_e.label) {
|
|
207
207
|
case 0:
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
208
|
+
req = new operations.AmendUsageRequest({
|
|
209
|
+
customerId: customerId,
|
|
210
|
+
updateEvent: updateEvent,
|
|
211
|
+
timeframeEnd: timeframeEnd,
|
|
212
|
+
timeframeStart: timeframeStart,
|
|
213
|
+
});
|
|
211
214
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
212
215
|
url = utils.generateURL(baseURL, "/customers/{customer_id}/usage", req);
|
|
213
216
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|
|
@@ -400,17 +403,20 @@ var Customer = /** @class */ (function () {
|
|
|
400
403
|
* In order to overwrite timeframes with a very large number of events, we suggest using multiple calls with small adjacent
|
|
401
404
|
* (e.g. every hour) timeframes.
|
|
402
405
|
*/
|
|
403
|
-
Customer.prototype.amendByExternalId = function (
|
|
406
|
+
Customer.prototype.amendByExternalId = function (externalCustomerId, updateEvent, timeframeEnd, timeframeStart, config) {
|
|
404
407
|
var _a, _b;
|
|
405
408
|
return __awaiter(this, void 0, void 0, function () {
|
|
406
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
409
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes;
|
|
407
410
|
var _d;
|
|
408
411
|
return __generator(this, function (_e) {
|
|
409
412
|
switch (_e.label) {
|
|
410
413
|
case 0:
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
+
req = new operations.AmendUsageExternalCustomerIdRequest({
|
|
415
|
+
externalCustomerId: externalCustomerId,
|
|
416
|
+
updateEvent: updateEvent,
|
|
417
|
+
timeframeEnd: timeframeEnd,
|
|
418
|
+
timeframeStart: timeframeStart,
|
|
419
|
+
});
|
|
414
420
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
415
421
|
url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/usage", req);
|
|
416
422
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|
|
@@ -665,17 +671,18 @@ var Customer = /** @class */ (function () {
|
|
|
665
671
|
* Creates an immutable balance transaction that updates the customer's balance and returns back the newly created
|
|
666
672
|
* transaction.
|
|
667
673
|
*/
|
|
668
|
-
Customer.prototype.createBalanceTransaction = function (
|
|
674
|
+
Customer.prototype.createBalanceTransaction = function (customerId, newCustomerBalanceTransaction, config) {
|
|
669
675
|
var _a, _b;
|
|
670
676
|
return __awaiter(this, void 0, void 0, function () {
|
|
671
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
677
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
672
678
|
var _d;
|
|
673
679
|
return __generator(this, function (_e) {
|
|
674
680
|
switch (_e.label) {
|
|
675
681
|
case 0:
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
682
|
+
req = new operations.CreateCustomerBalanceTransactionRequest({
|
|
683
|
+
customerId: customerId,
|
|
684
|
+
newCustomerBalanceTransaction: newCustomerBalanceTransaction,
|
|
685
|
+
});
|
|
679
686
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
680
687
|
url = utils.generateURL(baseURL, "/customers/{customer_id}/balance_transactions", req);
|
|
681
688
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|
|
@@ -804,16 +811,16 @@ var Customer = /** @class */ (function () {
|
|
|
804
811
|
*
|
|
805
812
|
* On successful processing, this returns an empty dictionary (`{}`) in the API.
|
|
806
813
|
*/
|
|
807
|
-
Customer.prototype.delete = function (
|
|
814
|
+
Customer.prototype.delete = function (customerId, config) {
|
|
808
815
|
var _a, _b;
|
|
809
816
|
return __awaiter(this, void 0, void 0, function () {
|
|
810
|
-
var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
817
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
811
818
|
return __generator(this, function (_c) {
|
|
812
819
|
switch (_c.label) {
|
|
813
820
|
case 0:
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
}
|
|
821
|
+
req = new operations.DeleteCustomerRequest({
|
|
822
|
+
customerId: customerId,
|
|
823
|
+
});
|
|
817
824
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
818
825
|
url = utils.generateURL(baseURL, "/customers/{customer_id}", req);
|
|
819
826
|
client = this.sdkConfiguration.defaultClient;
|
|
@@ -924,16 +931,16 @@ var Customer = /** @class */ (function () {
|
|
|
924
931
|
*
|
|
925
932
|
* See the [Customer resource](../guides/core-concepts.mdx#customer) for a full discussion of the Customer model.
|
|
926
933
|
*/
|
|
927
|
-
Customer.prototype.fetch = function (
|
|
934
|
+
Customer.prototype.fetch = function (customerId, config) {
|
|
928
935
|
var _a, _b;
|
|
929
936
|
return __awaiter(this, void 0, void 0, function () {
|
|
930
|
-
var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
937
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
931
938
|
return __generator(this, function (_c) {
|
|
932
939
|
switch (_c.label) {
|
|
933
940
|
case 0:
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
}
|
|
941
|
+
req = new operations.FetchCustomerRequest({
|
|
942
|
+
customerId: customerId,
|
|
943
|
+
});
|
|
937
944
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
938
945
|
url = utils.generateURL(baseURL, "/customers/{customer_id}", req);
|
|
939
946
|
client = this.sdkConfiguration.defaultClient;
|
|
@@ -1044,16 +1051,16 @@ var Customer = /** @class */ (function () {
|
|
|
1044
1051
|
*
|
|
1045
1052
|
* Note that the resource and semantics of this endpoint exactly mirror [Get Customer](fetch-customer).
|
|
1046
1053
|
*/
|
|
1047
|
-
Customer.prototype.fetchByExternalId = function (
|
|
1054
|
+
Customer.prototype.fetchByExternalId = function (externalCustomerId, config) {
|
|
1048
1055
|
var _a, _b;
|
|
1049
1056
|
return __awaiter(this, void 0, void 0, function () {
|
|
1050
|
-
var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
1057
|
+
var req, baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
1051
1058
|
return __generator(this, function (_c) {
|
|
1052
1059
|
switch (_c.label) {
|
|
1053
1060
|
case 0:
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
}
|
|
1061
|
+
req = new operations.FetchCustomerExternalIdRequest({
|
|
1062
|
+
externalCustomerId: externalCustomerId,
|
|
1063
|
+
});
|
|
1057
1064
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
1058
1065
|
url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}", req);
|
|
1059
1066
|
client = this.sdkConfiguration.defaultClient;
|
|
@@ -1865,17 +1872,18 @@ var Customer = /** @class */ (function () {
|
|
|
1865
1872
|
* Note that the resource and semantics of this
|
|
1866
1873
|
* endpoint exactly mirror [Update Customer](update-customer).
|
|
1867
1874
|
*/
|
|
1868
|
-
Customer.prototype.updateByExternalId = function (
|
|
1875
|
+
Customer.prototype.updateByExternalId = function (externalCustomerId, editCustomer, config) {
|
|
1869
1876
|
var _a, _b;
|
|
1870
1877
|
return __awaiter(this, void 0, void 0, function () {
|
|
1871
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
1878
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
1872
1879
|
var _d;
|
|
1873
1880
|
return __generator(this, function (_e) {
|
|
1874
1881
|
switch (_e.label) {
|
|
1875
1882
|
case 0:
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1883
|
+
req = new operations.UpdateCustomerExternalIdRequest({
|
|
1884
|
+
externalCustomerId: externalCustomerId,
|
|
1885
|
+
editCustomer: editCustomer,
|
|
1886
|
+
});
|
|
1879
1887
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
1880
1888
|
url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}", req);
|
|
1881
1889
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|
|
@@ -1994,17 +2002,18 @@ var Customer = /** @class */ (function () {
|
|
|
1994
2002
|
* `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and `additional_emails` of an existing customer.
|
|
1995
2003
|
* "Other fields on a customer are currently immutable.
|
|
1996
2004
|
*/
|
|
1997
|
-
Customer.prototype.updateCustomer = function (
|
|
2005
|
+
Customer.prototype.updateCustomer = function (customerId, editCustomer, config) {
|
|
1998
2006
|
var _a, _b;
|
|
1999
2007
|
return __awaiter(this, void 0, void 0, function () {
|
|
2000
|
-
var baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
2008
|
+
var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
|
|
2001
2009
|
var _d;
|
|
2002
2010
|
return __generator(this, function (_e) {
|
|
2003
2011
|
switch (_e.label) {
|
|
2004
2012
|
case 0:
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
|
|
2013
|
+
req = new operations.UpdateCustomerRequest({
|
|
2014
|
+
customerId: customerId,
|
|
2015
|
+
editCustomer: editCustomer,
|
|
2016
|
+
});
|
|
2008
2017
|
baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
|
|
2009
2018
|
url = utils.generateURL(baseURL, "/customers/{customer_id}", req);
|
|
2010
2019
|
_c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
|