@epilot/metering-client 0.5.5 → 0.5.7

package/dist/openapi.d.ts

@@ -12,17 +12,20 @@ declare namespace Components {
         export type Forbidden = Schemas.ErrorResp;
         export type InternalServerError = Schemas.ErrorResp;
         export type InvalidRequest = Schemas.ErrorResp;
-        export type NotFound = Schemas.ErrorResp;
         export type Unauthorized = Schemas.ErrorResp;
     }
     namespace Schemas {
+        export interface ActionLabel {
+            en?: string | null;
+            de?: string | null;
+        }
         export interface BaseEntity {
             /**
              * Entity ID
              * example:
              * 3fa85f64-5717-4562-b3fc-2c963f66afa6
              */
-            _id: EntityId;
+            _id: EntityId /* uuid */;
             /**
              * Title of the entity
              * example:
@@ -81,10 +84,10 @@ declare namespace Components {
         export interface Entity {
             [name: string]: any;
         }
-        export type EntityId = string;
+        export type EntityId = string; // uuid
         export interface EntityItem {
             [name: string]: any;
-            _id: EntityId;
+            _id: EntityId /* uuid */;
             /**
              * Title of the entity
              * example:
@@ -120,19 +123,9 @@ declare namespace Components {
             _updated_at: string; // date-time
         }
         export interface EntityRelation {
-            /**
-             * example:
-             * 9a2081a2-1615-44b8-b988-d757983290dd
-             */
-            entity_id?: string;
+            entity_id?: EntityId /* uuid */;
             _slug?: "contact" | "contract";
         }
-        /**
-         * URL-friendly identifier for the entity schema
-         * example:
-         * contact
-         */
-        export type EntitySlug = string;
         export interface ErrorResp {
             /**
              * Error message
@@ -140,8 +133,14 @@ declare namespace Components {
             message?: string;
         }
         export type Id = string;
+        export interface JourneyActions {
+            journey_id?: string | null;
+            action_label?: ActionLabel;
+            slug?: string | null;
+            rules?: Rule[] | null;
+        }
         export interface Meter {
-            _id: EntityId;
+            _id: EntityId /* uuid */;
             /**
              * Title of the entity
              * example:
@@ -258,7 +257,7 @@ declare namespace Components {
             };
         }
         export interface MeterCounter {
-            _id: EntityId;
+            _id: EntityId /* uuid */;
             /**
              * Title of the entity
              * example:
@@ -346,30 +345,26 @@ declare namespace Components {
              * 240
              */
             value: number;
-            /**
+            read_by?: /**
              * The person who recorded the reading
              * example:
              * John Doe
              */
-            read_by?: string;
-            /**
+            ReadBy;
+            reason?: /**
              * The reason for recording the reading
              * example:
              * Storing the feed-in record
              */
-            reason?: string;
+            Reason;
             /**
              * The ID of the associated meter
-             * example:
-             * 1446829f-4b6f-474e-b978-3997d89a7928
              */
-            meter_id: string;
+            meter_id: EntityId /* uuid */;
             /**
              * The ID of the associated meter counter
-             * example:
-             * 991a1821-43bc-46b8-967d-64a3d87c31f8
              */
-            counter_id?: string;
+            counter_id?: EntityId /* uuid */;
             /**
              * The direction of the reading (feed-in or feed-out)
              */
@@ -401,7 +396,13 @@ declare namespace Components {
              */
             maxNextReadingValue?: number;
         }
-        export type ReadingStatus = "valid" | "in-validation" | "implausible";
+        /**
+         * The person who recorded the reading
+         * example:
+         * John Doe
+         */
+        export type ReadBy = string | null;
+        export type ReadingStatus = "valid" | "in-validation" | "implausible" | null | "";
         export interface ReadingWithMeter {
             /**
              * The MA-LO ID of the meter
@@ -437,18 +438,18 @@ declare namespace Components {
              * 240
              */
             value?: number;
-            /**
+            read_by?: /**
              * The person who recorded the reading
              * example:
              * John Doe
              */
-            read_by?: string;
-            /**
+            ReadBy;
+            reason?: /**
              * The reason for recording the reading
              * example:
              * Storing the feed-in record
              */
-            reason?: string;
+            Reason;
             /**
              * If the value is not provided, the system will be set with the time the request is processed.
              * example:
@@ -460,6 +461,17 @@ declare namespace Components {
              */
             source?: Source;
         }
+        /**
+         * The reason for recording the reading
+         * example:
+         * Storing the feed-in record
+         */
+        export type Reason = string | null;
+        export interface Rule {
+            entity?: string | null;
+            attribute?: string | null;
+            attribute_value?: string | null;
+        }
         export type Source = "ECP" | "ERP" | "360" | "journey-submission";
         export type SubmissionMeterReading = {
             /**
@@ -490,12 +502,12 @@ declare namespace Components {
              * John Doe
              */
             readBy?: string;
-            /**
+            reason?: /**
              * The reason for recording the reading
              * example:
              * Storing the feed-in record
              */
-            reason?: string;
+            Reason;
             /**
              * The MA-LO ID of the meter
              * example:
@@ -589,6 +601,12 @@ declare namespace Paths {
         }
     }
     namespace CreateMeterReadings {
+        namespace Parameters {
+            export type Async = boolean;
+        }
+        export interface QueryParameters {
+            async?: Parameters.Async;
+        }
         export interface RequestBody {
             readings?: Components.Schemas.MeterReading[];
         }
@@ -712,7 +730,124 @@ declare namespace Paths {
     namespace GetCustomerMeters {
         namespace Responses {
             export interface $200 {
-                data?: Components.Schemas.Meter[];
+                data?: {
+                    _id: Components.Schemas.EntityId /* uuid */;
+                    /**
+                     * Title of the entity
+                     * example:
+                     * Example Entity
+                     */
+                    _title: string;
+                    /**
+                     * Organization ID the entity belongs to
+                     * example:
+                     * 123
+                     */
+                    _org: string;
+                    /**
+                     * Array of entity tags
+                     * example:
+                     * [
+                     *   "example",
+                     *   "mock"
+                     * ]
+                     */
+                    _tags?: string[];
+                    /**
+                     * Creation timestamp of the entity
+                     * example:
+                     * 2021-02-09T12:41:43.662Z
+                     */
+                    _created_at: string; // date-time
+                    /**
+                     * Last update timestamp of the entity
+                     * example:
+                     * 2021-02-09T12:41:43.662Z
+                     */
+                    _updated_at: string; // date-time
+                    /**
+                     * The schema type of the meter
+                     */
+                    _schema: "meter";
+                    /**
+                     * The MA-LO ID of the meter
+                     * example:
+                     * A09-123
+                     */
+                    ma_lo_id?: string;
+                    /**
+                     * The type of the meter
+                     */
+                    meter_type?: "three-phase-meter" | "bellow-gas-meter" | "rotary-piston-meter" | "smart-meter" | "performance-meter" | "maximum-meter" | "turbine-gas-meter" | "ultrasonic-gas-meter" | "alternating-current-meter" | "modern-metering-system" | "intelligent-measuring-system" | "electronic-meter";
+                    /**
+                     * The tariff type of the meter
+                     * example:
+                     * Peak load tariff
+                     */
+                    tariff_type?: string;
+                    /**
+                     * The number of the meter
+                     * example:
+                     * J-1093-1AK
+                     */
+                    meter_number?: string;
+                    /**
+                     * The sector to which the meter belongs
+                     */
+                    sector?: "power" | "water" | "gas";
+                    /**
+                     * The location information of the meter
+                     * example:
+                     * [
+                     *   {
+                     *     "country": "Germany",
+                     *     "city": "Koln",
+                     *     "postal_code": 81475,
+                     *     "street": "Melatengürtel",
+                     *     "street_number": 71,
+                     *     "additional_info": "5. Etage",
+                     *     "_tags": [
+                     *       "billing",
+                     *       "delivery"
+                     *     ]
+                     *   }
+                     * ]
+                     */
+                    location?: {
+                        [key: string]: any;
+                    };
+                    /**
+                     * The usage purpose of the meter
+                     * example:
+                     * Domestic Usage
+                     */
+                    used_for?: string;
+                    /**
+                     * The manufacturer of the meter
+                     * example:
+                     * Energy One
+                     */
+                    manufacturer?: string;
+                    /**
+                     * The calibration date of the meter
+                     * example:
+                     * 2022-10-10T00:00:00.000Z
+                     */
+                    calibration_date?: string;
+                    /**
+                     * The contract associated with the meter
+                     */
+                    contract?: {
+                        $relation?: Components.Schemas.EntityRelation[];
+                    };
+                    /**
+                     * The customer associated with the meter
+                     */
+                    customer?: {
+                        $relation?: Components.Schemas.EntityRelation[];
+                    };
+                    journey_actions?: Components.Schemas.JourneyActions;
+                }[];
             }
             export type $400 = Components.Responses.InvalidRequest;
             export type $401 = Components.Responses.Unauthorized;
@@ -769,7 +904,7 @@ declare namespace Paths {
     }
     namespace GetMeter {
         namespace Parameters {
-            export type Id = Components.Schemas.EntityId;
+            export type Id = Components.Schemas.EntityId /* uuid */;
         }
         export interface PathParameters {
             id: Parameters.Id;
@@ -778,6 +913,7 @@ declare namespace Paths {
             export interface $200 {
                 data?: {
                     entity?: Components.Schemas.Meter;
+                    journey_actions?: Components.Schemas.JourneyActions;
                     relations?: Components.Schemas.EntityItem[];
                 };
             }
@@ -789,18 +925,10 @@ declare namespace Paths {
     }
     namespace GetMeterCounters {
         namespace Parameters {
-            /**
-             * example:
-             * 1446829f-4b6f-474e-b978-3997d89a7928
-             */
-            export type MeterId = string;
+            export type MeterId = Components.Schemas.EntityId /* uuid */;
         }
         export interface QueryParameters {
-            meter_id: /**
-             * example:
-             * 1446829f-4b6f-474e-b978-3997d89a7928
-             */
-            Parameters.MeterId;
+            meter_id: Parameters.MeterId;
         }
         namespace Responses {
             export interface $200 {
@@ -814,7 +942,7 @@ declare namespace Paths {
     }
     namespace GetMetersByContractId {
         namespace Parameters {
-            export type ContractId = Components.Schemas.EntityId;
+            export type ContractId = Components.Schemas.EntityId /* uuid */;
         }
         export interface PathParameters {
             contract_id: Parameters.ContractId;
@@ -908,7 +1036,7 @@ declare namespace Paths {
     }
     namespace UpdateMeter {
         namespace Parameters {
-            export type Id = Components.Schemas.EntityId;
+            export type Id = Components.Schemas.EntityId /* uuid */;
         }
         export interface PathParameters {
             id: Parameters.Id;
@@ -975,7 +1103,7 @@ export interface OperationMethods {
    * Retrieves all meters related to a contract.
    */
   'getMetersByContractId'(
-    parameters: Parameters<Paths.GetMetersByContractId.PathParameters>,
+    parameters?: Parameters<Paths.GetMetersByContractId.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetMetersByContractId.Responses.$200>
@@ -985,7 +1113,7 @@ export interface OperationMethods {
    * Retrieves the details of a meter.
    */
   'getMeter'(
-    parameters: Parameters<Paths.GetMeter.PathParameters>,
+    parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetMeter.Responses.$200>
@@ -995,7 +1123,7 @@ export interface OperationMethods {
    * Updates the details of a meter.
    */
   'updateMeter'(
-    parameters: Parameters<Paths.UpdateMeter.PathParameters>,
+    parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
     data?: Paths.UpdateMeter.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateMeter.Responses.$200>
@@ -1015,7 +1143,7 @@ export interface OperationMethods {
    * Retrieves the details of a meter counter.
    */
   'getCounterDetails'(
-    parameters: Parameters<Paths.GetCounterDetails.PathParameters>,
+    parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
@@ -1032,10 +1160,10 @@ export interface OperationMethods {
   /**
    * createMeterReadings - Create Meter Readings
    * 
-   * Inserts multiple meter readings at once.
+   * Inserts multiple meter readings at once. Limited to 100 readings per request.
    */
   'createMeterReadings'(
-    parameters?: Parameters<UnknownParamsObject> | null,
+    parameters?: Parameters<Paths.CreateMeterReadings.QueryParameters> | null,
     data?: Paths.CreateMeterReadings.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
@@ -1055,7 +1183,7 @@ export interface OperationMethods {
    * Get allowed reading for the given meter
    */
   'getAllowedReadingForMeter'(
-    parameters: Parameters<Paths.GetAllowedReadingForMeter.QueryParameters & Paths.GetAllowedReadingForMeter.PathParameters>,
+    parameters?: Parameters<Paths.GetAllowedReadingForMeter.PathParameters & Paths.GetAllowedReadingForMeter.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetAllowedReadingForMeter.Responses.$200>
@@ -1078,7 +1206,7 @@ export interface OperationMethods {
    * 
    */
   'getReadingsByInterval'(
-    parameters: Parameters<Paths.GetReadingsByInterval.QueryParameters & Paths.GetReadingsByInterval.PathParameters>,
+    parameters?: Parameters<Paths.GetReadingsByInterval.PathParameters & Paths.GetReadingsByInterval.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
@@ -1088,7 +1216,7 @@ export interface OperationMethods {
    * Updates a meter reading.
    */
   'updateMeterReading'(
-    parameters: Parameters<Paths.UpdateMeterReading.QueryParameters & Paths.UpdateMeterReading.PathParameters>,
+    parameters?: Parameters<Paths.UpdateMeterReading.PathParameters & Paths.UpdateMeterReading.QueryParameters> | null,
     data?: Paths.UpdateMeterReading.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
@@ -1098,7 +1226,7 @@ export interface OperationMethods {
    * Deletes a meter reading.
    */
   'deleteMeterReading'(
-    parameters: Parameters<Paths.DeleteMeterReading.QueryParameters & Paths.DeleteMeterReading.PathParameters>,
+    parameters?: Parameters<Paths.DeleteMeterReading.PathParameters & Paths.DeleteMeterReading.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
@@ -1111,7 +1239,7 @@ export interface OperationMethods {
    * 
    */
   'getDownSampleReadingsByInterval'(
-    parameters: Parameters<Paths.GetDownSampleReadingsByInterval.QueryParameters & Paths.GetDownSampleReadingsByInterval.PathParameters>,
+    parameters?: Parameters<Paths.GetDownSampleReadingsByInterval.PathParameters & Paths.GetDownSampleReadingsByInterval.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetDownSampleReadingsByInterval.Responses.$200>
@@ -1137,7 +1265,7 @@ export interface PathsDictionary {
      * Retrieves all meters related to a contract.
      */
     'get'(
-      parameters: Parameters<Paths.GetMetersByContractId.PathParameters>,
+      parameters?: Parameters<Paths.GetMetersByContractId.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetMetersByContractId.Responses.$200>
@@ -1149,7 +1277,7 @@ export interface PathsDictionary {
      * Updates the details of a meter.
      */
     'patch'(
-      parameters: Parameters<Paths.UpdateMeter.PathParameters>,
+      parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
       data?: Paths.UpdateMeter.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateMeter.Responses.$200>
@@ -1159,7 +1287,7 @@ export interface PathsDictionary {
      * Retrieves the details of a meter.
      */
     'get'(
-      parameters: Parameters<Paths.GetMeter.PathParameters>,
+      parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetMeter.Responses.$200>
@@ -1183,7 +1311,7 @@ export interface PathsDictionary {
      * Retrieves the details of a meter counter.
      */
     'get'(
-      parameters: Parameters<Paths.GetCounterDetails.PathParameters>,
+      parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
@@ -1204,10 +1332,10 @@ export interface PathsDictionary {
     /**
      * createMeterReadings - Create Meter Readings
      * 
-     * Inserts multiple meter readings at once.
+     * Inserts multiple meter readings at once. Limited to 100 readings per request.
      */
     'post'(
-      parameters?: Parameters<UnknownParamsObject> | null,
+      parameters?: Parameters<Paths.CreateMeterReadings.QueryParameters> | null,
       data?: Paths.CreateMeterReadings.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
@@ -1231,7 +1359,7 @@ export interface PathsDictionary {
      * Get allowed reading for the given meter
      */
     'get'(
-      parameters: Parameters<Paths.GetAllowedReadingForMeter.QueryParameters & Paths.GetAllowedReadingForMeter.PathParameters>,
+      parameters?: Parameters<Paths.GetAllowedReadingForMeter.PathParameters & Paths.GetAllowedReadingForMeter.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetAllowedReadingForMeter.Responses.$200>
@@ -1258,7 +1386,7 @@ export interface PathsDictionary {
      * 
      */
     'get'(
-      parameters: Parameters<Paths.GetReadingsByInterval.QueryParameters & Paths.GetReadingsByInterval.PathParameters>,
+      parameters?: Parameters<Paths.GetReadingsByInterval.PathParameters & Paths.GetReadingsByInterval.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
@@ -1268,7 +1396,7 @@ export interface PathsDictionary {
      * Updates a meter reading.
      */
     'put'(
-      parameters: Parameters<Paths.UpdateMeterReading.QueryParameters & Paths.UpdateMeterReading.PathParameters>,
+      parameters?: Parameters<Paths.UpdateMeterReading.PathParameters & Paths.UpdateMeterReading.QueryParameters> | null,
       data?: Paths.UpdateMeterReading.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
@@ -1278,7 +1406,7 @@ export interface PathsDictionary {
      * Deletes a meter reading.
      */
     'delete'(
-      parameters: Parameters<Paths.DeleteMeterReading.QueryParameters & Paths.DeleteMeterReading.PathParameters>,
+      parameters?: Parameters<Paths.DeleteMeterReading.PathParameters & Paths.DeleteMeterReading.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
@@ -1293,7 +1421,7 @@ export interface PathsDictionary {
      * 
      */
     'get'(
-      parameters: Parameters<Paths.GetDownSampleReadingsByInterval.QueryParameters & Paths.GetDownSampleReadingsByInterval.PathParameters>,
+      parameters?: Parameters<Paths.GetDownSampleReadingsByInterval.PathParameters & Paths.GetDownSampleReadingsByInterval.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetDownSampleReadingsByInterval.Responses.$200>