orb-billing 2.5.1 → 2.6.0

package/resources/alerts.mjs

@@ -1,13 +1,106 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from 'orb-billing/resource';
+import { isRequestOptions } from 'orb-billing/core';
+import * as AlertsAPI from 'orb-billing/resources/alerts';
+import { Page } from 'orb-billing/pagination';
 export class Alerts extends APIResource {
     /**
-     * This endpoint can be used to enable an alert.
+     * This endpoint retrieves an alert by its ID.
      */
-    enable(alertConfigurationId, options) {
-        return this._client.post(`/alerts/${alertConfigurationId}/enable`, options);
+    retrieve(alertId, options) {
+        return this._client.get(`/alerts/${alertId}`, options);
     }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/alerts', AlertsPage, { query, ...options });
+    }
+    /**
+     * This endpoint creates a new alert to monitor a customer's credit balance. There
+     * are three types of alerts that can be scoped to customers:
+     * `credit_balance_depleted`, `credit_balance_dropped`, and
+     * `credit_balance_recovered`. Customers can have a maximum of one of each type of
+     * alert per
+     * [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+     * `credit_balance_dropped` alerts require a list of thresholds to be provided
+     * while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
+     * require thresholds.
+     */
+    createForCustomer(customerId, body, options) {
+        return this._client.post(`/alerts/customer_id/${customerId}`, { body, ...options });
+    }
+    /**
+     * This endpoint creates a new alert to monitor a customer's credit balance. There
+     * are three types of alerts that can be scoped to customers:
+     * `credit_balance_depleted`, `credit_balance_dropped`, and
+     * `credit_balance_recovered`. Customers can have a maximum of one of each type of
+     * alert per
+     * [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+     * `credit_balance_dropped` alerts require a list of thresholds to be provided
+     * while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
+     * require thresholds.
+     */
+    createForExternalCustomer(externalCustomerId, body, options) {
+        return this._client.post(`/alerts/external_customer_id/${externalCustomerId}`, { body, ...options });
+    }
+    /**
+     * This endpoint is used to create alerts at the plan level. Plan level alerts are
+     * automatically propagated to all subscriptions associated with the plan. These
+     * alerts are scoped to a specific plan version; if no version is specified, the
+     * active plan version is used.
+     *
+     * Plan level alerts can be of two types: `usage_exceeded` or `cost_exceeded`. A
+     * `usage_exceeded` alert is scoped to a particular metric and is triggered when
+     * the usage of that metric exceeds a predefined thresholds during the current
+     * invoice cycle. A `cost_exceeded` alert is triggered when the total cost of the
+     * subscription on the plan surpasses predefined thresholds in the current invoice
+     * cycle.Each plan can have one `cost_exceeded` alert and one `usage_exceeded`
+     * alert per metric that is apart of the plan.
+     */
+    createForPlan(planId, body, options) {
+        return this._client.post(`/alerts/plan_id/${planId}`, { body, ...options });
+    }
+    /**
+     * This endpoint is used to create alerts at the subscription level.
+     *
+     * Subscription level alerts can be one of two types: `usage_exceeded` or
+     * `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
+     * is triggered when the usage of that metric exceeds a predefined thresholds
+     * during the current invoice cycle. A `cost_exceeded` alert is triggered when the
+     * total cost of the subscription surpasses predefined thresholds in the current
+     * invoice cycle. Each subscription can have one `cost_exceeded` alert and one
+     * `usage_exceeded` alert per metric that is apart of the subscription. Alerts are
+     * triggered based on usage or cost conditions met during the current invoice
+     * cycle.
+     */
+    createForSubscription(subscriptionId, body, options) {
+        return this._client.post(`/alerts/subscription_id/${subscriptionId}`, { body, ...options });
+    }
+    disable(alertConfigurationId, params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.disable(alertConfigurationId, {}, params);
+        }
+        const { subscription_id } = params;
+        return this._client.post(`/alerts/${alertConfigurationId}/disable`, {
+            query: { subscription_id },
+            ...options,
+        });
+    }
+    enable(alertConfigurationId, params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.enable(alertConfigurationId, {}, params);
+        }
+        const { subscription_id } = params;
+        return this._client.post(`/alerts/${alertConfigurationId}/enable`, {
+            query: { subscription_id },
+            ...options,
+        });
+    }
+}
+export class AlertsPage extends Page {
 }
 (function (Alerts) {
+    Alerts.AlertsPage = AlertsAPI.AlertsPage;
 })(Alerts || (Alerts = {}));
 //# sourceMappingURL=alerts.mjs.map

