orb-billing 2.4.0 → 2.6.0

package/resources/alerts.d.ts

@@ -0,0 +1,340 @@
+import * as Core from 'orb-billing/core';
+import { APIResource } from 'orb-billing/resource';
+import * as AlertsAPI from 'orb-billing/resources/alerts';
+import { Page, type PageParams } from 'orb-billing/pagination';
+export declare class Alerts extends APIResource {
+    /**
+     * This endpoint retrieves an alert by its ID.
+     */
+    retrieve(alertId: string, options?: Core.RequestOptions): Core.APIPromise<Alert>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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, params?: AlertEnableParams, options?: Core.RequestOptions): Core.APIPromise<Alert>;
+    enable(alertConfigurationId: string, options?: Core.RequestOptions): Core.APIPromise<Alert>;
+}
+export declare class AlertsPage extends Page<Alert> {
+}
+/**
+ * An
+ * [Alert within Orb](https://docs.withorb.com/guides/product-catalog/configuring-alerts)
+ * monitors a customer's spending, usage, or credit balance and triggers a webhook
+ * when a threshold is exceeded.
+ *
+ * Alerts can be configured to monitor usage, cost, or credit balance. Alerts can
+ * be scoped to either a customer, a plan, or a subscription.
+ *
+ * Customer scoped alerts track a customer's credit balance. Valid customer alert
+ * types are "credit_balance_depleted", "credit_balance_recovered", and
+ * "credit_balance_dropped".
+ *
+ * Subscription scoped alerts track a subscriptions's usage or cost. Valid plan
+ * alert types are "usage_exceeded" or "cost_exceeded".
+ *
+ * Plan scoped alerts are similar to subscriptions alerts but when a plan alert is
+ * created, it is propagated to all subscriptions associated with the plan.
+ * Disabling a plan alert will disable the alert for all subscriptions. Valid plan
+ * alert types are "usage_exceeded" or "cost_exceeded".
+ */
+export interface Alert {
+    /**
+     * Also referred to as alert_id in this documentation.
+     */
+    id: string;
+    /**
+     * The creation time of the resource in Orb.
+     */
+    created_at: string;
+    /**
+     * The name of the currency the credit balance for this alert is denominated in.
+     */
+    currency: string | null;
+    /**
+     * The customer the alert applies to.
+     */
+    customer: Record<string, string | null> | null;
+    /**
+     * Whether the alert is enabled or disabled.
+     */
+    enabled: boolean;
+    /**
+     * The metric the alert applies to.
+     */
+    metric: Record<string, string | null> | null;
+    /**
+     * The plan the alert applies to.
+     */
+    plan: Record<string, string | null> | null;
+    /**
+     * The subscription the alert applies to.
+     */
+    subscription: Record<string, string | null> | null;
+    /**
+     * The thresholds that define the conditions under which the alert will be
+     * triggered.
+     */
+    thresholds: Array<Alert.Threshold> | null;
+    /**
+     * The type of alert. This must be a valid alert type.
+     */
+    type: 'usage_exceeded' | 'cost_exceeded' | 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered';
+}
+export declare namespace Alert {
+    /**
+     * Thresholds are used to define the conditions under which an alert will be
+     * triggered.
+     */
+    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 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 declare namespace AlertCreateForCustomerParams {
+    /**
+     * Thresholds are used to define the conditions under which an alert will be
+     * triggered.
+     */
+    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 declare namespace AlertCreateForExternalCustomerParams {
+    /**
+     * Thresholds are used to define the conditions under which an alert will be
+     * triggered.
+     */
+    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 declare namespace AlertCreateForPlanParams {
+    /**
+     * Thresholds are used to define the conditions under which an alert will be
+     * triggered.
+     */
+    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 declare namespace AlertCreateForSubscriptionParams {
+    /**
+     * Thresholds are used to define the conditions under which an alert will be
+     * triggered.
+     */
+    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 declare 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;
+}
+//# sourceMappingURL=alerts.d.ts.map

package/resources/alerts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,SAAS,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE/D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIhF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IACjG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAWxE;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;;OAUG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;OAOG;IACH,OAAO,CACL,oBAAoB,EAAE,MAAM,EAC5B,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IACzB,OAAO,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAgB5F;;;;;;;OAOG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IACzB,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;CAe5F;AAED,qBAAa,UAAW,SAAQ,IAAI,CAAC,KAAK,CAAC;CAAG;AAE9C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,EACA,gBAAgB,GAChB,eAAe,GACf,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,CAAC;CAChC;AAED,yBAAiB,KAAK,CAAC;IACrB;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,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;IAElC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CACnE;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC;IAE9D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,MAAM,CAAC;IACtB,MAAM,QAAQ,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;IACtC,MAAM,QAAQ,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;IAChD,MAAM,QAAQ,eAAe,GAAG,SAAS,CAAC,eAAe,CAAC;IAC1D,MAAM,QAAQ,4BAA4B,GAAG,SAAS,CAAC,4BAA4B,CAAC;IACpF,MAAM,QAAQ,oCAAoC,GAAG,SAAS,CAAC,oCAAoC,CAAC;IACpG,MAAM,QAAQ,wBAAwB,GAAG,SAAS,CAAC,wBAAwB,CAAC;IAC5E,MAAM,QAAQ,gCAAgC,GAAG,SAAS,CAAC,gCAAgC,CAAC;IAC5F,MAAM,QAAQ,kBAAkB,GAAG,SAAS,CAAC,kBAAkB,CAAC;IAChE,MAAM,QAAQ,iBAAiB,GAAG,SAAS,CAAC,iBAAiB,CAAC;CAC/D"}

package/resources/alerts.js

@@ -0,0 +1,134 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertsPage = exports.Alerts = void 0;
+const resource_1 = require("orb-billing/resource");
+const core_1 = require("orb-billing/core");
+const AlertsAPI = __importStar(require("orb-billing/resources/alerts"));
+const pagination_1 = require("orb-billing/pagination");
+class Alerts extends resource_1.APIResource {
+    /**
+     * This endpoint retrieves an alert by its ID.
+     */
+    retrieve(alertId, options) {
+        return this._client.get(`/alerts/${alertId}`, options);
+    }
+    list(query = {}, options) {
+        if ((0, core_1.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 ((0, core_1.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 ((0, core_1.isRequestOptions)(params)) {
+            return this.enable(alertConfigurationId, {}, params);
+        }
+        const { subscription_id } = params;
+        return this._client.post(`/alerts/${alertConfigurationId}/enable`, {
+            query: { subscription_id },
+            ...options,
+        });
+    }
+}
+exports.Alerts = Alerts;
+class AlertsPage extends pagination_1.Page {
+}
+exports.AlertsPage = AlertsPage;
+(function (Alerts) {
+    Alerts.AlertsPage = AlertsAPI.AlertsPage;
+})(Alerts = exports.Alerts || (exports.Alerts = {}));
+//# sourceMappingURL=alerts.js.map

package/resources/alerts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,mDAAmD;AACnD,2CAAoD;AACpD,wEAA0D;AAC1D,uDAA+D;AAE/D,MAAa,MAAO,SAAQ,sBAAW;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,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,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,IAAA,uBAAgB,EAAC,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,IAAA,uBAAgB,EAAC,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;AA5KD,wBA4KC;AAED,MAAa,UAAW,SAAQ,iBAAW;CAAG;AAA9C,gCAA8C;AAiR9C,WAAiB,MAAM;IAEP,iBAAU,GAAG,SAAS,CAAC,UAAU,CAAC;AAQlD,CAAC,EAVgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAUtB"}

package/resources/alerts.mjs

@@ -0,0 +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 retrieves an alert by its ID.
+     */
+    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

@@ -0,0 +1 @@
+{"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"}