orb-billing 6.4.0 → 6.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/package.json +1 -1
- package/resources/alerts.d.mts +21 -17
- package/resources/alerts.d.mts.map +1 -1
- package/resources/alerts.d.ts +21 -17
- package/resources/alerts.d.ts.map +1 -1
- package/resources/alerts.js +13 -10
- package/resources/alerts.js.map +1 -1
- package/resources/alerts.mjs +13 -10
- package/resources/alerts.mjs.map +1 -1
- package/src/resources/alerts.ts +21 -16
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [6.6.0](https://github.com/orbcorp/orb-typescript/compare/v6.5.0...v6.6.0) (2026-07-26)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** add `spend_exceeded` alert type for subscription-level alerts ([d7c2508](https://github.com/orbcorp/orb-typescript/commit/d7c2508a509f2ee6d7990d963b7d3d51c82e0813))
|
|
9
|
+
|
|
10
|
+
## [6.5.0](https://github.com/orbcorp/orb-typescript/compare/v6.4.0...v6.5.0) (2026-07-25)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **api:** rename "trash alert" endpoint to "delete alert" ([7e3b50d](https://github.com/orbcorp/orb-typescript/commit/7e3b50dde544bee33285de67a6a715f1d1a52b60))
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Bug Fixes
|
|
19
|
+
|
|
20
|
+
* **api:** rename "trash alert" endpoint to "delete alert" ([7e3b50d](https://github.com/orbcorp/orb-typescript/commit/7e3b50dde544bee33285de67a6a715f1d1a52b60))
|
|
21
|
+
|
|
3
22
|
## [6.4.0](https://github.com/orbcorp/orb-typescript/compare/v6.3.0...v6.4.0) (2026-07-24)
|
|
4
23
|
|
|
5
24
|
|
package/package.json
CHANGED
package/resources/alerts.d.mts
CHANGED
|
@@ -34,11 +34,11 @@ export declare class Alerts extends APIResource {
|
|
|
34
34
|
*/
|
|
35
35
|
list(query?: AlertListParams | null | undefined, options?: RequestOptions): PagePromise<AlertsPage, Alert>;
|
|
36
36
|
/**
|
|
37
|
-
* This endpoint
|
|
37
|
+
* This endpoint deletes a subscription or customer-scoped alert. The alert is
|
|
38
38
|
* soft-deleted: it stops firing immediately and no longer appears in fetch or list
|
|
39
39
|
* responses, while the underlying record is retained internally for audit.
|
|
40
40
|
*
|
|
41
|
-
* Plan-level alerts cannot be
|
|
41
|
+
* Plan-level alerts cannot be deleted via the API — disable them instead
|
|
42
42
|
* (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
|
|
43
43
|
* to be unwound from every subscription the alert was propagated to, which isn't
|
|
44
44
|
* supported yet.
|
|
@@ -69,15 +69,18 @@ export declare class Alerts extends APIResource {
|
|
|
69
69
|
/**
|
|
70
70
|
* This endpoint is used to create alerts at the subscription level.
|
|
71
71
|
*
|
|
72
|
-
* Subscription level alerts can be one of
|
|
73
|
-
* `cost_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
74
|
-
* is triggered when the usage of that metric exceeds
|
|
75
|
-
* the current billing cycle. A `cost_exceeded` alert
|
|
76
|
-
* amount due during the current billing cycle
|
|
77
|
-
* `cost_exceeded` alerts do not include burndown
|
|
72
|
+
* Subscription level alerts can be one of three types: `usage_exceeded`,
|
|
73
|
+
* `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
74
|
+
* particular metric and is triggered when the usage of that metric exceeds
|
|
75
|
+
* predefined thresholds during the current billing cycle. A `cost_exceeded` alert
|
|
76
|
+
* is triggered when the total amount due during the current billing cycle
|
|
77
|
+
* surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
|
|
78
|
+
* of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
|
|
79
|
+
* spend (the pricing subtotal, before invoice-level adjustments and credits)
|
|
80
|
+
* denominated in the alert's currency exceeds predefined thresholds during the
|
|
81
|
+
* current billing cycle; `price_filters` can scope which prices contribute. Each
|
|
78
82
|
* subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
|
|
79
|
-
* per metric that is a part of the subscription.
|
|
80
|
-
* usage or cost conditions met during the current billing cycle.
|
|
83
|
+
* per metric that is a part of the subscription.
|
|
81
84
|
*/
|
|
82
85
|
createForSubscription(subscriptionID: string, body: AlertCreateForSubscriptionParams, options?: RequestOptions): APIPromise<Alert>;
|
|
83
86
|
/**
|
|
@@ -142,7 +145,7 @@ export interface Alert {
|
|
|
142
145
|
/**
|
|
143
146
|
* The type of alert. This must be a valid alert type.
|
|
144
147
|
*/
|
|
145
|
-
type: 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered' | 'usage_exceeded' | 'cost_exceeded' | 'license_balance_threshold_reached';
|
|
148
|
+
type: 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered' | 'usage_exceeded' | 'cost_exceeded' | 'spend_exceeded' | 'license_balance_threshold_reached';
|
|
146
149
|
/**
|
|
147
150
|
* The current status of the alert. This field is only present for credit balance
|
|
148
151
|
* alerts.
|
|
@@ -358,10 +361,10 @@ export interface AlertCreateForSubscriptionParams {
|
|
|
358
361
|
/**
|
|
359
362
|
* The type of alert to create. This must be a valid alert type.
|
|
360
363
|
*/
|
|
361
|
-
type: 'usage_exceeded' | 'cost_exceeded';
|
|
364
|
+
type: 'usage_exceeded' | 'cost_exceeded' | 'spend_exceeded';
|
|
362
365
|
/**
|
|
363
|
-
* The case sensitive currency or custom pricing unit
|
|
364
|
-
* alerts
|
|
366
|
+
* The case sensitive currency or custom pricing unit the alert is denominated in.
|
|
367
|
+
* Required for spend_exceeded alerts and when grouping_keys is set.
|
|
365
368
|
*/
|
|
366
369
|
currency?: string | null;
|
|
367
370
|
/**
|
|
@@ -374,9 +377,10 @@ export interface AlertCreateForSubscriptionParams {
|
|
|
374
377
|
*/
|
|
375
378
|
metric_id?: string | null;
|
|
376
379
|
/**
|
|
377
|
-
* Filters to scope which prices are included in
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
+
* Filters to scope which prices are included in alert evaluation. Supports
|
|
381
|
+
* filtering by price_id, item_id, or price_type with includes/excludes operators.
|
|
382
|
+
* Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
|
|
383
|
+
* grouping_keys set.
|
|
380
384
|
*/
|
|
381
385
|
price_filters?: Array<AlertCreateForSubscriptionParams.PriceFilter> | null;
|
|
382
386
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.d.mts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,+BAA2B;AAExE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;OAEG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB
|
|
1
|
+
{"version":3,"file":"alerts.d.mts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,+BAA2B;AAExE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;OAEG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CACnB,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;OAIG;IACH,OAAO,CACL,oBAAoB,EAAE,MAAM,EAC5B,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAQpB;;;;OAIG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;CAOrB;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;AAErC;;;;;;GAMG;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,gBAAgB,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,IAAI,EACA,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,mCAAmC,CAAC;IAExC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAEhD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,YAAY,EAAE,MAAM,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,WAAW;QAC1B;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;;;OAKG;IACH,UAAiB,iBAAiB;QAChC;;;WAGG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACxC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CACzE;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,WAAW;QAC1B;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;;;OAKG;IACH,UAAiB,iBAAiB;QAChC;;;;WAIG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACxC;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,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,yBAAyB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;IAExF;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,yBAAyB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;IAExF;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,gBAAgB,GAAG,eAAe,GAAG,gBAAgB,CAAC;IAE5D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3E;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CACxF;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,WAAW;QAC1B;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;;;OAKG;IACH,UAAiB,iBAAiB;QAChC;;;;WAIG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACxC;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,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/alerts.d.ts
CHANGED
|
@@ -34,11 +34,11 @@ export declare class Alerts extends APIResource {
|
|
|
34
34
|
*/
|
|
35
35
|
list(query?: AlertListParams | null | undefined, options?: RequestOptions): PagePromise<AlertsPage, Alert>;
|
|
36
36
|
/**
|
|
37
|
-
* This endpoint
|
|
37
|
+
* This endpoint deletes a subscription or customer-scoped alert. The alert is
|
|
38
38
|
* soft-deleted: it stops firing immediately and no longer appears in fetch or list
|
|
39
39
|
* responses, while the underlying record is retained internally for audit.
|
|
40
40
|
*
|
|
41
|
-
* Plan-level alerts cannot be
|
|
41
|
+
* Plan-level alerts cannot be deleted via the API — disable them instead
|
|
42
42
|
* (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
|
|
43
43
|
* to be unwound from every subscription the alert was propagated to, which isn't
|
|
44
44
|
* supported yet.
|
|
@@ -69,15 +69,18 @@ export declare class Alerts extends APIResource {
|
|
|
69
69
|
/**
|
|
70
70
|
* This endpoint is used to create alerts at the subscription level.
|
|
71
71
|
*
|
|
72
|
-
* Subscription level alerts can be one of
|
|
73
|
-
* `cost_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
74
|
-
* is triggered when the usage of that metric exceeds
|
|
75
|
-
* the current billing cycle. A `cost_exceeded` alert
|
|
76
|
-
* amount due during the current billing cycle
|
|
77
|
-
* `cost_exceeded` alerts do not include burndown
|
|
72
|
+
* Subscription level alerts can be one of three types: `usage_exceeded`,
|
|
73
|
+
* `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
74
|
+
* particular metric and is triggered when the usage of that metric exceeds
|
|
75
|
+
* predefined thresholds during the current billing cycle. A `cost_exceeded` alert
|
|
76
|
+
* is triggered when the total amount due during the current billing cycle
|
|
77
|
+
* surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
|
|
78
|
+
* of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
|
|
79
|
+
* spend (the pricing subtotal, before invoice-level adjustments and credits)
|
|
80
|
+
* denominated in the alert's currency exceeds predefined thresholds during the
|
|
81
|
+
* current billing cycle; `price_filters` can scope which prices contribute. Each
|
|
78
82
|
* subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
|
|
79
|
-
* per metric that is a part of the subscription.
|
|
80
|
-
* usage or cost conditions met during the current billing cycle.
|
|
83
|
+
* per metric that is a part of the subscription.
|
|
81
84
|
*/
|
|
82
85
|
createForSubscription(subscriptionID: string, body: AlertCreateForSubscriptionParams, options?: RequestOptions): APIPromise<Alert>;
|
|
83
86
|
/**
|
|
@@ -142,7 +145,7 @@ export interface Alert {
|
|
|
142
145
|
/**
|
|
143
146
|
* The type of alert. This must be a valid alert type.
|
|
144
147
|
*/
|
|
145
|
-
type: 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered' | 'usage_exceeded' | 'cost_exceeded' | 'license_balance_threshold_reached';
|
|
148
|
+
type: 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered' | 'usage_exceeded' | 'cost_exceeded' | 'spend_exceeded' | 'license_balance_threshold_reached';
|
|
146
149
|
/**
|
|
147
150
|
* The current status of the alert. This field is only present for credit balance
|
|
148
151
|
* alerts.
|
|
@@ -358,10 +361,10 @@ export interface AlertCreateForSubscriptionParams {
|
|
|
358
361
|
/**
|
|
359
362
|
* The type of alert to create. This must be a valid alert type.
|
|
360
363
|
*/
|
|
361
|
-
type: 'usage_exceeded' | 'cost_exceeded';
|
|
364
|
+
type: 'usage_exceeded' | 'cost_exceeded' | 'spend_exceeded';
|
|
362
365
|
/**
|
|
363
|
-
* The case sensitive currency or custom pricing unit
|
|
364
|
-
* alerts
|
|
366
|
+
* The case sensitive currency or custom pricing unit the alert is denominated in.
|
|
367
|
+
* Required for spend_exceeded alerts and when grouping_keys is set.
|
|
365
368
|
*/
|
|
366
369
|
currency?: string | null;
|
|
367
370
|
/**
|
|
@@ -374,9 +377,10 @@ export interface AlertCreateForSubscriptionParams {
|
|
|
374
377
|
*/
|
|
375
378
|
metric_id?: string | null;
|
|
376
379
|
/**
|
|
377
|
-
* Filters to scope which prices are included in
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
+
* Filters to scope which prices are included in alert evaluation. Supports
|
|
381
|
+
* filtering by price_id, item_id, or price_type with includes/excludes operators.
|
|
382
|
+
* Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
|
|
383
|
+
* grouping_keys set.
|
|
380
384
|
*/
|
|
381
385
|
price_filters?: Array<AlertCreateForSubscriptionParams.PriceFilter> | null;
|
|
382
386
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,8BAA2B;AAExE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;OAEG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB
|
|
1
|
+
{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,8BAA2B;AAExE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;OAEG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CACnB,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;OAIG;IACH,OAAO,CACL,oBAAoB,EAAE,MAAM,EAC5B,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAQpB;;;;OAIG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;CAOrB;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;AAErC;;;;;;GAMG;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,gBAAgB,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,IAAI,EACA,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,mCAAmC,CAAC;IAExC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAEhD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,YAAY,EAAE,MAAM,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,WAAW;QAC1B;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;;;OAKG;IACH,UAAiB,iBAAiB;QAChC;;;WAGG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACxC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CACzE;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,WAAW;QAC1B;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;;;OAKG;IACH,UAAiB,iBAAiB;QAChC;;;;WAIG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACxC;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,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,yBAAyB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;IAExF;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,yBAAyB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;IAExF;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,gBAAgB,GAAG,eAAe,GAAG,gBAAgB,CAAC;IAE5D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3E;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CACxF;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,WAAW;QAC1B;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;QAE9E;;WAEG;QACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED;;;;;OAKG;IACH,UAAiB,iBAAiB;QAChC;;;;WAIG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACxC;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,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/alerts.js
CHANGED
|
@@ -42,11 +42,11 @@ class Alerts extends resource_1.APIResource {
|
|
|
42
42
|
return this._client.getAPIList('/alerts', (pagination_1.Page), { query, ...options });
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* This endpoint
|
|
45
|
+
* This endpoint deletes a subscription or customer-scoped alert. The alert is
|
|
46
46
|
* soft-deleted: it stops firing immediately and no longer appears in fetch or list
|
|
47
47
|
* responses, while the underlying record is retained internally for audit.
|
|
48
48
|
*
|
|
49
|
-
* Plan-level alerts cannot be
|
|
49
|
+
* Plan-level alerts cannot be deleted via the API — disable them instead
|
|
50
50
|
* (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
|
|
51
51
|
* to be unwound from every subscription the alert was propagated to, which isn't
|
|
52
52
|
* supported yet.
|
|
@@ -86,15 +86,18 @@ class Alerts extends resource_1.APIResource {
|
|
|
86
86
|
/**
|
|
87
87
|
* This endpoint is used to create alerts at the subscription level.
|
|
88
88
|
*
|
|
89
|
-
* Subscription level alerts can be one of
|
|
90
|
-
* `cost_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
91
|
-
* is triggered when the usage of that metric exceeds
|
|
92
|
-
* the current billing cycle. A `cost_exceeded` alert
|
|
93
|
-
* amount due during the current billing cycle
|
|
94
|
-
* `cost_exceeded` alerts do not include burndown
|
|
89
|
+
* Subscription level alerts can be one of three types: `usage_exceeded`,
|
|
90
|
+
* `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
91
|
+
* particular metric and is triggered when the usage of that metric exceeds
|
|
92
|
+
* predefined thresholds during the current billing cycle. A `cost_exceeded` alert
|
|
93
|
+
* is triggered when the total amount due during the current billing cycle
|
|
94
|
+
* surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
|
|
95
|
+
* of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
|
|
96
|
+
* spend (the pricing subtotal, before invoice-level adjustments and credits)
|
|
97
|
+
* denominated in the alert's currency exceeds predefined thresholds during the
|
|
98
|
+
* current billing cycle; `price_filters` can scope which prices contribute. Each
|
|
95
99
|
* subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
|
|
96
|
-
* per metric that is a part of the subscription.
|
|
97
|
-
* usage or cost conditions met during the current billing cycle.
|
|
100
|
+
* per metric that is a part of the subscription.
|
|
98
101
|
*/
|
|
99
102
|
createForSubscription(subscriptionID, body, options) {
|
|
100
103
|
return this._client.post((0, path_1.path) `/alerts/subscription_id/${subscriptionID}`, { body, ...options });
|
package/resources/alerts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAwE;AACxE,oDAAmD;AAEnD,oDAA8C;AAE9C;;;;;GAKG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oBAA4B,EAAE,IAAuB,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,iBAAW,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,oBAAoB,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAwE;AACxE,oDAAmD;AAEnD,oDAA8C;AAE9C;;;;;GAKG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oBAA4B,EAAE,IAAuB,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,iBAAW,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,oBAAoB,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CACnB,cAAsB,EACtB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,2BAA2B,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,OAAO,CACL,oBAA4B,EAC5B,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,WAAW,oBAAoB,UAAU,EAAE;YACtE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,oBAA4B,EAC5B,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,WAAW,oBAAoB,SAAS,EAAE;YACrE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAjJD,wBAiJC"}
|
package/resources/alerts.mjs
CHANGED
|
@@ -39,11 +39,11 @@ export class Alerts extends APIResource {
|
|
|
39
39
|
return this._client.getAPIList('/alerts', (Page), { query, ...options });
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* This endpoint
|
|
42
|
+
* This endpoint deletes a subscription or customer-scoped alert. The alert is
|
|
43
43
|
* soft-deleted: it stops firing immediately and no longer appears in fetch or list
|
|
44
44
|
* responses, while the underlying record is retained internally for audit.
|
|
45
45
|
*
|
|
46
|
-
* Plan-level alerts cannot be
|
|
46
|
+
* Plan-level alerts cannot be deleted via the API — disable them instead
|
|
47
47
|
* (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
|
|
48
48
|
* to be unwound from every subscription the alert was propagated to, which isn't
|
|
49
49
|
* supported yet.
|
|
@@ -83,15 +83,18 @@ export class Alerts extends APIResource {
|
|
|
83
83
|
/**
|
|
84
84
|
* This endpoint is used to create alerts at the subscription level.
|
|
85
85
|
*
|
|
86
|
-
* Subscription level alerts can be one of
|
|
87
|
-
* `cost_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
88
|
-
* is triggered when the usage of that metric exceeds
|
|
89
|
-
* the current billing cycle. A `cost_exceeded` alert
|
|
90
|
-
* amount due during the current billing cycle
|
|
91
|
-
* `cost_exceeded` alerts do not include burndown
|
|
86
|
+
* Subscription level alerts can be one of three types: `usage_exceeded`,
|
|
87
|
+
* `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
88
|
+
* particular metric and is triggered when the usage of that metric exceeds
|
|
89
|
+
* predefined thresholds during the current billing cycle. A `cost_exceeded` alert
|
|
90
|
+
* is triggered when the total amount due during the current billing cycle
|
|
91
|
+
* surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
|
|
92
|
+
* of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
|
|
93
|
+
* spend (the pricing subtotal, before invoice-level adjustments and credits)
|
|
94
|
+
* denominated in the alert's currency exceeds predefined thresholds during the
|
|
95
|
+
* current billing cycle; `price_filters` can scope which prices contribute. Each
|
|
92
96
|
* subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
|
|
93
|
-
* per metric that is a part of the subscription.
|
|
94
|
-
* usage or cost conditions met during the current billing cycle.
|
|
97
|
+
* per metric that is a part of the subscription.
|
|
95
98
|
*/
|
|
96
99
|
createForSubscription(subscriptionID, body, options) {
|
|
97
100
|
return this._client.post(path `/alerts/subscription_id/${subscriptionID}`, { body, ...options });
|
package/resources/alerts.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAgC,+BAA2B;AACxE,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;GAKG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oBAA4B,EAAE,IAAuB,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,IAAW,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,oBAAoB,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAgC,+BAA2B;AACxE,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;GAKG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oBAA4B,EAAE,IAAuB,EAAE,OAAwB;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,IAAW,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,oBAAoB,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CACnB,cAAsB,EACtB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,2BAA2B,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,OAAO,CACL,oBAA4B,EAC5B,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,oBAAoB,UAAU,EAAE;YACtE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,oBAA4B,EAC5B,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,WAAW,oBAAoB,SAAS,EAAE;YACrE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/src/resources/alerts.ts
CHANGED
|
@@ -51,11 +51,11 @@ export class Alerts extends APIResource {
|
|
|
51
51
|
}
|
|
52
52
|
|
|
53
53
|
/**
|
|
54
|
-
* This endpoint
|
|
54
|
+
* This endpoint deletes a subscription or customer-scoped alert. The alert is
|
|
55
55
|
* soft-deleted: it stops firing immediately and no longer appears in fetch or list
|
|
56
56
|
* responses, while the underlying record is retained internally for audit.
|
|
57
57
|
*
|
|
58
|
-
* Plan-level alerts cannot be
|
|
58
|
+
* Plan-level alerts cannot be deleted via the API — disable them instead
|
|
59
59
|
* (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
|
|
60
60
|
* to be unwound from every subscription the alert was propagated to, which isn't
|
|
61
61
|
* supported yet.
|
|
@@ -106,15 +106,18 @@ export class Alerts extends APIResource {
|
|
|
106
106
|
/**
|
|
107
107
|
* This endpoint is used to create alerts at the subscription level.
|
|
108
108
|
*
|
|
109
|
-
* Subscription level alerts can be one of
|
|
110
|
-
* `cost_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
111
|
-
* is triggered when the usage of that metric exceeds
|
|
112
|
-
* the current billing cycle. A `cost_exceeded` alert
|
|
113
|
-
* amount due during the current billing cycle
|
|
114
|
-
* `cost_exceeded` alerts do not include burndown
|
|
109
|
+
* Subscription level alerts can be one of three types: `usage_exceeded`,
|
|
110
|
+
* `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
|
|
111
|
+
* particular metric and is triggered when the usage of that metric exceeds
|
|
112
|
+
* predefined thresholds during the current billing cycle. A `cost_exceeded` alert
|
|
113
|
+
* is triggered when the total amount due during the current billing cycle
|
|
114
|
+
* surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
|
|
115
|
+
* of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
|
|
116
|
+
* spend (the pricing subtotal, before invoice-level adjustments and credits)
|
|
117
|
+
* denominated in the alert's currency exceeds predefined thresholds during the
|
|
118
|
+
* current billing cycle; `price_filters` can scope which prices contribute. Each
|
|
115
119
|
* subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
|
|
116
|
-
* per metric that is a part of the subscription.
|
|
117
|
-
* usage or cost conditions met during the current billing cycle.
|
|
120
|
+
* per metric that is a part of the subscription.
|
|
118
121
|
*/
|
|
119
122
|
createForSubscription(
|
|
120
123
|
subscriptionID: string,
|
|
@@ -224,6 +227,7 @@ export interface Alert {
|
|
|
224
227
|
| 'credit_balance_recovered'
|
|
225
228
|
| 'usage_exceeded'
|
|
226
229
|
| 'cost_exceeded'
|
|
230
|
+
| 'spend_exceeded'
|
|
227
231
|
| 'license_balance_threshold_reached';
|
|
228
232
|
|
|
229
233
|
/**
|
|
@@ -482,11 +486,11 @@ export interface AlertCreateForSubscriptionParams {
|
|
|
482
486
|
/**
|
|
483
487
|
* The type of alert to create. This must be a valid alert type.
|
|
484
488
|
*/
|
|
485
|
-
type: 'usage_exceeded' | 'cost_exceeded';
|
|
489
|
+
type: 'usage_exceeded' | 'cost_exceeded' | 'spend_exceeded';
|
|
486
490
|
|
|
487
491
|
/**
|
|
488
|
-
* The case sensitive currency or custom pricing unit
|
|
489
|
-
* alerts
|
|
492
|
+
* The case sensitive currency or custom pricing unit the alert is denominated in.
|
|
493
|
+
* Required for spend_exceeded alerts and when grouping_keys is set.
|
|
490
494
|
*/
|
|
491
495
|
currency?: string | null;
|
|
492
496
|
|
|
@@ -502,9 +506,10 @@ export interface AlertCreateForSubscriptionParams {
|
|
|
502
506
|
metric_id?: string | null;
|
|
503
507
|
|
|
504
508
|
/**
|
|
505
|
-
* Filters to scope which prices are included in
|
|
506
|
-
*
|
|
507
|
-
*
|
|
509
|
+
* Filters to scope which prices are included in alert evaluation. Supports
|
|
510
|
+
* filtering by price_id, item_id, or price_type with includes/excludes operators.
|
|
511
|
+
* Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
|
|
512
|
+
* grouping_keys set.
|
|
508
513
|
*/
|
|
509
514
|
price_filters?: Array<AlertCreateForSubscriptionParams.PriceFilter> | null;
|
|
510
515
|
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.6.0'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.6.0";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.6.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.6.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|