orb-billing 1.20.2 → 1.22.0

package/resources/customers/customers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../src/resources/customers/customers.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGrD,mDAAmD;AACnD,2CAAoD;AACpD,wFAA0E;AAC1E,6GAA+F;AAC/F,gFAAkE;AAClE,gFAAkE;AAClE,4FAA8E;AAC9E,uDAA+D;AAE/D,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClE,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAmIhE,CAAC;IAjIC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;IAeD,MAAM,CACJ,UAAkB,EAClB,OAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC1C;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAaD,IAAI,CACF,QAAkD,EAAE,EACpD,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,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,UAAkB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,UAAU,EAAE,EAAE;YAC7C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,kBAA0B,EAAE,OAA6B;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAcD,kBAAkB,CAChB,EAAU,EACV,OAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAxID,8BAwIC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD;AAyiBpD,WAAiB,SAAS;IAEV,uBAAa,GAAG,YAAY,CAAC,aAAa,CAAC;IAK3C,eAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAKvB,eAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAKvB,iBAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAG7B,iCAAuB,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAC7D,6CAAmC,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAGrF,6BAAmB,GAAG,sBAAsB,CAAC,mBAAmB,CAAC;IAGjE,6CAAmC,GAAG,sBAAsB,CAAC,mCAAmC,CAAC;AAGjH,CAAC,EA9BgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA8BzB"}

package/resources/customers/customers.mjs

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from 'orb-billing/resource';
+import { isRequestOptions } from 'orb-billing/core';
+import * as CustomersAPI from 'orb-billing/resources/customers/customers';
+import * as BalanceTransactionsAPI from 'orb-billing/resources/customers/balance-transactions';
+import * as CostsAPI from 'orb-billing/resources/customers/costs';
+import * as UsageAPI from 'orb-billing/resources/customers/usage';
+import * as CreditsAPI from 'orb-billing/resources/customers/credits/credits';
+import { Page } from 'orb-billing/pagination';
+export class Customers extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.costs = new CostsAPI.Costs(this.client);
+        this.usage = new UsageAPI.Usage(this.client);
+        this.credits = new CreditsAPI.Credits(this.client);
+        this.balanceTransactions = new BalanceTransactionsAPI.BalanceTransactions(this.client);
+    }
+    /**
+     * This operation is used to create an Orb customer, who is party to the core
+     * billing relationship. See [Customer](../guides/concepts#customer) for an
+     * overview of the customer resource.
+     *
+     * This endpoint is critical in the following Orb functionality:
+     *
+     * - Automated charges can be configured by setting `payment_provider` and
+     *   `payment_provider_id` to automatically issue invoices
+     * - [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) can be
+     *   configured by setting `external_customer_id`
+     * - [Timezone localization](../guides/product-catalog/timezones.md) can be
+     *   configured on a per-customer basis by setting the `timezone` parameter
+     */
+    create(body, options) {
+        return this.post('/customers', { body, ...options });
+    }
+    update(customerId, body = {}, options) {
+        if (isRequestOptions(body)) {
+            return this.update(customerId, {}, body);
+        }
+        return this.put(`/customers/${customerId}`, { body, ...options });
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/customers', CustomersPage, { query, ...options });
+    }
+    /**
+     * This performs a deletion of this customer, its subscriptions, and its invoices.
+     * This operation is irreversible. Note that this is a _soft_ deletion, but the
+     * data will be inaccessible through the API and Orb dashboard. For hard-deletion,
+     * please reach out to the Orb team directly.
+     *
+     * **Note**: This operation happens asynchronously and can be expected to take a
+     * few minutes to propagate to related resources. However, querying for the
+     * customer on subsequent GET requests while deletion is in process will reflect
+     * its deletion with a `deleted: true` property. Once the customer deletion has
+     * been fully processed, the customer will not be returned in the API.
+     *
+     * On successful processing, this returns an empty dictionary (`{}`) in the API.
+     */
+    del(customerId, options) {
+        return this.delete(`/customers/${customerId}`, {
+            ...options,
+            headers: { Accept: '', ...options?.headers },
+        });
+    }
+    /**
+     * This endpoint is used to fetch customer details given an identifier. If the
+     * `Customer` is in the process of being deleted, only the properties `id` and
+     * `deleted: true` will be returned.
+     *
+     * See the [Customer resource](../guides/core-concepts.mdx#customer) for a full
+     * discussion of the Customer model.
+     */
+    fetch(customerId, options) {
+        return this.get(`/customers/${customerId}`, options);
+    }
+    /**
+     * This endpoint is used to fetch customer details given an `external_customer_id`
+     * (see [Customer ID Aliases](../guides/events-and-metrics/customer-aliases)).
+     *
+     * Note that the resource and semantics of this endpoint exactly mirror
+     * [Get Customer](fetch-customer).
+     */
+    fetchByExternalId(externalCustomerId, options) {
+        return this.get(`/customers/external_customer_id/${externalCustomerId}`, options);
+    }
+    updateByExternalId(id, body = {}, options) {
+        if (isRequestOptions(body)) {
+            return this.updateByExternalId(id, {}, body);
+        }
+        return this.put(`/customers/external_customer_id/${id}`, { body, ...options });
+    }
+}
+export class CustomersPage extends Page {
+}
+(function (Customers) {
+    Customers.CustomersPage = CustomersAPI.CustomersPage;
+    Customers.Costs = CostsAPI.Costs;
+    Customers.Usage = UsageAPI.Usage;
+    Customers.Credits = CreditsAPI.Credits;
+    Customers.CreditListResponsesPage = CreditsAPI.CreditListResponsesPage;
+    Customers.CreditListByExternalIDResponsesPage = CreditsAPI.CreditListByExternalIDResponsesPage;
+    Customers.BalanceTransactions = BalanceTransactionsAPI.BalanceTransactions;
+    Customers.BalanceTransactionListResponsesPage = BalanceTransactionsAPI.BalanceTransactionListResponsesPage;
+})(Customers || (Customers = {}));
+//# sourceMappingURL=customers.mjs.map

