orb-billing 4.0.0 → 4.1.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 CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 4.1.0 (2024-08-15)
4
+
5
+ Full Changelog: [v4.0.0...v4.1.0](https://github.com/orbcorp/orb-node/compare/v4.0.0...v4.1.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** OpenAPI spec update via Stainless API ([#253](https://github.com/orbcorp/orb-node/issues/253)) ([02e8a7b](https://github.com/orbcorp/orb-node/commit/02e8a7b8e75a610560bb28425273c16ee937b278))
10
+
3
11
  ## 4.0.0 (2024-08-14)
4
12
 
5
13
  Full Changelog: [v3.2.0...v4.0.0](https://github.com/orbcorp/orb-node/compare/v3.2.0...v4.0.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orb-billing",
3
- "version": "4.0.0",
3
+ "version": "4.1.0",
4
4
  "description": "The official TypeScript library for the Orb API",
5
5
  "author": "Orb <team@withorb.com>",
6
6
  "types": "./index.d.ts",
@@ -33,6 +33,12 @@ export declare class Backfills extends APIResource {
33
33
  * If a `customer_id` or `external_customer_id` is specified, the backfill will
34
34
  * only affect events for that customer. If neither is specified, the backfill will
35
35
  * affect all customers.
36
+ *
37
+ * When `replace_existing_events` is `true`, the field `filter` can be optionally
38
+ * added which enables filtering using
39
+ * [computed properties](../guides/extensibility/advanced-metrics#computed-properties).
40
+ * The expressiveness of computed properties allows you to deprecate existing
41
+ * events based on both a period of time and specific property values.
36
42
  */
37
43
  create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse>;
38
44
  /**
@@ -101,6 +107,12 @@ export interface BackfillCreateResponse {
101
107
  status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
102
108
  timeframe_end: string;
103
109
  timeframe_start: string;
110
+ /**
111
+ * A boolean
112
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
113
+ * used to filter the set of events to deprecate
114
+ */
115
+ deprecation_filter?: string | null;
104
116
  }
105
117
  /**
106
118
  * A backfill represents an update to historical usage data, adding or replacing
@@ -133,6 +145,12 @@ export interface BackfillListResponse {
133
145
  status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
134
146
  timeframe_end: string;
135
147
  timeframe_start: string;
148
+ /**
149
+ * A boolean
150
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
151
+ * used to filter the set of events to deprecate
152
+ */
153
+ deprecation_filter?: string | null;
136
154
  }
137
155
  /**
138
156
  * A backfill represents an update to historical usage data, adding or replacing
@@ -165,6 +183,12 @@ export interface BackfillCloseResponse {
165
183
  status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
166
184
  timeframe_end: string;
167
185
  timeframe_start: string;
186
+ /**
187
+ * A boolean
188
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
189
+ * used to filter the set of events to deprecate
190
+ */
191
+ deprecation_filter?: string | null;
168
192
  }
169
193
  /**
170
194
  * A backfill represents an update to historical usage data, adding or replacing
@@ -197,6 +221,12 @@ export interface BackfillFetchResponse {
197
221
  status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
198
222
  timeframe_end: string;
199
223
  timeframe_start: string;
224
+ /**
225
+ * A boolean
226
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
227
+ * used to filter the set of events to deprecate
228
+ */
229
+ deprecation_filter?: string | null;
200
230
  }
201
231
  /**
202
232
  * A backfill represents an update to historical usage data, adding or replacing
@@ -229,6 +259,12 @@ export interface BackfillRevertResponse {
229
259
  status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
230
260
  timeframe_end: string;
231
261
  timeframe_start: string;
262
+ /**
263
+ * A boolean
264
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
265
+ * used to filter the set of events to deprecate
266
+ */
267
+ deprecation_filter?: string | null;
232
268
  }