package/resources/alerts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,sBAAsB;AAGlD,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,MAAM,CAAC,oBAA4B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAoFD,WAAiB,MAAM;AAEvB,CAAC,EAFgB,MAAM,KAAN,MAAM,QAEtB"}
+{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,sBAAsB;OAC3C,EAAE,gBAAgB,EAAE,MAAM,kBAAkB;OAC5C,KAAK,SAAS,MAAM,8BAA8B;OAClD,EAAE,IAAI,EAAmB,MAAM,wBAAwB;AAE9D,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAkBD,IAAI,CACF,QAA+C,EAAE,EACjD,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,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;OAUG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAc,EACd,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAgBD,OAAO,CACL,oBAA4B,EAC5B,SAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACvD;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,UAAU,EAAE;YAClE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAgBD,MAAM,CACJ,oBAA4B,EAC5B,SAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACtD;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,SAAS,EAAE;YACjE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,IAAW;CAAG;AAiR9C,WAAiB,MAAM;IAEP,iBAAU,GAAG,SAAS,CAAC,UAAU,CAAC;AAQlD,CAAC,EAVgB,MAAM,KAAN,MAAM,QAUtB"}

package/resources/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./shared.js";
-export { Alert, Alerts } from "./alerts.js";
+export { Alert, AlertListParams, AlertCreateForCustomerParams, AlertCreateForExternalCustomerParams, AlertCreateForPlanParams, AlertCreateForSubscriptionParams, AlertDisableParams, AlertEnableParams, AlertsPage, Alerts, } from "./alerts.js";
 export { Coupon, CouponCreateParams, CouponListParams, CouponsPage, Coupons } from "./coupons/coupons.js";
 export { CreditNote, CreditNoteListParams, CreditNotesPage, CreditNotes } from "./credit-notes.js";
 export { Customer, CustomerCreateParams, CustomerUpdateParams, CustomerListParams, CustomerUpdateByExternalIDParams, CustomersPage, Customers, } from "./customers/customers.js";

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EACL,QAAQ,EACR,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,gCAAgC,EAChC,aAAa,EACb,SAAS,GACV,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,kBAAkB,EAClB,KAAK,EACL,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,UAAU,EACV,MAAM,GACP,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,GACP,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,OAAO,EACP,4BAA4B,EAC5B,mBAAmB,EACnB,iBAAiB,EACjB,0BAA0B,EAC1B,qBAAqB,EACrB,YAAY,EACZ,QAAQ,GACT,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,OAAO,GACR,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3G,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,8BAA8B,EAC9B,iCAAiC,EACjC,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,+BAA+B,EAC/B,4BAA4B,EAC5B,gCAAgC,EAChC,oCAAoC,EACpC,8BAA8B,EAC9B,mDAAmD,EACnD,wCAAwC,EACxC,iBAAiB,EACjB,sCAAsC,GACvC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,OAAO,EACL,KAAK,EACL,eAAe,EACf,4BAA4B,EAC5B,oCAAoC,EACpC,wBAAwB,EACxB,gCAAgC,EAChC,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,MAAM,GACP,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EACL,QAAQ,EACR,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,gCAAgC,EAChC,aAAa,EACb,SAAS,GACV,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,kBAAkB,EAClB,KAAK,EACL,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,UAAU,EACV,MAAM,GACP,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,GACP,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,OAAO,EACP,4BAA4B,EAC5B,mBAAmB,EACnB,iBAAiB,EACjB,0BAA0B,EAC1B,qBAAqB,EACrB,YAAY,EACZ,QAAQ,GACT,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,OAAO,GACR,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3G,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,8BAA8B,EAC9B,iCAAiC,EACjC,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,+BAA+B,EAC/B,4BAA4B,EAC5B,gCAAgC,EAChC,oCAAoC,EACpC,8BAA8B,EAC9B,mDAAmD,EACnD,wCAAwC,EACxC,iBAAiB,EACjB,sCAAsC,GACvC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/resources/index.js

@@ -15,9 +15,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Webhooks = exports.TopLevel = exports.SubscriptionFetchScheduleResponsesPage = exports.SubscriptionsPage = exports.Subscriptions = exports.Plans = exports.PlansPage = exports.Metrics = exports.MetricListResponsesPage = exports.Items = exports.ItemsPage = exports.InvoiceLineItems = exports.Invoices = exports.InvoicesPage = exports.Events = exports.Prices = exports.PricesPage = exports.Customers = exports.CustomersPage = exports.CreditNotes = exports.CreditNotesPage = exports.Coupons = exports.CouponsPage = exports.Alerts = void 0;
+exports.Webhooks = exports.TopLevel = exports.SubscriptionFetchScheduleResponsesPage = exports.SubscriptionsPage = exports.Subscriptions = exports.Plans = exports.PlansPage = exports.Metrics = exports.MetricListResponsesPage = exports.Items = exports.ItemsPage = exports.InvoiceLineItems = exports.Invoices = exports.InvoicesPage = exports.Events = exports.Prices = exports.PricesPage = exports.Customers = exports.CustomersPage = exports.CreditNotes = exports.CreditNotesPage = exports.Coupons = exports.CouponsPage = exports.Alerts = exports.AlertsPage = void 0;
 __exportStar(require("./shared.js"), exports);
 var alerts_1 = require("./alerts.js");
+Object.defineProperty(exports, "AlertsPage", { enumerable: true, get: function () { return alerts_1.AlertsPage; } });
 Object.defineProperty(exports, "Alerts", { enumerable: true, get: function () { return alerts_1.Alerts; } });
 var coupons_1 = require("./coupons/coupons.js");
 Object.defineProperty(exports, "CouponsPage", { enumerable: true, get: function () { return coupons_1.CouponsPage; } });

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,8CAAyB;AACzB,sCAAyC;AAAzB,gGAAA,MAAM,OAAA;AACtB,gDAAuG;AAAhD,sGAAA,WAAW,OAAA;AAAE,kGAAA,OAAO,OAAA;AAC3E,kDAAgG;AAArD,+GAAA,eAAe,OAAA;AAAE,2GAAA,WAAW,OAAA;AACvE,sDAQ+B;AAF7B,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AAEX,6CASyB;AAFvB,oGAAA,UAAU,OAAA;AACV,gGAAA,MAAM,OAAA;AAER,6CASyB;AADvB,gGAAA,MAAM,OAAA;AAER,0CASoB;AAFlB,wGAAA,YAAY,OAAA;AACZ,oGAAA,QAAQ,OAAA;AAEV,8DAI8B;AAD5B,sHAAA,gBAAgB,OAAA;AAElB,oCAAmF;AAAlC,kGAAA,SAAS,OAAA;AAAE,8FAAA,KAAK,OAAA;AACjE,wCAQmB;AAFjB,kHAAA,uBAAuB,OAAA;AACvB,kGAAA,OAAO,OAAA;AAET,0CAA2G;AAAxC,kGAAA,SAAS,OAAA;AAAE,8FAAA,KAAK,OAAA;AACnF,oDAoByB;AAjBvB,8GAAA,aAAa,OAAA;AAeb,kHAAA,iBAAiB,OAAA;AACjB,uIAAA,sCAAsC,OAAA;AAExC,4CAA6D;AAA9B,qGAAA,QAAQ,OAAA;AACvC,0CAAsC;AAA7B,oGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,8CAAyB;AACzB,sCAWkB;AAFhB,oGAAA,UAAU,OAAA;AACV,gGAAA,MAAM,OAAA;AAER,gDAAuG;AAAhD,sGAAA,WAAW,OAAA;AAAE,kGAAA,OAAO,OAAA;AAC3E,kDAAgG;AAArD,+GAAA,eAAe,OAAA;AAAE,2GAAA,WAAW,OAAA;AACvE,sDAQ+B;AAF7B,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AAEX,6CASyB;AAFvB,oGAAA,UAAU,OAAA;AACV,gGAAA,MAAM,OAAA;AAER,6CASyB;AADvB,gGAAA,MAAM,OAAA;AAER,0CASoB;AAFlB,wGAAA,YAAY,OAAA;AACZ,oGAAA,QAAQ,OAAA;AAEV,8DAI8B;AAD5B,sHAAA,gBAAgB,OAAA;AAElB,oCAAmF;AAAlC,kGAAA,SAAS,OAAA;AAAE,8FAAA,KAAK,OAAA;AACjE,wCAQmB;AAFjB,kHAAA,uBAAuB,OAAA;AACvB,kGAAA,OAAO,OAAA;AAET,0CAA2G;AAAxC,kGAAA,SAAS,OAAA;AAAE,8FAAA,KAAK,OAAA;AACnF,oDAoByB;AAjBvB,8GAAA,aAAa,OAAA;AAeb,kHAAA,iBAAiB,OAAA;AACjB,uIAAA,sCAAsC,OAAA;AAExC,4CAA6D;AAA9B,qGAAA,QAAQ,OAAA;AACvC,0CAAsC;AAA7B,oGAAA,QAAQ,OAAA"}

package/resources/index.mjs

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export * from "./shared.mjs";
-export { Alerts } from "./alerts.mjs";
+export { AlertsPage, Alerts, } from "./alerts.mjs";
 export { CouponsPage, Coupons } from "./coupons/coupons.mjs";
 export { CreditNotesPage, CreditNotes } from "./credit-notes.mjs";
 export { CustomersPage, Customers, } from "./customers/customers.mjs";

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EAAS,MAAM,EAAE;OACjB,EAAgD,WAAW,EAAE,OAAO,EAAE;OACtE,EAAoC,eAAe,EAAE,WAAW,EAAE;OAClE,EAML,aAAa,EACb,SAAS,GACV;OACM,EAOL,UAAU,EACV,MAAM,GACP;OACM,EAQL,MAAM,GACP;OACM,EAOL,YAAY,EACZ,QAAQ,GACT;OACM,EAGL,gBAAgB,GACjB;OACM,EAA0C,SAAS,EAAE,KAAK,EAAE;OAC5D,EAML,uBAAuB,EACvB,OAAO,GACR;OACM,EAA4D,SAAS,EAAE,KAAK,EAAE;OAC9E,EAGL,aAAa,EAeb,iBAAiB,EACjB,sCAAsC,GACvC;OACM,EAAwB,QAAQ,EAAE;OAClC,EAAE,QAAQ,EAAE"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EASL,UAAU,EACV,MAAM,GACP;OACM,EAAgD,WAAW,EAAE,OAAO,EAAE;OACtE,EAAoC,eAAe,EAAE,WAAW,EAAE;OAClE,EAML,aAAa,EACb,SAAS,GACV;OACM,EAOL,UAAU,EACV,MAAM,GACP;OACM,EAQL,MAAM,GACP;OACM,EAOL,YAAY,EACZ,QAAQ,GACT;OACM,EAGL,gBAAgB,GACjB;OACM,EAA0C,SAAS,EAAE,KAAK,EAAE;OAC5D,EAML,uBAAuB,EACvB,OAAO,GACR;OACM,EAA4D,SAAS,EAAE,KAAK,EAAE;OAC9E,EAGL,aAAa,EAeb,iBAAiB,EACjB,sCAAsC,GACvC;OACM,EAAwB,QAAQ,EAAE;OAClC,EAAE,QAAQ,EAAE"}

