@epilot/pricing-client 3.47.0 → 3.47.1

package/dist/openapi.d.ts

@@ -216,10 +216,41 @@ declare namespace Components {
                 };
             }[];
         }
+        /**
+         * An average market price over a given period in time.
+         */
+        export interface AverageMarketPriceRecord {
+            /**
+             * Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
+             * example:
+             * 12.3
+             */
+            unit_amount: number;
+            /**
+             * Cost in decimal format, e.g. 0.123€.
+             * example:
+             * 0.123
+             */
+            unit_amount_decimal: string;
+            unit_amount_currency: /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * An ISO 8601 interval in the format 'start/end'.
+             * example:
+             * 2025-01-01T00:00:00Z/2025-01-31T23:59:59Z
+             */
+            timestamp: string;
+        }
         export interface AverageMarketPriceResult {
             market: /* The market for a spot market price. */ SpotMarketType;
             bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
-            price: /* A market price at a given point in time. */ MarketPriceRecord;
+            price: /* An average market price over a given period in time. */ AverageMarketPriceRecord;
             _meta?: /* Signature meta data payload */ SignatureMeta;
         }
         /**
@@ -326,6 +357,28 @@ declare namespace Components {
              */
             Price[];
         }
+        export interface BaseMarketPriceRecord {
+            /**
+             * Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
+             * example:
+             * 12.3
+             */
+            unit_amount: number;
+            /**
+             * Cost in decimal format, e.g. 0.123€.
+             * example:
+             * 0.123
+             */
+            unit_amount_decimal: string;
+            unit_amount_currency: /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+        }
         /**
          * Represents a price item
          * example:
@@ -1365,6 +1418,38 @@ declare namespace Components {
          */
         export interface CompositePrice {
             [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
             /**
              * Whether the price can be used for new purchases.
              */
@@ -2683,7 +2768,7 @@ declare namespace Components {
         export interface ExternalPriceMetadata {
             market: /* The market for a spot market price. */ SpotMarketType;
             bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
-            price: /* A market price at a given point in time. */ MarketPriceRecord;
+            price: /* An average market price over a given period in time. */ AverageMarketPriceRecord;
             _meta?: /* Signature meta data payload */ SignatureMeta;
             inputs?: {
                 [name: string]: any;
@@ -2712,10 +2797,39 @@ declare namespace Components {
          * The concession type for gas
          */
         export type GasConcessionType = "standard" | "special";
+        /**
+         * A market price at a given point in time.
+         */
+        export interface HistoricMarketPriceRecord {
+            /**
+             * Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
+             * example:
+             * 12.3
+             */
+            unit_amount: number;
+            /**
+             * Cost in decimal format, e.g. 0.123€.
+             * example:
+             * 0.123
+             */
+            unit_amount_decimal: string;
+            unit_amount_currency: /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * ISO 8601 timestamp of the price record in UTC.
+             */
+            timestamp: string; // date-time
+        }
         export interface HistoricMarketPricesResult {
             market: /* The market for a spot market price. */ SpotMarketType;
             bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
-            prices: /* A market price at a given point in time. */ MarketPriceRecord[];
+            prices: /* A market price at a given point in time. */ HistoricMarketPriceRecord[];
         }
         export type IntegrationCredentialsResult = /* The basic auth credentials */ BasicAuthCredentials;
         export type IntegrationId = "getag" | "ikom";
@@ -2784,35 +2898,6 @@ declare namespace Components {
                 };
             }[];
         }
-        /**
-         * A market price at a given point in time.
-         */
-        export interface MarketPriceRecord {
-            /**
-             * ISO 8601 timestamp of the price record in UTC.
-             */
-            timestamp: string; // date-time
-            /**
-             * Cost in Cents, e.g. 123 for 12,3 Cents = 0.123€.
-             * example:
-             * 12.3
-             */
-            unit_amount: number;
-            /**
-             * Cost in decimal format, e.g. 0.123€.
-             * example:
-             * 0.123
-             */
-            unit_amount_decimal: string;
-            unit_amount_currency: /**
-             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
-             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
-             *
-             * example:
-             * EUR
-             */
-            Currency;
-        }
         /**
          * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
          * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
@@ -3276,6 +3361,38 @@ declare namespace Components {
          */
         export interface Price {
             [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
             /**
              * Whether the price can be used for new purchases.
              */
@@ -3380,38 +3497,6 @@ declare namespace Components {
              * Defines the way the price amount is display in epilot journeys.
              */
             price_display_in_journeys?: "show_price" | "show_as_starting_price" | "show_as_on_request" | "estimated_price";
-            /**
-             * The billing period duration
-             */
-            billing_duration_amount?: number;
-            /**
-             * The billing period duration unit
-             */
-            billing_duration_unit?: "weeks" | "months" | "years";
-            /**
-             * The notice period duration
-             */
-            notice_time_amount?: number;
-            /**
-             * The notice period duration unit
-             */
-            notice_time_unit?: "weeks" | "months" | "years";
-            /**
-             * The termination period duration
-             */
-            termination_time_amount?: number;
-            /**
-             * The termination period duration unit
-             */
-            termination_time_unit?: "weeks" | "months" | "years";
-            /**
-             * The renewal period duration
-             */
-            renewal_duration_amount?: number;
-            /**
-             * The renewal period duration unit
-             */
-            renewal_duration_unit?: "weeks" | "months" | "years";
             /**
              * The flag for prices that can be influenced by external variables such as user input.
              */
@@ -3463,6 +3548,40 @@ declare namespace Components {
              */
             _tags?: string[];
         }
+        export interface PriceConditions {
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
+        }
         export interface PriceDynamicTariff {
             mode: /* The mode of the dynamic tariff. `day_ahead_market` uses the Day-Ahead spot market price as base. */ DynamicTariffMode;
             interval?: /* The interval of the tariff if a spot market price is used as base. */ DynamicTariffInterval;
@@ -4239,6 +4358,38 @@ declare namespace Components {
              */
             _price?: {
                 [name: string]: any;
+                /**
+                 * The billing period duration
+                 */
+                billing_duration_amount?: number;
+                /**
+                 * The billing period duration unit
+                 */
+                billing_duration_unit?: "weeks" | "months" | "years";
+                /**
+                 * The notice period duration
+                 */
+                notice_time_amount?: number;
+                /**
+                 * The notice period duration unit
+                 */
+                notice_time_unit?: "weeks" | "months" | "years";
+                /**
+                 * The termination period duration
+                 */
+                termination_time_amount?: number;
+                /**
+                 * The termination period duration unit
+                 */
+                termination_time_unit?: "weeks" | "months" | "years";
+                /**
+                 * The renewal period duration
+                 */
+                renewal_duration_amount?: number;
+                /**
+                 * The renewal period duration unit
+                 */
+                renewal_duration_unit?: "weeks" | "months" | "years";
                 /**
                  * Whether the price can be used for new purchases.
                  */
@@ -4343,38 +4494,6 @@ declare namespace Components {
                  * Defines the way the price amount is display in epilot journeys.
                  */
                 price_display_in_journeys?: "show_price" | "show_as_starting_price" | "show_as_on_request" | "estimated_price";
-                /**
-                 * The billing period duration
-                 */
-                billing_duration_amount?: number;
-                /**
-                 * The billing period duration unit
-                 */
-                billing_duration_unit?: "weeks" | "months" | "years";
-                /**
-                 * The notice period duration
-                 */
-                notice_time_amount?: number;
-                /**
-                 * The notice period duration unit
-                 */
-                notice_time_unit?: "weeks" | "months" | "years";
-                /**
-                 * The termination period duration
-                 */
-                termination_time_amount?: number;
-                /**
-                 * The termination period duration unit
-                 */
-                termination_time_unit?: "weeks" | "months" | "years";
-                /**
-                 * The renewal period duration
-                 */
-                renewal_duration_amount?: number;
-                /**
-                 * The renewal period duration unit
-                 */
-                renewal_duration_unit?: "weeks" | "months" | "years";
                 /**
                  * The flag for prices that can be influenced by external variables such as user input.
                  */
@@ -5342,15 +5461,15 @@ declare namespace Paths {
     namespace $AverageMarketPrice {
         namespace Parameters {
             export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
-            export type From = string; // date
+            export type From = string /* date */ | string /* date-time */;
             export type Market = /* The market for a spot market price. */ Components.Schemas.SpotMarketType;
-            export type To = string; // date
+            export type To = string /* date */ | string /* date-time */;
         }
         export interface QueryParameters {
             market: Parameters.Market;
             bidding_zone: Parameters.BiddingZone;
-            from: Parameters.From /* date */;
-            to: Parameters.To /* date */;
+            from: Parameters.From;
+            to: Parameters.To;
         }
         namespace Responses {
             export type $200 = Components.Schemas.AverageMarketPriceResult;
@@ -5428,16 +5547,16 @@ declare namespace Paths {
         namespace Parameters {
             export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
             export type Frequency = /* The aggregation frequency for a series of spot market price data. */ Components.Schemas.SpotMarketDataFrequency;
-            export type From = string; // date
+            export type From = string /* date */ | string /* date-time */;
             export type Market = /* The market for a spot market price. */ Components.Schemas.SpotMarketType;
-            export type To = string; // date
+            export type To = string /* date */ | string /* date-time */;
         }
         export interface QueryParameters {
             market: Parameters.Market;
             bidding_zone: Parameters.BiddingZone;
             frequency: Parameters.Frequency;
-            from: Parameters.From /* date */;
-            to: Parameters.To /* date */;
+            from: Parameters.From;
+            to: Parameters.To;
         }
         namespace Responses {
             export type $200 = Components.Schemas.HistoricMarketPricesResult;
@@ -6103,8 +6222,10 @@ export type AvailabilityDate = Components.Schemas.AvailabilityDate;
 export type AvailabilityFilters = Components.Schemas.AvailabilityFilters;
 export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
 export type AvailabilityResult = Components.Schemas.AvailabilityResult;
+export type AverageMarketPriceRecord = Components.Schemas.AverageMarketPriceRecord;
 export type AverageMarketPriceResult = Components.Schemas.AverageMarketPriceResult;
 export type BaseCoupon = Components.Schemas.BaseCoupon;
+export type BaseMarketPriceRecord = Components.Schemas.BaseMarketPriceRecord;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
 export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
 export type BasePriceItemDto = Components.Schemas.BasePriceItemDto;
@@ -6147,11 +6268,11 @@ export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
 export type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata;
 export type File = Components.Schemas.File;
 export type GasConcessionType = Components.Schemas.GasConcessionType;
+export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
 export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
 export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
 export type IntegrationId = Components.Schemas.IntegrationId;
 export type JourneyContext = Components.Schemas.JourneyContext;
-export type MarketPriceRecord = Components.Schemas.MarketPriceRecord;
 export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
 export type MetaData = Components.Schemas.MetaData;
 export type Opportunity = Components.Schemas.Opportunity;
@@ -6165,6 +6286,7 @@ export type PaymentMethod = Components.Schemas.PaymentMethod;
 export type PowerMeterType = Components.Schemas.PowerMeterType;
 export type Price = Components.Schemas.Price;
 export type PriceComponentRelation = Components.Schemas.PriceComponentRelation;
+export type PriceConditions = Components.Schemas.PriceConditions;
 export type PriceDynamicTariff = Components.Schemas.PriceDynamicTariff;
 export type PriceGetAg = Components.Schemas.PriceGetAg;
 export type PriceInputMapping = Components.Schemas.PriceInputMapping;

package/dist/openapi.json

@@ -1243,20 +1243,34 @@
             "name": "from",
             "schema": {
               "type": "string",
-              "format": "date"
+              "anyOf": [
+                {
+                  "format": "date"
+                },
+                {
+                  "format": "date-time"
+                }
+              ]
             },
             "required": true,
-            "description": "Start of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DDD) the timzone of the bidding zone is used.\n"
+            "description": "Start of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DD) the timzone of the bidding zone is used.\n"
           },
           {
             "in": "query",
             "name": "to",
             "schema": {
               "type": "string",
-              "format": "date"
+              "anyOf": [
+                {
+                  "format": "date"
+                },
+                {
+                  "format": "date-time"
+                }
+              ]
             },
             "required": true,
-            "description": "End of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DDD) the timzone of the bidding zone is used.\n"
+            "description": "End of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DD) the timzone of the bidding zone is used.\n"
           }
         ],
         "responses": {
@@ -1320,20 +1334,34 @@
             "name": "from",
             "schema": {
               "type": "string",
-              "format": "date"
+              "anyOf": [
+                {
+                  "format": "date"
+                },
+                {
+                  "format": "date-time"
+                }
+              ]
             },
             "required": true,
-            "description": "Start of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DDD) the timzone of the bidding zone is used.\n"
+            "description": "Start of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DD) the timzone of the bidding zone is used.\n"
           },
           {
             "in": "query",
             "name": "to",
             "schema": {
               "type": "string",
-              "format": "date"
+              "anyOf": [
+                {
+                  "format": "date"
+                },
+                {
+                  "format": "date-time"
+                }
+              ]
             },
             "required": true,
-            "description": "End of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DDD) the timzone of the bidding zone is used.\n"
+            "description": "End of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-DD) the timzone of the bidding zone is used.\n"
           }
         ],
         "responses": {
@@ -2529,6 +2557,11 @@
         }
       },
       "Price": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PriceConditions"
+          }
+        ],
         "type": "object",
         "description": "The price entity schema for simple pricing",
         "example": {
@@ -2649,58 +2682,6 @@
               "estimated_price"
             ]
           },
-          "billing_duration_amount": {
-            "description": "The billing period duration",
-            "type": "number"
-          },
-          "billing_duration_unit": {
-            "description": "The billing period duration unit",
-            "type": "string",
-            "enum": [
-              "weeks",
-              "months",
-              "years"
-            ]
-          },
-          "notice_time_amount": {
-            "description": "The notice period duration",
-            "type": "number"
-          },
-          "notice_time_unit": {
-            "description": "The notice period duration unit",
-            "type": "string",
-            "enum": [
-              "weeks",
-              "months",
-              "years"
-            ]
-          },
-          "termination_time_amount": {
-            "description": "The termination period duration",
-            "type": "number"
-          },
-          "termination_time_unit": {
-            "description": "The termination period duration unit",
-            "type": "string",
-            "enum": [
-              "weeks",
-              "months",
-              "years"
-            ]
-          },
-          "renewal_duration_amount": {
-            "description": "The renewal period duration",
-            "type": "number"
-          },
-          "renewal_duration_unit": {
-            "description": "The renewal period duration unit",
-            "type": "string",
-            "enum": [
-              "weeks",
-              "months",
-              "years"
-            ]
-          },
           "variable_price": {
             "description": "The flag for prices that can be influenced by external variables such as user input.",
             "type": "boolean"
@@ -2772,6 +2753,11 @@
         ]
       },
       "CompositePrice": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PriceConditions"
+          }
+        ],
         "type": "object",
         "description": "The price entity schema for dynamic pricing",
         "example": {
@@ -2952,6 +2938,63 @@
           }
         }
       },
+      "PriceConditions": {
+        "type": "object",
+        "properties": {
+          "billing_duration_amount": {
+            "description": "The billing period duration",
+            "type": "number"
+          },
+          "billing_duration_unit": {
+            "description": "The billing period duration unit",
+            "type": "string",
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
+          },
+          "notice_time_amount": {
+            "description": "The notice period duration",
+            "type": "number"
+          },
+          "notice_time_unit": {
+            "description": "The notice period duration unit",
+            "type": "string",
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
+          },
+          "termination_time_amount": {
+            "description": "The termination period duration",
+            "type": "number"
+          },
+          "termination_time_unit": {
+            "description": "The termination period duration unit",
+            "type": "string",
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
+          },
+          "renewal_duration_amount": {
+            "description": "The renewal period duration",
+            "type": "number"
+          },
+          "renewal_duration_unit": {
+            "description": "The renewal period duration unit",
+            "type": "string",
+            "enum": [
+              "weeks",
+              "months",
+              "years"
+            ]
+          }
+        }
+      },
       "ExternalFeeMetadata": {
         "allOf": [
           {
@@ -3598,7 +3641,7 @@
           "prices": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/MarketPriceRecord"
+              "$ref": "#/components/schemas/HistoricMarketPriceRecord"
             }
           }
         },
@@ -3618,7 +3661,7 @@
             "$ref": "#/components/schemas/SpotMarketBiddingZone"
           },
           "price": {
-            "$ref": "#/components/schemas/MarketPriceRecord"
+            "$ref": "#/components/schemas/AverageMarketPriceRecord"
           },
           "_meta": {
             "$ref": "#/components/schemas/SignatureMeta"
@@ -3630,18 +3673,48 @@
           "price"
         ]
       },
-      "MarketPriceRecord": {
+      "AverageMarketPriceRecord": {
+        "description": "An average market price over a given period in time.",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseMarketPriceRecord"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "timestamp": {
+                "type": "string",
+                "description": "An ISO 8601 interval in the format 'start/end'.",
+                "example": "2025-01-01T00:00:00Z/2025-01-31T23:59:59Z"
+              }
+            }
+          }
+        ]
+      },
+      "HistoricMarketPriceRecord": {
         "description": "A market price at a given point in time.",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseMarketPriceRecord"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "timestamp": {
+                "type": "string",
+                "format": "date-time",
+                "description": "ISO 8601 timestamp of the price record in UTC."
+              }
+            }
+          }
+        ]
+      },
+      "BaseMarketPriceRecord": {
         "type": "object",
         "properties": {
-          "timestamp": {
-            "type": "string",
-            "format": "date-time",
-            "description": "ISO 8601 timestamp of the price record in UTC."
-          },
           "unit_amount": {
-            "type": "integer",
-            "description": "Cost in Cents, e.g. 123 for 12,3 Cents = 0.123€.",
+            "type": "number",
+            "description": "Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.",
             "example": 12.3
           },
           "unit_amount_decimal": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.47.0",
+  "version": "3.47.1",
   "description": "Client for epilot Pricing APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",