233
269
  export interface BackfillCreateParams {
234
270
  /**
@@ -249,6 +285,12 @@ export interface BackfillCreateParams {
249
285
  * The ID of the customer to which this backfill is scoped.
250
286
  */
251
287
  customer_id?: string | null;
288
+ /**
289
+ * A boolean
290
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
291
+ * used to filter the set of events to deprecate
292
+ */
293
+ deprecation_filter?: string | null;
252
294
  /**
253
295
  * The external customer ID of the customer to which this backfill is scoped.
254
296
  */
@@ -1 +1 @@
1
- {"version":3,"file":"backfills.d.ts","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IACpE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IAWtG;;;;;OAKG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;OAEG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;CAGnG;AAED,qBAAa,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,CAAC;CAAG;AAE5E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;CAAG;AAEzD,yBAAiB,SAAS,CAAC;IACzB,MAAM,QAAQ,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAC3E,MAAM,QAAQ,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IACvE,MAAM,QAAQ,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;IACzE,MAAM,QAAQ,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;IACzE,MAAM,QAAQ,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAC3E,MAAM,QAAQ,yBAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;IACjF,MAAM,QAAQ,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IACvE,MAAM,QAAQ,kBAAkB,GAAG,YAAY,CAAC,kBAAkB,CAAC;CACpE"}
1
+ {"version":3,"file":"backfills.d.ts","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IACpE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IAWtG;;;;;OAKG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;OAEG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;CAGnG;AAED,qBAAa,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,CAAC;CAAG;AAE5E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;CAAG;AAEzD,yBAAiB,SAAS,CAAC;IACzB,MAAM,QAAQ,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAC3E,MAAM,QAAQ,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IACvE,MAAM,QAAQ,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;IACzE,MAAM,QAAQ,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;IACzE,MAAM,QAAQ,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAC3E,MAAM,QAAQ,yBAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;IACjF,MAAM,QAAQ,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IACvE,MAAM,QAAQ,kBAAkB,GAAG,YAAY,CAAC,kBAAkB,CAAC;CACpE"}
@@ -60,6 +60,12 @@ class Backfills extends resource_1.APIResource {
60
60
  * If a `customer_id` or `external_customer_id` is specified, the backfill will
61
61
  * only affect events for that customer. If neither is specified, the backfill will
62
62
  * affect all customers.
63
+ *
64
+ * When `replace_existing_events` is `true`, the field `filter` can be optionally
65
+ * added which enables filtering using
66
+ * [computed properties](../guides/extensibility/advanced-metrics#computed-properties).
67
+ * The expressiveness of computed properties allows you to deprecate existing
68
+ * events based on both a period of time and specific property values.
63
69
  */
64
70
  create(body, options) {
65
71
  return this._client.post('/events/backfills', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"backfills.js","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,6DAA4C;AAC5C,oDAAyD;AAEzD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAgBD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAzFD,8BAyFC;AAED,MAAa,yBAA0B,SAAQ,iBAA0B;CAAG;AAA5E,8DAA4E;AAoP5E,WAAiB,SAAS;IAMV,mCAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAGnF,CAAC,EATgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASzB"}
1
+ {"version":3,"file":"backfills.js","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,6DAA4C;AAC5C,oDAAyD;AAEzD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAgBD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AA/FD,8BA+FC;AAED,MAAa,yBAA0B,SAAQ,iBAA0B;CAAG;AAA5E,8DAA4E;AA8R5E,WAAiB,SAAS;IAMV,mCAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAGnF,CAAC,EATgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASzB"}
@@ -34,6 +34,12 @@ export class Backfills extends APIResource {
34
34
  * If a `customer_id` or `external_customer_id` is specified, the backfill will
35
35
  * only affect events for that customer. If neither is specified, the backfill will
36
36
  * affect all customers.
37
+ *
38
+ * When `replace_existing_events` is `true`, the field `filter` can be optionally
39
+ * added which enables filtering using
40
+ * [computed properties](../guides/extensibility/advanced-metrics#computed-properties).
41
+ * The expressiveness of computed properties allows you to deprecate existing
42
+ * events based on both a period of time and specific property values.
37
43
  */
38
44
  create(body, options) {
39
45
  return this._client.post('/events/backfills', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"backfills.mjs","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,YAAY;OACjB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAgBD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,IAA0B;CAAG;AAoP5E,WAAiB,SAAS;IAMV,mCAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAGnF,CAAC,EATgB,SAAS,KAAT,SAAS,QASzB"}
1
+ {"version":3,"file":"backfills.mjs","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,YAAY;OACjB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAgBD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,IAA0B;CAAG;AA8R5E,WAAiB,SAAS;IAMV,mCAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAGnF,CAAC,EATgB,SAAS,KAAT,SAAS,QASzB"}
@@ -4347,11 +4347,11 @@ export interface SubscriptionSchedulePlanChangeParams {
4347
4347
  change_option: 'requested_date' | 'end_of_subscription_term' | 'immediate';
4348
4348
  /**
4349
4349
  * [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be
4350
- * aligned with the plan changes effective date.
4350
+ * aligned with the plan change's effective date.
4351
4351
  */
4352
4352
  align_billing_with_plan_change_date?: boolean | null;
4353
4353
  /**
4354
- * Reset billing periods to be aligned with the plan changes effective date or
4354
+ * Reset billing periods to be aligned with the plan change's effective date or
4355
4355
  * start of the month. Defaults to `unchanged` which keeps subscription's existing
4356
4356
  * billing cycle alignment.
4357
4357
  */
@@ -37,6 +37,12 @@ export class Backfills extends APIResource {
37
37
  * If a `customer_id` or `external_customer_id` is specified, the backfill will
38
38
  * only affect events for that customer. If neither is specified, the backfill will
39
39
  * affect all customers.
40
+ *
41
+ * When `replace_existing_events` is `true`, the field `filter` can be optionally
42
+ * added which enables filtering using
43
+ * [computed properties](../guides/extensibility/advanced-metrics#computed-properties).
44
+ * The expressiveness of computed properties allows you to deprecate existing
45
+ * events based on both a period of time and specific property values.
40
46
  */
41
47
  create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse> {
42
48
  return this._client.post('/events/backfills', { body, ...options });
@@ -138,6 +144,13 @@ export interface BackfillCreateResponse {
138
144
  timeframe_end: string;
139
145
 
140
146
  timeframe_start: string;
147
+
148
+ /**
149
+ * A boolean
150
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
151
+ * used to filter the set of events to deprecate
152
+ */
153
+ deprecation_filter?: string | null;
141
154
  }
142
155
 
143
156
  /**
@@ -179,6 +192,13 @@ export interface BackfillListResponse {
179
192
  timeframe_end: string;
180
193
 
181
194
  timeframe_start: string;
195
+
196
+ /**
197
+ * A boolean
198
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
199
+ * used to filter the set of events to deprecate
200
+ */
201
+ deprecation_filter?: string | null;
182
202
  }
183
203
 
184
204
  /**
@@ -220,6 +240,13 @@ export interface BackfillCloseResponse {
220
240
  timeframe_end: string;
221
241
 
222
242
  timeframe_start: string;
243
+
244
+ /**
245
+ * A boolean
246
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
247
+ * used to filter the set of events to deprecate
248
+ */
249
+ deprecation_filter?: string | null;
223
250
  }
224
251
 
225
252
  /**
@@ -261,6 +288,13 @@ export interface BackfillFetchResponse {
261
288
  timeframe_end: string;
262
289
 
263
290
  timeframe_start: string;
291
+
292
+ /**
293
+ * A boolean
294
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
295
+ * used to filter the set of events to deprecate
296
+ */
297
+ deprecation_filter?: string | null;
264
298
  }
265
299
 
266
300
  /**
@@ -302,6 +336,13 @@ export interface BackfillRevertResponse {
302
336
  timeframe_end: string;
303
337
 
304
338
  timeframe_start: string;
339
+
340
+ /**
341
+ * A boolean
342
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
343
+ * used to filter the set of events to deprecate
344
+ */
345
+ deprecation_filter?: string | null;
305
346
  }
306
347
 
307
348
  export interface BackfillCreateParams {
@@ -327,6 +368,13 @@ export interface BackfillCreateParams {
327
368
  */
328
369
  customer_id?: string | null;
329
370
 
371
+ /**
372
+ * A boolean
373
+ * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
374
+ * used to filter the set of events to deprecate
375
+ */
376
+ deprecation_filter?: string | null;
377
+
330
378
  /**
331
379
  * The external customer ID of the customer to which this backfill is scoped.
332
380
  */
@@ -5305,12 +5305,12 @@ export interface SubscriptionSchedulePlanChangeParams {
5305
5305
 
5306
5306
  /**
5307
5307
  * [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be
5308
- * aligned with the plan changes effective date.
5308
+ * aligned with the plan change's effective date.
5309
5309
  */
5310
5310
  align_billing_with_plan_change_date?: boolean | null;
5311
5311
 
5312
5312
  /**
5313
- * Reset billing periods to be aligned with the plan changes effective date or
5313
+ * Reset billing periods to be aligned with the plan change's effective date or
5314
5314
  * start of the month. Defaults to `unchanged` which keeps subscription's existing
5315
5315
  * billing cycle alignment.
5316
5316
  */
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '4.0.0'; // x-release-please-version
1
+ export const VERSION = '4.1.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "4.0.0";
1
+ export declare const VERSION = "4.1.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '4.0.0'; // x-release-please-version
4
+ exports.VERSION = '4.1.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '4.0.0'; // x-release-please-version
1
+ export const VERSION = '4.1.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map