orb-billing 1.20.2 → 1.22.0

package/resources/events/backfills.d.ts

@@ -0,0 +1,250 @@
+import * as Core from 'orb-billing/core';
+import { APIResource } from 'orb-billing/resource';
+import * as BackfillsAPI from 'orb-billing/resources/events/backfills';
+import { Page, type PageParams } from 'orb-billing/pagination';
+export declare class Backfills extends APIResource {
+    /**
+     * Creating the backfill enables adding or replacing past events, even those that
+     * are older than the ingestion grace period. Performing a backfill in Orb involves
+     * 3 steps:
+     *
+     * 1. Create the backfill, specifying its parameters.
+     * 2. [Ingest](ingest) usage events, referencing the backfill (query parameter
+     *    `backfill_id`).
+     * 3. [Close](close-backfill) the backfill, propagating the update in past usage
+     *    throughout Orb.
+     *
+     * Changes from a backfill are not reflected until the backfill is closed, so you
+     * won’t need to worry about your customers seeing partially updated usage data.
+     * Backfills are also reversible, so you’ll be able to revert a backfill if you’ve
+     * made a mistake.
+     *
+     * This endpoint will return a backfill object, which contains an `id`. That `id`
+     * can then be used as the `backfill_id` query parameter to the event ingestion
+     * endpoint to associate ingested events with this backfill. The effects (e.g.
+     * updated usage graphs) of this backfill will not take place until the backfill is
+     * closed.
+     *
+     * If the `replace_existing_events` is `true`, existing events in the backfill's
+     * timeframe will be replaced with the newly ingested events associated with the
+     * backfill. If `false`, newly ingested events will be added to the existing
+     * events.
+     */
+    create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse>;
+    /**
+     * This endpoint returns a list of all backfills in a list format.
+     *
+     * The list of backfills is ordered starting from the most recently created
+     * backfill. The response also includes
+     * [`pagination_metadata`](../reference/pagination), which lets the caller retrieve
+     * the next page of results if they exist. More information about pagination can be
+     * found in the [Pagination-metadata schema](pagination).
+     */
+    list(query?: BackfillListParams, options?: Core.RequestOptions): Core.PagePromise<BackfillListResponsesPage, BackfillListResponse>;
+    list(options?: Core.RequestOptions): Core.PagePromise<BackfillListResponsesPage, BackfillListResponse>;
+    /**
+     * Closing a backfill makes the updated usage visible in Orb. Upon closing a
+     * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
+     * and usage graphs. Once all of the updates are complete, the backfill's status
+     * will transition to `reflected`.
+     */
+    close(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillCloseResponse>;
+    /**
+     * This endpoint is used to fetch a backfill given an identifier.
+     */
+    fetch(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillFetchResponse>;
+    /**
+     * Reverting a backfill undoes all the effects of closing the backfill. If the
+     * backfill is reflected, the status will transition to `pending_revert` while the
+     * effects of the backfill are undone. Once all effects are undone, the backfill
+     * will transition to `reverted`.
+     *
+     * If a backfill is reverted before its closed, no usage will be updated as a
+     * result of the backfill and it will immediately transition to `reverted`.
+     */
+    revert(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillRevertResponse>;
+}
+export declare class BackfillListResponsesPage extends Page<BackfillListResponse> {
+}
+/**
+ * A backfill represents an update to historical usage data, adding or replacing
+ * events in a timeframe.
+ */
+export interface BackfillCreateResponse {
+    id: string;
+    /**
+     * If in the future, the time at which the backfill will automatically close. If in
+     * the past, the time at which the backfill was closed.
+     */
+    close_time: string | null;
+    created_at: string;
+    /**
+     * The customer ID this backfill is scoped to. If null, this backfill is not scoped
+     * to a single customer.
+     */
+    customer_id: string | null;
+    /**
+     * The time at which this backfill was reverted.
+     */
+    reverted_at: string | null;
+    /**
+     * The status of the backfill.
+     */
+    status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
+    timeframe_end: string;
+    timeframe_start: string;
+}
+/**
+ * A backfill represents an update to historical usage data, adding or replacing
+ * events in a timeframe.
+ */
+export interface BackfillListResponse {
+    id: string;
+    /**
+     * If in the future, the time at which the backfill will automatically close. If in
+     * the past, the time at which the backfill was closed.
+     */
+    close_time: string | null;
+    created_at: string;
+    /**
+     * The customer ID this backfill is scoped to. If null, this backfill is not scoped
+     * to a single customer.
+     */
+    customer_id: string | null;
+    /**
+     * The time at which this backfill was reverted.
+     */
+    reverted_at: string | null;
+    /**
+     * The status of the backfill.
+     */
+    status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
+    timeframe_end: string;
+    timeframe_start: string;
+}
+/**
+ * A backfill represents an update to historical usage data, adding or replacing
+ * events in a timeframe.
+ */
+export interface BackfillCloseResponse {
+    id: string;
+    /**
+     * If in the future, the time at which the backfill will automatically close. If in
+     * the past, the time at which the backfill was closed.
+     */
+    close_time: string | null;
+    created_at: string;
+    /**
+     * The customer ID this backfill is scoped to. If null, this backfill is not scoped
+     * to a single customer.
+     */
+    customer_id: string | null;
+    /**
+     * The time at which this backfill was reverted.
+     */
+    reverted_at: string | null;
+    /**
+     * The status of the backfill.
+     */
+    status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
+    timeframe_end: string;
+    timeframe_start: string;
+}
+/**
+ * A backfill represents an update to historical usage data, adding or replacing
+ * events in a timeframe.
+ */
+export interface BackfillFetchResponse {
+    id: string;
+    /**
+     * If in the future, the time at which the backfill will automatically close. If in
+     * the past, the time at which the backfill was closed.
+     */
+    close_time: string | null;
+    created_at: string;
+    /**
+     * The customer ID this backfill is scoped to. If null, this backfill is not scoped
+     * to a single customer.
+     */
+    customer_id: string | null;
+    /**
+     * The time at which this backfill was reverted.
+     */
+    reverted_at: string | null;
+    /**
+     * The status of the backfill.
+     */
+    status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
+    timeframe_end: string;
+    timeframe_start: string;
+}
+/**
+ * A backfill represents an update to historical usage data, adding or replacing
+ * events in a timeframe.
+ */
+export interface BackfillRevertResponse {
+    id: string;
+    /**
+     * If in the future, the time at which the backfill will automatically close. If in
+     * the past, the time at which the backfill was closed.
+     */
+    close_time: string | null;
+    created_at: string;
+    /**
+     * The customer ID this backfill is scoped to. If null, this backfill is not scoped
+     * to a single customer.
+     */
+    customer_id: string | null;
+    /**
+     * The time at which this backfill was reverted.
+     */
+    reverted_at: string | null;
+    /**
+     * The status of the backfill.
+     */
+    status: 'pending' | 'reflected' | 'pending_revert' | 'reverted';
+    timeframe_end: string;
+    timeframe_start: string;
+}
+export interface BackfillCreateParams {
+    /**
+     * The (exclusive) end of the usage timeframe affected by this backfill.
+     */
+    timeframe_end: string;
+    /**
+     * The (inclusive) start of the usage timeframe affected by this backfill.
+     */
+    timeframe_start: string;
+    /**
+     * The time at which no more events will be accepted for this backfill. The
+     * backfill will automatically begin reflecting throughout Orb at the close time.
+     * If not specified, it will default to 1 day after the creation of the backfill.
+     */
+    close_time?: string | null;
+    /**
+     * The ID of the customer to which this backfill is scoped.
+     */
+    customer_id?: string | null;
+    /**
+     * The external customer ID of the customer to which this backfill is scoped.
+     */
+    external_customer_id?: string | null;
+    /**
+     * If true, replaces all existing events in the timeframe with the newly ingested
+     * events. If false, adds the newly ingested events to the existing events.
+     */
+    replace_existing_events?: boolean;
+}
+export interface BackfillListParams extends PageParams {
+}
+export declare namespace Backfills {
+    export import BackfillCreateResponse = BackfillsAPI.BackfillCreateResponse;
+    export import BackfillListResponse = BackfillsAPI.BackfillListResponse;
+    export import BackfillCloseResponse = BackfillsAPI.BackfillCloseResponse;
+    export import BackfillFetchResponse = BackfillsAPI.BackfillFetchResponse;
+    export import BackfillRevertResponse = BackfillsAPI.BackfillRevertResponse;
+    export import BackfillListResponsesPage = BackfillsAPI.BackfillListResponsesPage;
+    export import BackfillCreateParams = BackfillsAPI.BackfillCreateParams;
+    export import BackfillListParams = BackfillsAPI.BackfillListParams;
+}
+//# sourceMappingURL=backfills.d.ts.map

package/resources/events/backfills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backfills.d.ts","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,YAAY,MAAM,wCAAwC,CAAC;AACvE,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE/D,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;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,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,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,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,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,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"}

package/resources/events/backfills.js

@@ -0,0 +1,104 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+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.BackfillListResponsesPage = exports.Backfills = void 0;
+const resource_1 = require("orb-billing/resource");
+const core_1 = require("orb-billing/core");
+const BackfillsAPI = __importStar(require("orb-billing/resources/events/backfills"));
+const pagination_1 = require("orb-billing/pagination");
+class Backfills extends resource_1.APIResource {
+    /**
+     * Creating the backfill enables adding or replacing past events, even those that
+     * are older than the ingestion grace period. Performing a backfill in Orb involves
+     * 3 steps:
+     *
+     * 1. Create the backfill, specifying its parameters.
+     * 2. [Ingest](ingest) usage events, referencing the backfill (query parameter
+     *    `backfill_id`).
+     * 3. [Close](close-backfill) the backfill, propagating the update in past usage
+     *    throughout Orb.
+     *
+     * Changes from a backfill are not reflected until the backfill is closed, so you
+     * won’t need to worry about your customers seeing partially updated usage data.
+     * Backfills are also reversible, so you’ll be able to revert a backfill if you’ve
+     * made a mistake.
+     *
+     * This endpoint will return a backfill object, which contains an `id`. That `id`
+     * can then be used as the `backfill_id` query parameter to the event ingestion
+     * endpoint to associate ingested events with this backfill. The effects (e.g.
+     * updated usage graphs) of this backfill will not take place until the backfill is
+     * closed.
+     *
+     * If the `replace_existing_events` is `true`, existing events in the backfill's
+     * timeframe will be replaced with the newly ingested events associated with the
+     * backfill. If `false`, newly ingested events will be added to the existing
+     * events.
+     */
+    create(body, options) {
+        return this.post('/events/backfills', { body, ...options });
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/events/backfills', BackfillListResponsesPage, { query, ...options });
+    }
+    /**
+     * Closing a backfill makes the updated usage visible in Orb. Upon closing a
+     * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
+     * and usage graphs. Once all of the updates are complete, the backfill's status
+     * will transition to `reflected`.
+     */
+    close(backfillId, options) {
+        return this.post(`/events/backfills/${backfillId}/close`, options);
+    }
+    /**
+     * This endpoint is used to fetch a backfill given an identifier.
+     */
+    fetch(backfillId, options) {
+        return this.get(`/events/backfills/${backfillId}`, options);
+    }
+    /**
+     * Reverting a backfill undoes all the effects of closing the backfill. If the
+     * backfill is reflected, the status will transition to `pending_revert` while the
+     * effects of the backfill are undone. Once all effects are undone, the backfill
+     * will transition to `reverted`.
+     *
+     * If a backfill is reverted before its closed, no usage will be updated as a
+     * result of the backfill and it will immediately transition to `reverted`.
+     */
+    revert(backfillId, options) {
+        return this.post(`/events/backfills/${backfillId}/revert`, options);
+    }
+}
+exports.Backfills = Backfills;
+class BackfillListResponsesPage extends pagination_1.Page {
+}
+exports.BackfillListResponsesPage = BackfillListResponsesPage;
+(function (Backfills) {
+    Backfills.BackfillListResponsesPage = BackfillsAPI.BackfillListResponsesPage;
+})(Backfills = exports.Backfills || (exports.Backfills = {}));
+//# sourceMappingURL=backfills.js.map

package/resources/events/backfills.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backfills.js","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGrD,mDAAmD;AACnD,2CAAoD;AACpD,qFAAuE;AACvE,uDAA+D;AAE/D,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,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,UAAU,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AArFD,8BAqFC;AAED,MAAa,yBAA0B,SAAQ,iBAA0B;CAAG;AAA5E,8DAA4E;AA2N5E,WAAiB,SAAS;IAMV,mCAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAGnF,CAAC,EATgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASzB"}

package/resources/events/backfills.mjs

@@ -0,0 +1,76 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from 'orb-billing/resource';
+import { isRequestOptions } from 'orb-billing/core';
+import * as BackfillsAPI from 'orb-billing/resources/events/backfills';
+import { Page } from 'orb-billing/pagination';
+export class Backfills extends APIResource {
+    /**
+     * Creating the backfill enables adding or replacing past events, even those that
+     * are older than the ingestion grace period. Performing a backfill in Orb involves
+     * 3 steps:
+     *
+     * 1. Create the backfill, specifying its parameters.
+     * 2. [Ingest](ingest) usage events, referencing the backfill (query parameter
+     *    `backfill_id`).
+     * 3. [Close](close-backfill) the backfill, propagating the update in past usage
+     *    throughout Orb.
+     *
+     * Changes from a backfill are not reflected until the backfill is closed, so you
+     * won’t need to worry about your customers seeing partially updated usage data.
+     * Backfills are also reversible, so you’ll be able to revert a backfill if you’ve
+     * made a mistake.
+     *
+     * This endpoint will return a backfill object, which contains an `id`. That `id`
+     * can then be used as the `backfill_id` query parameter to the event ingestion
+     * endpoint to associate ingested events with this backfill. The effects (e.g.
+     * updated usage graphs) of this backfill will not take place until the backfill is
+     * closed.
+     *
+     * If the `replace_existing_events` is `true`, existing events in the backfill's
+     * timeframe will be replaced with the newly ingested events associated with the
+     * backfill. If `false`, newly ingested events will be added to the existing
+     * events.
+     */
+    create(body, options) {
+        return this.post('/events/backfills', { body, ...options });
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/events/backfills', BackfillListResponsesPage, { query, ...options });
+    }
+    /**
+     * Closing a backfill makes the updated usage visible in Orb. Upon closing a
+     * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
+     * and usage graphs. Once all of the updates are complete, the backfill's status
+     * will transition to `reflected`.
+     */
+    close(backfillId, options) {
+        return this.post(`/events/backfills/${backfillId}/close`, options);
+    }
+    /**
+     * This endpoint is used to fetch a backfill given an identifier.
+     */
+    fetch(backfillId, options) {
+        return this.get(`/events/backfills/${backfillId}`, options);
+    }
+    /**
+     * Reverting a backfill undoes all the effects of closing the backfill. If the
+     * backfill is reflected, the status will transition to `pending_revert` while the
+     * effects of the backfill are undone. Once all effects are undone, the backfill
+     * will transition to `reverted`.
+     *
+     * If a backfill is reverted before its closed, no usage will be updated as a
+     * result of the backfill and it will immediately transition to `reverted`.
+     */
+    revert(backfillId, options) {
+        return this.post(`/events/backfills/${backfillId}/revert`, options);
+    }
+}
+export class BackfillListResponsesPage extends Page {
+}
+(function (Backfills) {
+    Backfills.BackfillListResponsesPage = BackfillsAPI.BackfillListResponsesPage;
+})(Backfills || (Backfills = {}));
+//# sourceMappingURL=backfills.mjs.map

package/resources/events/backfills.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"backfills.mjs","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,sBAAsB;OAC3C,EAAE,gBAAgB,EAAE,MAAM,kBAAkB;OAC5C,KAAK,YAAY,MAAM,wCAAwC;OAC/D,EAAE,IAAI,EAAmB,MAAM,wBAAwB;AAE9D,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,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,UAAU,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,IAA0B;CAAG;AA2N5E,WAAiB,SAAS;IAMV,mCAAyB,GAAG,YAAY,CAAC,yBAAyB,CAAC;AAGnF,CAAC,EATgB,SAAS,KAAT,SAAS,QASzB"}