@epilot/sdk 2.14.6 → 2.15.1

package/dist/{metering.d-DoC7rUbS.d.cts → metering.d-DomHYl06.d.cts}

@@ -495,7 +495,7 @@ declare namespace Components {
             /**
              * The calibration date of the meter
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             calibration_date?: string;
             /**
@@ -570,7 +570,7 @@ declare namespace Components {
             /**
              * The date as of which the forecast reading value is applicable
              * example:
-             * 2022-12-10T00:00:00.000Z
+             * 2022-12-10
              */
             forecast_as_of?: string;
             /**
@@ -582,7 +582,7 @@ declare namespace Components {
             /**
              * The timestamp of the last reading
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             last_reading?: string;
             /**
@@ -618,7 +618,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             source: Source;
@@ -748,7 +748,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             source: Source;
@@ -790,6 +790,32 @@ declare namespace Components {
             status?: "valid" | "in-validation" | "implausible";
             external_id?: string;
         }
+        export interface PruneMeterReadingsPayload {
+            /**
+             * The ID of the meter whose readings are pruned
+             */
+            meter_id: EntityId /* uuid */;
+            /**
+             * Optionally narrows the prune scope to a single counter of the meter
+             */
+            counter_id?: EntityId /* uuid */;
+            /**
+             * Optionally only prune readings with this source (e.g. `ERP`)
+             */
+            source?: Source;
+            /**
+             * Readings whose `external_id` is contained in this list are kept; every other reading in scope is deleted.
+             * An empty array deletes all readings in scope (subject to the no-external-id rule described on the endpoint).
+             * Limited to 10000 entries.
+             *
+             * example:
+             * [
+             *   "erp-reading-1",
+             *   "erp-reading-2"
+             * ]
+             */
+            keep_external_ids: string[];
+        }
         /**
          * The person who recorded the reading
          * example:
@@ -830,7 +856,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             /**
@@ -1121,7 +1147,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             /**
@@ -1583,7 +1609,7 @@ declare namespace Paths {
                     /**
                      * The calibration date of the meter
                      * example:
-                     * 2022-10-10T00:00:00.000Z
+                     * 2022-10-10
                      */
                     calibration_date?: string;
                     /**
@@ -1602,7 +1628,7 @@ declare namespace Paths {
                     /**
                      * The timestamp of the last reading
                      * example:
-                     * 2022-10-10T00:00:00.000Z
+                     * 2022-10-10
                      */
                     last_reading?: string;
                     /**
@@ -1771,6 +1797,48 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace PruneMeterReadings {
+        namespace Parameters {
+            export type ActivityId = /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            Components.Schemas.ActivityId /* ulid */;
+            export type Async = boolean;
+            export type CreateTicket = boolean;
+            export type DryRun = boolean;
+        }
+        export interface QueryParameters {
+            async?: Parameters.Async;
+            activity_id?: Parameters.ActivityId;
+            create_ticket?: Parameters.CreateTicket;
+            dry_run?: Parameters.DryRun;
+        }
+        export type RequestBody = Components.Schemas.PruneMeterReadingsPayload;
+        namespace Responses {
+            export interface $200 {
+                data?: {
+                    /**
+                     * Number of readings deleted (or that would be deleted when `dry_run=true`).
+                     * example:
+                     * 42
+                     */
+                    deleted_count?: number;
+                    /**
+                     * Number of readings in scope that were kept.
+                     * example:
+                     * 12
+                     */
+                    kept_count?: number;
+                };
+            }
+            export type $400 = Components.Responses.InvalidRequest;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace UpdateMeter {
         namespace Parameters {
             export type Id = Components.Schemas.EntityId /* uuid */;
@@ -1982,6 +2050,32 @@ interface OperationMethods {
     data?: Paths.BatchWriteMeterReadings.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.BatchWriteMeterReadings.Responses.$200>
+  /**
+   * pruneMeterReadings - pruneMeterReadings
+   * 
+   * Deletes every reading of a meter whose `external_id` is NOT in the provided keep list — in a single request.
+   * 
+   * The prune scope can optionally be narrowed to a single counter (`counter_id`) and/or a reading `source` (e.g. `ERP`).
+   * Replaces the client-side pattern of paginating the full reading history and issuing chunked batch deletes.
+   * 
+   * Readings without an `external_id`:
+   * - when a `source` filter is provided, they are **deleted** — they cannot be referenced by any keep list
+   * - when no `source` filter is provided, they are **kept** (conservative default)
+   * 
+   * Deletions reuse the same internal path as `batchWriteMeterReadings` with `operation: delete`: the same
+   * per-reading lifecycle events are emitted, and providing `activity_id` suppresses the per-reading delete
+   * activities and attaches the given activity to the affected meter and counters instead. Delete operations
+   * never create manual-intervention tickets; `create_ticket` is accepted for call-site parity with
+   * `batchWriteMeterReadings`.
+   * 
+   * `keep_external_ids` is limited to 10000 entries.
+   * 
+   */
+  'pruneMeterReadings'(
+    parameters?: Parameters<Paths.PruneMeterReadings.QueryParameters> | null,
+    data?: Paths.PruneMeterReadings.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PruneMeterReadings.Responses.$200>
   /**
    * createMeterReadingFromSubmission - createMeterReadingFromSubmission
    * 
@@ -2254,6 +2348,34 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.BatchWriteMeterReadings.Responses.$200>
   }
+  ['/v2/metering/readings/prune']: {
+    /**
+     * pruneMeterReadings - pruneMeterReadings
+     * 
+     * Deletes every reading of a meter whose `external_id` is NOT in the provided keep list — in a single request.
+     * 
+     * The prune scope can optionally be narrowed to a single counter (`counter_id`) and/or a reading `source` (e.g. `ERP`).
+     * Replaces the client-side pattern of paginating the full reading history and issuing chunked batch deletes.
+     * 
+     * Readings without an `external_id`:
+     * - when a `source` filter is provided, they are **deleted** — they cannot be referenced by any keep list
+     * - when no `source` filter is provided, they are **kept** (conservative default)
+     * 
+     * Deletions reuse the same internal path as `batchWriteMeterReadings` with `operation: delete`: the same
+     * per-reading lifecycle events are emitted, and providing `activity_id` suppresses the per-reading delete
+     * activities and attaches the given activity to the affected meter and counters instead. Delete operations
+     * never create manual-intervention tickets; `create_ticket` is accepted for call-site parity with
+     * `batchWriteMeterReadings`.
+     * 
+     * `keep_external_ids` is limited to 10000 entries.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.PruneMeterReadings.QueryParameters> | null,
+      data?: Paths.PruneMeterReadings.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PruneMeterReadings.Responses.$200>
+  }
   ['/v1/metering/reading/submission']: {
     /**
      * createMeterReadingFromSubmission - createMeterReadingFromSubmission
@@ -2418,6 +2540,7 @@ type MeterReading = Components.Schemas.MeterReading;
 type MeterReadingChangeset = Components.Schemas.MeterReadingChangeset;
 type PortalMeterReading = Components.Schemas.PortalMeterReading;
 type ProposedReading = Components.Schemas.ProposedReading;
+type PruneMeterReadingsPayload = Components.Schemas.PruneMeterReadingsPayload;
 type ReadBy = Components.Schemas.ReadBy;
 type Reading = Components.Schemas.Reading;
 type ReadingStatus = Components.Schemas.ReadingStatus;
@@ -2432,4 +2555,4 @@ type TimestampTolerance = Components.Schemas.TimestampTolerance;
 type Unit = Components.Schemas.Unit;
 type UpdateMeterReading = Components.Schemas.UpdateMeterReading;
 
-export { type ActionLabel as A, type BaseEntity as B, type Client as C, type DeleteBatchReading as D, type Entity as E, type FuzzyConfig as F, type TimestampTolerance as G, UpdateMeterReading as H, type Id as I, type JourneyActions as J, type Meter as M, type OperationMethods as O, Paths as P, type ReadBy as R, type Source as S, type TariffType as T, type Unit as U, Components as a, type PathsDictionary as b, type ActivityId as c, type BatchReading as d, type BatchReadingBase as e, type ChangesetCreator as f, type CounterReadingOnSubmission as g, type CreateOrUpdateBatchReading as h, type Direction as i, type EntityId as j, type EntityItem as k, type EntityRelation as l, type EntitySlug as m, type ErrorResp as n, type MeterCounter as o, type MeterReading as p, type MeterReadingChangeset as q, type PortalMeterReading as r, type ProposedReading as s, type Reading as t, type ReadingStatus as u, type ReadingWithMeter as v, type Reason as w, type ReasonString as x, type Rule as y, type SubmissionMeterReading as z };
+export { type ActionLabel as A, type BaseEntity as B, type Client as C, type DeleteBatchReading as D, type Entity as E, type FuzzyConfig as F, type SubmissionMeterReading as G, type TimestampTolerance as H, type Id as I, type JourneyActions as J, UpdateMeterReading as K, type Meter as M, type OperationMethods as O, Paths as P, type ReadBy as R, type Source as S, type TariffType as T, type Unit as U, Components as a, type PathsDictionary as b, type ActivityId as c, type BatchReading as d, type BatchReadingBase as e, type ChangesetCreator as f, type CounterReadingOnSubmission as g, type CreateOrUpdateBatchReading as h, type Direction as i, type EntityId as j, type EntityItem as k, type EntityRelation as l, type EntitySlug as m, type ErrorResp as n, type MeterCounter as o, type MeterReading as p, type MeterReadingChangeset as q, type PortalMeterReading as r, type ProposedReading as s, type PruneMeterReadingsPayload as t, type Reading as u, type ReadingStatus as v, type ReadingWithMeter as w, type Reason as x, type ReasonString as y, type Rule as z };

package/dist/{metering.d-DoC7rUbS.d.ts → metering.d-DomHYl06.d.ts}

@@ -495,7 +495,7 @@ declare namespace Components {
             /**
              * The calibration date of the meter
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             calibration_date?: string;
             /**
@@ -570,7 +570,7 @@ declare namespace Components {
             /**
              * The date as of which the forecast reading value is applicable
              * example:
-             * 2022-12-10T00:00:00.000Z
+             * 2022-12-10
              */
             forecast_as_of?: string;
             /**
@@ -582,7 +582,7 @@ declare namespace Components {
             /**
              * The timestamp of the last reading
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             last_reading?: string;
             /**
@@ -618,7 +618,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             source: Source;
@@ -748,7 +748,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             source: Source;
@@ -790,6 +790,32 @@ declare namespace Components {
             status?: "valid" | "in-validation" | "implausible";
             external_id?: string;
         }
+        export interface PruneMeterReadingsPayload {
+            /**
+             * The ID of the meter whose readings are pruned
+             */
+            meter_id: EntityId /* uuid */;
+            /**
+             * Optionally narrows the prune scope to a single counter of the meter
+             */
+            counter_id?: EntityId /* uuid */;
+            /**
+             * Optionally only prune readings with this source (e.g. `ERP`)
+             */
+            source?: Source;
+            /**
+             * Readings whose `external_id` is contained in this list are kept; every other reading in scope is deleted.
+             * An empty array deletes all readings in scope (subject to the no-external-id rule described on the endpoint).
+             * Limited to 10000 entries.
+             *
+             * example:
+             * [
+             *   "erp-reading-1",
+             *   "erp-reading-2"
+             * ]
+             */
+            keep_external_ids: string[];
+        }
         /**
          * The person who recorded the reading
          * example:
@@ -830,7 +856,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             /**
@@ -1121,7 +1147,7 @@ declare namespace Components {
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
-             * 2022-10-10T00:00:00.000Z
+             * 2022-10-10
              */
             timestamp?: string; // date-time
             /**
@@ -1583,7 +1609,7 @@ declare namespace Paths {
                     /**
                      * The calibration date of the meter
                      * example:
-                     * 2022-10-10T00:00:00.000Z
+                     * 2022-10-10
                      */
                     calibration_date?: string;
                     /**
@@ -1602,7 +1628,7 @@ declare namespace Paths {
                     /**
                      * The timestamp of the last reading
                      * example:
-                     * 2022-10-10T00:00:00.000Z
+                     * 2022-10-10
                      */
                     last_reading?: string;
                     /**
@@ -1771,6 +1797,48 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace PruneMeterReadings {
+        namespace Parameters {
+            export type ActivityId = /**
+             * See https://github.com/ulid/spec
+             * example:
+             * 01F130Q52Q6MWSNS8N2AVXV4JN
+             */
+            Components.Schemas.ActivityId /* ulid */;
+            export type Async = boolean;
+            export type CreateTicket = boolean;
+            export type DryRun = boolean;
+        }
+        export interface QueryParameters {
+            async?: Parameters.Async;
+            activity_id?: Parameters.ActivityId;
+            create_ticket?: Parameters.CreateTicket;
+            dry_run?: Parameters.DryRun;
+        }
+        export type RequestBody = Components.Schemas.PruneMeterReadingsPayload;
+        namespace Responses {
+            export interface $200 {
+                data?: {
+                    /**
+                     * Number of readings deleted (or that would be deleted when `dry_run=true`).
+                     * example:
+                     * 42
+                     */
+                    deleted_count?: number;
+                    /**
+                     * Number of readings in scope that were kept.
+                     * example:
+                     * 12
+                     */
+                    kept_count?: number;
+                };
+            }
+            export type $400 = Components.Responses.InvalidRequest;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace UpdateMeter {
         namespace Parameters {
             export type Id = Components.Schemas.EntityId /* uuid */;
@@ -1982,6 +2050,32 @@ interface OperationMethods {
     data?: Paths.BatchWriteMeterReadings.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.BatchWriteMeterReadings.Responses.$200>
+  /**
+   * pruneMeterReadings - pruneMeterReadings
+   * 
+   * Deletes every reading of a meter whose `external_id` is NOT in the provided keep list — in a single request.
+   * 
+   * The prune scope can optionally be narrowed to a single counter (`counter_id`) and/or a reading `source` (e.g. `ERP`).
+   * Replaces the client-side pattern of paginating the full reading history and issuing chunked batch deletes.
+   * 
+   * Readings without an `external_id`:
+   * - when a `source` filter is provided, they are **deleted** — they cannot be referenced by any keep list
+   * - when no `source` filter is provided, they are **kept** (conservative default)
+   * 
+   * Deletions reuse the same internal path as `batchWriteMeterReadings` with `operation: delete`: the same
+   * per-reading lifecycle events are emitted, and providing `activity_id` suppresses the per-reading delete
+   * activities and attaches the given activity to the affected meter and counters instead. Delete operations
+   * never create manual-intervention tickets; `create_ticket` is accepted for call-site parity with
+   * `batchWriteMeterReadings`.
+   * 
+   * `keep_external_ids` is limited to 10000 entries.
+   * 
+   */
+  'pruneMeterReadings'(
+    parameters?: Parameters<Paths.PruneMeterReadings.QueryParameters> | null,
+    data?: Paths.PruneMeterReadings.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PruneMeterReadings.Responses.$200>
   /**
    * createMeterReadingFromSubmission - createMeterReadingFromSubmission
    * 
@@ -2254,6 +2348,34 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.BatchWriteMeterReadings.Responses.$200>
   }
+  ['/v2/metering/readings/prune']: {
+    /**
+     * pruneMeterReadings - pruneMeterReadings
+     * 
+     * Deletes every reading of a meter whose `external_id` is NOT in the provided keep list — in a single request.
+     * 
+     * The prune scope can optionally be narrowed to a single counter (`counter_id`) and/or a reading `source` (e.g. `ERP`).
+     * Replaces the client-side pattern of paginating the full reading history and issuing chunked batch deletes.
+     * 
+     * Readings without an `external_id`:
+     * - when a `source` filter is provided, they are **deleted** — they cannot be referenced by any keep list
+     * - when no `source` filter is provided, they are **kept** (conservative default)
+     * 
+     * Deletions reuse the same internal path as `batchWriteMeterReadings` with `operation: delete`: the same
+     * per-reading lifecycle events are emitted, and providing `activity_id` suppresses the per-reading delete
+     * activities and attaches the given activity to the affected meter and counters instead. Delete operations
+     * never create manual-intervention tickets; `create_ticket` is accepted for call-site parity with
+     * `batchWriteMeterReadings`.
+     * 
+     * `keep_external_ids` is limited to 10000 entries.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.PruneMeterReadings.QueryParameters> | null,
+      data?: Paths.PruneMeterReadings.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PruneMeterReadings.Responses.$200>
+  }
   ['/v1/metering/reading/submission']: {
     /**
      * createMeterReadingFromSubmission - createMeterReadingFromSubmission
@@ -2418,6 +2540,7 @@ type MeterReading = Components.Schemas.MeterReading;
 type MeterReadingChangeset = Components.Schemas.MeterReadingChangeset;
 type PortalMeterReading = Components.Schemas.PortalMeterReading;
 type ProposedReading = Components.Schemas.ProposedReading;
+type PruneMeterReadingsPayload = Components.Schemas.PruneMeterReadingsPayload;
 type ReadBy = Components.Schemas.ReadBy;
 type Reading = Components.Schemas.Reading;
 type ReadingStatus = Components.Schemas.ReadingStatus;
@@ -2432,4 +2555,4 @@ type TimestampTolerance = Components.Schemas.TimestampTolerance;
 type Unit = Components.Schemas.Unit;
 type UpdateMeterReading = Components.Schemas.UpdateMeterReading;
 
-export { type ActionLabel as A, type BaseEntity as B, type Client as C, type DeleteBatchReading as D, type Entity as E, type FuzzyConfig as F, type TimestampTolerance as G, UpdateMeterReading as H, type Id as I, type JourneyActions as J, type Meter as M, type OperationMethods as O, Paths as P, type ReadBy as R, type Source as S, type TariffType as T, type Unit as U, Components as a, type PathsDictionary as b, type ActivityId as c, type BatchReading as d, type BatchReadingBase as e, type ChangesetCreator as f, type CounterReadingOnSubmission as g, type CreateOrUpdateBatchReading as h, type Direction as i, type EntityId as j, type EntityItem as k, type EntityRelation as l, type EntitySlug as m, type ErrorResp as n, type MeterCounter as o, type MeterReading as p, type MeterReadingChangeset as q, type PortalMeterReading as r, type ProposedReading as s, type Reading as t, type ReadingStatus as u, type ReadingWithMeter as v, type Reason as w, type ReasonString as x, type Rule as y, type SubmissionMeterReading as z };
+export { type ActionLabel as A, type BaseEntity as B, type Client as C, type DeleteBatchReading as D, type Entity as E, type FuzzyConfig as F, type SubmissionMeterReading as G, type TimestampTolerance as H, type Id as I, type JourneyActions as J, UpdateMeterReading as K, type Meter as M, type OperationMethods as O, Paths as P, type ReadBy as R, type Source as S, type TariffType as T, type Unit as U, Components as a, type PathsDictionary as b, type ActivityId as c, type BatchReading as d, type BatchReadingBase as e, type ChangesetCreator as f, type CounterReadingOnSubmission as g, type CreateOrUpdateBatchReading as h, type Direction as i, type EntityId as j, type EntityItem as k, type EntityRelation as l, type EntitySlug as m, type ErrorResp as n, type MeterCounter as o, type MeterReading as p, type MeterReadingChangeset as q, type PortalMeterReading as r, type ProposedReading as s, type PruneMeterReadingsPayload as t, type Reading as u, type ReadingStatus as v, type ReadingWithMeter as w, type Reason as x, type ReasonString as y, type Rule as z };