package/resources/subscriptions.d.ts

@@ -896,7 +896,7 @@ export interface Subscription {
     /**
      * Determines whether issued invoices for this subscription will automatically be
      * charged with the saved payment method on the due date. This property defaults to
-     * the plan's behavior.
+     * the plan's behavior. If null, defaults to the customer's setting.
      */
     auto_collection: boolean | null;
     /**

package/src/index.ts

@@ -329,6 +329,14 @@ export namespace Orb {
 
   export import Alerts = API.Alerts;
   export import Alert = API.Alert;
+  export import AlertsPage = API.AlertsPage;
+  export import AlertListParams = API.AlertListParams;
+  export import AlertCreateForCustomerParams = API.AlertCreateForCustomerParams;
+  export import AlertCreateForExternalCustomerParams = API.AlertCreateForExternalCustomerParams;
+  export import AlertCreateForPlanParams = API.AlertCreateForPlanParams;
+  export import AlertCreateForSubscriptionParams = API.AlertCreateForSubscriptionParams;
+  export import AlertDisableParams = API.AlertDisableParams;
+  export import AlertEnableParams = API.AlertEnableParams;
 
   export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
   export import Discount = API.Discount;

package/src/resources/alerts.ts

@@ -2,17 +2,186 @@
 
 import * as Core from "../core";
 import { APIResource } from "../resource";
+import { isRequestOptions } from "../core";
 import * as AlertsAPI from "./alerts";
+import { Page, type PageParams } from "../pagination";
 
 export class Alerts extends APIResource {
+  /**
+   * This endpoint retrieves an alert by its ID.
+   */
+  retrieve(alertId: string, options?: Core.RequestOptions): Core.APIPromise<Alert> {
+    return this._client.get(`/alerts/${alertId}`, options);
+  }
+
+  /**
+   * This endpoint returns a list of all
+   * [`alerts`](https://docs.withorb.com/guides/product-catalog/configuring-alerts).
+   *
+   * The list of alerts is ordered starting from the most recently created alert.
+   * This endpoint follows Orb's
+   * [standardized pagination format](../reference/pagination).
+   *
+   * The request must specify one of customer_id, external_customer_id,
+   * subscription_id, or plan_id
+   *
+   * If querying by subscripion_id, the endpoint will return the subscription level
+   * alerts as well as the plan level alerts associated with the subscription.
+   */
+  list(query?: AlertListParams, options?: Core.RequestOptions): Core.PagePromise<AlertsPage, Alert>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AlertsPage, Alert>;
+  list(
+    query: AlertListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AlertsPage, Alert> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/alerts', AlertsPage, { query, ...options });
+  }
+
+  /**
+   * This endpoint creates a new alert to monitor a customer's credit balance. There
+   * are three types of alerts that can be scoped to customers:
+   * `credit_balance_depleted`, `credit_balance_dropped`, and
+   * `credit_balance_recovered`. Customers can have a maximum of one of each type of
+   * alert per
+   * [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+   * `credit_balance_dropped` alerts require a list of thresholds to be provided
+   * while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
+   * require thresholds.
+   */
+  createForCustomer(
+    customerId: string,
+    body: AlertCreateForCustomerParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert> {
+    return this._client.post(`/alerts/customer_id/${customerId}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint creates a new alert to monitor a customer's credit balance. There
+   * are three types of alerts that can be scoped to customers:
+   * `credit_balance_depleted`, `credit_balance_dropped`, and
+   * `credit_balance_recovered`. Customers can have a maximum of one of each type of
+   * alert per
+   * [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+   * `credit_balance_dropped` alerts require a list of thresholds to be provided
+   * while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
+   * require thresholds.
+   */
+  createForExternalCustomer(
+    externalCustomerId: string,
+    body: AlertCreateForExternalCustomerParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert> {
+    return this._client.post(`/alerts/external_customer_id/${externalCustomerId}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint is used to create alerts at the plan level. Plan level alerts are
+   * automatically propagated to all subscriptions associated with the plan. These
+   * alerts are scoped to a specific plan version; if no version is specified, the
+   * active plan version is used.
+   *
+   * Plan level alerts can be of two types: `usage_exceeded` or `cost_exceeded`. A
+   * `usage_exceeded` alert is scoped to a particular metric and is triggered when
+   * the usage of that metric exceeds a predefined thresholds during the current
+   * invoice cycle. A `cost_exceeded` alert is triggered when the total cost of the
+   * subscription on the plan surpasses predefined thresholds in the current invoice
+   * cycle.Each plan can have one `cost_exceeded` alert and one `usage_exceeded`
+   * alert per metric that is apart of the plan.
+   */
+  createForPlan(
+    planId: string,
+    body: AlertCreateForPlanParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert> {
+    return this._client.post(`/alerts/plan_id/${planId}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint is used to create alerts at the subscription level.
+   *
+   * Subscription level alerts can be one of two types: `usage_exceeded` or
+   * `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
+   * is triggered when the usage of that metric exceeds a predefined thresholds
+   * during the current invoice cycle. A `cost_exceeded` alert is triggered when the
+   * total cost of the subscription surpasses predefined thresholds in the current
+   * invoice cycle. Each subscription can have one `cost_exceeded` alert and one
+   * `usage_exceeded` alert per metric that is apart of the subscription. Alerts are
+   * triggered based on usage or cost conditions met during the current invoice
+   * cycle.
+   */
+  createForSubscription(
+    subscriptionId: string,
+    body: AlertCreateForSubscriptionParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert> {
+    return this._client.post(`/alerts/subscription_id/${subscriptionId}`, { body, ...options });
+  }
+
+  /**
+   * This endpoint can be used to disable an alert.
+   *
+   * By default, disabling a plan level alert will apply to all subscriptions on that
+   * plan. In order to toggle a plan level alert for a specific subscription, the
+   * client must provide the plan level alert id as well as the subscription_id
+   * parameter.
+   */
+  disable(
+    alertConfigurationId: string,
+    params?: AlertDisableParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert>;
+  disable(alertConfigurationId: string, options?: Core.RequestOptions): Core.APIPromise<Alert>;
+  disable(
+    alertConfigurationId: string,
+    params: AlertDisableParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert> {
+    if (isRequestOptions(params)) {
+      return this.disable(alertConfigurationId, {}, params);
+    }
+    const { subscription_id } = params;
+    return this._client.post(`/alerts/${alertConfigurationId}/disable`, {
+      query: { subscription_id },
+      ...options,
+    });
+  }
+
   /**
    * This endpoint can be used to enable an alert.
+   *
+   * By default, enabling a plan level alert will apply to all subscriptions on that
+   * plan. In order to toggle a plan level alert for a specific subscription, the
+   * client must provide the plan level alert id as well as the subscription_id
+   * parameter.
    */
-  enable(alertConfigurationId: string, options?: Core.RequestOptions): Core.APIPromise<Alert> {
-    return this._client.post(`/alerts/${alertConfigurationId}/enable`, options);
+  enable(
+    alertConfigurationId: string,
+    params?: AlertEnableParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert>;
+  enable(alertConfigurationId: string, options?: Core.RequestOptions): Core.APIPromise<Alert>;
+  enable(
+    alertConfigurationId: string,
+    params: AlertEnableParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Alert> {
+    if (isRequestOptions(params)) {
+      return this.enable(alertConfigurationId, {}, params);
+    }
+    const { subscription_id } = params;
+    return this._client.post(`/alerts/${alertConfigurationId}/enable`, {
+      query: { subscription_id },
+      ...options,
+    });
   }
 }
 
+export class AlertsPage extends Page<Alert> {}
+
 /**
  * An
  * [Alert within Orb](https://docs.withorb.com/guides/product-catalog/configuring-alerts)
@@ -51,7 +220,7 @@ export interface Alert {
   currency: string | null;
 
   /**
-   * The customer that the alert is scoped to.
+   * The customer the alert applies to.
    */
   customer: Record<string, string | null> | null;
 
@@ -60,13 +229,19 @@ export interface Alert {
    */
   enabled: boolean;
 
+  /**
+   * The metric the alert applies to.
+   */
   metric: Record<string, string | null> | null;
 
   /**
-   * The plan that the alert is scoped to.
+   * The plan the alert applies to.
    */
   plan: Record<string, string | null> | null;
 
+  /**
+   * The subscription the alert applies to.
+   */
   subscription: Record<string, string | null> | null;
 
   /**
@@ -78,7 +253,12 @@ export interface Alert {
   /**
    * The type of alert. This must be a valid alert type.
    */
-  type: 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered';
+  type:
+    | 'usage_exceeded'
+    | 'cost_exceeded'
+    | 'credit_balance_depleted'
+    | 'credit_balance_dropped'
+    | 'credit_balance_recovered';
 }
 
 export namespace Alert {
@@ -95,6 +275,192 @@ export namespace Alert {
   }
 }
 
+export interface AlertListParams extends PageParams {
+  'created_at[gt]'?: string | null;
+
+  'created_at[gte]'?: string | null;
+
+  'created_at[lt]'?: string | null;
+
+  'created_at[lte]'?: string | null;
+
+  /**
+   * Fetch alerts scoped to this customer_id
+   */
+  customer_id?: string | null;
+
+  /**
+   * Fetch alerts scoped to this external_customer_id
+   */
+  external_customer_id?: string | null;
+
+  /**
+   * Fetch alerts scoped to this plan_id
+   */
+  plan_id?: string | null;
+
+  /**
+   * If provided alongside plan_id, only the alerts that are scoped to the specified plan_version will be returned.
+   */
+  plan_version?: number | null;
+
+  /**
+   * Fetch alerts scoped to this subscription_id
+   */
+  subscription_id?: string | null;
+}
+
+export interface AlertCreateForCustomerParams {
+  /**
+   * The case sensitive currency or custom pricing unit to use for this alert.
+   */
+  currency: string;
+
+  /**
+   * The thresholds that define the values at which the alert will be triggered.
+   */
+  type: string;
+
+  /**
+   * The thresholds for the alert.
+   */
+  thresholds?: Array<AlertCreateForCustomerParams.Threshold> | null;
+}
+
+export namespace AlertCreateForCustomerParams {
+  /**
+   * Thresholds are used to define the conditions under which an alert will be
+   * triggered.
+   */
+  export interface Threshold {
+    /**
+     * The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and
+     *         cost alerts, the alert will fire at or above this value.
+     */
+    value: number;
+  }
+}
+
+export interface AlertCreateForExternalCustomerParams {
+  /**
+   * The case sensitive currency or custom pricing unit to use for this alert.
+   */
+  currency: string;
+
+  /**
+   * The thresholds that define the values at which the alert will be triggered.
+   */
+  type: string;
+
+  /**
+   * The thresholds for the alert.
+   */
+  thresholds?: Array<AlertCreateForExternalCustomerParams.Threshold> | null;
+}
+
+export namespace AlertCreateForExternalCustomerParams {
+  /**
+   * Thresholds are used to define the conditions under which an alert will be
+   * triggered.
+   */
+  export interface Threshold {
+    /**
+     * The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and
+     *         cost alerts, the alert will fire at or above this value.
+     */
+    value: number;
+  }
+}
+
+export interface AlertCreateForPlanParams {
+  /**
+   * The thresholds for the alert.
+   */
+  thresholds: Array<AlertCreateForPlanParams.Threshold>;
+
+  /**
+   * The thresholds that define the values at which the alert will be triggered.
+   */
+  type: string;
+
+  /**
+   * The metric to track usage for.
+   */
+  metric_id?: string | null;
+
+  /**
+   * The plan version to create alerts for. If not specified, the default will be the plan's active plan version.
+   */
+  plan_version?: number | null;
+}
+
+export namespace AlertCreateForPlanParams {
+  /**
+   * Thresholds are used to define the conditions under which an alert will be
+   * triggered.
+   */
+  export interface Threshold {
+    /**
+     * The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and
+     *         cost alerts, the alert will fire at or above this value.
+     */
+    value: number;
+  }
+}
+
+export interface AlertCreateForSubscriptionParams {
+  /**
+   * The thresholds for the alert.
+   */
+  thresholds: Array<AlertCreateForSubscriptionParams.Threshold>;
+
+  /**
+   * The thresholds that define the values at which the alert will be triggered.
+   */
+  type: string;
+
+  /**
+   * The metric to track usage for.
+   */
+  metric_id?: string | null;
+}
+
+export namespace AlertCreateForSubscriptionParams {
+  /**
+   * Thresholds are used to define the conditions under which an alert will be
+   * triggered.
+   */
+  export interface Threshold {
+    /**
+     * The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and
+     *         cost alerts, the alert will fire at or above this value.
+     */
+    value: number;
+  }
+}
+
+export interface AlertDisableParams {
+  /**
+   * Used to update the status of a plan alert scoped to this subscription_id
+   */
+  subscription_id?: string | null;
+}
+
+export interface AlertEnableParams {
+  /**
+   * Used to update the status of a plan alert scoped to this subscription_id
+   */
+  subscription_id?: string | null;
+}
+
 export namespace Alerts {
   export import Alert = AlertsAPI.Alert;
+  export import AlertsPage = AlertsAPI.AlertsPage;
+  export import AlertListParams = AlertsAPI.AlertListParams;
+  export import AlertCreateForCustomerParams = AlertsAPI.AlertCreateForCustomerParams;
+  export import AlertCreateForExternalCustomerParams = AlertsAPI.AlertCreateForExternalCustomerParams;
+  export import AlertCreateForPlanParams = AlertsAPI.AlertCreateForPlanParams;
+  export import AlertCreateForSubscriptionParams = AlertsAPI.AlertCreateForSubscriptionParams;
+  export import AlertDisableParams = AlertsAPI.AlertDisableParams;
+  export import AlertEnableParams = AlertsAPI.AlertEnableParams;
 }

package/src/resources/index.ts

@@ -1,7 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
-export { Alert, Alerts } from './alerts';
+export {
+  Alert,
+  AlertListParams,
+  AlertCreateForCustomerParams,
+  AlertCreateForExternalCustomerParams,
+  AlertCreateForPlanParams,
+  AlertCreateForSubscriptionParams,
+  AlertDisableParams,
+  AlertEnableParams,
+  AlertsPage,
+  Alerts,
+} from './alerts';
 export { Coupon, CouponCreateParams, CouponListParams, CouponsPage, Coupons } from './coupons/coupons';
 export { CreditNote, CreditNoteListParams, CreditNotesPage, CreditNotes } from './credit-notes';
 export {

package/src/resources/subscriptions.ts

@@ -1074,7 +1074,7 @@ export interface Subscription {
   /**
    * Determines whether issued invoices for this subscription will automatically be
    * charged with the saved payment method on the due date. This property defaults to
-   * the plan's behavior.
+   * the plan's behavior. If null, defaults to the customer's setting.
    */
   auto_collection: boolean | null;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.5.1'; // x-release-please-version
+export const VERSION = '2.6.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.5.1";
+export declare const VERSION = "2.6.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.5.1'; // x-release-please-version
+exports.VERSION = '2.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map