package/resources/customers/customers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.mjs","sourceRoot":"","sources":["../../src/resources/customers/customers.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,sBAAsB;OAC3C,EAAE,gBAAgB,EAAE,MAAM,kBAAkB;OAC5C,KAAK,YAAY,MAAM,2CAA2C;OAClE,KAAK,sBAAsB,MAAM,sDAAsD;OACvF,KAAK,QAAQ,MAAM,uCAAuC;OAC1D,KAAK,QAAQ,MAAM,uCAAuC;OAC1D,KAAK,UAAU,MAAM,iDAAiD;OACtE,EAAE,IAAI,EAAmB,MAAM,wBAAwB;AAE9D,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxD,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClE,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAmIhE,CAAC;IAjIC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;IAeD,MAAM,CACJ,UAAkB,EAClB,OAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC1C;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAaD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,UAAkB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,UAAU,EAAE,EAAE;YAC7C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,kBAA0B,EAAE,OAA6B;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAcD,kBAAkB,CAChB,EAAU,EACV,OAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAc;CAAG;AAyiBpD,WAAiB,SAAS;IAEV,uBAAa,GAAG,YAAY,CAAC,aAAa,CAAC;IAK3C,eAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAKvB,eAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAKvB,iBAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAG7B,iCAAuB,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAC7D,6CAAmC,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAGrF,6BAAmB,GAAG,sBAAsB,CAAC,mBAAmB,CAAC;IAGjE,6CAAmC,GAAG,sBAAsB,CAAC,mCAAmC,CAAC;AAGjH,CAAC,EA9BgB,SAAS,KAAT,SAAS,QA8BzB"}

package/resources/customers/index.d.ts

@@ -0,0 +1,6 @@
+export { BalanceTransactionCreateResponse, BalanceTransactionListResponse, BalanceTransactionCreateParams, BalanceTransactionListParams, BalanceTransactionListResponsesPage, BalanceTransactions, } from "./balance-transactions.js";
+export { CostListResponse, CostListByExternalIDResponse, CostListParams, CostListByExternalIDParams, Costs, } from "./costs.js";
+export { CreditListResponse, CreditListByExternalIDResponse, CreditListParams, CreditListByExternalIDParams, CreditListResponsesPage, CreditListByExternalIDResponsesPage, Credits, } from "./credits/index.js";
+export { Customer, CustomerCreateParams, CustomerUpdateParams, CustomerListParams, CustomerUpdateByExternalIDParams, CustomersPage, Customers, } from "./customers.js";
+export { UsageUpdateResponse, UsageUpdateByExternalIDResponse, UsageUpdateParams, UsageUpdateByExternalIDParams, Usage, } from "./usage.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/customers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/customers/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gCAAgC,EAChC,8BAA8B,EAC9B,8BAA8B,EAC9B,4BAA4B,EAC5B,mCAAmC,EACnC,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,gBAAgB,EAChB,4BAA4B,EAC5B,cAAc,EACd,0BAA0B,EAC1B,KAAK,GACN,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,kBAAkB,EAClB,8BAA8B,EAC9B,gBAAgB,EAChB,4BAA4B,EAC5B,uBAAuB,EACvB,mCAAmC,EACnC,OAAO,GACR,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,QAAQ,EACR,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,gCAAgC,EAChC,aAAa,EACb,SAAS,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,iBAAiB,EACjB,6BAA6B,EAC7B,KAAK,GACN,MAAM,SAAS,CAAC"}

