orb-billing 1.21.0 → 1.23.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/CHANGELOG.md +32 -0
- package/LICENSE +201 -0
- package/README.md +196 -192
- package/_shims/MultipartBody.d.ts +9 -0
- package/_shims/MultipartBody.d.ts.map +1 -0
- package/_shims/MultipartBody.js +16 -0
- package/_shims/MultipartBody.js.map +1 -0
- package/_shims/MultipartBody.mjs +12 -0
- package/_shims/MultipartBody.mjs.map +1 -0
- package/_shims/README.md +46 -0
- package/_shims/auto/runtime-bun.d.ts +5 -0
- package/_shims/auto/runtime-bun.d.ts.map +1 -0
- package/_shims/auto/runtime-bun.js +21 -0
- package/_shims/auto/runtime-bun.js.map +1 -0
- package/_shims/auto/runtime-bun.mjs +2 -0
- package/_shims/auto/runtime-bun.mjs.map +1 -0
- package/_shims/auto/runtime-node.d.ts +5 -0
- package/_shims/auto/runtime-node.d.ts.map +1 -0
- package/_shims/auto/runtime-node.js +21 -0
- package/_shims/auto/runtime-node.js.map +1 -0
- package/_shims/auto/runtime-node.mjs +2 -0
- package/_shims/auto/runtime-node.mjs.map +1 -0
- package/_shims/auto/runtime.d.ts +5 -0
- package/_shims/auto/runtime.d.ts.map +1 -0
- package/_shims/auto/runtime.js +21 -0
- package/_shims/auto/runtime.js.map +1 -0
- package/_shims/auto/runtime.mjs +2 -0
- package/_shims/auto/runtime.mjs.map +1 -0
- package/_shims/auto/types-node.d.ts +5 -0
- package/_shims/auto/types-node.d.ts.map +1 -0
- package/_shims/auto/types-node.js +21 -0
- package/_shims/auto/types-node.js.map +1 -0
- package/_shims/auto/types-node.mjs +2 -0
- package/_shims/auto/types-node.mjs.map +1 -0
- package/_shims/auto/types.d.ts +101 -0
- package/_shims/auto/types.js +3 -0
- package/_shims/auto/types.mjs +3 -0
- package/_shims/bun-runtime.d.ts +6 -0
- package/_shims/bun-runtime.d.ts.map +1 -0
- package/_shims/bun-runtime.js +14 -0
- package/_shims/bun-runtime.js.map +1 -0
- package/_shims/bun-runtime.mjs +10 -0
- package/_shims/bun-runtime.mjs.map +1 -0
- package/_shims/index.d.ts +81 -0
- package/_shims/index.js +13 -0
- package/_shims/index.mjs +7 -0
- package/_shims/manual-types.d.ts +12 -0
- package/_shims/manual-types.js +3 -0
- package/_shims/manual-types.mjs +3 -0
- package/_shims/node-runtime.d.ts +3 -0
- package/_shims/node-runtime.d.ts.map +1 -0
- package/_shims/node-runtime.js +90 -0
- package/_shims/node-runtime.js.map +1 -0
- package/_shims/node-runtime.mjs +56 -0
- package/_shims/node-runtime.mjs.map +1 -0
- package/_shims/node-types.d.ts +42 -0
- package/_shims/node-types.js +3 -0
- package/_shims/node-types.mjs +3 -0
- package/_shims/registry.d.ts +37 -0
- package/_shims/registry.d.ts.map +1 -0
- package/_shims/registry.js +41 -0
- package/_shims/registry.js.map +1 -0
- package/_shims/registry.mjs +37 -0
- package/_shims/registry.mjs.map +1 -0
- package/_shims/web-runtime.d.ts +5 -0
- package/_shims/web-runtime.d.ts.map +1 -0
- package/_shims/web-runtime.js +78 -0
- package/_shims/web-runtime.js.map +1 -0
- package/_shims/web-runtime.mjs +71 -0
- package/_shims/web-runtime.mjs.map +1 -0
- package/_shims/web-types.d.ts +83 -0
- package/_shims/web-types.js +3 -0
- package/_shims/web-types.mjs +3 -0
- package/core.d.ts +239 -0
- package/core.d.ts.map +1 -0
- package/core.js +830 -0
- package/core.js.map +1 -0
- package/core.mjs +799 -0
- package/core.mjs.map +1 -0
- package/error.d.ts +131 -0
- package/error.d.ts.map +1 -0
- package/error.js +298 -0
- package/error.js.map +1 -0
- package/error.mjs +271 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +210 -0
- package/index.d.ts +210 -0
- package/index.d.ts.map +1 -0
- package/index.js +153 -0
- package/index.js.map +1 -0
- package/index.mjs +125 -0
- package/index.mjs.map +1 -0
- package/package.json +90 -27
- package/pagination.d.ts +31 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +34 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +30 -0
- package/pagination.mjs.map +1 -0
- package/resource.d.ts +12 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +17 -0
- package/resource.js.map +1 -0
- package/resource.mjs +13 -0
- package/resource.mjs.map +1 -0
- package/resources/coupons/coupons.d.ts +114 -0
- package/resources/coupons/coupons.d.ts.map +1 -0
- package/resources/coupons/coupons.js +76 -0
- package/resources/coupons/coupons.js.map +1 -0
- package/resources/coupons/coupons.mjs +48 -0
- package/resources/coupons/coupons.mjs.map +1 -0
- package/resources/coupons/index.d.ts +3 -0
- package/resources/coupons/index.d.ts.map +1 -0
- package/resources/coupons/index.js +10 -0
- package/resources/coupons/index.js.map +1 -0
- package/resources/coupons/index.mjs +4 -0
- package/resources/coupons/index.mjs.map +1 -0
- package/resources/coupons/subscriptions.d.ts +23 -0
- package/resources/coupons/subscriptions.d.ts.map +1 -0
- package/resources/coupons/subscriptions.js +20 -0
- package/resources/coupons/subscriptions.js.map +1 -0
- package/resources/coupons/subscriptions.mjs +16 -0
- package/resources/coupons/subscriptions.mjs.map +1 -0
- package/resources/credit-notes.d.ts +136 -0
- package/resources/credit-notes.d.ts.map +1 -0
- package/resources/credit-notes.js +54 -0
- package/resources/credit-notes.js.map +1 -0
- package/resources/credit-notes.mjs +26 -0
- package/resources/credit-notes.mjs.map +1 -0
- package/resources/customers/balance-transactions.d.ts +159 -0
- package/resources/customers/balance-transactions.d.ts.map +1 -0
- package/resources/customers/balance-transactions.js +54 -0
- package/resources/customers/balance-transactions.js.map +1 -0
- package/resources/customers/balance-transactions.mjs +26 -0
- package/resources/customers/balance-transactions.mjs.map +1 -0
- package/resources/customers/costs.d.ts +915 -0
- package/resources/customers/costs.d.ts.map +1 -0
- package/resources/customers/costs.js +24 -0
- package/resources/customers/costs.js.map +1 -0
- package/resources/customers/costs.mjs +20 -0
- package/resources/customers/costs.mjs.map +1 -0
- package/resources/customers/credits/credits.d.ts +58 -0
- package/resources/customers/credits/credits.d.ts.map +1 -0
- package/resources/customers/credits/credits.js +68 -0
- package/resources/customers/credits/credits.js.map +1 -0
- package/resources/customers/credits/credits.mjs +39 -0
- package/resources/customers/credits/credits.mjs.map +1 -0
- package/resources/customers/credits/index.d.ts +3 -0
- package/resources/customers/credits/index.d.ts.map +1 -0
- package/resources/customers/credits/index.js +13 -0
- package/resources/customers/credits/index.js.map +1 -0
- package/resources/customers/credits/index.mjs +4 -0
- package/resources/customers/credits/index.mjs.map +1 -0
- package/resources/customers/credits/ledger.d.ts +1537 -0
- package/resources/customers/credits/ledger.d.ts.map +1 -0
- package/resources/customers/credits/ledger.js +291 -0
- package/resources/customers/credits/ledger.js.map +1 -0
- package/resources/customers/credits/ledger.mjs +262 -0
- package/resources/customers/credits/ledger.mjs.map +1 -0
- package/resources/customers/customers.d.ts +524 -0
- package/resources/customers/customers.d.ts.map +1 -0
- package/resources/customers/customers.js +135 -0
- package/resources/customers/customers.js.map +1 -0
- package/resources/customers/customers.mjs +107 -0
- package/resources/customers/customers.mjs.map +1 -0
- package/resources/customers/index.d.ts +6 -0
- package/resources/customers/index.d.ts.map +1 -0
- package/resources/customers/index.js +19 -0
- package/resources/customers/index.js.map +1 -0
- package/resources/customers/index.mjs +7 -0
- package/resources/customers/index.mjs.map +1 -0
- package/resources/customers/usage.d.ts +306 -0
- package/resources/customers/usage.d.ts.map +1 -0
- package/resources/customers/usage.js +223 -0
- package/resources/customers/usage.js.map +1 -0
- package/resources/customers/usage.mjs +219 -0
- package/resources/customers/usage.mjs.map +1 -0
- package/resources/events/backfills.d.ts +250 -0
- package/resources/events/backfills.d.ts.map +1 -0
- package/resources/events/backfills.js +104 -0
- package/resources/events/backfills.js.map +1 -0
- package/resources/events/backfills.mjs +76 -0
- package/resources/events/backfills.mjs.map +1 -0
- package/resources/events/events.d.ts +547 -0
- package/resources/events/events.d.ts.map +1 -0
- package/resources/events/events.js +354 -0
- package/resources/events/events.js.map +1 -0
- package/resources/events/events.mjs +327 -0
- package/resources/events/events.mjs.map +1 -0
- package/resources/events/index.d.ts +3 -0
- package/resources/events/index.d.ts.map +1 -0
- package/resources/events/index.js +10 -0
- package/resources/events/index.js.map +1 -0
- package/resources/events/index.mjs +4 -0
- package/resources/events/index.mjs.map +1 -0
- package/resources/index.d.ts +13 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +39 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +14 -0
- package/resources/index.mjs.map +1 -0
- package/resources/invoice-line-items.d.ts +434 -0
- package/resources/invoice-line-items.d.ts.map +1 -0
- package/resources/invoice-line-items.js +18 -0
- package/resources/invoice-line-items.js.map +1 -0
- package/resources/invoice-line-items.mjs +14 -0
- package/resources/invoice-line-items.mjs.map +1 -0
- package/resources/invoices.d.ts +1541 -0
- package/resources/invoices.d.ts.map +1 -0
- package/resources/invoices.js +96 -0
- package/resources/invoices.js.map +1 -0
- package/resources/invoices.mjs +68 -0
- package/resources/invoices.mjs.map +1 -0
- package/resources/items.d.ts +61 -0
- package/resources/items.d.ts.map +1 -0
- package/resources/items.js +53 -0
- package/resources/items.js.map +1 -0
- package/resources/items.mjs +25 -0
- package/resources/items.mjs.map +1 -0
- package/resources/metrics.d.ts +176 -0
- package/resources/metrics.d.ts.map +1 -0
- package/resources/metrics.js +63 -0
- package/resources/metrics.js.map +1 -0
- package/resources/metrics.mjs +35 -0
- package/resources/metrics.mjs.map +1 -0
- package/resources/plans/external-plan-id.d.ts +50 -0
- package/resources/plans/external-plan-id.d.ts.map +1 -0
- package/resources/plans/external-plan-id.js +35 -0
- package/resources/plans/external-plan-id.js.map +1 -0
- package/resources/plans/external-plan-id.mjs +31 -0
- package/resources/plans/external-plan-id.mjs.map +1 -0
- package/resources/plans/index.d.ts +3 -0
- package/resources/plans/index.d.ts.map +1 -0
- package/resources/plans/index.js +10 -0
- package/resources/plans/index.js.map +1 -0
- package/resources/plans/index.mjs +4 -0
- package/resources/plans/index.mjs.map +1 -0
- package/resources/plans/plans.d.ts +256 -0
- package/resources/plans/plans.d.ts.map +1 -0
- package/resources/plans/plans.js +87 -0
- package/resources/plans/plans.js.map +1 -0
- package/resources/plans/plans.mjs +59 -0
- package/resources/plans/plans.mjs.map +1 -0
- package/resources/prices/external-price-id.d.ts +12 -0
- package/resources/prices/external-price-id.d.ts.map +1 -0
- package/resources/prices/external-price-id.js +17 -0
- package/resources/prices/external-price-id.js.map +1 -0
- package/resources/prices/external-price-id.mjs +13 -0
- package/resources/prices/external-price-id.mjs.map +1 -0
- package/resources/prices/index.d.ts +3 -0
- package/resources/prices/index.d.ts.map +1 -0
- package/resources/prices/index.js +10 -0
- package/resources/prices/index.js.map +1 -0
- package/resources/prices/index.mjs +4 -0
- package/resources/prices/index.mjs.map +1 -0
- package/resources/prices/prices.d.ts +1872 -0
- package/resources/prices/prices.d.ts.map +1 -0
- package/resources/prices/prices.js +74 -0
- package/resources/prices/prices.js.map +1 -0
- package/resources/prices/prices.mjs +46 -0
- package/resources/prices/prices.mjs.map +1 -0
- package/resources/subscriptions.d.ts +3752 -0
- package/resources/subscriptions.d.ts.map +1 -0
- package/resources/subscriptions.js +254 -0
- package/resources/subscriptions.js.map +1 -0
- package/resources/subscriptions.mjs +225 -0
- package/resources/subscriptions.mjs.map +1 -0
- package/resources/top-level.d.ts +21 -0
- package/resources/top-level.d.ts.map +1 -0
- package/resources/top-level.js +22 -0
- package/resources/top-level.js.map +1 -0
- package/resources/top-level.mjs +18 -0
- package/resources/top-level.mjs.map +1 -0
- package/shims/node.d.ts +29 -0
- package/shims/node.d.ts.map +1 -0
- package/shims/node.js +31 -0
- package/shims/node.js.map +1 -0
- package/shims/node.mjs +5 -0
- package/shims/node.mjs.map +1 -0
- package/shims/web.d.ts +26 -0
- package/shims/web.d.ts.map +1 -0
- package/shims/web.js +31 -0
- package/shims/web.js.map +1 -0
- package/shims/web.mjs +5 -0
- package/shims/web.mjs.map +1 -0
- package/src/_shims/MultipartBody.ts +9 -0
- package/src/_shims/README.md +46 -0
- package/src/_shims/auto/runtime-bun.ts +4 -0
- package/src/_shims/auto/runtime-node.ts +4 -0
- package/src/_shims/auto/runtime.ts +4 -0
- package/src/_shims/auto/types-node.ts +4 -0
- package/src/_shims/auto/types.d.ts +101 -0
- package/src/_shims/auto/types.js +3 -0
- package/src/_shims/auto/types.mjs +3 -0
- package/src/_shims/bun-runtime.ts +14 -0
- package/src/_shims/index.d.ts +81 -0
- package/src/_shims/index.js +13 -0
- package/src/_shims/index.mjs +7 -0
- package/src/_shims/manual-types.d.ts +12 -0
- package/src/_shims/manual-types.js +3 -0
- package/src/_shims/manual-types.mjs +3 -0
- package/src/_shims/node-runtime.ts +83 -0
- package/src/_shims/node-types.d.ts +42 -0
- package/src/_shims/node-types.js +3 -0
- package/src/_shims/node-types.mjs +3 -0
- package/src/_shims/registry.ts +67 -0
- package/src/_shims/web-runtime.ts +103 -0
- package/src/_shims/web-types.d.ts +83 -0
- package/src/_shims/web-types.js +3 -0
- package/src/_shims/web-types.mjs +3 -0
- package/src/core.ts +1099 -0
- package/src/error.ts +469 -0
- package/src/index.ts +305 -0
- package/src/pagination.ts +63 -0
- package/src/resource.ts +24 -0
- package/src/resources/coupons/coupons.ts +150 -0
- package/src/resources/coupons/index.ts +4 -0
- package/src/resources/coupons/subscriptions.ts +45 -0
- package/src/resources/credit-notes.ts +184 -0
- package/src/resources/customers/balance-transactions.ts +222 -0
- package/src/resources/customers/costs.ts +991 -0
- package/src/resources/customers/credits/credits.ts +113 -0
- package/src/resources/customers/credits/index.ts +24 -0
- package/src/resources/customers/credits/ledger.ts +2254 -0
- package/src/resources/customers/customers.ts +734 -0
- package/src/resources/customers/index.ts +42 -0
- package/src/resources/customers/usage.ts +350 -0
- package/src/resources/events/backfills.ts +324 -0
- package/src/resources/events/events.ts +635 -0
- package/src/resources/events/index.ts +23 -0
- package/src/resources/index.ts +72 -0
- package/src/resources/invoice-line-items.ts +502 -0
- package/src/resources/invoices.ts +1906 -0
- package/src/resources/items.ts +106 -0
- package/src/resources/metrics.ts +264 -0
- package/src/resources/plans/external-plan-id.ts +73 -0
- package/src/resources/plans/index.ts +4 -0
- package/src/resources/plans/plans.ts +350 -0
- package/src/resources/prices/external-price-id.ts +16 -0
- package/src/resources/prices/index.ts +4 -0
- package/src/resources/prices/prices.ts +2466 -0
- package/src/resources/subscriptions.ts +4590 -0
- package/src/resources/top-level.ts +27 -0
- package/src/shims/node.ts +50 -0
- package/src/shims/web.ts +50 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +246 -0
- package/src/version.ts +1 -0
- package/uploads.d.ts +75 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +162 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +149 -0
- package/uploads.mjs.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
- package/LICENSE.md +0 -21
- package/dist/index.d.ts +0 -1
- package/dist/index.js +0 -20
- package/dist/internal/utils/contenttype.d.ts +0 -1
- package/dist/internal/utils/contenttype.js +0 -33
- package/dist/internal/utils/headers.d.ts +0 -4
- package/dist/internal/utils/headers.js +0 -92
- package/dist/internal/utils/index.d.ts +0 -8
- package/dist/internal/utils/index.js +0 -27
- package/dist/internal/utils/pathparams.d.ts +0 -2
- package/dist/internal/utils/pathparams.js +0 -53
- package/dist/internal/utils/queryparams.d.ts +0 -2
- package/dist/internal/utils/queryparams.js +0 -178
- package/dist/internal/utils/requestbody.d.ts +0 -2
- package/dist/internal/utils/requestbody.js +0 -318
- package/dist/internal/utils/retries.d.ts +0 -20
- package/dist/internal/utils/retries.js +0 -250
- package/dist/internal/utils/security.d.ts +0 -5
- package/dist/internal/utils/security.js +0 -188
- package/dist/internal/utils/utils.d.ts +0 -37
- package/dist/internal/utils/utils.js +0 -370
- package/dist/sdk/availability.d.ts +0 -18
- package/dist/sdk/availability.js +0 -186
- package/dist/sdk/coupon.d.ts +0 -62
- package/dist/sdk/coupon.js +0 -629
- package/dist/sdk/credit.d.ts +0 -348
- package/dist/sdk/credit.js +0 -1020
- package/dist/sdk/creditnote.d.ts +0 -29
- package/dist/sdk/creditnote.js +0 -293
- package/dist/sdk/customer.d.ts +0 -529
- package/dist/sdk/customer.js +0 -1882
- package/dist/sdk/event.d.ts +0 -353
- package/dist/sdk/event.js +0 -1314
- package/dist/sdk/index.d.ts +0 -1
- package/dist/sdk/index.js +0 -20
- package/dist/sdk/invoice.d.ts +0 -89
- package/dist/sdk/invoice.js +0 -945
- package/dist/sdk/item.d.ts +0 -27
- package/dist/sdk/item.js +0 -291
- package/dist/sdk/metric.d.ts +0 -39
- package/dist/sdk/metric.js +0 -418
- package/dist/sdk/models/errors/fivehundrederror.d.ts +0 -11
- package/dist/sdk/models/errors/fivehundrederror.js +0 -88
- package/dist/sdk/models/errors/fourhundredandoneerror.d.ts +0 -11
- package/dist/sdk/models/errors/fourhundredandoneerror.js +0 -88
- package/dist/sdk/models/errors/fourhundredandtwentynineerror.d.ts +0 -11
- package/dist/sdk/models/errors/fourhundredandtwentynineerror.js +0 -88
- package/dist/sdk/models/errors/index.d.ts +0 -4
- package/dist/sdk/models/errors/index.js +0 -23
- package/dist/sdk/models/errors/sdkerror.d.ts +0 -7
- package/dist/sdk/models/errors/sdkerror.js +0 -40
- package/dist/sdk/models/operations/addeditpriceintervals.d.ts +0 -25
- package/dist/sdk/models/operations/addeditpriceintervals.js +0 -95
- package/dist/sdk/models/operations/amendevent.d.ts +0 -25
- package/dist/sdk/models/operations/amendevent.js +0 -95
- package/dist/sdk/models/operations/amendusage.d.ts +0 -27
- package/dist/sdk/models/operations/amendusage.js +0 -103
- package/dist/sdk/models/operations/amendusageexternalcustomerid.d.ts +0 -27
- package/dist/sdk/models/operations/amendusageexternalcustomerid.js +0 -103
- package/dist/sdk/models/operations/archivecoupon.d.ts +0 -24
- package/dist/sdk/models/operations/archivecoupon.js +0 -91
- package/dist/sdk/models/operations/cancelsubscription.d.ts +0 -25
- package/dist/sdk/models/operations/cancelsubscription.js +0 -95
- package/dist/sdk/models/operations/closebackfill.d.ts +0 -24
- package/dist/sdk/models/operations/closebackfill.js +0 -91
- package/dist/sdk/models/operations/createbackfill.d.ts +0 -21
- package/dist/sdk/models/operations/createbackfill.js +0 -79
- package/dist/sdk/models/operations/createcoupon.d.ts +0 -21
- package/dist/sdk/models/operations/createcoupon.js +0 -79
- package/dist/sdk/models/operations/createcustomer.d.ts +0 -21
- package/dist/sdk/models/operations/createcustomer.js +0 -79
- package/dist/sdk/models/operations/createcustomerbalancetransaction.d.ts +0 -25
- package/dist/sdk/models/operations/createcustomerbalancetransaction.js +0 -95
- package/dist/sdk/models/operations/createinvoice.d.ts +0 -21
- package/dist/sdk/models/operations/createinvoice.js +0 -79
- package/dist/sdk/models/operations/createinvoicelineitem.d.ts +0 -21
- package/dist/sdk/models/operations/createinvoicelineitem.js +0 -79
- package/dist/sdk/models/operations/createledgerentry.d.ts +0 -24
- package/dist/sdk/models/operations/createledgerentry.js +0 -71
- package/dist/sdk/models/operations/createledgerentryexternalid.d.ts +0 -24
- package/dist/sdk/models/operations/createledgerentryexternalid.js +0 -71
- package/dist/sdk/models/operations/createmetric.d.ts +0 -21
- package/dist/sdk/models/operations/createmetric.js +0 -79
- package/dist/sdk/models/operations/createplan.d.ts +0 -21
- package/dist/sdk/models/operations/createplan.js +0 -79
- package/dist/sdk/models/operations/createprice.d.ts +0 -20
- package/dist/sdk/models/operations/createprice.js +0 -55
- package/dist/sdk/models/operations/createsubscription.d.ts +0 -21
- package/dist/sdk/models/operations/createsubscription.js +0 -79
- package/dist/sdk/models/operations/deletecustomer.d.ts +0 -24
- package/dist/sdk/models/operations/deletecustomer.js +0 -91
- package/dist/sdk/models/operations/deprecateevent.d.ts +0 -24
- package/dist/sdk/models/operations/deprecateevent.js +0 -91
- package/dist/sdk/models/operations/fetchbackfill.d.ts +0 -24
- package/dist/sdk/models/operations/fetchbackfill.js +0 -91
- package/dist/sdk/models/operations/fetchcoupon.d.ts +0 -24
- package/dist/sdk/models/operations/fetchcoupon.js +0 -91
- package/dist/sdk/models/operations/fetchcreditnote.d.ts +0 -24
- package/dist/sdk/models/operations/fetchcreditnote.js +0 -91
- package/dist/sdk/models/operations/fetchcustomer.d.ts +0 -24
- package/dist/sdk/models/operations/fetchcustomer.js +0 -91
- package/dist/sdk/models/operations/fetchcustomercosts.d.ts +0 -38
- package/dist/sdk/models/operations/fetchcustomercosts.js +0 -115
- package/dist/sdk/models/operations/fetchcustomercostsexternalid.d.ts +0 -38
- package/dist/sdk/models/operations/fetchcustomercostsexternalid.js +0 -115
- package/dist/sdk/models/operations/fetchcustomercredits.d.ts +0 -26
- package/dist/sdk/models/operations/fetchcustomercredits.js +0 -99
- package/dist/sdk/models/operations/fetchcustomercreditsexternalid.d.ts +0 -26
- package/dist/sdk/models/operations/fetchcustomercreditsexternalid.js +0 -99
- package/dist/sdk/models/operations/fetchcustomercreditsledger.d.ts +0 -47
- package/dist/sdk/models/operations/fetchcustomercreditsledger.js +0 -146
- package/dist/sdk/models/operations/fetchcustomercreditsledgerexternalid.d.ts +0 -47
- package/dist/sdk/models/operations/fetchcustomercreditsledgerexternalid.js +0 -146
- package/dist/sdk/models/operations/fetchcustomerexternalid.d.ts +0 -24
- package/dist/sdk/models/operations/fetchcustomerexternalid.js +0 -91
- package/dist/sdk/models/operations/fetchinvoice.d.ts +0 -24
- package/dist/sdk/models/operations/fetchinvoice.js +0 -91
- package/dist/sdk/models/operations/fetchitem.d.ts +0 -24
- package/dist/sdk/models/operations/fetchitem.js +0 -91
- package/dist/sdk/models/operations/fetchmetric.d.ts +0 -24
- package/dist/sdk/models/operations/fetchmetric.js +0 -91
- package/dist/sdk/models/operations/fetchplan.d.ts +0 -24
- package/dist/sdk/models/operations/fetchplan.js +0 -91
- package/dist/sdk/models/operations/fetchplanexternalid.d.ts +0 -24
- package/dist/sdk/models/operations/fetchplanexternalid.js +0 -91
- package/dist/sdk/models/operations/fetchprice.d.ts +0 -23
- package/dist/sdk/models/operations/fetchprice.js +0 -67
- package/dist/sdk/models/operations/fetchpriceexternalid.d.ts +0 -23
- package/dist/sdk/models/operations/fetchpriceexternalid.js +0 -67
- package/dist/sdk/models/operations/fetchsubscription.d.ts +0 -24
- package/dist/sdk/models/operations/fetchsubscription.js +0 -91
- package/dist/sdk/models/operations/fetchsubscriptioncosts.d.ts +0 -38
- package/dist/sdk/models/operations/fetchsubscriptioncosts.js +0 -115
- package/dist/sdk/models/operations/fetchsubscriptionschedule.d.ts +0 -30
- package/dist/sdk/models/operations/fetchsubscriptionschedule.js +0 -115
- package/dist/sdk/models/operations/fetchsubscriptionusage.d.ts +0 -54
- package/dist/sdk/models/operations/fetchsubscriptionusage.js +0 -130
- package/dist/sdk/models/operations/fetchupcominginvoice.d.ts +0 -24
- package/dist/sdk/models/operations/fetchupcominginvoice.js +0 -91
- package/dist/sdk/models/operations/index.d.ts +0 -73
- package/dist/sdk/models/operations/index.js +0 -92
- package/dist/sdk/models/operations/ingest.d.ts +0 -26
- package/dist/sdk/models/operations/ingest.js +0 -99
- package/dist/sdk/models/operations/issueinvoice.d.ts +0 -24
- package/dist/sdk/models/operations/issueinvoice.js +0 -91
- package/dist/sdk/models/operations/listbackfills.d.ts +0 -25
- package/dist/sdk/models/operations/listbackfills.js +0 -95
- package/dist/sdk/models/operations/listbalancetransactions.d.ts +0 -30
- package/dist/sdk/models/operations/listbalancetransactions.js +0 -115
- package/dist/sdk/models/operations/listcoupons.d.ts +0 -27
- package/dist/sdk/models/operations/listcoupons.js +0 -103
- package/dist/sdk/models/operations/listcouponsubscriptions.d.ts +0 -26
- package/dist/sdk/models/operations/listcouponsubscriptions.js +0 -99
- package/dist/sdk/models/operations/listcreditnotes.d.ts +0 -25
- package/dist/sdk/models/operations/listcreditnotes.js +0 -95
- package/dist/sdk/models/operations/listcustomers.d.ts +0 -29
- package/dist/sdk/models/operations/listcustomers.js +0 -111
- package/dist/sdk/models/operations/listinvoices.d.ts +0 -62
- package/dist/sdk/models/operations/listinvoices.js +0 -189
- package/dist/sdk/models/operations/listitems.d.ts +0 -25
- package/dist/sdk/models/operations/listitems.js +0 -95
- package/dist/sdk/models/operations/listmetrics.d.ts +0 -29
- package/dist/sdk/models/operations/listmetrics.js +0 -111
- package/dist/sdk/models/operations/listplans.d.ts +0 -41
- package/dist/sdk/models/operations/listplans.js +0 -124
- package/dist/sdk/models/operations/listprices.d.ts +0 -25
- package/dist/sdk/models/operations/listprices.js +0 -95
- package/dist/sdk/models/operations/listsubscriptions.d.ts +0 -37
- package/dist/sdk/models/operations/listsubscriptions.js +0 -129
- package/dist/sdk/models/operations/markinvoiceaspaid.d.ts +0 -25
- package/dist/sdk/models/operations/markinvoiceaspaid.js +0 -95
- package/dist/sdk/models/operations/ping.d.ts +0 -21
- package/dist/sdk/models/operations/ping.js +0 -79
- package/dist/sdk/models/operations/revertbackfill.d.ts +0 -24
- package/dist/sdk/models/operations/revertbackfill.js +0 -91
- package/dist/sdk/models/operations/scheduleplanchange.d.ts +0 -25
- package/dist/sdk/models/operations/scheduleplanchange.js +0 -95
- package/dist/sdk/models/operations/searchevents.d.ts +0 -30
- package/dist/sdk/models/operations/searchevents.js +0 -115
- package/dist/sdk/models/operations/triggerphase.d.ts +0 -25
- package/dist/sdk/models/operations/triggerphase.js +0 -95
- package/dist/sdk/models/operations/unschedulecancellation.d.ts +0 -24
- package/dist/sdk/models/operations/unschedulecancellation.js +0 -91
- package/dist/sdk/models/operations/unschedulefixedfeequantity.d.ts +0 -25
- package/dist/sdk/models/operations/unschedulefixedfeequantity.js +0 -95
- package/dist/sdk/models/operations/unscheduleplanchange.d.ts +0 -24
- package/dist/sdk/models/operations/unscheduleplanchange.js +0 -91
- package/dist/sdk/models/operations/updatecustomer.d.ts +0 -25
- package/dist/sdk/models/operations/updatecustomer.js +0 -95
- package/dist/sdk/models/operations/updatecustomerexternalid.d.ts +0 -25
- package/dist/sdk/models/operations/updatecustomerexternalid.js +0 -95
- package/dist/sdk/models/operations/updatefixedfeequantity.d.ts +0 -25
- package/dist/sdk/models/operations/updatefixedfeequantity.js +0 -95
- package/dist/sdk/models/operations/updateplan.d.ts +0 -25
- package/dist/sdk/models/operations/updateplan.js +0 -95
- package/dist/sdk/models/operations/updateplanexternal.d.ts +0 -25
- package/dist/sdk/models/operations/updateplanexternal.js +0 -95
- package/dist/sdk/models/operations/voidinvoice.d.ts +0 -24
- package/dist/sdk/models/operations/voidinvoice.js +0 -91
- package/dist/sdk/models/shared/accountingprovider.d.ts +0 -9
- package/dist/sdk/models/shared/accountingprovider.js +0 -55
- package/dist/sdk/models/shared/accountingproviderconfig.d.ts +0 -5
- package/dist/sdk/models/shared/accountingproviderconfig.js +0 -50
- package/dist/sdk/models/shared/accountingsyncconfiguration.d.ts +0 -6
- package/dist/sdk/models/shared/accountingsyncconfiguration.js +0 -52
- package/dist/sdk/models/shared/addeditpriceintervalparams.d.ts +0 -13
- package/dist/sdk/models/shared/addeditpriceintervalparams.js +0 -54
- package/dist/sdk/models/shared/addpriceintervalparams.d.ts +0 -40
- package/dist/sdk/models/shared/addpriceintervalparams.js +0 -87
- package/dist/sdk/models/shared/address.d.ts +0 -9
- package/dist/sdk/models/shared/address.js +0 -70
- package/dist/sdk/models/shared/addressinput.d.ts +0 -9
- package/dist/sdk/models/shared/addressinput.js +0 -70
- package/dist/sdk/models/shared/aggregatedcost.d.ts +0 -15
- package/dist/sdk/models/shared/aggregatedcost.js +0 -75
- package/dist/sdk/models/shared/amendedevent.d.ts +0 -28
- package/dist/sdk/models/shared/amendedevent.js +0 -81
- package/dist/sdk/models/shared/amendedusage.d.ts +0 -11
- package/dist/sdk/models/shared/amendedusage.js +0 -50
- package/dist/sdk/models/shared/amendeventresult.d.ts +0 -7
- package/dist/sdk/models/shared/amendeventresult.js +0 -45
- package/dist/sdk/models/shared/autocollection.d.ts +0 -15
- package/dist/sdk/models/shared/autocollection.js +0 -63
- package/dist/sdk/models/shared/backfill.d.ts +0 -27
- package/dist/sdk/models/shared/backfill.js +0 -104
- package/dist/sdk/models/shared/backfills.d.ts +0 -7
- package/dist/sdk/models/shared/backfills.js +0 -54
- package/dist/sdk/models/shared/backfillstatus.d.ts +0 -9
- package/dist/sdk/models/shared/backfillstatus.js +0 -16
- package/dist/sdk/models/shared/billablemetric.d.ts +0 -27
- package/dist/sdk/models/shared/billablemetric.js +0 -84
- package/dist/sdk/models/shared/billablemetrics.d.ts +0 -7
- package/dist/sdk/models/shared/billablemetrics.js +0 -54
- package/dist/sdk/models/shared/billingcyclealignment.d.ts +0 -8
- package/dist/sdk/models/shared/billingcyclealignment.js +0 -15
- package/dist/sdk/models/shared/cancelsubscriptionparams.d.ts +0 -19
- package/dist/sdk/models/shared/cancelsubscriptionparams.js +0 -63
- package/dist/sdk/models/shared/changeoption.d.ts +0 -5
- package/dist/sdk/models/shared/changeoption.js +0 -12
- package/dist/sdk/models/shared/coupon.d.ts +0 -40
- package/dist/sdk/models/shared/coupon.js +0 -98
- package/dist/sdk/models/shared/couponredemption.d.ts +0 -6
- package/dist/sdk/models/shared/couponredemption.js +0 -63
- package/dist/sdk/models/shared/coupons.d.ts +0 -7
- package/dist/sdk/models/shared/coupons.js +0 -54
- package/dist/sdk/models/shared/createinvoicelineitemparams.d.ts +0 -28
- package/dist/sdk/models/shared/createinvoicelineitemparams.js +0 -81
- package/dist/sdk/models/shared/createoneoffinvoiceparams.d.ts +0 -33
- package/dist/sdk/models/shared/createoneoffinvoiceparams.js +0 -86
- package/dist/sdk/models/shared/creditledgerentries.d.ts +0 -6
- package/dist/sdk/models/shared/creditledgerentries.js +0 -52
- package/dist/sdk/models/shared/creditnote.d.ts +0 -83
- package/dist/sdk/models/shared/creditnote.js +0 -171
- package/dist/sdk/models/shared/creditnotelineitem.d.ts +0 -40
- package/dist/sdk/models/shared/creditnotelineitem.js +0 -100
- package/dist/sdk/models/shared/creditnoteminified.d.ts +0 -7
- package/dist/sdk/models/shared/creditnoteminified.js +0 -45
- package/dist/sdk/models/shared/creditnotes.d.ts +0 -7
- package/dist/sdk/models/shared/creditnotes.js +0 -54
- package/dist/sdk/models/shared/creditnotesublineitem.d.ts +0 -6
- package/dist/sdk/models/shared/creditnotesublineitem.js +0 -55
- package/dist/sdk/models/shared/creditnotesummary.d.ts +0 -12
- package/dist/sdk/models/shared/creditnotesummary.js +0 -74
- package/dist/sdk/models/shared/customer.d.ts +0 -76
- package/dist/sdk/models/shared/customer.js +0 -182
- package/dist/sdk/models/shared/customerbalancetransaction.d.ts +0 -42
- package/dist/sdk/models/shared/customerbalancetransaction.js +0 -109
- package/dist/sdk/models/shared/customerbalancetransactions.d.ts +0 -7
- package/dist/sdk/models/shared/customerbalancetransactions.js +0 -54
- package/dist/sdk/models/shared/customercosts.d.ts +0 -5
- package/dist/sdk/models/shared/customercosts.js +0 -47
- package/dist/sdk/models/shared/customercreditbalance.d.ts +0 -7
- package/dist/sdk/models/shared/customercreditbalance.js +0 -64
- package/dist/sdk/models/shared/customercreditbalances.d.ts +0 -7
- package/dist/sdk/models/shared/customercreditbalances.js +0 -54
- package/dist/sdk/models/shared/customerminified.d.ts +0 -5
- package/dist/sdk/models/shared/customerminified.js +0 -50
- package/dist/sdk/models/shared/customers.d.ts +0 -7
- package/dist/sdk/models/shared/customers.js +0 -54
- package/dist/sdk/models/shared/customertaxid.d.ts +0 -6
- package/dist/sdk/models/shared/customertaxid.js +0 -55
- package/dist/sdk/models/shared/debug.d.ts +0 -8
- package/dist/sdk/models/shared/debug.js +0 -53
- package/dist/sdk/models/shared/deletecustomerresponse.d.ts +0 -3
- package/dist/sdk/models/shared/deletecustomerresponse.js +0 -30
- package/dist/sdk/models/shared/deprecatedeventresult.d.ts +0 -7
- package/dist/sdk/models/shared/deprecatedeventresult.js +0 -45
- package/dist/sdk/models/shared/discount.d.ts +0 -33
- package/dist/sdk/models/shared/discount.js +0 -80
- package/dist/sdk/models/shared/editcustomer.d.ts +0 -72
- package/dist/sdk/models/shared/editcustomer.js +0 -151
- package/dist/sdk/models/shared/editplan.d.ts +0 -10
- package/dist/sdk/models/shared/editplan.js +0 -59
- package/dist/sdk/models/shared/editpriceintervalparams.d.ts +0 -20
- package/dist/sdk/models/shared/editpriceintervalparams.js +0 -62
- package/dist/sdk/models/shared/event.d.ts +0 -39
- package/dist/sdk/models/shared/event.js +0 -93
- package/dist/sdk/models/shared/events.d.ts +0 -7
- package/dist/sdk/models/shared/events.js +0 -54
- package/dist/sdk/models/shared/eventsearchcriteria.d.ts +0 -11
- package/dist/sdk/models/shared/eventsearchcriteria.js +0 -50
- package/dist/sdk/models/shared/fixedfeequantitychange.d.ts +0 -25
- package/dist/sdk/models/shared/fixedfeequantitychange.js +0 -75
- package/dist/sdk/models/shared/fixedfeequantityscheduleentry.d.ts +0 -7
- package/dist/sdk/models/shared/fixedfeequantityscheduleentry.js +0 -68
- package/dist/sdk/models/shared/fixedfeequantitytransition.d.ts +0 -6
- package/dist/sdk/models/shared/fixedfeequantitytransition.js +0 -59
- package/dist/sdk/models/shared/index.d.ts +0 -109
- package/dist/sdk/models/shared/index.js +0 -128
- package/dist/sdk/models/shared/ingestevent.d.ts +0 -32
- package/dist/sdk/models/shared/ingestevent.js +0 -86
- package/dist/sdk/models/shared/ingestionresponse.d.ts +0 -13
- package/dist/sdk/models/shared/ingestionresponse.js +0 -54
- package/dist/sdk/models/shared/ingestrequestbody.d.ts +0 -5
- package/dist/sdk/models/shared/ingestrequestbody.js +0 -47
- package/dist/sdk/models/shared/invoice.d.ts +0 -138
- package/dist/sdk/models/shared/invoice.js +0 -329
- package/dist/sdk/models/shared/invoicelineitem.d.ts +0 -49
- package/dist/sdk/models/shared/invoicelineitem.js +0 -134
- package/dist/sdk/models/shared/invoicelineitemparams.d.ts +0 -26
- package/dist/sdk/models/shared/invoicelineitemparams.js +0 -90
- package/dist/sdk/models/shared/invoiceminified.d.ts +0 -7
- package/dist/sdk/models/shared/invoiceminified.js +0 -45
- package/dist/sdk/models/shared/invoices.d.ts +0 -7
- package/dist/sdk/models/shared/invoices.js +0 -54
- package/dist/sdk/models/shared/item.d.ts +0 -14
- package/dist/sdk/models/shared/item.js +0 -72
- package/dist/sdk/models/shared/itemexternalconnection.d.ts +0 -5
- package/dist/sdk/models/shared/itemexternalconnection.js +0 -50
- package/dist/sdk/models/shared/items.d.ts +0 -7
- package/dist/sdk/models/shared/items.js +0 -54
- package/dist/sdk/models/shared/markaspaidrequestparams.d.ts +0 -16
- package/dist/sdk/models/shared/markaspaidrequestparams.js +0 -61
- package/dist/sdk/models/shared/maximum.d.ts +0 -11
- package/dist/sdk/models/shared/maximum.js +0 -50
- package/dist/sdk/models/shared/maximuminterval.d.ts +0 -23
- package/dist/sdk/models/shared/maximuminterval.js +0 -73
- package/dist/sdk/models/shared/minimum.d.ts +0 -11
- package/dist/sdk/models/shared/minimum.js +0 -50
- package/dist/sdk/models/shared/minimuminterval.d.ts +0 -23
- package/dist/sdk/models/shared/minimuminterval.js +0 -73
- package/dist/sdk/models/shared/newaccountingsyncconfiguration.d.ts +0 -6
- package/dist/sdk/models/shared/newaccountingsyncconfiguration.js +0 -52
- package/dist/sdk/models/shared/newbackfill.d.ts +0 -27
- package/dist/sdk/models/shared/newbackfill.js +0 -82
- package/dist/sdk/models/shared/newbillablemetric.d.ts +0 -28
- package/dist/sdk/models/shared/newbillablemetric.js +0 -77
- package/dist/sdk/models/shared/newcoupon.d.ts +0 -18
- package/dist/sdk/models/shared/newcoupon.js +0 -69
- package/dist/sdk/models/shared/newcustomer.d.ts +0 -68
- package/dist/sdk/models/shared/newcustomer.js +0 -152
- package/dist/sdk/models/shared/newcustomerbalancetransaction.d.ts +0 -13
- package/dist/sdk/models/shared/newcustomerbalancetransaction.js +0 -60
- package/dist/sdk/models/shared/newplan.d.ts +0 -26
- package/dist/sdk/models/shared/newplan.js +0 -93
- package/dist/sdk/models/shared/newreportingconfiguration.d.ts +0 -4
- package/dist/sdk/models/shared/newreportingconfiguration.js +0 -45
- package/dist/sdk/models/shared/newsubscription.d.ts +0 -54
- package/dist/sdk/models/shared/newsubscription.js +0 -187
- package/dist/sdk/models/shared/paginationmetadata.d.ts +0 -5
- package/dist/sdk/models/shared/paginationmetadata.js +0 -50
- package/dist/sdk/models/shared/perpricecost.d.ts +0 -224
- package/dist/sdk/models/shared/perpricecost.js +0 -67
- package/dist/sdk/models/shared/phaseoverride.d.ts +0 -17
- package/dist/sdk/models/shared/phaseoverride.js +0 -62
- package/dist/sdk/models/shared/pingresponse.d.ts +0 -4
- package/dist/sdk/models/shared/pingresponse.js +0 -45
- package/dist/sdk/models/shared/plan.d.ts +0 -66
- package/dist/sdk/models/shared/plan.js +0 -188
- package/dist/sdk/models/shared/planminified.d.ts +0 -9
- package/dist/sdk/models/shared/planminified.js +0 -55
- package/dist/sdk/models/shared/planphase.d.ts +0 -28
- package/dist/sdk/models/shared/planphase.js +0 -106
- package/dist/sdk/models/shared/plans.d.ts +0 -7
- package/dist/sdk/models/shared/plans.js +0 -54
- package/dist/sdk/models/shared/pricegroup.d.ts +0 -17
- package/dist/sdk/models/shared/pricegroup.js +0 -65
- package/dist/sdk/models/shared/priceinterval.d.ts +0 -239
- package/dist/sdk/models/shared/priceinterval.js +0 -104
- package/dist/sdk/models/shared/priceintervalfixedfeequantitytransitionparams.d.ts +0 -11
- package/dist/sdk/models/shared/priceintervalfixedfeequantitytransitionparams.js +0 -54
- package/dist/sdk/models/shared/prices.d.ts +0 -6
- package/dist/sdk/models/shared/prices.js +0 -52
- package/dist/sdk/models/shared/product.d.ts +0 -6
- package/dist/sdk/models/shared/product.js +0 -59
- package/dist/sdk/models/shared/reportingconfiguration.d.ts +0 -4
- package/dist/sdk/models/shared/reportingconfiguration.js +0 -45
- package/dist/sdk/models/shared/security.d.ts +0 -4
- package/dist/sdk/models/shared/security.js +0 -45
- package/dist/sdk/models/shared/subscription.d.ts +0 -128
- package/dist/sdk/models/shared/subscription.js +0 -226
- package/dist/sdk/models/shared/subscriptioncosts.d.ts +0 -5
- package/dist/sdk/models/shared/subscriptioncosts.js +0 -47
- package/dist/sdk/models/shared/subscriptionminified.d.ts +0 -4
- package/dist/sdk/models/shared/subscriptionminified.js +0 -45
- package/dist/sdk/models/shared/subscriptionplanchange.d.ts +0 -59
- package/dist/sdk/models/shared/subscriptionplanchange.js +0 -126
- package/dist/sdk/models/shared/subscriptions.d.ts +0 -7
- package/dist/sdk/models/shared/subscriptions.js +0 -54
- package/dist/sdk/models/shared/subscriptionscheduleitem.d.ts +0 -7
- package/dist/sdk/models/shared/subscriptionscheduleitem.js +0 -65
- package/dist/sdk/models/shared/subscriptionscheduleitems.d.ts +0 -7
- package/dist/sdk/models/shared/subscriptionscheduleitems.js +0 -54
- package/dist/sdk/models/shared/subscriptiontrialinfo.d.ts +0 -4
- package/dist/sdk/models/shared/subscriptiontrialinfo.js +0 -49
- package/dist/sdk/models/shared/taxamount.d.ts +0 -15
- package/dist/sdk/models/shared/taxamount.js +0 -55
- package/dist/sdk/models/shared/trialconfig.d.ts +0 -8
- package/dist/sdk/models/shared/trialconfig.js +0 -54
- package/dist/sdk/models/shared/triggersubscriptionphaseparams.d.ts +0 -8
- package/dist/sdk/models/shared/triggersubscriptionphaseparams.js +0 -51
- package/dist/sdk/models/shared/unschedulefixedfeequantitychangeparams.d.ts +0 -7
- package/dist/sdk/models/shared/unschedulefixedfeequantitychangeparams.js +0 -45
- package/dist/sdk/models/shared/upcominginvoice.d.ts +0 -130
- package/dist/sdk/models/shared/upcominginvoice.js +0 -321
- package/dist/sdk/models/shared/updateevent.d.ts +0 -28
- package/dist/sdk/models/shared/updateevent.js +0 -81
- package/dist/sdk/models/shared/validationerror.d.ts +0 -11
- package/dist/sdk/models/shared/validationerror.js +0 -50
- package/dist/sdk/plan.d.ts +0 -90
- package/dist/sdk/plan.js +0 -764
- package/dist/sdk/price.d.ts +0 -246
- package/dist/sdk/price.js +0 -715
- package/dist/sdk/priceinterval.d.ts +0 -66
- package/dist/sdk/priceinterval.js +0 -263
- package/dist/sdk/sdk.d.ts +0 -389
- package/dist/sdk/sdk.js +0 -93
- package/dist/sdk/subscription.d.ts +0 -769
- package/dist/sdk/subscription.js +0 -2116
- package/dist/sdk/types/index.d.ts +0 -1
- package/dist/sdk/types/index.js +0 -20
- package/dist/sdk/types/rfcdate.d.ts +0 -9
- package/dist/sdk/types/rfcdate.js +0 -59
- package/docs/models/errors/fivehundrederror.md +0 -12
- package/docs/models/errors/fivehundrederrorheaders.md +0 -7
- package/docs/models/errors/fourhundredandoneerror.md +0 -12
- package/docs/models/errors/fourhundredandoneerrorheaders.md +0 -7
- package/docs/models/errors/fourhundredandtwentynineerror.md +0 -12
- package/docs/models/errors/fourhundredandtwentynineerrorheaders.md +0 -7
- package/docs/models/operations/addeditpriceintervalsrequest.md +0 -9
- package/docs/models/operations/addeditpriceintervalsresponse.md +0 -11
- package/docs/models/operations/amendeventrequest.md +0 -9
- package/docs/models/operations/amendeventresponse.md +0 -11
- package/docs/models/operations/amendusageexternalcustomeridrequest.md +0 -11
- package/docs/models/operations/amendusageexternalcustomeridresponse.md +0 -11
- package/docs/models/operations/amendusagerequest.md +0 -11
- package/docs/models/operations/amendusageresponse.md +0 -11
- package/docs/models/operations/archivecouponrequest.md +0 -8
- package/docs/models/operations/archivecouponresponse.md +0 -11
- package/docs/models/operations/cancelsubscriptionrequest.md +0 -9
- package/docs/models/operations/cancelsubscriptionresponse.md +0 -11
- package/docs/models/operations/closebackfillrequest.md +0 -8
- package/docs/models/operations/closebackfillresponse.md +0 -11
- package/docs/models/operations/createbackfillresponse.md +0 -11
- package/docs/models/operations/createcouponresponse.md +0 -11
- package/docs/models/operations/createcustomerbalancetransactionrequest.md +0 -9
- package/docs/models/operations/createcustomerbalancetransactionresponse.md +0 -11
- package/docs/models/operations/createcustomerresponse.md +0 -11
- package/docs/models/operations/createinvoicelineitemresponse.md +0 -11
- package/docs/models/operations/createinvoiceresponse.md +0 -11
- package/docs/models/operations/createledgerentryexternalidrequest.md +0 -9
- package/docs/models/operations/createledgerentryexternalidresponse.md +0 -11
- package/docs/models/operations/createledgerentryrequest.md +0 -9
- package/docs/models/operations/createledgerentryresponse.md +0 -11
- package/docs/models/operations/createmetricresponse.md +0 -11
- package/docs/models/operations/createplanresponse.md +0 -11
- package/docs/models/operations/createpriceresponse.md +0 -11
- package/docs/models/operations/createsubscriptionresponse.md +0 -11
- package/docs/models/operations/deletecustomerrequest.md +0 -8
- package/docs/models/operations/deletecustomerresponse.md +0 -11
- package/docs/models/operations/deprecateeventrequest.md +0 -8
- package/docs/models/operations/deprecateeventresponse.md +0 -11
- package/docs/models/operations/fetchbackfillrequest.md +0 -8
- package/docs/models/operations/fetchbackfillresponse.md +0 -11
- package/docs/models/operations/fetchcouponrequest.md +0 -8
- package/docs/models/operations/fetchcouponresponse.md +0 -11
- package/docs/models/operations/fetchcreditnoterequest.md +0 -8
- package/docs/models/operations/fetchcreditnoteresponse.md +0 -11
- package/docs/models/operations/fetchcustomercostsexternalidrequest.md +0 -12
- package/docs/models/operations/fetchcustomercostsexternalidresponse.md +0 -11
- package/docs/models/operations/fetchcustomercostsexternalidviewmodeviewmode.md +0 -11
- package/docs/models/operations/fetchcustomercostsrequest.md +0 -12
- package/docs/models/operations/fetchcustomercostsresponse.md +0 -11
- package/docs/models/operations/fetchcustomercostsviewmodeviewmode.md +0 -11
- package/docs/models/operations/fetchcustomercreditsexternalidrequest.md +0 -10
- package/docs/models/operations/fetchcustomercreditsexternalidresponse.md +0 -11
- package/docs/models/operations/fetchcustomercreditsledgerentrystatusentrystatus.md +0 -9
- package/docs/models/operations/fetchcustomercreditsledgerentrytypeentrytype.md +0 -14
- package/docs/models/operations/fetchcustomercreditsledgerexternalidentrystatusentrystatus.md +0 -9
- package/docs/models/operations/fetchcustomercreditsledgerexternalidentrytypeentrytype.md +0 -14
- package/docs/models/operations/fetchcustomercreditsledgerexternalidrequest.md +0 -18
- package/docs/models/operations/fetchcustomercreditsledgerexternalidresponse.md +0 -11
- package/docs/models/operations/fetchcustomercreditsledgerrequest.md +0 -18
- package/docs/models/operations/fetchcustomercreditsledgerresponse.md +0 -11
- package/docs/models/operations/fetchcustomercreditsrequest.md +0 -10
- package/docs/models/operations/fetchcustomercreditsresponse.md +0 -11
- package/docs/models/operations/fetchcustomerexternalidrequest.md +0 -8
- package/docs/models/operations/fetchcustomerexternalidresponse.md +0 -11
- package/docs/models/operations/fetchcustomerrequest.md +0 -8
- package/docs/models/operations/fetchcustomerresponse.md +0 -11
- package/docs/models/operations/fetchinvoicerequest.md +0 -8
- package/docs/models/operations/fetchinvoiceresponse.md +0 -11
- package/docs/models/operations/fetchitemrequest.md +0 -8
- package/docs/models/operations/fetchitemresponse.md +0 -11
- package/docs/models/operations/fetchmetricrequest.md +0 -8
- package/docs/models/operations/fetchmetricresponse.md +0 -11
- package/docs/models/operations/fetchplanexternalidrequest.md +0 -8
- package/docs/models/operations/fetchplanexternalidresponse.md +0 -11
- package/docs/models/operations/fetchplanrequest.md +0 -8
- package/docs/models/operations/fetchplanresponse.md +0 -11
- package/docs/models/operations/fetchpriceexternalidrequest.md +0 -8
- package/docs/models/operations/fetchpriceexternalidresponse.md +0 -11
- package/docs/models/operations/fetchpricerequest.md +0 -8
- package/docs/models/operations/fetchpriceresponse.md +0 -11
- package/docs/models/operations/fetchsubscriptioncostsrequest.md +0 -12
- package/docs/models/operations/fetchsubscriptioncostsresponse.md +0 -11
- package/docs/models/operations/fetchsubscriptioncostsviewmodeviewmode.md +0 -11
- package/docs/models/operations/fetchsubscriptionrequest.md +0 -8
- package/docs/models/operations/fetchsubscriptionresponse.md +0 -11
- package/docs/models/operations/fetchsubscriptionschedulerequest.md +0 -14
- package/docs/models/operations/fetchsubscriptionscheduleresponse.md +0 -11
- package/docs/models/operations/fetchsubscriptionusagegranularitygranularity.md +0 -10
- package/docs/models/operations/fetchsubscriptionusagerequest.md +0 -20
- package/docs/models/operations/fetchsubscriptionusageresponse.md +0 -11
- package/docs/models/operations/fetchsubscriptionusageviewmodeviewmode.md +0 -11
- package/docs/models/operations/fetchupcominginvoicerequest.md +0 -8
- package/docs/models/operations/fetchupcominginvoiceresponse.md +0 -11
- package/docs/models/operations/ingestrequest.md +0 -10
- package/docs/models/operations/ingestresponse.md +0 -11
- package/docs/models/operations/issueinvoicerequest.md +0 -8
- package/docs/models/operations/issueinvoiceresponse.md +0 -11
- package/docs/models/operations/listbackfillsrequest.md +0 -9
- package/docs/models/operations/listbackfillsresponse.md +0 -11
- package/docs/models/operations/listbalancetransactionsrequest.md +0 -14
- package/docs/models/operations/listbalancetransactionsresponse.md +0 -11
- package/docs/models/operations/listcouponsrequest.md +0 -11
- package/docs/models/operations/listcouponsresponse.md +0 -11
- package/docs/models/operations/listcouponsubscriptionsrequest.md +0 -10
- package/docs/models/operations/listcouponsubscriptionsresponse.md +0 -11
- package/docs/models/operations/listcreditnotesrequest.md +0 -9
- package/docs/models/operations/listcreditnotesresponse.md +0 -11
- package/docs/models/operations/listcustomersrequest.md +0 -13
- package/docs/models/operations/listcustomersresponse.md +0 -11
- package/docs/models/operations/listinvoicesdatetypedatetype.md +0 -9
- package/docs/models/operations/listinvoicesrequest.md +0 -27
- package/docs/models/operations/listinvoicesresponse.md +0 -11
- package/docs/models/operations/listinvoicesstatus.md +0 -12
- package/docs/models/operations/listinvoicesstatusstatus.md +0 -12
- package/docs/models/operations/listitemsrequest.md +0 -9
- package/docs/models/operations/listitemsresponse.md +0 -11
- package/docs/models/operations/listmetricsrequest.md +0 -13
- package/docs/models/operations/listmetricsresponse.md +0 -11
- package/docs/models/operations/listplansrequest.md +0 -14
- package/docs/models/operations/listplansresponse.md +0 -11
- package/docs/models/operations/listplansstatusstatus.md +0 -12
- package/docs/models/operations/listpricesrequest.md +0 -9
- package/docs/models/operations/listpricesresponse.md +0 -11
- package/docs/models/operations/listsubscriptionsrequest.md +0 -16
- package/docs/models/operations/listsubscriptionsresponse.md +0 -11
- package/docs/models/operations/listsubscriptionsstatusstatus.md +0 -10
- package/docs/models/operations/markinvoiceaspaidrequest.md +0 -9
- package/docs/models/operations/markinvoiceaspaidresponse.md +0 -11
- package/docs/models/operations/pingresponse.md +0 -11
- package/docs/models/operations/revertbackfillrequest.md +0 -8
- package/docs/models/operations/revertbackfillresponse.md +0 -11
- package/docs/models/operations/scheduleplanchangerequest.md +0 -9
- package/docs/models/operations/scheduleplanchangeresponse.md +0 -11
- package/docs/models/operations/searcheventsrequest.md +0 -14
- package/docs/models/operations/searcheventsresponse.md +0 -11
- package/docs/models/operations/triggerphaserequest.md +0 -9
- package/docs/models/operations/triggerphaseresponse.md +0 -11
- package/docs/models/operations/unschedulecancellationrequest.md +0 -8
- package/docs/models/operations/unschedulecancellationresponse.md +0 -11
- package/docs/models/operations/unschedulefixedfeequantityrequest.md +0 -9
- package/docs/models/operations/unschedulefixedfeequantityresponse.md +0 -11
- package/docs/models/operations/unscheduleplanchangerequest.md +0 -8
- package/docs/models/operations/unscheduleplanchangeresponse.md +0 -11
- package/docs/models/operations/updatecustomerexternalidrequest.md +0 -9
- package/docs/models/operations/updatecustomerexternalidresponse.md +0 -11
- package/docs/models/operations/updatecustomerrequest.md +0 -9
- package/docs/models/operations/updatecustomerresponse.md +0 -11
- package/docs/models/operations/updatefixedfeequantityrequest.md +0 -9
- package/docs/models/operations/updatefixedfeequantityresponse.md +0 -11
- package/docs/models/operations/updateplanexternalrequest.md +0 -9
- package/docs/models/operations/updateplanexternalresponse.md +0 -11
- package/docs/models/operations/updateplanrequest.md +0 -9
- package/docs/models/operations/updateplanresponse.md +0 -11
- package/docs/models/operations/voidinvoicerequest.md +0 -8
- package/docs/models/operations/voidinvoiceresponse.md +0 -11
- package/docs/models/shared/accountingprovider.md +0 -9
- package/docs/models/shared/accountingproviderconfig.md +0 -9
- package/docs/models/shared/accountingproviderprovidertype.md +0 -9
- package/docs/models/shared/accountingsyncconfiguration.md +0 -9
- package/docs/models/shared/addeditpriceintervalparams.md +0 -9
- package/docs/models/shared/addpriceintervalparams.md +0 -16
- package/docs/models/shared/address.md +0 -13
- package/docs/models/shared/addressinput.md +0 -13
- package/docs/models/shared/aggregatedcost.md +0 -12
- package/docs/models/shared/amendedevent.md +0 -12
- package/docs/models/shared/amendedeventproperties.md +0 -9
- package/docs/models/shared/amendedusage.md +0 -9
- package/docs/models/shared/amendeventresult.md +0 -8
- package/docs/models/shared/autocollection.md +0 -10
- package/docs/models/shared/backfill.md +0 -17
- package/docs/models/shared/backfills.md +0 -9
- package/docs/models/shared/backfillstatus.md +0 -13
- package/docs/models/shared/billablemetric.md +0 -16
- package/docs/models/shared/billablemetrics.md +0 -9
- package/docs/models/shared/billablemetricstatus.md +0 -10
- package/docs/models/shared/billingcyclealignment.md +0 -12
- package/docs/models/shared/cancelsubscriptionparams.md +0 -9
- package/docs/models/shared/cancelsubscriptionparamscanceloption.md +0 -12
- package/docs/models/shared/changeoption.md +0 -10
- package/docs/models/shared/coupon.md +0 -21
- package/docs/models/shared/coupondiscount.md +0 -7
- package/docs/models/shared/couponredemption.md +0 -10
- package/docs/models/shared/coupons.md +0 -9
- package/docs/models/shared/createinvoicelineitemparams.md +0 -13
- package/docs/models/shared/createoneoffinvoiceparams.md +0 -15
- package/docs/models/shared/creditledgerentries.md +0 -9
- package/docs/models/shared/creditnote.md +0 -26
- package/docs/models/shared/creditnotediscounts.md +0 -7
- package/docs/models/shared/creditnotelineitem.md +0 -15
- package/docs/models/shared/creditnotelineitemdiscounts.md +0 -7
- package/docs/models/shared/creditnotelineitemtaxamounts.md +0 -7
- package/docs/models/shared/creditnotemaximumamountadjustment.md +0 -9
- package/docs/models/shared/creditnoteminified.md +0 -8
- package/docs/models/shared/creditnotereason.md +0 -11
- package/docs/models/shared/creditnotes.md +0 -9
- package/docs/models/shared/creditnotesublineitem.md +0 -10
- package/docs/models/shared/creditnotesummary.md +0 -13
- package/docs/models/shared/creditnotetype.md +0 -9
- package/docs/models/shared/customer.md +0 -42
- package/docs/models/shared/customerbalancetransaction.md +0 -17
- package/docs/models/shared/customerbalancetransactionaction.md +0 -10
- package/docs/models/shared/customerbalancetransactions.md +0 -9
- package/docs/models/shared/customerbalancetransactiontype.md +0 -9
- package/docs/models/shared/customercosts.md +0 -8
- package/docs/models/shared/customercreditbalance.md +0 -11
- package/docs/models/shared/customercreditbalances.md +0 -9
- package/docs/models/shared/customerminified.md +0 -9
- package/docs/models/shared/customerpaymentprovider.md +0 -14
- package/docs/models/shared/customers.md +0 -9
- package/docs/models/shared/customertaxid.md +0 -10
- package/docs/models/shared/debug.md +0 -11
- package/docs/models/shared/deletecustomerresponse.md +0 -7
- package/docs/models/shared/deprecatedeventresult.md +0 -8
- package/docs/models/shared/discount.md +0 -15
- package/docs/models/shared/discountdiscounttype.md +0 -11
- package/docs/models/shared/editcustomer.md +0 -22
- package/docs/models/shared/editcustomermetadata.md +0 -9
- package/docs/models/shared/editcustomerpaymentprovider.md +0 -16
- package/docs/models/shared/editplan.md +0 -9
- package/docs/models/shared/editplanmetadata.md +0 -7
- package/docs/models/shared/editpriceintervalparams.md +0 -11
- package/docs/models/shared/event.md +0 -17
- package/docs/models/shared/eventproperties.md +0 -9
- package/docs/models/shared/events.md +0 -9
- package/docs/models/shared/eventsearchcriteria.md +0 -9
- package/docs/models/shared/fixedfeequantitychange.md +0 -11
- package/docs/models/shared/fixedfeequantitychangechangeoption.md +0 -12
- package/docs/models/shared/fixedfeequantityscheduleentry.md +0 -11
- package/docs/models/shared/fixedfeequantitytransition.md +0 -10
- package/docs/models/shared/ingestevent.md +0 -13
- package/docs/models/shared/ingesteventproperties.md +0 -9
- package/docs/models/shared/ingestionresponse.md +0 -9
- package/docs/models/shared/ingestrequestbody.md +0 -8
- package/docs/models/shared/invoice.md +0 -51
- package/docs/models/shared/invoicelineitem.md +0 -23
- package/docs/models/shared/invoicelineitemparams.md +0 -14
- package/docs/models/shared/invoicelineitemparamsmodeltype.md +0 -8
- package/docs/models/shared/invoicemetadata.md +0 -7
- package/docs/models/shared/invoiceminified.md +0 -8
- package/docs/models/shared/invoices.md +0 -9
- package/docs/models/shared/invoicestatus.md +0 -12
- package/docs/models/shared/item.md +0 -14
- package/docs/models/shared/itemexternalconnection.md +0 -9
- package/docs/models/shared/items.md +0 -9
- package/docs/models/shared/markaspaidrequestparams.md +0 -10
- package/docs/models/shared/maximum.md +0 -9
- package/docs/models/shared/maximuminterval.md +0 -12
- package/docs/models/shared/minimum.md +0 -9
- package/docs/models/shared/minimuminterval.md +0 -12
- package/docs/models/shared/newaccountingsyncconfiguration.md +0 -9
- package/docs/models/shared/newbackfill.md +0 -13
- package/docs/models/shared/newbillablemetric.md +0 -12
- package/docs/models/shared/newbillablemetricmetadata.md +0 -9
- package/docs/models/shared/newcoupon.md +0 -11
- package/docs/models/shared/newcoupondiscount.md +0 -7
- package/docs/models/shared/newcustomer.md +0 -23
- package/docs/models/shared/newcustomerbalancetransaction.md +0 -10
- package/docs/models/shared/newcustomerbalancetransactiontype.md +0 -9
- package/docs/models/shared/newcustomermetadata.md +0 -9
- package/docs/models/shared/newcustomerpaymentprovider.md +0 -14
- package/docs/models/shared/newplan.md +0 -14
- package/docs/models/shared/newplanmetadata.md +0 -7
- package/docs/models/shared/newplanprices.md +0 -7
- package/docs/models/shared/newreportingconfiguration.md +0 -8
- package/docs/models/shared/newsubscription.md +0 -31
- package/docs/models/shared/newsubscriptionexternalmarketplace.md +0 -10
- package/docs/models/shared/newsubscriptionmetadata.md +0 -7
- package/docs/models/shared/paginationmetadata.md +0 -9
- package/docs/models/shared/perpricecost.md +0 -12
- package/docs/models/shared/phaseoverride.md +0 -11
- package/docs/models/shared/pingresponse.md +0 -8
- package/docs/models/shared/plan.md +0 -33
- package/docs/models/shared/planmetadata.md +0 -7
- package/docs/models/shared/planminified.md +0 -10
- package/docs/models/shared/planphase.md +0 -18
- package/docs/models/shared/planphasedurationunit.md +0 -11
- package/docs/models/shared/plans.md +0 -9
- package/docs/models/shared/planstatus.md +0 -10
- package/docs/models/shared/pricegroup.md +0 -12
- package/docs/models/shared/priceinterval.md +0 -18
- package/docs/models/shared/priceintervalfixedfeequantitytransitionparams.md +0 -9
- package/docs/models/shared/prices.md +0 -9
- package/docs/models/shared/product.md +0 -10
- package/docs/models/shared/reportingconfiguration.md +0 -8
- package/docs/models/shared/security.md +0 -8
- package/docs/models/shared/subscription.md +0 -44
- package/docs/models/shared/subscriptioncosts.md +0 -8
- package/docs/models/shared/subscriptionmetadata.md +0 -9
- package/docs/models/shared/subscriptionminified.md +0 -8
- package/docs/models/shared/subscriptionplanchange.md +0 -23
- package/docs/models/shared/subscriptions.md +0 -9
- package/docs/models/shared/subscriptionscheduleitem.md +0 -10
- package/docs/models/shared/subscriptionscheduleitems.md +0 -9
- package/docs/models/shared/subscriptionstatus.md +0 -10
- package/docs/models/shared/subscriptiontrialinfo.md +0 -8
- package/docs/models/shared/taxamount.md +0 -10
- package/docs/models/shared/trialconfig.md +0 -9
- package/docs/models/shared/trialconfigtrialperiodunit.md +0 -8
- package/docs/models/shared/triggersubscriptionphaseparams.md +0 -8
- package/docs/models/shared/unschedulefixedfeequantitychangeparams.md +0 -8
- package/docs/models/shared/upcominginvoice.md +0 -46
- package/docs/models/shared/upcominginvoicemetadata.md +0 -7
- package/docs/models/shared/upcominginvoicestatus.md +0 -12
- package/docs/models/shared/updateevent.md +0 -12
- package/docs/models/shared/updateeventproperties.md +0 -9
- package/docs/models/shared/validationerror.md +0 -9
- package/docs/sdks/availability/README.md +0 -46
- package/docs/sdks/coupon/README.md +0 -235
- package/docs/sdks/credit/README.md +0 -565
- package/docs/sdks/creditnote/README.md +0 -94
- package/docs/sdks/customer/README.md +0 -1080
- package/docs/sdks/event/README.md +0 -674
- package/docs/sdks/invoice/README.md +0 -388
- package/docs/sdks/item/README.md +0 -92
- package/docs/sdks/metric/README.md +0 -136
- package/docs/sdks/orb/README.md +0 -21
- package/docs/sdks/plan/README.md +0 -298
- package/docs/sdks/price/README.md +0 -375
- package/docs/sdks/priceinterval/README.md +0 -137
- package/docs/sdks/subscription/README.md +0 -1306
- package/docs/types/rfcdate.md +0 -11
package/README.md
CHANGED
|
@@ -1,240 +1,244 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Orb TypeScript API Library
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
## SDK Installation
|
|
3
|
+
[](https://npmjs.org/package/orb-billing)
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
This library provides convenient access to the Orb REST API from server-side TypeScript or JavaScript.
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
npm add orb-billing
|
|
10
|
-
```
|
|
7
|
+
The API documentation can be found [here](https://www.withorb.com/https://docs.withorb.com/reference/api-reference).
|
|
11
8
|
|
|
12
|
-
|
|
9
|
+
## Installation
|
|
13
10
|
|
|
14
|
-
```
|
|
11
|
+
```sh
|
|
12
|
+
npm install --save orb-billing
|
|
13
|
+
# or
|
|
15
14
|
yarn add orb-billing
|
|
16
15
|
```
|
|
17
|
-
<!-- End SDK Installation -->
|
|
18
16
|
|
|
19
|
-
##
|
|
20
|
-
<!-- Start SDK Example Usage -->
|
|
21
|
-
```typescript
|
|
22
|
-
import { Orb } from "orb-billing";
|
|
17
|
+
## Usage
|
|
23
18
|
|
|
24
|
-
(
|
|
25
|
-
const sdk = new Orb({
|
|
26
|
-
security: {
|
|
27
|
-
apiKey: "",
|
|
28
|
-
},
|
|
29
|
-
});
|
|
19
|
+
The full API of this library can be found in [api.md](https://www.github.com/orbcorp/orb-node/blob/main/api.md).
|
|
30
20
|
|
|
31
|
-
|
|
21
|
+
```js
|
|
22
|
+
import Orb from 'orb-billing';
|
|
32
23
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
24
|
+
const orb = new Orb({
|
|
25
|
+
apiKey: 'My API Key', // defaults to process.env["ORB_API_KEY"]
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
async function main() {
|
|
29
|
+
const customer = await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' });
|
|
30
|
+
|
|
31
|
+
console.log(customer);
|
|
32
|
+
}
|
|
39
33
|
|
|
40
|
-
|
|
41
|
-
|
|
34
|
+
main();
|
|
35
|
+
```
|
|
42
36
|
|
|
43
|
-
|
|
44
|
-
returned response object will have a `next` method that can be called to pull down the next group of results. If the
|
|
45
|
-
return value of `next` is `null`, then there are no more pages to be fetched.
|
|
37
|
+
### Request & Response types
|
|
46
38
|
|
|
47
|
-
|
|
48
|
-
<!-- End Pagination -->
|
|
39
|
+
This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
|
|
49
40
|
|
|
50
41
|
```ts
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
const sdk = new Orb({
|
|
56
|
-
security: {
|
|
57
|
-
apiKeyAuth: "",
|
|
58
|
-
},
|
|
42
|
+
import Orb from 'orb-billing';
|
|
43
|
+
|
|
44
|
+
const orb = new Orb({
|
|
45
|
+
apiKey: 'My API Key', // defaults to process.env["ORB_API_KEY"]
|
|
59
46
|
});
|
|
60
47
|
|
|
61
|
-
async function
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
if (statusCode !== 200) {
|
|
71
|
-
throw new Error(`Unexpected status code sent from server: ${statusCode}`);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
// We capture the cursor for the next iteration but we also check if we
|
|
75
|
-
// received an empty page of results as a signal to stop making additional
|
|
76
|
-
// requests.
|
|
77
|
-
cursor = response.coupons?.paginationMetadata.nextCursor;
|
|
78
|
-
const page = response.coupons?.data;
|
|
79
|
-
if (!page?.length) {
|
|
80
|
-
break;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
// At this point we have a page of coupon entries that we can collect or
|
|
84
|
-
// iterate through as shown below.
|
|
85
|
-
page.forEach((coupon) => {
|
|
86
|
-
const { redemptionCode: code, timesRedeemed } = coupon;
|
|
87
|
-
console.log(`Coupon ${code} was redeemed ${timesRedeemed} times.`);
|
|
88
|
-
});
|
|
48
|
+
async function main() {
|
|
49
|
+
const params: Orb.CustomerCreateParams = { email: 'example-customer@withorb.com', name: 'My Customer' };
|
|
50
|
+
const customer: Orb.Customer = await orb.customers.create(params);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
main();
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
|
|
89
57
|
|
|
90
|
-
|
|
91
|
-
|
|
58
|
+
## Handling errors
|
|
59
|
+
|
|
60
|
+
When the library is unable to connect to the API,
|
|
61
|
+
or if the API returns a non-success status code (i.e., 4xx or 5xx response),
|
|
62
|
+
a subclass of `APIError` will be thrown:
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
async function main() {
|
|
66
|
+
const customer = await orb.customers
|
|
67
|
+
.create({ email: 'example-customer@withorb.com', name: 'My Customer' })
|
|
68
|
+
.catch((err) => {
|
|
69
|
+
if (err instanceof Orb.APIError) {
|
|
70
|
+
console.log(err.status); // 400
|
|
71
|
+
console.log(err.name); // BadRequestError
|
|
72
|
+
|
|
73
|
+
console.log(err.headers); // {server: 'nginx', ...}
|
|
74
|
+
} else {
|
|
75
|
+
throw err;
|
|
76
|
+
}
|
|
77
|
+
});
|
|
92
78
|
}
|
|
93
79
|
|
|
94
|
-
|
|
95
|
-
paginationDemo();
|
|
80
|
+
main();
|
|
96
81
|
```
|
|
97
82
|
|
|
98
|
-
|
|
99
|
-
## Available Resources and Operations
|
|
83
|
+
Error codes are as followed:
|
|
100
84
|
|
|
85
|
+
| Status Code | Error Type |
|
|
86
|
+
| ----------- | -------------------------- |
|
|
87
|
+
| 400 | `BadRequestError` |
|
|
88
|
+
| 401 | `AuthenticationError` |
|
|
89
|
+
| 403 | `PermissionDeniedError` |
|
|
90
|
+
| 404 | `NotFoundError` |
|
|
91
|
+
| 422 | `UnprocessableEntityError` |
|
|
92
|
+
| 429 | `RateLimitError` |
|
|
93
|
+
| >=500 | `InternalServerError` |
|
|
94
|
+
| N/A | `APIConnectionError` |
|
|
101
95
|
|
|
102
|
-
###
|
|
96
|
+
### Retries
|
|
103
97
|
|
|
104
|
-
|
|
98
|
+
Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
|
|
99
|
+
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
|
|
100
|
+
429 Rate Limit, and >=500 Internal errors will all be retried by default.
|
|
105
101
|
|
|
106
|
-
|
|
102
|
+
You can use the `maxRetries` option to configure or disable this:
|
|
107
103
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
### [credit](docs/sdks/credit/README.md)
|
|
104
|
+
<!-- prettier-ignore -->
|
|
105
|
+
```js
|
|
106
|
+
// Configure the default for all requests:
|
|
107
|
+
const orb = new Orb({
|
|
108
|
+
maxRetries: 0, // default is 2
|
|
109
|
+
});
|
|
115
110
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
* [fetchLedgerByExternalId](docs/sdks/credit/README.md#fetchledgerbyexternalid) - Fetch customer credits ledger by external ID
|
|
122
|
-
|
|
123
|
-
### [creditNote](docs/sdks/creditnote/README.md)
|
|
124
|
-
|
|
125
|
-
* [fetch](docs/sdks/creditnote/README.md#fetch) - Fetch credit note
|
|
126
|
-
* [list](docs/sdks/creditnote/README.md#list) - List credit notes
|
|
111
|
+
// Or, configure per-request:
|
|
112
|
+
await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
|
|
113
|
+
maxRetries: 5,
|
|
114
|
+
});
|
|
115
|
+
```
|
|
127
116
|
|
|
128
|
-
###
|
|
117
|
+
### Timeouts
|
|
129
118
|
|
|
130
|
-
|
|
131
|
-
* [amendByExternalId](docs/sdks/customer/README.md#amendbyexternalid) - Amend usage by external ID
|
|
132
|
-
* [create](docs/sdks/customer/README.md#create) - Create customer
|
|
133
|
-
* [createBalanceTransaction](docs/sdks/customer/README.md#createbalancetransaction) - Create customer balance transaction
|
|
134
|
-
* [delete](docs/sdks/customer/README.md#delete) - Delete customer
|
|
135
|
-
* [fetch](docs/sdks/customer/README.md#fetch) - Fetch customer
|
|
136
|
-
* [fetchByExternalId](docs/sdks/customer/README.md#fetchbyexternalid) - Fetch customer by external ID
|
|
137
|
-
* [fetchCosts](docs/sdks/customer/README.md#fetchcosts) - Fetch customer costs
|
|
138
|
-
* [fetchCostsByExternalId](docs/sdks/customer/README.md#fetchcostsbyexternalid) - Fetch customer costs by external ID
|
|
139
|
-
* [list](docs/sdks/customer/README.md#list) - List customers
|
|
140
|
-
* [listBalanceTransactions](docs/sdks/customer/README.md#listbalancetransactions) - List balance transactions
|
|
141
|
-
* [updateByExternalId](docs/sdks/customer/README.md#updatebyexternalid) - Update customer by external ID
|
|
142
|
-
* [updateCustomer](docs/sdks/customer/README.md#updatecustomer) - Update customer
|
|
119
|
+
Requests time out after 1 minute by default. You can configure this with a `timeout` option:
|
|
143
120
|
|
|
144
|
-
|
|
121
|
+
<!-- prettier-ignore -->
|
|
122
|
+
```ts
|
|
123
|
+
// Configure the default for all requests:
|
|
124
|
+
const orb = new Orb({
|
|
125
|
+
timeout: 20 * 1000, // 20 seconds (default is 1 minute)
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
// Override per-request:
|
|
129
|
+
await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
|
|
130
|
+
timeout: 5 * 1000,
|
|
131
|
+
});
|
|
132
|
+
```
|
|
145
133
|
|
|
146
|
-
|
|
147
|
-
* [closeBackfill](docs/sdks/event/README.md#closebackfill) - Close backfill
|
|
148
|
-
* [create](docs/sdks/event/README.md#create) - Create backfill
|
|
149
|
-
* [deprecateEvent](docs/sdks/event/README.md#deprecateevent) - Deprecate event
|
|
150
|
-
* [fetch](docs/sdks/event/README.md#fetch) - Fetch backfill
|
|
151
|
-
* [ingest](docs/sdks/event/README.md#ingest) - Ingest events
|
|
152
|
-
* [listBackfills](docs/sdks/event/README.md#listbackfills) - List backfills
|
|
153
|
-
* [revertBackfill](docs/sdks/event/README.md#revertbackfill) - Revert backfill
|
|
154
|
-
* [search](docs/sdks/event/README.md#search) - Search events
|
|
134
|
+
On timeout, an `APIConnectionTimeoutError` is thrown.
|
|
155
135
|
|
|
156
|
-
|
|
136
|
+
Note that requests which time out will be [retried twice by default](#retries).
|
|
157
137
|
|
|
158
|
-
|
|
159
|
-
* [createLineItem](docs/sdks/invoice/README.md#createlineitem) - Create invoice line item
|
|
160
|
-
* [fetch](docs/sdks/invoice/README.md#fetch) - Fetch invoice
|
|
161
|
-
* [fetchUpcoming](docs/sdks/invoice/README.md#fetchupcoming) - Fetch upcoming invoice
|
|
162
|
-
* [issue](docs/sdks/invoice/README.md#issue) - Issue invoice
|
|
163
|
-
* [list](docs/sdks/invoice/README.md#list) - List invoices
|
|
164
|
-
* [markInvoiceAsPaid](docs/sdks/invoice/README.md#markinvoiceaspaid) - Mark invoice as paid
|
|
165
|
-
* [void](docs/sdks/invoice/README.md#void) - Void invoice
|
|
138
|
+
## Auto-pagination
|
|
166
139
|
|
|
167
|
-
|
|
140
|
+
List methods in the Orb API are paginated.
|
|
141
|
+
You can use `for await … of` syntax to iterate through items across all pages:
|
|
168
142
|
|
|
169
|
-
|
|
170
|
-
|
|
143
|
+
```ts
|
|
144
|
+
async function fetchAllCoupons(params) {
|
|
145
|
+
const allCoupons = [];
|
|
146
|
+
// Automatically fetches more pages as needed.
|
|
147
|
+
for await (const coupon of orb.coupons.list()) {
|
|
148
|
+
allCoupons.push(coupon);
|
|
149
|
+
}
|
|
150
|
+
return allCoupons;
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Alternatively, you can make request a single page at a time:
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
let page = await orb.coupons.list();
|
|
158
|
+
for (const coupon of page.data) {
|
|
159
|
+
console.log(coupon);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
// Convenience methods are provided for manually paginating:
|
|
163
|
+
while (page.hasNextPage()) {
|
|
164
|
+
page = page.getNextPage();
|
|
165
|
+
// ...
|
|
166
|
+
}
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Advanced Usage
|
|
170
|
+
|
|
171
|
+
### Accessing raw Response data (e.g., headers)
|
|
172
|
+
|
|
173
|
+
The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
|
|
174
|
+
|
|
175
|
+
You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
|
|
176
|
+
|
|
177
|
+
```ts
|
|
178
|
+
const orb = new Orb();
|
|
179
|
+
|
|
180
|
+
const response = await orb.customers
|
|
181
|
+
.create({ email: 'example-customer@withorb.com', name: 'My Customer' })
|
|
182
|
+
.asResponse();
|
|
183
|
+
console.log(response.headers.get('X-My-Header'));
|
|
184
|
+
console.log(response.statusText); // access the underlying Response object
|
|
185
|
+
|
|
186
|
+
const { data: customer, response: raw } = await orb.customers
|
|
187
|
+
.create({ email: 'example-customer@withorb.com', name: 'My Customer' })
|
|
188
|
+
.withResponse();
|
|
189
|
+
console.log(raw.headers.get('X-My-Header'));
|
|
190
|
+
console.log(customer.id);
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## Configuring an HTTP(S) Agent (e.g., for proxies)
|
|
194
|
+
|
|
195
|
+
By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
|
|
196
|
+
|
|
197
|
+
If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
|
|
198
|
+
|
|
199
|
+
<!-- prettier-ignore -->
|
|
200
|
+
```ts
|
|
201
|
+
import http from 'http';
|
|
202
|
+
import HttpsProxyAgent from 'https-proxy-agent';
|
|
203
|
+
|
|
204
|
+
// Configure the default for all requests:
|
|
205
|
+
const orb = new Orb({
|
|
206
|
+
httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
|
|
207
|
+
});
|
|
208
|
+
|
|
209
|
+
// Override per-request:
|
|
210
|
+
await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
|
|
211
|
+
baseURL: 'http://localhost:8080/test-api',
|
|
212
|
+
httpAgent: new http.Agent({ keepAlive: false }),
|
|
213
|
+
})
|
|
214
|
+
```
|
|
171
215
|
|
|
172
|
-
|
|
216
|
+
## Semantic Versioning
|
|
173
217
|
|
|
174
|
-
|
|
175
|
-
* [fetch](docs/sdks/metric/README.md#fetch) - Get metric
|
|
176
|
-
* [list](docs/sdks/metric/README.md#list) - List metrics
|
|
218
|
+
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
|
|
177
219
|
|
|
178
|
-
|
|
220
|
+
1. Changes that only affect static types, without breaking runtime behavior.
|
|
221
|
+
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
|
|
222
|
+
3. Changes that we do not expect to impact the vast majority of users in practice.
|
|
179
223
|
|
|
180
|
-
|
|
181
|
-
* [fetch](docs/sdks/plan/README.md#fetch) - Fetch plan
|
|
182
|
-
* [fetchByExternalId](docs/sdks/plan/README.md#fetchbyexternalid) - Fetch plan by external ID
|
|
183
|
-
* [list](docs/sdks/plan/README.md#list) - List plans
|
|
184
|
-
* [updatePlan](docs/sdks/plan/README.md#updateplan) - Update plan by id
|
|
185
|
-
* [updatePlanExternal](docs/sdks/plan/README.md#updateplanexternal) - Update plan by external ID
|
|
224
|
+
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
|
|
186
225
|
|
|
187
|
-
|
|
226
|
+
We are keen for your feedback; please open an [issue](https://www.github.com/orbcorp/orb-node/issues) with questions, bugs, or suggestions.
|
|
188
227
|
|
|
189
|
-
|
|
190
|
-
* [fetch](docs/sdks/price/README.md#fetch) - Fetch price
|
|
191
|
-
* [fetchByExternalId](docs/sdks/price/README.md#fetchbyexternalid) - Fetch price by external price id
|
|
192
|
-
* [list](docs/sdks/price/README.md#list) - List prices
|
|
228
|
+
## Requirements
|
|
193
229
|
|
|
194
|
-
|
|
230
|
+
TypeScript >= 4.5 is supported.
|
|
195
231
|
|
|
196
|
-
|
|
232
|
+
The following runtimes are supported:
|
|
197
233
|
|
|
198
|
-
|
|
234
|
+
- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
|
|
235
|
+
- Deno v1.28.0 or higher, using `import Orb from "npm:orb-billing"`.
|
|
236
|
+
- Bun 1.0 or later.
|
|
237
|
+
- Cloudflare Workers.
|
|
238
|
+
- Vercel Edge Runtime.
|
|
239
|
+
- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
|
|
240
|
+
- Nitro v2.6 or greater.
|
|
199
241
|
|
|
200
|
-
|
|
201
|
-
* [create](docs/sdks/subscription/README.md#create) - Create subscription
|
|
202
|
-
* [fetch](docs/sdks/subscription/README.md#fetch) - Fetch subscription
|
|
203
|
-
* [fetchCosts](docs/sdks/subscription/README.md#fetchcosts) - Fetch subscription costs
|
|
204
|
-
* [fetchSchedule](docs/sdks/subscription/README.md#fetchschedule) - Fetch subscription schedule
|
|
205
|
-
* [fetchUsage](docs/sdks/subscription/README.md#fetchusage) - Fetch subscription usage
|
|
206
|
-
* [list](docs/sdks/subscription/README.md#list) - List subscriptions
|
|
207
|
-
* [schedulePlanChange](docs/sdks/subscription/README.md#scheduleplanchange) - Schedule plan change
|
|
208
|
-
* [triggerPhase](docs/sdks/subscription/README.md#triggerphase) - Trigger phase
|
|
209
|
-
* [unscheduleCancellation](docs/sdks/subscription/README.md#unschedulecancellation) - Unschedule subscription cancellation
|
|
210
|
-
* [unscheduleFixedFeeQuantity](docs/sdks/subscription/README.md#unschedulefixedfeequantity) - Unschedule fixed fee quantity updates
|
|
211
|
-
* [unschedulePlanChange](docs/sdks/subscription/README.md#unscheduleplanchange) - Unschedule plan change
|
|
212
|
-
* [updateFixedFeeQuantity](docs/sdks/subscription/README.md#updatefixedfeequantity) - Update price quantity
|
|
213
|
-
<!-- End SDK Available Operations -->
|
|
214
|
-
|
|
215
|
-
<!-- Start Dev Containers -->
|
|
216
|
-
# Dev Containers
|
|
217
|
-
<div align="left">
|
|
218
|
-
<a href="https://codespaces.new/orbcorp/orb-billing-typescript-sdk.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
|
|
219
|
-
|
|
220
|
-
</div>
|
|
221
|
-
|
|
222
|
-
Experience our SDK in an enhanced sandbox environment. Try it now in **GitHub Codespaces**!
|
|
223
|
-
|
|
224
|
-
* [Explore Dev Containers](.devcontainer/README.md)
|
|
225
|
-
<!-- End Dev Containers -->
|
|
226
|
-
|
|
227
|
-
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
228
|
-
|
|
229
|
-
### Maturity
|
|
230
|
-
|
|
231
|
-
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
|
232
|
-
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
|
233
|
-
looking for the latest version.
|
|
234
|
-
|
|
235
|
-
### Contributions
|
|
236
|
-
|
|
237
|
-
While we value open-source contributions to this SDK, this library is generated programmatically.
|
|
238
|
-
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
|
|
242
|
+
Note that React Native is not supported at this time.
|
|
239
243
|
|
|
240
|
-
|
|
244
|
+
If you are interested in other runtime environments, please open or upvote an issue on GitHub.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MultipartBody.d.ts","sourceRoot":"","sources":["../src/_shims/MultipartBody.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,aAAa;IACL,IAAI,EAAE,GAAG;gBAAT,IAAI,EAAE,GAAG;IAC5B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;CACF"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MultipartBody = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Disclaimer: modules in _shims aren't intended to be imported by SDK users.
|
|
6
|
+
*/
|
|
7
|
+
class MultipartBody {
|
|
8
|
+
constructor(body) {
|
|
9
|
+
this.body = body;
|
|
10
|
+
}
|
|
11
|
+
get [Symbol.toStringTag]() {
|
|
12
|
+
return 'MultipartBody';
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
exports.MultipartBody = MultipartBody;
|
|
16
|
+
//# sourceMappingURL=MultipartBody.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MultipartBody.js","sourceRoot":"","sources":["../src/_shims/MultipartBody.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,aAAa;IACxB,YAAmB,IAAS;QAAT,SAAI,GAAJ,IAAI,CAAK;IAAG,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AALD,sCAKC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Disclaimer: modules in _shims aren't intended to be imported by SDK users.
|
|
3
|
+
*/
|
|
4
|
+
export class MultipartBody {
|
|
5
|
+
constructor(body) {
|
|
6
|
+
this.body = body;
|
|
7
|
+
}
|
|
8
|
+
get [Symbol.toStringTag]() {
|
|
9
|
+
return 'MultipartBody';
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=MultipartBody.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MultipartBody.mjs","sourceRoot":"","sources":["../src/_shims/MultipartBody.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,aAAa;IACxB,YAAmB,IAAS;QAAT,SAAI,GAAJ,IAAI,CAAK;IAAG,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF"}
|
package/_shims/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# 👋 Wondering what everything in here does?
|
|
2
|
+
|
|
3
|
+
`orb-billing` supports a wide variety of runtime environments like Node.js, Deno, Bun, browsers, and various
|
|
4
|
+
edge runtimes, as well as both CommonJS (CJS) and EcmaScript Modules (ESM).
|
|
5
|
+
|
|
6
|
+
To do this, `orb-billing` provides shims for either using `node-fetch` when in Node (because `fetch` is still experimental there) or the global `fetch` API built into the environment when not in Node.
|
|
7
|
+
|
|
8
|
+
It uses [conditional exports](https://nodejs.org/api/packages.html#conditional-exports) to
|
|
9
|
+
automatically select the correct shims for each environment. However, conditional exports are a fairly new
|
|
10
|
+
feature and not supported everywhere. For instance, the TypeScript `"moduleResolution": "node"`
|
|
11
|
+
|
|
12
|
+
setting doesn't consult the `exports` map, compared to `"moduleResolution": "nodeNext"`, which does.
|
|
13
|
+
Unfortunately that's still the default setting, and it can result in errors like
|
|
14
|
+
getting the wrong raw `Response` type from `.asResponse()`, for example.
|
|
15
|
+
|
|
16
|
+
The user can work around these issues by manually importing one of:
|
|
17
|
+
|
|
18
|
+
- `import 'orb-billing/shims/node'`
|
|
19
|
+
- `import 'orb-billing/shims/web'`
|
|
20
|
+
|
|
21
|
+
All of the code here in `_shims` handles selecting the automatic default shims or manual overrides.
|
|
22
|
+
|
|
23
|
+
### How it works - Runtime
|
|
24
|
+
|
|
25
|
+
Runtime shims get installed by calling `setShims` exported by `orb-billing/_shims/registry`.
|
|
26
|
+
|
|
27
|
+
Manually importing `orb-billing/shims/node` or `orb-billing/shims/web`, calls `setShims` with the respective runtime shims.
|
|
28
|
+
|
|
29
|
+
All client code imports shims from `orb-billing/_shims/index`, which:
|
|
30
|
+
|
|
31
|
+
- checks if shims have been set manually
|
|
32
|
+
- if not, calls `setShims` with the shims from `orb-billing/_shims/auto/runtime`
|
|
33
|
+
- re-exports the installed shims from `orb-billing/_shims/registry`.
|
|
34
|
+
|
|
35
|
+
`orb-billing/_shims/auto/runtime` exports web runtime shims.
|
|
36
|
+
If the `node` export condition is set, the export map replaces it with `orb-billing/_shims/auto/runtime-node`.
|
|
37
|
+
|
|
38
|
+
### How it works - Type time
|
|
39
|
+
|
|
40
|
+
All client code imports shim types from `orb-billing/_shims/index`, which selects the manual types from `orb-billing/_shims/manual-types` if they have been declared, otherwise it exports the auto types from `orb-billing/_shims/auto/types`.
|
|
41
|
+
|
|
42
|
+
`orb-billing/_shims/manual-types` exports an empty namespace.
|
|
43
|
+
Manually importing `orb-billing/shims/node` or `orb-billing/shims/web` merges declarations into this empty namespace, so they get picked up by `orb-billing/_shims/index`.
|
|
44
|
+
|
|
45
|
+
`orb-billing/_shims/auto/types` exports web type definitions.
|
|
46
|
+
If the `node` export condition is set, the export map replaces it with `orb-billing/_shims/auto/types-node`, though TS only picks this up if `"moduleResolution": "nodenext"` or `"moduleResolution": "bundler"`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime-bun.d.ts","sourceRoot":"","sources":["../../src/_shims/auto/runtime-bun.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
/**
|
|
18
|
+
* Disclaimer: modules in _shims aren't intended to be imported by SDK users.
|
|
19
|
+
*/
|
|
20
|
+
__exportStar(require("../bun-runtime.js"), exports);
|
|
21
|
+
//# sourceMappingURL=runtime-bun.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime-bun.js","sourceRoot":"","sources":["../../src/_shims/auto/runtime-bun.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,oDAA+B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime-bun.mjs","sourceRoot":"","sources":["../../src/_shims/auto/runtime-bun.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime-node.d.ts","sourceRoot":"","sources":["../../src/_shims/auto/runtime-node.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,iBAAiB,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
/**
|
|
18
|
+
* Disclaimer: modules in _shims aren't intended to be imported by SDK users.
|
|
19
|
+
*/
|
|
20
|
+
__exportStar(require("../node-runtime.js"), exports);
|
|
21
|
+
//# sourceMappingURL=runtime-node.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime-node.js","sourceRoot":"","sources":["../../src/_shims/auto/runtime-node.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,qDAAgC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime-node.mjs","sourceRoot":"","sources":["../../src/_shims/auto/runtime-node.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/_shims/auto/runtime.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,gBAAgB,CAAC"}
|