orb-billing 5.44.0 → 5.45.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 +39 -0
- package/core.d.ts +1 -1
- package/core.d.ts.map +1 -1
- package/core.js +8 -17
- package/core.js.map +1 -1
- package/core.mjs +8 -17
- package/core.mjs.map +1 -1
- package/index.d.mts +91 -5
- package/index.d.ts +91 -5
- package/index.d.ts.map +1 -1
- package/index.js +90 -2
- package/index.js.map +1 -1
- package/index.mjs +91 -3
- package/index.mjs.map +1 -1
- package/internal/utils/query.d.ts +2 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +33 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +6 -0
- package/internal/utils/query.mjs.map +1 -0
- package/package.json +1 -1
- package/resources/alerts.d.ts +21 -0
- package/resources/alerts.d.ts.map +1 -1
- package/resources/alerts.js +6 -0
- package/resources/alerts.js.map +1 -1
- package/resources/alerts.mjs +6 -0
- package/resources/alerts.mjs.map +1 -1
- package/resources/beta/beta.d.ts +8293 -140
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js +5 -0
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs +5 -0
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/external-plan-id.d.ts +8293 -140
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/beta/external-plan-id.js +5 -0
- package/resources/beta/external-plan-id.js.map +1 -1
- package/resources/beta/external-plan-id.mjs +5 -0
- package/resources/beta/external-plan-id.mjs.map +1 -1
- package/resources/coupons/coupons.d.ts +3 -0
- package/resources/coupons/coupons.d.ts.map +1 -1
- package/resources/coupons/coupons.js +3 -0
- package/resources/coupons/coupons.js.map +1 -1
- package/resources/coupons/coupons.mjs +3 -0
- package/resources/coupons/coupons.mjs.map +1 -1
- package/resources/coupons/subscriptions.d.ts +3 -0
- package/resources/coupons/subscriptions.d.ts.map +1 -1
- package/resources/coupons/subscriptions.js +3 -0
- package/resources/coupons/subscriptions.js.map +1 -1
- package/resources/coupons/subscriptions.mjs +3 -0
- package/resources/coupons/subscriptions.mjs.map +1 -1
- package/resources/credit-blocks.d.ts +85 -1
- package/resources/credit-blocks.d.ts.map +1 -1
- package/resources/credit-blocks.js +22 -0
- package/resources/credit-blocks.js.map +1 -1
- package/resources/credit-blocks.mjs +22 -0
- package/resources/credit-blocks.mjs.map +1 -1
- package/resources/credit-notes.d.ts +4 -0
- package/resources/credit-notes.d.ts.map +1 -1
- package/resources/credit-notes.js +4 -0
- package/resources/credit-notes.js.map +1 -1
- package/resources/credit-notes.mjs +4 -0
- package/resources/credit-notes.mjs.map +1 -1
- package/resources/customers/balance-transactions.d.ts +16 -0
- package/resources/customers/balance-transactions.d.ts.map +1 -1
- package/resources/customers/balance-transactions.js +16 -0
- package/resources/customers/balance-transactions.js.map +1 -1
- package/resources/customers/balance-transactions.mjs +16 -0
- package/resources/customers/balance-transactions.mjs.map +1 -1
- package/resources/customers/costs.d.ts +16 -0
- package/resources/customers/costs.d.ts.map +1 -1
- package/resources/customers/costs.js +16 -0
- package/resources/customers/costs.js.map +1 -1
- package/resources/customers/costs.mjs +16 -0
- package/resources/customers/costs.mjs.map +1 -1
- package/resources/customers/credits/credits.d.ts +39 -0
- package/resources/customers/credits/credits.d.ts.map +1 -1
- package/resources/customers/credits/credits.js +3 -0
- package/resources/customers/credits/credits.js.map +1 -1
- package/resources/customers/credits/credits.mjs +3 -0
- package/resources/customers/credits/credits.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +31 -4
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js +19 -2
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs +19 -2
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/credits/top-ups.d.ts +3 -0
- package/resources/customers/credits/top-ups.d.ts.map +1 -1
- package/resources/customers/credits/top-ups.js +3 -0
- package/resources/customers/credits/top-ups.js.map +1 -1
- package/resources/customers/credits/top-ups.mjs +3 -0
- package/resources/customers/credits/top-ups.mjs.map +1 -1
- package/resources/customers/customers.d.ts +33 -12
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js +20 -3
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs +20 -3
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts.map +1 -1
- package/resources/events/backfills.d.ts +5 -0
- package/resources/events/backfills.d.ts.map +1 -1
- package/resources/events/backfills.js +5 -0
- package/resources/events/backfills.js.map +1 -1
- package/resources/events/backfills.mjs +5 -0
- package/resources/events/backfills.mjs.map +1 -1
- package/resources/events/events.d.ts +5 -0
- package/resources/events/events.d.ts.map +1 -1
- package/resources/events/events.js +5 -0
- package/resources/events/events.js.map +1 -1
- package/resources/events/events.mjs +5 -0
- package/resources/events/events.mjs.map +1 -1
- package/resources/events/volume.d.ts +5 -0
- package/resources/events/volume.d.ts.map +1 -1
- package/resources/events/volume.js +5 -0
- package/resources/events/volume.js.map +1 -1
- package/resources/events/volume.mjs +5 -0
- package/resources/events/volume.mjs.map +1 -1
- package/resources/index.d.ts +4 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +6 -0
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoice-line-items.js +6 -0
- package/resources/invoice-line-items.js.map +1 -1
- package/resources/invoice-line-items.mjs +6 -0
- package/resources/invoice-line-items.mjs.map +1 -1
- package/resources/invoices.d.ts +432 -7
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +18 -5
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +18 -5
- package/resources/invoices.mjs.map +1 -1
- package/resources/items.d.ts +6 -2
- package/resources/items.d.ts.map +1 -1
- package/resources/items.js +4 -0
- package/resources/items.js.map +1 -1
- package/resources/items.mjs +4 -0
- package/resources/items.mjs.map +1 -1
- package/resources/license-types.d.ts +113 -0
- package/resources/license-types.d.ts.map +1 -0
- package/resources/license-types.js +44 -0
- package/resources/license-types.js.map +1 -0
- package/resources/license-types.mjs +39 -0
- package/resources/license-types.mjs.map +1 -0
- package/resources/licenses/external-licenses.d.ts +114 -0
- package/resources/licenses/external-licenses.d.ts.map +1 -0
- package/resources/licenses/external-licenses.js +18 -0
- package/resources/licenses/external-licenses.js.map +1 -0
- package/resources/licenses/external-licenses.mjs +14 -0
- package/resources/licenses/external-licenses.mjs.map +1 -0
- package/resources/licenses/index.d.ts +4 -0
- package/resources/licenses/index.d.ts.map +1 -0
- package/resources/licenses/index.js +12 -0
- package/resources/licenses/index.js.map +1 -0
- package/resources/licenses/index.mjs +5 -0
- package/resources/licenses/index.mjs.map +1 -0
- package/resources/licenses/licenses.d.ts +133 -0
- package/resources/licenses/licenses.d.ts.map +1 -0
- package/resources/licenses/licenses.js +86 -0
- package/resources/licenses/licenses.js.map +1 -0
- package/resources/licenses/licenses.mjs +58 -0
- package/resources/licenses/licenses.mjs.map +1 -0
- package/resources/licenses/usage.d.ts +211 -0
- package/resources/licenses/usage.d.ts.map +1 -0
- package/resources/licenses/usage.js +25 -0
- package/resources/licenses/usage.js.map +1 -0
- package/resources/licenses/usage.mjs +21 -0
- package/resources/licenses/usage.mjs.map +1 -0
- package/resources/licenses.d.ts +2 -0
- package/resources/licenses.d.ts.map +1 -0
- package/resources/licenses.js +19 -0
- package/resources/licenses.js.map +1 -0
- package/resources/licenses.mjs +3 -0
- package/resources/licenses.mjs.map +1 -0
- package/resources/metrics.d.ts +7 -0
- package/resources/metrics.d.ts.map +1 -1
- package/resources/metrics.js +4 -0
- package/resources/metrics.js.map +1 -1
- package/resources/metrics.mjs +4 -0
- package/resources/metrics.mjs.map +1 -1
- package/resources/plans/external-plan-id.d.ts +5 -0
- package/resources/plans/external-plan-id.d.ts.map +1 -1
- package/resources/plans/external-plan-id.js +5 -0
- package/resources/plans/external-plan-id.js.map +1 -1
- package/resources/plans/external-plan-id.mjs +5 -0
- package/resources/plans/external-plan-id.mjs.map +1 -1
- package/resources/plans/migrations.d.ts +5 -0
- package/resources/plans/migrations.d.ts.map +1 -1
- package/resources/plans/migrations.js +5 -0
- package/resources/plans/migrations.js.map +1 -1
- package/resources/plans/migrations.mjs +5 -0
- package/resources/plans/migrations.mjs.map +1 -1
- package/resources/plans/plans.d.ts +4200 -121
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js +5 -0
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs +5 -0
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/external-price-id.d.ts +9 -0
- package/resources/prices/external-price-id.d.ts.map +1 -1
- package/resources/prices/external-price-id.js +9 -0
- package/resources/prices/external-price-id.js.map +1 -1
- package/resources/prices/external-price-id.mjs +9 -0
- package/resources/prices/external-price-id.mjs.map +1 -1
- package/resources/prices/prices.d.ts +198 -0
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js +9 -0
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs +9 -0
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +1040 -6
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/subscriptions.d.ts +262 -0
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/core.ts +10 -21
- package/src/index.ts +149 -5
- package/src/internal/utils/query.ts +7 -0
- package/src/resources/alerts.ts +24 -0
- package/src/resources/beta/beta.ts +9945 -194
- package/src/resources/beta/external-plan-id.ts +9945 -194
- package/src/resources/coupons/coupons.ts +3 -0
- package/src/resources/coupons/subscriptions.ts +3 -0
- package/src/resources/credit-blocks.ts +110 -1
- package/src/resources/credit-notes.ts +4 -0
- package/src/resources/customers/balance-transactions.ts +16 -0
- package/src/resources/customers/costs.ts +16 -0
- package/src/resources/customers/credits/credits.ts +45 -0
- package/src/resources/customers/credits/ledger.ts +33 -4
- package/src/resources/customers/credits/top-ups.ts +3 -0
- package/src/resources/customers/customers.ts +61 -12
- package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts +1 -1
- package/src/resources/events/backfills.ts +5 -0
- package/src/resources/events/events.ts +5 -0
- package/src/resources/events/volume.ts +5 -0
- package/src/resources/index.ts +29 -1
- package/src/resources/invoice-line-items.ts +6 -0
- package/src/resources/invoices.ts +523 -6
- package/src/resources/items.ts +8 -2
- package/src/resources/license-types.ts +163 -0
- package/src/resources/licenses/external-licenses.ts +147 -0
- package/src/resources/licenses/index.ts +27 -0
- package/src/resources/licenses/licenses.ts +248 -0
- package/src/resources/licenses/usage.ts +280 -0
- package/src/resources/licenses.ts +3 -0
- package/src/resources/metrics.ts +6 -0
- package/src/resources/plans/external-plan-id.ts +5 -0
- package/src/resources/plans/migrations.ts +5 -0
- package/src/resources/plans/plans.ts +5004 -126
- package/src/resources/prices/external-price-id.ts +9 -0
- package/src/resources/prices/prices.ts +237 -0
- package/src/resources/shared.ts +1213 -0
- package/src/resources/subscriptions.ts +311 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-blocks.d.ts","sourceRoot":"","sources":["../src/resources/credit-blocks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"credit-blocks.d.ts","sourceRoot":"","sources":["../src/resources/credit-blocks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAItG;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAO7E;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAGpD;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,KAAK,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;IAEnD,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAAC;CACtC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,KAAK,EAAE,+BAA+B,CAAC,KAAK,CAAC;IAE7C,QAAQ,EAAE,KAAK,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;CAC1D;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,KAAK;QACpB,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,MAAM,CAAC;QAEhB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC;;;;;WAKG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAAC;KACtC;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,MAAM;YACrB;;eAEG;YACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;YAE9E;;eAEG;YACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB;KACF;IAED,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAElC,cAAc,EAAE,MAAM,CAAC;QAEvB,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;QAExD,YAAY,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAClD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.CreditBlocks = void 0;
|
|
5
5
|
const resource_1 = require("../resource.js");
|
|
6
|
+
/**
|
|
7
|
+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
8
|
+
*/
|
|
6
9
|
class CreditBlocks extends resource_1.APIResource {
|
|
7
10
|
/**
|
|
8
11
|
* This endpoint returns a credit block identified by its block_id.
|
|
@@ -33,6 +36,25 @@ class CreditBlocks extends resource_1.APIResource {
|
|
|
33
36
|
headers: { Accept: '*/*', ...options?.headers },
|
|
34
37
|
});
|
|
35
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* This endpoint returns the credit block and its associated purchasing invoices.
|
|
41
|
+
*
|
|
42
|
+
* If a credit block was purchased (as opposed to being manually added or allocated
|
|
43
|
+
* from a subscription), this endpoint returns the invoices that were created to
|
|
44
|
+
* charge the customer for the credit block. For credit blocks with payment
|
|
45
|
+
* schedules spanning multiple periods (e.g., monthly payments over 12 months),
|
|
46
|
+
* multiple invoices will be returned.
|
|
47
|
+
*
|
|
48
|
+
* If the credit block was not purchased (e.g., manual increment, allocation), an
|
|
49
|
+
* empty invoices list is returned.
|
|
50
|
+
*
|
|
51
|
+
* **Note: This endpoint is currently experimental and its interface may change in
|
|
52
|
+
* future releases. Please contact support before building production integrations
|
|
53
|
+
* against this endpoint.**
|
|
54
|
+
*/
|
|
55
|
+
listInvoices(blockId, options) {
|
|
56
|
+
return this._client.get(`/credit_blocks/${blockId}/invoices`, options);
|
|
57
|
+
}
|
|
36
58
|
}
|
|
37
59
|
exports.CreditBlocks = CreditBlocks;
|
|
38
60
|
//# sourceMappingURL=credit-blocks.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-blocks.js","sourceRoot":"","sources":["../src/resources/credit-blocks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;
|
|
1
|
+
{"version":3,"file":"credit-blocks.js","sourceRoot":"","sources":["../src/resources/credit-blocks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,OAAe,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,OAAO,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,OAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,OAAO,WAAW,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AAtDD,oCAsDC"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../resource.mjs";
|
|
3
|
+
/**
|
|
4
|
+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
5
|
+
*/
|
|
3
6
|
export class CreditBlocks extends APIResource {
|
|
4
7
|
/**
|
|
5
8
|
* This endpoint returns a credit block identified by its block_id.
|
|
@@ -30,5 +33,24 @@ export class CreditBlocks extends APIResource {
|
|
|
30
33
|
headers: { Accept: '*/*', ...options?.headers },
|
|
31
34
|
});
|
|
32
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* This endpoint returns the credit block and its associated purchasing invoices.
|
|
38
|
+
*
|
|
39
|
+
* If a credit block was purchased (as opposed to being manually added or allocated
|
|
40
|
+
* from a subscription), this endpoint returns the invoices that were created to
|
|
41
|
+
* charge the customer for the credit block. For credit blocks with payment
|
|
42
|
+
* schedules spanning multiple periods (e.g., monthly payments over 12 months),
|
|
43
|
+
* multiple invoices will be returned.
|
|
44
|
+
*
|
|
45
|
+
* If the credit block was not purchased (e.g., manual increment, allocation), an
|
|
46
|
+
* empty invoices list is returned.
|
|
47
|
+
*
|
|
48
|
+
* **Note: This endpoint is currently experimental and its interface may change in
|
|
49
|
+
* future releases. Please contact support before building production integrations
|
|
50
|
+
* against this endpoint.**
|
|
51
|
+
*/
|
|
52
|
+
listInvoices(blockId, options) {
|
|
53
|
+
return this._client.get(`/credit_blocks/${blockId}/invoices`, options);
|
|
54
|
+
}
|
|
33
55
|
}
|
|
34
56
|
//# sourceMappingURL=credit-blocks.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-blocks.mjs","sourceRoot":"","sources":["../src/resources/credit-blocks.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"credit-blocks.mjs","sourceRoot":"","sources":["../src/resources/credit-blocks.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,OAAe,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,OAAO,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,OAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,OAAO,WAAW,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF"}
|
|
@@ -3,6 +3,10 @@ import * as Core from "../core.js";
|
|
|
3
3
|
import * as Shared from "./shared.js";
|
|
4
4
|
import { CreditNotesPage } from "./shared.js";
|
|
5
5
|
import { type PageParams } from "../pagination.js";
|
|
6
|
+
/**
|
|
7
|
+
* The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
|
|
8
|
+
* particular invoice.
|
|
9
|
+
*/
|
|
6
10
|
export declare class CreditNotes extends APIResource {
|
|
7
11
|
/**
|
|
8
12
|
* This endpoint is used to create a single
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-notes.d.ts","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIvG;;;;OAIG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IACvD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IAWzF;;;OAGG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG/F;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE/E;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"credit-notes.d.ts","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIvG;;;;OAIG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IACvD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IAWzF;;;OAGG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG/F;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE/E;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
|
|
@@ -6,6 +6,10 @@ const resource_1 = require("../resource.js");
|
|
|
6
6
|
const core_1 = require("../core.js");
|
|
7
7
|
const shared_1 = require("./shared.js");
|
|
8
8
|
Object.defineProperty(exports, "CreditNotesPage", { enumerable: true, get: function () { return shared_1.CreditNotesPage; } });
|
|
9
|
+
/**
|
|
10
|
+
* The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
|
|
11
|
+
* particular invoice.
|
|
12
|
+
*/
|
|
9
13
|
class CreditNotes extends resource_1.APIResource {
|
|
10
14
|
/**
|
|
11
15
|
* This endpoint is used to create a single
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-notes.js","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,wCAA2C;
|
|
1
|
+
{"version":3,"file":"credit-notes.js","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,wCAA2C;AAoJlC,gGApJA,wBAAe,OAoJA;AAjJxB;;;GAGG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,IAA4B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAYD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,wBAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAoB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AA7DD,kCA6DC"}
|
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
import { APIResource } from "../resource.mjs";
|
|
3
3
|
import { isRequestOptions } from "../core.mjs";
|
|
4
4
|
import { CreditNotesPage } from "./shared.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
|
|
7
|
+
* particular invoice.
|
|
8
|
+
*/
|
|
5
9
|
export class CreditNotes extends APIResource {
|
|
6
10
|
/**
|
|
7
11
|
* This endpoint is used to create a single
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-notes.mjs","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,eAAe,EAAE;AAG1B,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,IAA4B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAYD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAoB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAgFD,OAAO,EAAE,eAAe,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"credit-notes.mjs","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,eAAe,EAAE;AAG1B;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,IAA4B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAYD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAoB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAgFD,OAAO,EAAE,eAAe,EAAE,CAAC"}
|
|
@@ -2,6 +2,22 @@ import { APIResource } from "../../resource.js";
|
|
|
2
2
|
import * as Core from "../../core.js";
|
|
3
3
|
import * as Shared from "../shared.js";
|
|
4
4
|
import { Page, type PageParams } from "../../pagination.js";
|
|
5
|
+
/**
|
|
6
|
+
* A customer is a buyer of your products, and the other party to the billing relationship.
|
|
7
|
+
*
|
|
8
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
9
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
10
|
+
* `external_customer_id` with your own identifier. See
|
|
11
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
|
|
12
|
+
* aliases work in Orb.
|
|
13
|
+
*
|
|
14
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
15
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
16
|
+
*
|
|
17
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
18
|
+
* defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
19
|
+
* information on what this timezone parameter influences within Orb.
|
|
20
|
+
*/
|
|
5
21
|
export declare class BalanceTransactions extends APIResource {
|
|
6
22
|
/**
|
|
7
23
|
* Creates an immutable balance transaction that updates the customer's balance and
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"balance-transactions.d.ts","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAIpD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;IACxF,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAezF;AAED,qBAAa,mCAAoC,SAAQ,IAAI,CAAC,8BAA8B,CAAC;CAAG;AAEhG,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAID,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,mCAAmC,IAAI,mCAAmC,EAC1E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"balance-transactions.d.ts","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAIpD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;IACxF,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAezF;AAED,qBAAa,mCAAoC,SAAQ,IAAI,CAAC,8BAA8B,CAAC;CAAG;AAEhG,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAID,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,mCAAmC,IAAI,mCAAmC,EAC1E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -5,6 +5,22 @@ exports.BalanceTransactionListResponsesPage = exports.BalanceTransactions = void
|
|
|
5
5
|
const resource_1 = require("../../resource.js");
|
|
6
6
|
const core_1 = require("../../core.js");
|
|
7
7
|
const pagination_1 = require("../../pagination.js");
|
|
8
|
+
/**
|
|
9
|
+
* A customer is a buyer of your products, and the other party to the billing relationship.
|
|
10
|
+
*
|
|
11
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
12
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
13
|
+
* `external_customer_id` with your own identifier. See
|
|
14
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
|
|
15
|
+
* aliases work in Orb.
|
|
16
|
+
*
|
|
17
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
18
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
19
|
+
*
|
|
20
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
21
|
+
* defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
22
|
+
* information on what this timezone parameter influences within Orb.
|
|
23
|
+
*/
|
|
8
24
|
class BalanceTransactions extends resource_1.APIResource {
|
|
9
25
|
/**
|
|
10
26
|
* Creates an immutable balance transaction that updates the customer's balance and
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"balance-transactions.js","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAyD;AAEzD,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAkCD,IAAI,CACF,UAAkB,EAClB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,cAAc,UAAU,uBAAuB,EAC/C,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA3DD,kDA2DC;AAED,MAAa,mCAAoC,SAAQ,iBAAoC;CAAG;AAAhG,kFAAgG;AA+HhG,mBAAmB,CAAC,mCAAmC,GAAG,mCAAmC,CAAC"}
|
|
1
|
+
{"version":3,"file":"balance-transactions.js","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAyD;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAkCD,IAAI,CACF,UAAkB,EAClB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,cAAc,UAAU,uBAAuB,EAC/C,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA3DD,kDA2DC;AAED,MAAa,mCAAoC,SAAQ,iBAAoC;CAAG;AAAhG,kFAAgG;AA+HhG,mBAAmB,CAAC,mCAAmC,GAAG,mCAAmC,CAAC"}
|
|
@@ -2,6 +2,22 @@
|
|
|
2
2
|
import { APIResource } from "../../resource.mjs";
|
|
3
3
|
import { isRequestOptions } from "../../core.mjs";
|
|
4
4
|
import { Page } from "../../pagination.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* A customer is a buyer of your products, and the other party to the billing relationship.
|
|
7
|
+
*
|
|
8
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
9
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
10
|
+
* `external_customer_id` with your own identifier. See
|
|
11
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
|
|
12
|
+
* aliases work in Orb.
|
|
13
|
+
*
|
|
14
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
15
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
16
|
+
*
|
|
17
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
18
|
+
* defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
19
|
+
* information on what this timezone parameter influences within Orb.
|
|
20
|
+
*/
|
|
5
21
|
export class BalanceTransactions extends APIResource {
|
|
6
22
|
/**
|
|
7
23
|
* Creates an immutable balance transaction that updates the customer's balance and
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"balance-transactions.mjs","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAkCD,IAAI,CACF,UAAkB,EAClB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,cAAc,UAAU,uBAAuB,EAC/C,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,mCAAoC,SAAQ,IAAoC;CAAG;AA+HhG,mBAAmB,CAAC,mCAAmC,GAAG,mCAAmC,CAAC"}
|
|
1
|
+
{"version":3,"file":"balance-transactions.mjs","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,IAAI,EAAmB;AAEhC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAkCD,IAAI,CACF,UAAkB,EAClB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,cAAc,UAAU,uBAAuB,EAC/C,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,mCAAoC,SAAQ,IAAoC;CAAG;AA+HhG,mBAAmB,CAAC,mCAAmC,GAAG,mCAAmC,CAAC"}
|
|
@@ -1,6 +1,22 @@
|
|
|
1
1
|
import { APIResource } from "../../resource.js";
|
|
2
2
|
import * as Core from "../../core.js";
|
|
3
3
|
import * as Shared from "../shared.js";
|
|
4
|
+
/**
|
|
5
|
+
* A customer is a buyer of your products, and the other party to the billing relationship.
|
|
6
|
+
*
|
|
7
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
8
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
9
|
+
* `external_customer_id` with your own identifier. See
|
|
10
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
|
|
11
|
+
* aliases work in Orb.
|
|
12
|
+
*
|
|
13
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
14
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
15
|
+
*
|
|
16
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
17
|
+
* defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
18
|
+
* information on what this timezone parameter influences within Orb.
|
|
19
|
+
*/
|
|
4
20
|
export declare class Costs extends APIResource {
|
|
5
21
|
/**
|
|
6
22
|
* This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"costs.d.ts","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACpC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAY1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAChD,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAcjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"costs.d.ts","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACpC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAY1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAChD,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAcjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|
|
@@ -4,6 +4,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.Costs = void 0;
|
|
5
5
|
const resource_1 = require("../../resource.js");
|
|
6
6
|
const core_1 = require("../../core.js");
|
|
7
|
+
/**
|
|
8
|
+
* A customer is a buyer of your products, and the other party to the billing relationship.
|
|
9
|
+
*
|
|
10
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
11
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
12
|
+
* `external_customer_id` with your own identifier. See
|
|
13
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
|
|
14
|
+
* aliases work in Orb.
|
|
15
|
+
*
|
|
16
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
17
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
18
|
+
*
|
|
19
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
20
|
+
* defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
21
|
+
* information on what this timezone parameter influences within Orb.
|
|
22
|
+
*/
|
|
7
23
|
class Costs extends resource_1.APIResource {
|
|
8
24
|
list(customerId, query = {}, options) {
|
|
9
25
|
if ((0, core_1.isRequestOptions)(query)) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"costs.js","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,KAAM,SAAQ,sBAAW;IA8HpC,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAkID,gBAAgB,CACd,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,QAAQ,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtRD,sBAsRC"}
|
|
1
|
+
{"version":3,"file":"costs.js","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C;;;;;;;;;;;;;;;GAeG;AACH,MAAa,KAAM,SAAQ,sBAAW;IA8HpC,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAkID,gBAAgB,CACd,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,QAAQ,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtRD,sBAsRC"}
|
|
@@ -1,6 +1,22 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../../resource.mjs";
|
|
3
3
|
import { isRequestOptions } from "../../core.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* A customer is a buyer of your products, and the other party to the billing relationship.
|
|
6
|
+
*
|
|
7
|
+
* In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
|
|
8
|
+
* match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
|
|
9
|
+
* `external_customer_id` with your own identifier. See
|
|
10
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
|
|
11
|
+
* aliases work in Orb.
|
|
12
|
+
*
|
|
13
|
+
* In addition to having an identifier in your system, a customer may exist in a payment provider solution like
|
|
14
|
+
* Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
|
|
15
|
+
*
|
|
16
|
+
* A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
|
|
17
|
+
* defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
18
|
+
* information on what this timezone parameter influences within Orb.
|
|
19
|
+
*/
|
|
4
20
|
export class Costs extends APIResource {
|
|
5
21
|
list(customerId, query = {}, options) {
|
|
6
22
|
if (isRequestOptions(query)) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"costs.mjs","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,KAAM,SAAQ,WAAW;IA8HpC,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAkID,gBAAgB,CACd,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,QAAQ,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"costs.mjs","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IA8HpC,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAkID,gBAAgB,CACd,kBAA0B,EAC1B,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,QAAQ,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -5,6 +5,9 @@ import { AffectedBlock, AmendmentLedgerEntry, CreditBlockExpiryLedgerEntry, Decr
|
|
|
5
5
|
import * as TopUpsAPI from "./top-ups.js";
|
|
6
6
|
import { TopUpCreateByExternalIDParams, TopUpCreateByExternalIDResponse, TopUpCreateParams, TopUpCreateResponse, TopUpInvoiceSettings, TopUpListByExternalIDParams, TopUpListByExternalIDResponse, TopUpListByExternalIDResponsesPage, TopUpListParams, TopUpListResponse, TopUpListResponsesPage, TopUps } from "./top-ups.js";
|
|
7
7
|
import { Page, type PageParams } from "../../../pagination.js";
|
|
8
|
+
/**
|
|
9
|
+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
10
|
+
*/
|
|
8
11
|
export declare class Credits extends APIResource {
|
|
9
12
|
ledger: LedgerAPI.Ledger;
|
|
10
13
|
topUps: TopUpsAPI.TopUps;
|
|
@@ -16,6 +19,11 @@ export declare class Credits extends APIResource {
|
|
|
16
19
|
*
|
|
17
20
|
* Note that `currency` defaults to credits if not specified. To use a real world
|
|
18
21
|
* currency, set `currency` to an ISO 4217 string.
|
|
22
|
+
*
|
|
23
|
+
* Results can be filtered by the block's `effective_date` using the
|
|
24
|
+
* `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
|
|
25
|
+
* `effective_date[lte]` query parameters. This filters on when the credit block
|
|
26
|
+
* becomes effective, which may differ from creation time for backdated credits.
|
|
19
27
|
*/
|
|
20
28
|
list(customerId: string, query?: CreditListParams, options?: Core.RequestOptions): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
|
|
21
29
|
list(customerId: string, options?: Core.RequestOptions): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
|
|
@@ -27,6 +35,11 @@ export declare class Credits extends APIResource {
|
|
|
27
35
|
*
|
|
28
36
|
* Note that `currency` defaults to credits if not specified. To use a real world
|
|
29
37
|
* currency, set `currency` to an ISO 4217 string.
|
|
38
|
+
*
|
|
39
|
+
* Results can be filtered by the block's `effective_date` using the
|
|
40
|
+
* `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
|
|
41
|
+
* `effective_date[lte]` query parameters. This filters on when the credit block
|
|
42
|
+
* becomes effective, which may differ from creation time for backdated credits.
|
|
30
43
|
*/
|
|
31
44
|
listByExternalId(externalCustomerId: string, query?: CreditListByExternalIDParams, options?: Core.RequestOptions): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
|
|
32
45
|
listByExternalId(externalCustomerId: string, options?: Core.RequestOptions): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
|
|
@@ -42,6 +55,15 @@ export interface CreditListResponse {
|
|
|
42
55
|
expiry_date: string | null;
|
|
43
56
|
filters: Array<CreditListResponse.Filter>;
|
|
44
57
|
maximum_initial_balance: number | null;
|
|
58
|
+
/**
|
|
59
|
+
* User specified key-value pairs for the resource. If not present, this defaults
|
|
60
|
+
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
61
|
+
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
62
|
+
* `null`.
|
|
63
|
+
*/
|
|
64
|
+
metadata: {
|
|
65
|
+
[key: string]: string;
|
|
66
|
+
};
|
|
45
67
|
per_unit_cost_basis: string | null;
|
|
46
68
|
status: 'active' | 'pending_payment';
|
|
47
69
|
}
|
|
@@ -71,6 +93,15 @@ export interface CreditListByExternalIDResponse {
|
|
|
71
93
|
expiry_date: string | null;
|
|
72
94
|
filters: Array<CreditListByExternalIDResponse.Filter>;
|
|
73
95
|
maximum_initial_balance: number | null;
|
|
96
|
+
/**
|
|
97
|
+
* User specified key-value pairs for the resource. If not present, this defaults
|
|
98
|
+
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
99
|
+
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
100
|
+
* `null`.
|
|
101
|
+
*/
|
|
102
|
+
metadata: {
|
|
103
|
+
[key: string]: string;
|
|
104
|
+
};
|
|
74
105
|
per_unit_cost_basis: string | null;
|
|
75
106
|
status: 'active' | 'pending_payment';
|
|
76
107
|
}
|
|
@@ -98,6 +129,10 @@ export interface CreditListParams extends PageParams {
|
|
|
98
129
|
* The ledger currency or custom pricing unit to use.
|
|
99
130
|
*/
|
|
100
131
|
currency?: string | null;
|
|
132
|
+
'effective_date[gt]'?: string | null;
|
|
133
|
+
'effective_date[gte]'?: string | null;
|
|
134
|
+
'effective_date[lt]'?: string | null;
|
|
135
|
+
'effective_date[lte]'?: string | null;
|
|
101
136
|
/**
|
|
102
137
|
* If set to True, all expired and depleted blocks, as well as active block will be
|
|
103
138
|
* returned.
|
|
@@ -109,6 +144,10 @@ export interface CreditListByExternalIDParams extends PageParams {
|
|
|
109
144
|
* The ledger currency or custom pricing unit to use.
|
|
110
145
|
*/
|
|
111
146
|
currency?: string | null;
|
|
147
|
+
'effective_date[gt]'?: string | null;
|
|
148
|
+
'effective_date[gte]'?: string | null;
|
|
149
|
+
'effective_date[lt]'?: string | null;
|
|
150
|
+
'effective_date[lte]'?: string | null;
|
|
112
151
|
/**
|
|
113
152
|
* If set to True, all expired and depleted blocks, as well as active block will be
|
|
114
153
|
* returned.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AACtC,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,4BAA4B,EAC5B,oBAAoB,EACpB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,EACN,mCAAmC,EACnC,qCAAqC,EACrC,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mCAAmC,EACnC,gBAAgB,EAChB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,SAAS,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,kCAAkC,EAClC,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,EACP,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE5D,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D
|
|
1
|
+
{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AACtC,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,4BAA4B,EAC5B,oBAAoB,EACpB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,EACN,mCAAmC,EACnC,qCAAqC,EACrC,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,EAC9B,mCAAmC,EACnC,gBAAgB,EAChB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EAChB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,SAAS,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,kCAAkC,EAClC,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,EACP,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAehE;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;IACxF,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAezF;AAED,qBAAa,uBAAwB,SAAQ,IAAI,CAAC,kBAAkB,CAAC;CAAG;AAExE,qBAAa,mCAAoC,SAAQ,IAAI,CAAC,8BAA8B,CAAC;CAAG;AAEhG,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE1C,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAAC;CACtC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,SAAS,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;IAEtD,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAAC;CACtC;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,KAAK,EAAE,SAAS,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAWD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,uBAAuB,IAAI,uBAAuB,EAClD,mCAAmC,IAAI,mCAAmC,EAC1E,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,uBAAuB,IAAI,uBAAuB,EAClD,mCAAmC,IAAI,mCAAmC,EAC1E,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,sBAAsB,IAAI,sBAAsB,EAChD,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
|
@@ -32,6 +32,9 @@ const ledger_1 = require("./ledger.js");
|
|
|
32
32
|
const TopUpsAPI = __importStar(require("./top-ups.js"));
|
|
33
33
|
const top_ups_1 = require("./top-ups.js");
|
|
34
34
|
const pagination_1 = require("../../../pagination.js");
|
|
35
|
+
/**
|
|
36
|
+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
37
|
+
*/
|
|
35
38
|
class Credits extends resource_1.APIResource {
|
|
36
39
|
constructor() {
|
|
37
40
|
super(...arguments);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credits.js","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAEjD,uDAAsC;AACtC,wCAoBkB;AAClB,wDAAuC;AACvC,0CAamB;AACnB,uDAA4D;AAE5D,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"credits.js","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAEjD,uDAAsC;AACtC,wCAoBkB;AAClB,wDAAuC;AACvC,0CAamB;AACnB,uDAA4D;AAE5D;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4EhE,CAAC;IAnDC,IAAI,CACF,UAAkB,EAClB,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,UAAU,EAAE,uBAAuB,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAyBD,gBAAgB,CACd,kBAA0B,EAC1B,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mCAAmC,kBAAkB,UAAU,EAC/D,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA9ED,0BA8EC;AAED,MAAa,uBAAwB,SAAQ,iBAAwB;CAAG;AAAxE,0DAAwE;AAExE,MAAa,mCAAoC,SAAQ,iBAAoC;CAAG;AAAhG,kFAAgG;AA4IhG,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,mCAAmC,GAAG,mCAAmC,CAAC;AAClF,OAAO,CAAC,MAAM,GAAG,eAAM,CAAC;AACxB,OAAO,CAAC,uBAAuB,GAAG,gCAAuB,CAAC;AAC1D,OAAO,CAAC,mCAAmC,GAAG,4CAAmC,CAAC;AAClF,OAAO,CAAC,MAAM,GAAG,gBAAM,CAAC;AACxB,OAAO,CAAC,sBAAsB,GAAG,gCAAsB,CAAC;AACxD,OAAO,CAAC,kCAAkC,GAAG,4CAAkC,CAAC"}
|
|
@@ -6,6 +6,9 @@ import { Ledger, LedgerListByExternalIDResponsesPage, LedgerListResponsesPage, }
|
|
|
6
6
|
import * as TopUpsAPI from "./top-ups.mjs";
|
|
7
7
|
import { TopUpListByExternalIDResponsesPage, TopUpListResponsesPage, TopUps, } from "./top-ups.mjs";
|
|
8
8
|
import { Page } from "../../../pagination.mjs";
|
|
9
|
+
/**
|
|
10
|
+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
11
|
+
*/
|
|
9
12
|
export class Credits extends APIResource {
|
|
10
13
|
constructor() {
|
|
11
14
|
super(...arguments);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,SAAS;OACd,EAOL,MAAM,EAON,mCAAmC,EAGnC,uBAAuB,GAGxB;OACM,KAAK,SAAS;OACd,EAQL,kCAAkC,EAGlC,sBAAsB,EACtB,MAAM,GACP;OACM,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../../../src/resources/customers/credits/credits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,SAAS;OACd,EAOL,MAAM,EAON,mCAAmC,EAGnC,uBAAuB,GAGxB;OACM,KAAK,SAAS;OACd,EAQL,kCAAkC,EAGlC,sBAAsB,EACtB,MAAM,GACP;OACM,EAAE,IAAI,EAAmB;AAEhC;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4EhE,CAAC;IAnDC,IAAI,CACF,UAAkB,EAClB,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,UAAU,EAAE,uBAAuB,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAyBD,gBAAgB,CACd,kBAA0B,EAC1B,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mCAAmC,kBAAkB,UAAU,EAC/D,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,IAAwB;CAAG;AAExE,MAAM,OAAO,mCAAoC,SAAQ,IAAoC;CAAG;AA4IhG,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,mCAAmC,GAAG,mCAAmC,CAAC;AAClF,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;AACxB,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,mCAAmC,GAAG,mCAAmC,CAAC;AAClF,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;AACxB,OAAO,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AACxD,OAAO,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}
|
|
@@ -2,6 +2,9 @@ import { APIResource } from "../../../resource.js";
|
|
|
2
2
|
import * as Core from "../../../core.js";
|
|
3
3
|
import * as Shared from "../../shared.js";
|
|
4
4
|
import { Page, type PageParams } from "../../../pagination.js";
|
|
5
|
+
/**
|
|
6
|
+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
|
|
7
|
+
*/
|
|
5
8
|
export declare class Ledger extends APIResource {
|
|
6
9
|
/**
|
|
7
10
|
* The credits ledger provides _auditing_ functionality over Orb's credits system
|
|
@@ -137,7 +140,14 @@ export declare class Ledger extends APIResource {
|
|
|
137
140
|
* also generate a one-off invoice for the customer for the credits pre-purchase.
|
|
138
141
|
* Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
|
|
139
142
|
* on the invoice are calculated by multiplying the cost basis with the number of
|
|
140
|
-
* credit units added.
|
|
143
|
+
* credit units added. If you invoice or handle payment of credits outside of Orb
|
|
144
|
+
* (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
|
|
145
|
+
* `true` to prevent duplicate invoicing effects.
|
|
146
|
+
*
|
|
147
|
+
* - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
|
|
148
|
+
* and `invoice_settings` must be included
|
|
149
|
+
* - if `invoice_settings` is passed, one of either `custom_due_date` or
|
|
150
|
+
* `net_terms` is required to determine the due date
|
|
141
151
|
*
|
|
142
152
|
* ## Deducting Credits
|
|
143
153
|
*
|
|
@@ -250,7 +260,14 @@ export declare class Ledger extends APIResource {
|
|
|
250
260
|
* also generate a one-off invoice for the customer for the credits pre-purchase.
|
|
251
261
|
* Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
|
|
252
262
|
* on the invoice are calculated by multiplying the cost basis with the number of
|
|
253
|
-
* credit units added.
|
|
263
|
+
* credit units added. If you invoice or handle payment of credits outside of Orb
|
|
264
|
+
* (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
|
|
265
|
+
* `true` to prevent duplicate invoicing effects.
|
|
266
|
+
*
|
|
267
|
+
* - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
|
|
268
|
+
* and `invoice_settings` must be included
|
|
269
|
+
* - if `invoice_settings` is passed, one of either `custom_due_date` or
|
|
270
|
+
* `net_terms` is required to determine the due date
|
|
254
271
|
*
|
|
255
272
|
* ## Deducting Credits
|
|
256
273
|
*
|
|
@@ -730,6 +747,10 @@ export declare namespace LedgerCreateEntryParams {
|
|
|
730
747
|
* default 'Credits' item will be used.
|
|
731
748
|
*/
|
|
732
749
|
item_id?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* If true, the new credits purchase invoice will be marked as paid.
|
|
752
|
+
*/
|
|
753
|
+
mark_as_paid?: boolean;
|
|
733
754
|
/**
|
|
734
755
|
* An optional memo to display on the invoice.
|
|
735
756
|
*/
|
|
@@ -739,7 +760,8 @@ export declare namespace LedgerCreateEntryParams {
|
|
|
739
760
|
* based on the invoice or issuance date, depending on the account's configured due
|
|
740
761
|
* date calculation method. A value of '0' here represents that the invoice is due
|
|
741
762
|
* on issue, whereas a value of '30' represents that the customer has 30 days to
|
|
742
|
-
* pay the invoice.
|
|
763
|
+
* pay the invoice. You must set either `net_terms` or `custom_due_date`, but not
|
|
764
|
+
* both.
|
|
743
765
|
*/
|
|
744
766
|
net_terms?: number | null;
|
|
745
767
|
/**
|
|
@@ -986,6 +1008,10 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
|
|
|
986
1008
|
* default 'Credits' item will be used.
|
|
987
1009
|
*/
|
|
988
1010
|
item_id?: string | null;
|
|
1011
|
+
/**
|
|
1012
|
+
* If true, the new credits purchase invoice will be marked as paid.
|
|
1013
|
+
*/
|
|
1014
|
+
mark_as_paid?: boolean;
|
|
989
1015
|
/**
|
|
990
1016
|
* An optional memo to display on the invoice.
|
|
991
1017
|
*/
|
|
@@ -995,7 +1021,8 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
|
|
|
995
1021
|
* based on the invoice or issuance date, depending on the account's configured due
|
|
996
1022
|
* date calculation method. A value of '0' here represents that the invoice is due
|
|
997
1023
|
* on issue, whereas a value of '30' represents that the customer has 30 days to
|
|
998
|
-
* pay the invoice.
|
|
1024
|
+
* pay the invoice. You must set either `net_terms` or `custom_due_date`, but not
|
|
1025
|
+
* both.
|
|
999
1026
|
*/
|
|
1000
1027
|
net_terms?: number | null;
|
|
1001
1028
|
/**
|