package/resources/customers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Usage = exports.Customers = exports.CustomersPage = exports.Credits = exports.CreditListByExternalIDResponsesPage = exports.CreditListResponsesPage = exports.Costs = exports.BalanceTransactions = exports.BalanceTransactionListResponsesPage = void 0;
+var balance_transactions_1 = require("./balance-transactions.js");
+Object.defineProperty(exports, "BalanceTransactionListResponsesPage", { enumerable: true, get: function () { return balance_transactions_1.BalanceTransactionListResponsesPage; } });
+Object.defineProperty(exports, "BalanceTransactions", { enumerable: true, get: function () { return balance_transactions_1.BalanceTransactions; } });
+var costs_1 = require("./costs.js");
+Object.defineProperty(exports, "Costs", { enumerable: true, get: function () { return costs_1.Costs; } });
+var index_1 = require("./credits/index.js");
+Object.defineProperty(exports, "CreditListResponsesPage", { enumerable: true, get: function () { return index_1.CreditListResponsesPage; } });
+Object.defineProperty(exports, "CreditListByExternalIDResponsesPage", { enumerable: true, get: function () { return index_1.CreditListByExternalIDResponsesPage; } });
+Object.defineProperty(exports, "Credits", { enumerable: true, get: function () { return index_1.Credits; } });
+var customers_1 = require("./customers.js");
+Object.defineProperty(exports, "CustomersPage", { enumerable: true, get: function () { return customers_1.CustomersPage; } });
+Object.defineProperty(exports, "Customers", { enumerable: true, get: function () { return customers_1.Customers; } });
+var usage_1 = require("./usage.js");
+Object.defineProperty(exports, "Usage", { enumerable: true, get: function () { return usage_1.Usage; } });
+//# sourceMappingURL=index.js.map

package/resources/customers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/customers/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,kEAOgC;AAF9B,2IAAA,mCAAmC,OAAA;AACnC,2HAAA,mBAAmB,OAAA;AAErB,oCAMiB;AADf,8FAAA,KAAK,OAAA;AAEP,4CAQyB;AAHvB,gHAAA,uBAAuB,OAAA;AACvB,4HAAA,mCAAmC,OAAA;AACnC,gGAAA,OAAO,OAAA;AAET,4CAQqB;AAFnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AAEX,oCAMiB;AADf,8FAAA,KAAK,OAAA"}

package/resources/customers/index.mjs

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless.
+export { BalanceTransactionListResponsesPage, BalanceTransactions, } from "./balance-transactions.mjs";
+export { Costs, } from "./costs.mjs";
+export { CreditListResponsesPage, CreditListByExternalIDResponsesPage, Credits, } from "./credits/index.mjs";
+export { CustomersPage, Customers, } from "./customers.mjs";
+export { Usage, } from "./usage.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/customers/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/customers/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAKL,mCAAmC,EACnC,mBAAmB,GACpB;OACM,EAKL,KAAK,GACN;OACM,EAKL,uBAAuB,EACvB,mCAAmC,EACnC,OAAO,GACR;OACM,EAML,aAAa,EACb,SAAS,GACV;OACM,EAKL,KAAK,GACN"}

package/resources/customers/usage.d.ts

@@ -0,0 +1,306 @@
+import * as Core from 'orb-billing/core';
+import { APIResource } from 'orb-billing/resource';
+import * as UsageAPI from 'orb-billing/resources/customers/usage';
+export declare class Usage extends APIResource {
+    /**
+     * This endpoint is used to amend usage within a timeframe for a customer that has
+     * an active subscription.
+     *
+     * This endpoint will mark _all_ existing events within
+     * `[timeframe_start, timeframe_end)` as _ignored_ for billing purpo ses, and Orb
+     * will only use the _new_ events passed in the body of this request as the source
+     * of truth for that timeframe moving forwards. Note that a given time period can
+     * be amended any number of times, so events can be overwritten in subsequent calls
+     * to th is endpoint.
+     *
+     * This is a powerful and audit-safe mechanism to retroactively change usage data
+     * in cases where you need to:
+     *
+     * - decrease historical usage consumption because of degraded service availability
+     *   in your systems
+     * - account for gaps from your usage reporting mechanism
+     * - make point-in-time fixes for specific event records, while ret aining the
+     *   original time of usage and associated metadata. This amendment API is designed
+     *   with two explicit goals:
+     *
+     * 1. Amendments are **always audit-safe**. The amendment process will still retain
+     *    original events in the timeframe, though they will be ignored for billing
+     *    calculations. For auditing a nd data fidelity purposes, Orb never overwrites
+     *    or permanently deletes ingested usage data.
+     * 2. Amendments always preser ve data **consistency**. In other words, either an
+     *    amendment is fully processed by the system (and the new events for th e
+     *    timeframe are honored rather than the existing ones) or the amendment request
+     *    fails. To maintain this important proper ty, Orb prevents _partial event
+     *    ingestion_ on this endpoint.
+     *
+     * ## Response semantics
+     *
+     * - Either all events are ingested successfully, or all fail to ingest (returning
+     *   a `4xx` or `5xx` response code).
+     * - Any event that fails schema validation will lead to a `4xx` response. In this
+     *   case, to maintain data consistency, Orb will not ingest any events and will
+     *   also not deprecate existing events in the time period.
+     * - You can assume that the amendment is successful on receipt of a `2xx`
+     *   response.While a successful response from this endpoint indicates that the new
+     *   events have been ingested, updati ng usage totals happens asynchronously and
+     *   may be delayed by a few minutes.
+     *
+     * As emphasized above, Orb will never show an inconsistent state (e.g. in invoice
+     * previews or dashboards); either it will show the existing state (before the
+     * amend ment) or the new state (with new events in the requested timeframe).
+     *
+     * ## Sample request body
+     *
+     * ```json
+     * {
+     *   "events": [
+     *     {
+     *       "event_name": "payment_processed",
+     *       "timestamp": "2022-03-24T07:15:00Z",
+     *       "properties": {
+     *         "amount": 100
+     *       }
+     *     },
+     *     {
+     *       "event_name": "payment_failed",
+     *       "timestamp": "2022-03-24T07:15:00Z",
+     *       "properties": {
+     *         "amount": 100
+     *       }
+     *     }
+     *   ]
+     * }
+     * ```
+     *
+     * ## Request Validation
+     *
+     * - The `timestamp` of each event reported must fall within the bounds of
+     *   `timeframe_start` and `timeframe_end`. As with ingestion, all timesta mps must
+     *   be sent in ISO8601 format with UTC timezone offset.
+     * - Orb **does not accept an `idempotency_key`** with each event in this endpoint,
+     *   since the entirety of the event list must be ingested to ensure consistency.
+     *   On retryable errors , you should retry the request in its entirety, and assume
+     *   that the amendment operation has not succeeded until receipt of a `2xx`.
+     *
+     * - Both `timeframe_start` and `timeframe_end` must be timestamps in the past.
+     *   Furthermore, Orb will genera lly validate that the `timeframe_start` and
+     *   `timeframe_end` fall within the customer's _current_ subscription billing pe
+     *   riod. However, Orb does allow amendments while in the grace period of the
+     *   previous billing period; in this instance, the timeframe can start before the
+     *   current period.
+     *
+     * ## API Limits
+     *
+     * Note that Orb does not currently enforce a hard rate- limit for API usage or a
+     * maximum request payload size. Similar to the event ingestion API, this API is
+     * architected for h igh-throughput ingestion. It is also safe to
+     * _programmatically_ call this endpoint if your system can automatically dete ct a
+     * need for historical amendment.
+     *
+     * In order to overwrite timeframes with a very large number of events, we suggest
+     * using multiple calls with small adjacent (e.g. every hour) timeframes.
+     */
+    update(id: string | null, params: UsageUpdateParams, options?: Core.RequestOptions): Core.APIPromise<UsageUpdateResponse>;
+    /**
+     * This endpoint is used to amend usage within a timeframe for a customer that has
+     * an active subscription.
+     *
+     * This endpoint will mark _all_ existing events within
+     * `[timeframe_start, timeframe_end)` as _ignored_ for billing purpo ses, and Orb
+     * will only use the _new_ events passed in the body of this request as the source
+     * of truth for that timeframe moving forwards. Note that a given time period can
+     * be amended any number of times, so events can be overwritten in subsequent calls
+     * to th is endpoint.
+     *
+     * This is a powerful and audit-safe mechanism to retroactively change usage data
+     * in cases where you need to:
+     *
+     * - decrease historical usage consumption because of degraded service availability
+     *   in your systems
+     * - account for gaps from your usage reporting mechanism
+     * - make point-in-time fixes for specific event records, while ret aining the
+     *   original time of usage and associated metadata. This amendment API is designed
+     *   with two explicit goals:
+     *
+     * 1. Amendments are **always audit-safe**. The amendment process will still retain
+     *    original events in the timeframe, though they will be ignored for billing
+     *    calculations. For auditing a nd data fidelity purposes, Orb never overwrites
+     *    or permanently deletes ingested usage data.
+     * 2. Amendments always preser ve data **consistency**. In other words, either an
+     *    amendment is fully processed by the system (and the new events for th e
+     *    timeframe are honored rather than the existing ones) or the amendment request
+     *    fails. To maintain this important proper ty, Orb prevents _partial event
+     *    ingestion_ on this endpoint.
+     *
+     * ## Response semantics
+     *
+     * - Either all events are ingested successfully, or all fail to ingest (returning
+     *   a `4xx` or `5xx` response code).
+     * - Any event that fails schema validation will lead to a `4xx` response. In this
+     *   case, to maintain data consistency, Orb will not ingest any events and will
+     *   also not deprecate existing events in the time period.
+     * - You can assume that the amendment is successful on receipt of a `2xx`
+     *   response.While a successful response from this endpoint indicates that the new
+     *   events have been ingested, updati ng usage totals happens asynchronously and
+     *   may be delayed by a few minutes.
+     *
+     * As emphasized above, Orb will never show an inconsistent state (e.g. in invoice
+     * previews or dashboards); either it will show the existing state (before the
+     * amend ment) or the new state (with new events in the requested timeframe).
+     *
+     * ## Sample request body
+     *
+     * ```json
+     * {
+     *   "events": [
+     *     {
+     *       "event_name": "payment_processed",
+     *       "timestamp": "2022-03-24T07:15:00Z",
+     *       "properties": {
+     *         "amount": 100
+     *       }
+     *     },
+     *     {
+     *       "event_name": "payment_failed",
+     *       "timestamp": "2022-03-24T07:15:00Z",
+     *       "properties": {
+     *         "amount": 100
+     *       }
+     *     }
+     *   ]
+     * }
+     * ```
+     *
+     * ## Request Validation
+     *
+     * - The `timestamp` of each event reported must fall within the bounds of
+     *   `timeframe_start` and `timeframe_end`. As with ingestion, all timesta mps must
+     *   be sent in ISO8601 format with UTC timezone offset.
+     * - Orb **does not accept an `idempotency_key`** with each event in this endpoint,
+     *   since the entirety of the event list must be ingested to ensure consistency.
+     *   On retryable errors , you should retry the request in its entirety, and assume
+     *   that the amendment operation has not succeeded until receipt of a `2xx`.
+     *
+     * - Both `timeframe_start` and `timeframe_end` must be timestamps in the past.
+     *   Furthermore, Orb will genera lly validate that the `timeframe_start` and
+     *   `timeframe_end` fall within the customer's _current_ subscription billing pe
+     *   riod. However, Orb does allow amendments while in the grace period of the
+     *   previous billing period; in this instance, the timeframe can start before the
+     *   current period.
+     *
+     * ## API Limits
+     *
+     * Note that Orb does not currently enforce a hard rate- limit for API usage or a
+     * maximum request payload size. Similar to the event ingestion API, this API is
+     * architected for h igh-throughput ingestion. It is also safe to
+     * _programmatically_ call this endpoint if your system can automatically dete ct a
+     * need for historical amendment.
+     *
+     * In order to overwrite timeframes with a very large number of events, we suggest
+     * using multiple calls with small adjacent (e.g. every hour) timeframes.
+     */
+    updateByExternalId(id: string | null, params: UsageUpdateByExternalIDParams, options?: Core.RequestOptions): Core.APIPromise<UsageUpdateByExternalIDResponse>;
+}
+export interface UsageUpdateResponse {
+    /**
+     * An array of strings, corresponding to idempotency_key's marked as duplicates
+     * (previously ingested)
+     */
+    duplicate: Array<string>;
+    /**
+     * An array of strings, corresponding to idempotency_key's which were successfully
+     * ingested.
+     */
+    ingested: Array<string>;
+}
+export interface UsageUpdateByExternalIDResponse {
+    /**
+     * An array of strings, corresponding to idempotency_key's marked as duplicates
+     * (previously ingested)
+     */
+    duplicate: Array<string>;
+    /**
+     * An array of strings, corresponding to idempotency_key's which were successfully
+     * ingested.
+     */
+    ingested: Array<string>;
+}
+export interface UsageUpdateParams {
+    /**
+     * Body param: A name to meaningfully identify the action or event type.
+     */
+    event_name: string;
+    /**
+     * Body param: A dictionary of custom properties. Values in this dictionary must be
+     * numeric, boolean, or strings. Nested dictionaries are disallowed.
+     */
+    properties: unknown;
+    /**
+     * Body param: An ISO 8601 format date with no timezone offset (i.e. UTC). This
+     * should represent the time that usage was recorded, and is particularly important
+     * to attribute usage to a given billing period.
+     */
+    timestamp: string;
+    /**
+     * Query param: This bound is exclusive (i.e. events before this timestamp will be
+     * updated)
+     */
+    timeframe_end?: string;
+    /**
+     * Query param: This bound is inclusive (i.e. events with this timestamp onward,
+     * inclusive will be updated)
+     */
+    timeframe_start?: string;
+    /**
+     * Body param: The Orb Customer identifier
+     */
+    customer_id?: string | null;
+    /**
+     * Body param: An alias for the Orb customer, whose mapping is specified when
+     * creating the customer
+     */
+    external_customer_id?: string | null;
+}
+export interface UsageUpdateByExternalIDParams {
+    /**
+     * Body param: A name to meaningfully identify the action or event type.
+     */
+    event_name: string;
+    /**
+     * Body param: A dictionary of custom properties. Values in this dictionary must be
+     * numeric, boolean, or strings. Nested dictionaries are disallowed.
+     */
+    properties: unknown;
+    /**
+     * Body param: An ISO 8601 format date with no timezone offset (i.e. UTC). This
+     * should represent the time that usage was recorded, and is particularly important
+     * to attribute usage to a given billing period.
+     */
+    timestamp: string;
+    /**
+     * Query param: This bound is exclusive (i.e. events before this timestamp will be
+     * updated)
+     */
+    timeframe_end?: string;
+    /**
+     * Query param: This bound is inclusive (i.e. events with this timestamp onward,
+     * inclusive will be updated)
+     */
+    timeframe_start?: string;
+    /**
+     * Body param: The Orb Customer identifier
+     */
+    customer_id?: string | null;
+    /**
+     * Body param: An alias for the Orb customer, whose mapping is specified when
+     * creating the customer
+     */
+    external_customer_id?: string | null;
+}
+export declare namespace Usage {
+    export import UsageUpdateResponse = UsageAPI.UsageUpdateResponse;
+    export import UsageUpdateByExternalIDResponse = UsageAPI.UsageUpdateByExternalIDResponse;
+    export import UsageUpdateParams = UsageAPI.UsageUpdateParams;
+    export import UsageUpdateByExternalIDParams = UsageAPI.UsageUpdateByExternalIDParams;
+}
+//# sourceMappingURL=usage.d.ts.map

package/resources/customers/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/customers/usage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,QAAQ,MAAM,uCAAuC,CAAC;AAElE,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiGG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IASvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiGG;IACH,kBAAkB,CAChB,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAQpD;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,yBAAiB,KAAK,CAAC;IACrB,MAAM,QAAQ,mBAAmB,GAAG,QAAQ,CAAC,mBAAmB,CAAC;IACjE,MAAM,QAAQ,+BAA+B,GAAG,QAAQ,CAAC,+BAA+B,CAAC;IACzF,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAC7D,MAAM,QAAQ,6BAA6B,GAAG,QAAQ,CAAC,6BAA6B,CAAC;CACtF"}