@epilot/pricing-client 3.46.0 → 3.46.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.d.ts CHANGED
@@ -216,6 +216,12 @@ declare namespace Components {
216
216
  };
217
217
  }[];
218
218
  }
219
+ export interface AverageMarketPriceResult {
220
+ market: /* The market for a spot market price. */ SpotMarketType;
221
+ bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
222
+ price: /* A market price at a given point in time. */ MarketPriceRecord;
223
+ _meta?: /* Signature meta data payload */ SignatureMeta;
224
+ }
219
225
  /**
220
226
  * The coupon configuration
221
227
  * example:
@@ -456,6 +462,10 @@ declare namespace Components {
456
462
  * The product main name
457
463
  */
458
464
  name?: string;
465
+ /**
466
+ * The product categories
467
+ */
468
+ categories?: string[];
459
469
  feature?: {
460
470
  /**
461
471
  * An arbitrary set of tags attached to a feature
@@ -769,6 +779,10 @@ declare namespace Components {
769
779
  * The product main name
770
780
  */
771
781
  name?: string;
782
+ /**
783
+ * The product categories
784
+ */
785
+ categories?: string[];
772
786
  feature?: {
773
787
  /**
774
788
  * An arbitrary set of tags attached to a feature
@@ -911,6 +925,10 @@ declare namespace Components {
911
925
  * The product main name
912
926
  */
913
927
  name?: string;
928
+ /**
929
+ * The product categories
930
+ */
931
+ categories?: string[];
914
932
  feature?: {
915
933
  /**
916
934
  * An arbitrary set of tags attached to a feature
@@ -989,6 +1007,7 @@ declare namespace Components {
989
1007
  */
990
1008
  ExternalFeeMappings;
991
1009
  external_fees_metadata?: ExternalFeeMetadata;
1010
+ external_price_metadata?: ExternalPriceMetadata;
992
1011
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
993
1012
  /**
994
1013
  * The ids of the coupons applicable to the price item
@@ -1543,6 +1562,10 @@ declare namespace Components {
1543
1562
  * The product main name
1544
1563
  */
1545
1564
  name?: string;
1565
+ /**
1566
+ * The product categories
1567
+ */
1568
+ categories?: string[];
1546
1569
  feature?: {
1547
1570
  /**
1548
1571
  * An arbitrary set of tags attached to a feature
@@ -1865,6 +1888,10 @@ declare namespace Components {
1865
1888
  * The product main name
1866
1889
  */
1867
1890
  name?: string;
1891
+ /**
1892
+ * The product categories
1893
+ */
1894
+ categories?: string[];
1868
1895
  feature?: {
1869
1896
  /**
1870
1897
  * An arbitrary set of tags attached to a feature
@@ -1943,6 +1970,7 @@ declare namespace Components {
1943
1970
  */
1944
1971
  ExternalFeeMappings;
1945
1972
  external_fees_metadata?: ExternalFeeMetadata;
1973
+ external_price_metadata?: ExternalPriceMetadata;
1946
1974
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
1947
1975
  /**
1948
1976
  * The ids of the coupons applicable to the price item
@@ -2652,6 +2680,15 @@ declare namespace Components {
2652
2680
  [name: string]: any;
2653
2681
  };
2654
2682
  }
2683
+ export interface ExternalPriceMetadata {
2684
+ market: /* The market for a spot market price. */ SpotMarketType;
2685
+ bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
2686
+ price: /* A market price at a given point in time. */ MarketPriceRecord;
2687
+ _meta?: /* Signature meta data payload */ SignatureMeta;
2688
+ inputs?: {
2689
+ [name: string]: any;
2690
+ };
2691
+ }
2655
2692
  export interface File {
2656
2693
  [name: string]: any;
2657
2694
  _id: string;
@@ -2675,6 +2712,11 @@ declare namespace Components {
2675
2712
  * The concession type for gas
2676
2713
  */
2677
2714
  export type GasConcessionType = "standard" | "special";
2715
+ export interface HistoricMarketPricesResult {
2716
+ market: /* The market for a spot market price. */ SpotMarketType;
2717
+ bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
2718
+ prices: /* A market price at a given point in time. */ MarketPriceRecord[];
2719
+ }
2678
2720
  export type IntegrationCredentialsResult = /* The basic auth credentials */ BasicAuthCredentials;
2679
2721
  export type IntegrationId = "getag" | "ikom";
2680
2722
  export interface JourneyContext {
@@ -2742,6 +2784,35 @@ declare namespace Components {
2742
2784
  };
2743
2785
  }[];
2744
2786
  }
2787
+ /**
2788
+ * A market price at a given point in time.
2789
+ */
2790
+ export interface MarketPriceRecord {
2791
+ /**
2792
+ * ISO 8601 timestamp of the price record in UTC.
2793
+ */
2794
+ timestamp: string; // date-time
2795
+ /**
2796
+ * Cost in Cents, e.g. 123 for 12,3 Cents = 0.123€.
2797
+ * example:
2798
+ * 12.3
2799
+ */
2800
+ unit_amount: number;
2801
+ /**
2802
+ * Cost in decimal format, e.g. 0.123€.
2803
+ * example:
2804
+ * 0.123
2805
+ */
2806
+ unit_amount_decimal: string;
2807
+ unit_amount_currency: /**
2808
+ * Three-letter ISO currency code, in lowercase. Must be a supported currency.
2809
+ * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
2810
+ *
2811
+ * example:
2812
+ * EUR
2813
+ */
2814
+ Currency;
2815
+ }
2745
2816
  /**
2746
2817
  * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
2747
2818
  * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
@@ -3654,6 +3725,10 @@ declare namespace Components {
3654
3725
  * The product main name
3655
3726
  */
3656
3727
  name?: string;
3728
+ /**
3729
+ * The product categories
3730
+ */
3731
+ categories?: string[];
3657
3732
  feature?: {
3658
3733
  /**
3659
3734
  * An arbitrary set of tags attached to a feature
@@ -3986,6 +4061,10 @@ declare namespace Components {
3986
4061
  * The product main name
3987
4062
  */
3988
4063
  name?: string;
4064
+ /**
4065
+ * The product categories
4066
+ */
4067
+ categories?: string[];
3989
4068
  feature?: {
3990
4069
  /**
3991
4070
  * An arbitrary set of tags attached to a feature
@@ -4064,6 +4143,7 @@ declare namespace Components {
4064
4143
  */
4065
4144
  ExternalFeeMappings;
4066
4145
  external_fees_metadata?: ExternalFeeMetadata;
4146
+ external_price_metadata?: ExternalPriceMetadata;
4067
4147
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
4068
4148
  /**
4069
4149
  * The ids of the coupons applicable to the price item
@@ -4516,6 +4596,10 @@ declare namespace Components {
4516
4596
  * The product main name
4517
4597
  */
4518
4598
  name?: string;
4599
+ /**
4600
+ * The product categories
4601
+ */
4602
+ categories?: string[];
4519
4603
  feature?: {
4520
4604
  /**
4521
4605
  * An arbitrary set of tags attached to a feature
@@ -4970,6 +5054,18 @@ declare namespace Components {
4970
5054
  */
4971
5055
  timestamp: number;
4972
5056
  }
5057
+ /**
5058
+ * The bidding zone for a spot market price.
5059
+ */
5060
+ export type SpotMarketBiddingZone = "AT" | "DE-LU";
5061
+ /**
5062
+ * The aggregation frequency for a series of spot market price data.
5063
+ */
5064
+ export type SpotMarketDataFrequency = "PT15M" | "PT1H" | "P1D" | "P1M";
5065
+ /**
5066
+ * The market for a spot market price.
5067
+ */
5068
+ export type SpotMarketType = "day_ahead";
4973
5069
  /**
4974
5070
  * The street entity
4975
5071
  */
@@ -5245,36 +5341,19 @@ declare namespace Paths {
5245
5341
  }
5246
5342
  namespace $AverageMarketPrice {
5247
5343
  namespace Parameters {
5248
- export type Interval = "previous_week" | "previous_month" | "previous_year";
5249
- export type Market = "day_ahead";
5344
+ export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
5345
+ export type From = string; // date
5346
+ export type Market = /* The market for a spot market price. */ Components.Schemas.SpotMarketType;
5347
+ export type To = string; // date
5250
5348
  }
5251
5349
  export interface QueryParameters {
5252
5350
  market: Parameters.Market;
5253
- interval: Parameters.Interval;
5351
+ bidding_zone: Parameters.BiddingZone;
5352
+ from: Parameters.From /* date */;
5353
+ to: Parameters.To /* date */;
5254
5354
  }
5255
5355
  namespace Responses {
5256
- export interface $200 {
5257
- market?: "day_ahead";
5258
- interval?: "previous_week" | "previous_month" | "previous_year";
5259
- price?: {
5260
- /**
5261
- * ISO 8601 timestamp of the price record in UTC.
5262
- */
5263
- timestamp: string; // date-time
5264
- /**
5265
- * Cost in Cents, e.g. 123 for 12,3 Cents = 0.123€.
5266
- * example:
5267
- * 123
5268
- */
5269
- unit_amount: number;
5270
- /**
5271
- * Cost in decimal format, e.g. 0.123€.
5272
- * example:
5273
- * 0.123
5274
- */
5275
- unit_amount_decimal: string;
5276
- };
5277
- }
5356
+ export type $200 = Components.Schemas.AverageMarketPriceResult;
5278
5357
  export type $400 = Components.Schemas.Error;
5279
5358
  }
5280
5359
  }
@@ -5347,40 +5426,21 @@ declare namespace Paths {
5347
5426
  }
5348
5427
  namespace $HistoricMarketPrices {
5349
5428
  namespace Parameters {
5350
- export type Frequency = "hourly" | "daily" | "monthly";
5429
+ export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
5430
+ export type Frequency = /* The aggregation frequency for a series of spot market price data. */ Components.Schemas.SpotMarketDataFrequency;
5351
5431
  export type From = string; // date
5352
- export type Market = "day_ahead";
5432
+ export type Market = /* The market for a spot market price. */ Components.Schemas.SpotMarketType;
5353
5433
  export type To = string; // date
5354
5434
  }
5355
5435
  export interface QueryParameters {
5356
5436
  market: Parameters.Market;
5437
+ bidding_zone: Parameters.BiddingZone;
5438
+ frequency: Parameters.Frequency;
5357
5439
  from: Parameters.From /* date */;
5358
5440
  to: Parameters.To /* date */;
5359
- frequency: Parameters.Frequency;
5360
5441
  }
5361
5442
  namespace Responses {
5362
- export interface $200 {
5363
- market?: "day_ahead";
5364
- frequency?: "hourly" | "daily" | "monthly";
5365
- prices?: {
5366
- /**
5367
- * ISO 8601 timestamp of the price record in UTC.
5368
- */
5369
- timestamp: string; // date-time
5370
- /**
5371
- * Cost in cents, e.g. 123 for 12,3 Cents = 0.123€.
5372
- * example:
5373
- * 123
5374
- */
5375
- unit_amount: number;
5376
- /**
5377
- * Cost in decimal format, e.g. 0.123€.
5378
- * example:
5379
- * 0.123
5380
- */
5381
- unit_amount_decimal?: string;
5382
- }[];
5383
- }
5443
+ export type $200 = Components.Schemas.HistoricMarketPricesResult;
5384
5444
  export type $400 = Components.Schemas.Error;
5385
5445
  }
5386
5446
  }
@@ -5715,8 +5775,7 @@ export interface OperationMethods {
5715
5775
  /**
5716
5776
  * $historicMarketPrices - historicMarketPrices
5717
5777
  *
5718
- * BETA: Get historic energy prices in a given time period
5719
- *
5778
+ * Get a series of historic energy prices for a given time period, market and bidding zone.
5720
5779
  */
5721
5780
  '$historicMarketPrices'(
5722
5781
  parameters?: Parameters<Paths.$HistoricMarketPrices.QueryParameters> | null,
@@ -5726,8 +5785,7 @@ export interface OperationMethods {
5726
5785
  /**
5727
5786
  * $averageMarketPrice - averageMarketPrice
5728
5787
  *
5729
- * BETA: Get average energy prices in a given time period
5730
- *
5788
+ * Get the average energy prices for a given time period, market and bidding zone.
5731
5789
  */
5732
5790
  '$averageMarketPrice'(
5733
5791
  parameters?: Parameters<Paths.$AverageMarketPrice.QueryParameters> | null,
@@ -5930,8 +5988,7 @@ export interface PathsDictionary {
5930
5988
  /**
5931
5989
  * $historicMarketPrices - historicMarketPrices
5932
5990
  *
5933
- * BETA: Get historic energy prices in a given time period
5934
- *
5991
+ * Get a series of historic energy prices for a given time period, market and bidding zone.
5935
5992
  */
5936
5993
  'get'(
5937
5994
  parameters?: Parameters<Paths.$HistoricMarketPrices.QueryParameters> | null,
@@ -5943,8 +6000,7 @@ export interface PathsDictionary {
5943
6000
  /**
5944
6001
  * $averageMarketPrice - averageMarketPrice
5945
6002
  *
5946
- * BETA: Get average energy prices in a given time period
5947
- *
6003
+ * Get the average energy prices for a given time period, market and bidding zone.
5948
6004
  */
5949
6005
  'get'(
5950
6006
  parameters?: Parameters<Paths.$AverageMarketPrice.QueryParameters> | null,
@@ -6047,6 +6103,7 @@ export type AvailabilityDate = Components.Schemas.AvailabilityDate;
6047
6103
  export type AvailabilityFilters = Components.Schemas.AvailabilityFilters;
6048
6104
  export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
6049
6105
  export type AvailabilityResult = Components.Schemas.AvailabilityResult;
6106
+ export type AverageMarketPriceResult = Components.Schemas.AverageMarketPriceResult;
6050
6107
  export type BaseCoupon = Components.Schemas.BaseCoupon;
6051
6108
  export type BasePriceItem = Components.Schemas.BasePriceItem;
6052
6109
  export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
@@ -6087,11 +6144,14 @@ export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
6087
6144
  export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
6088
6145
  export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
6089
6146
  export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
6147
+ export type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata;
6090
6148
  export type File = Components.Schemas.File;
6091
6149
  export type GasConcessionType = Components.Schemas.GasConcessionType;
6150
+ export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
6092
6151
  export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
6093
6152
  export type IntegrationId = Components.Schemas.IntegrationId;
6094
6153
  export type JourneyContext = Components.Schemas.JourneyContext;
6154
+ export type MarketPriceRecord = Components.Schemas.MarketPriceRecord;
6095
6155
  export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
6096
6156
  export type MetaData = Components.Schemas.MetaData;
6097
6157
  export type Opportunity = Components.Schemas.Opportunity;
@@ -6137,6 +6197,9 @@ export type SearchProvidersResult = Components.Schemas.SearchProvidersResult;
6137
6197
  export type SearchStreetsParams = Components.Schemas.SearchStreetsParams;
6138
6198
  export type SearchStreetsResult = Components.Schemas.SearchStreetsResult;
6139
6199
  export type SignatureMeta = Components.Schemas.SignatureMeta;
6200
+ export type SpotMarketBiddingZone = Components.Schemas.SpotMarketBiddingZone;
6201
+ export type SpotMarketDataFrequency = Components.Schemas.SpotMarketDataFrequency;
6202
+ export type SpotMarketType = Components.Schemas.SpotMarketType;
6140
6203
  export type Street = Components.Schemas.Street;
6141
6204
  export type TariffTypeGetAg = Components.Schemas.TariffTypeGetAg;
6142
6205
  export type Tax = Components.Schemas.Tax;
package/dist/openapi.json CHANGED
@@ -34,7 +34,7 @@
34
34
  },
35
35
  {
36
36
  "name": "Spot Market API",
37
- "description": "Proviodes endpoints to fetch (historic) spot market data.\n"
37
+ "description": "Provides endpoints to fetch (historic) spot market data.\n"
38
38
  },
39
39
  {
40
40
  "name": "External Integrations API",
@@ -1199,7 +1199,7 @@
1199
1199
  },
1200
1200
  "/v1/public/historicMarketPrices": {
1201
1201
  "get": {
1202
- "description": "BETA: Get historic energy prices in a given time period\n",
1202
+ "description": "Get a series of historic energy prices for a given time period, market and bidding zone.",
1203
1203
  "operationId": "$historicMarketPrices",
1204
1204
  "summary": "historicMarketPrices",
1205
1205
  "tags": [
@@ -1215,47 +1215,48 @@
1215
1215
  "in": "query",
1216
1216
  "name": "market",
1217
1217
  "schema": {
1218
- "type": "string",
1219
- "enum": [
1220
- "day_ahead"
1221
- ]
1218
+ "$ref": "#/components/schemas/SpotMarketType"
1222
1219
  },
1223
1220
  "required": true,
1224
1221
  "description": "Market to use. For now, only day ahead prices are supported."
1225
1222
  },
1226
1223
  {
1227
1224
  "in": "query",
1228
- "name": "from",
1225
+ "name": "bidding_zone",
1229
1226
  "schema": {
1230
- "type": "string",
1231
- "format": "date"
1227
+ "$ref": "#/components/schemas/SpotMarketBiddingZone"
1232
1228
  },
1233
1229
  "required": true,
1234
- "description": "Start date for price data (YYYY-MM-DDD)."
1230
+ "description": "Bidding zone to use. For now, only AT and DE-LU are supported."
1235
1231
  },
1236
1232
  {
1237
1233
  "in": "query",
1238
- "name": "to",
1234
+ "name": "frequency",
1235
+ "schema": {
1236
+ "$ref": "#/components/schemas/SpotMarketDataFrequency"
1237
+ },
1238
+ "required": true,
1239
+ "description": "Frequency of the price data points in ISO 8601 format."
1240
+ },
1241
+ {
1242
+ "in": "query",
1243
+ "name": "from",
1239
1244
  "schema": {
1240
1245
  "type": "string",
1241
1246
  "format": "date"
1242
1247
  },
1243
1248
  "required": true,
1244
- "description": "End date for price data (YYYY-MM-DDD)."
1249
+ "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"
1245
1250
  },
1246
1251
  {
1247
1252
  "in": "query",
1248
- "name": "frequency",
1253
+ "name": "to",
1249
1254
  "schema": {
1250
1255
  "type": "string",
1251
- "enum": [
1252
- "hourly",
1253
- "daily",
1254
- "monthly"
1255
- ]
1256
+ "format": "date"
1256
1257
  },
1257
1258
  "required": true,
1258
- "description": "Frequency of the price data points"
1259
+ "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"
1259
1260
  }
1260
1261
  ],
1261
1262
  "responses": {
@@ -1264,50 +1265,7 @@
1264
1265
  "content": {
1265
1266
  "application/json": {
1266
1267
  "schema": {
1267
- "type": "object",
1268
- "properties": {
1269
- "market": {
1270
- "type": "string",
1271
- "enum": [
1272
- "day_ahead"
1273
- ]
1274
- },
1275
- "frequency": {
1276
- "type": "string",
1277
- "enum": [
1278
- "hourly",
1279
- "daily",
1280
- "monthly"
1281
- ]
1282
- },
1283
- "prices": {
1284
- "type": "array",
1285
- "items": {
1286
- "type": "object",
1287
- "properties": {
1288
- "timestamp": {
1289
- "type": "string",
1290
- "format": "date-time",
1291
- "description": "ISO 8601 timestamp of the price record in UTC."
1292
- },
1293
- "unit_amount": {
1294
- "type": "integer",
1295
- "description": "Cost in cents, e.g. 123 for 12,3 Cents = 0.123€.",
1296
- "example": 123
1297
- },
1298
- "unit_amount_decimal": {
1299
- "type": "string",
1300
- "description": "Cost in decimal format, e.g. 0.123€.",
1301
- "example": "0.123"
1302
- }
1303
- },
1304
- "required": [
1305
- "timestamp",
1306
- "unit_amount"
1307
- ]
1308
- }
1309
- }
1310
- }
1268
+ "$ref": "#/components/schemas/HistoricMarketPricesResult"
1311
1269
  }
1312
1270
  }
1313
1271
  }
@@ -1327,7 +1285,7 @@
1327
1285
  },
1328
1286
  "/v1/public/averageMarketPrice": {
1329
1287
  "get": {
1330
- "description": "BETA: Get average energy prices in a given time period\n",
1288
+ "description": "Get the average energy prices for a given time period, market and bidding zone.",
1331
1289
  "operationId": "$averageMarketPrice",
1332
1290
  "summary": "averageMarketPrice",
1333
1291
  "tags": [
@@ -1343,27 +1301,39 @@
1343
1301
  "in": "query",
1344
1302
  "name": "market",
1345
1303
  "schema": {
1346
- "type": "string",
1347
- "enum": [
1348
- "day_ahead"
1349
- ]
1304
+ "$ref": "#/components/schemas/SpotMarketType"
1350
1305
  },
1351
1306
  "required": true,
1352
1307
  "description": "Market to use. For now, only day ahead prices are supported."
1353
1308
  },
1354
1309
  {
1355
1310
  "in": "query",
1356
- "name": "interval",
1311
+ "name": "bidding_zone",
1312
+ "schema": {
1313
+ "$ref": "#/components/schemas/SpotMarketBiddingZone"
1314
+ },
1315
+ "required": true,
1316
+ "description": "Bidding zone to use. For now, only AT and DE-LU are supported."
1317
+ },
1318
+ {
1319
+ "in": "query",
1320
+ "name": "from",
1357
1321
  "schema": {
1358
1322
  "type": "string",
1359
- "enum": [
1360
- "previous_week",
1361
- "previous_month",
1362
- "previous_year"
1363
- ]
1323
+ "format": "date"
1324
+ },
1325
+ "required": true,
1326
+ "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"
1327
+ },
1328
+ {
1329
+ "in": "query",
1330
+ "name": "to",
1331
+ "schema": {
1332
+ "type": "string",
1333
+ "format": "date"
1364
1334
  },
1365
1335
  "required": true,
1366
- "description": "Interval for the average."
1336
+ "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"
1367
1337
  }
1368
1338
  ],
1369
1339
  "responses": {
@@ -1372,48 +1342,7 @@
1372
1342
  "content": {
1373
1343
  "application/json": {
1374
1344
  "schema": {
1375
- "type": "object",
1376
- "properties": {
1377
- "market": {
1378
- "type": "string",
1379
- "enum": [
1380
- "day_ahead"
1381
- ]
1382
- },
1383
- "interval": {
1384
- "type": "string",
1385
- "enum": [
1386
- "previous_week",
1387
- "previous_month",
1388
- "previous_year"
1389
- ]
1390
- },
1391
- "price": {
1392
- "type": "object",
1393
- "properties": {
1394
- "timestamp": {
1395
- "type": "string",
1396
- "format": "date-time",
1397
- "description": "ISO 8601 timestamp of the price record in UTC."
1398
- },
1399
- "unit_amount": {
1400
- "type": "integer",
1401
- "description": "Cost in Cents, e.g. 123 for 12,3 Cents = 0.123€.",
1402
- "example": 123
1403
- },
1404
- "unit_amount_decimal": {
1405
- "type": "string",
1406
- "description": "Cost in decimal format, e.g. 0.123€.",
1407
- "example": "0.123"
1408
- }
1409
- },
1410
- "required": [
1411
- "timestamp",
1412
- "unit_amount",
1413
- "unit_amount_decimal"
1414
- ]
1415
- }
1416
- }
1345
+ "$ref": "#/components/schemas/AverageMarketPriceResult"
1417
1346
  }
1418
1347
  }
1419
1348
  }
@@ -2061,6 +1990,13 @@
2061
1990
  "type": "string",
2062
1991
  "description": "The product main name"
2063
1992
  },
1993
+ "categories": {
1994
+ "type": "array",
1995
+ "items": {
1996
+ "type": "string"
1997
+ },
1998
+ "description": "The product categories"
1999
+ },
2064
2000
  "feature": {
2065
2001
  "type": "array",
2066
2002
  "items": {
@@ -3030,6 +2966,20 @@
3030
2966
  }
3031
2967
  }
3032
2968
  },
2969
+ "ExternalPriceMetadata": {
2970
+ "allOf": [
2971
+ {
2972
+ "$ref": "#/components/schemas/AverageMarketPriceResult"
2973
+ }
2974
+ ],
2975
+ "type": "object",
2976
+ "properties": {
2977
+ "inputs": {
2978
+ "type": "object",
2979
+ "additionalProperties": true
2980
+ }
2981
+ }
2982
+ },
3033
2983
  "ExternalFeeMappings": {
3034
2984
  "type": "array",
3035
2985
  "items": {
@@ -3611,6 +3561,105 @@
3611
3561
  "breakdown"
3612
3562
  ]
3613
3563
  },
3564
+ "SpotMarketBiddingZone": {
3565
+ "description": "The bidding zone for a spot market price.",
3566
+ "type": "string",
3567
+ "enum": [
3568
+ "AT",
3569
+ "DE-LU"
3570
+ ]
3571
+ },
3572
+ "SpotMarketType": {
3573
+ "description": "The market for a spot market price.",
3574
+ "type": "string",
3575
+ "enum": [
3576
+ "day_ahead"
3577
+ ]
3578
+ },
3579
+ "SpotMarketDataFrequency": {
3580
+ "description": "The aggregation frequency for a series of spot market price data.",
3581
+ "type": "string",
3582
+ "enum": [
3583
+ "PT15M",
3584
+ "PT1H",
3585
+ "P1D",
3586
+ "P1M"
3587
+ ]
3588
+ },
3589
+ "HistoricMarketPricesResult": {
3590
+ "type": "object",
3591
+ "properties": {
3592
+ "market": {
3593
+ "$ref": "#/components/schemas/SpotMarketType"
3594
+ },
3595
+ "bidding_zone": {
3596
+ "$ref": "#/components/schemas/SpotMarketBiddingZone"
3597
+ },
3598
+ "prices": {
3599
+ "type": "array",
3600
+ "items": {
3601
+ "$ref": "#/components/schemas/MarketPriceRecord"
3602
+ }
3603
+ }
3604
+ },
3605
+ "required": [
3606
+ "market",
3607
+ "bidding_zone",
3608
+ "prices"
3609
+ ]
3610
+ },
3611
+ "AverageMarketPriceResult": {
3612
+ "type": "object",
3613
+ "properties": {
3614
+ "market": {
3615
+ "$ref": "#/components/schemas/SpotMarketType"
3616
+ },
3617
+ "bidding_zone": {
3618
+ "$ref": "#/components/schemas/SpotMarketBiddingZone"
3619
+ },
3620
+ "price": {
3621
+ "$ref": "#/components/schemas/MarketPriceRecord"
3622
+ },
3623
+ "_meta": {
3624
+ "$ref": "#/components/schemas/SignatureMeta"
3625
+ }
3626
+ },
3627
+ "required": [
3628
+ "market",
3629
+ "bidding_zone",
3630
+ "price"
3631
+ ]
3632
+ },
3633
+ "MarketPriceRecord": {
3634
+ "description": "A market price at a given point in time.",
3635
+ "type": "object",
3636
+ "properties": {
3637
+ "timestamp": {
3638
+ "type": "string",
3639
+ "format": "date-time",
3640
+ "description": "ISO 8601 timestamp of the price record in UTC."
3641
+ },
3642
+ "unit_amount": {
3643
+ "type": "integer",
3644
+ "description": "Cost in Cents, e.g. 123 for 12,3 Cents = 0.123€.",
3645
+ "example": 12.3
3646
+ },
3647
+ "unit_amount_decimal": {
3648
+ "type": "string",
3649
+ "description": "Cost in decimal format, e.g. 0.123€.",
3650
+ "example": "0.123"
3651
+ },
3652
+ "unit_amount_currency": {
3653
+ "$ref": "#/components/schemas/Currency"
3654
+ }
3655
+ },
3656
+ "required": [
3657
+ "timestamp",
3658
+ "unit_amount",
3659
+ "unit_amount_decimal",
3660
+ "unit_amount_currency"
3661
+ ]
3662
+ },
3614
3663
  "BasicAuthCredentials": {
3615
3664
  "description": "The basic auth credentials",
3616
3665
  "type": "object",
@@ -3920,6 +3969,10 @@
3920
3969
  "description": "External fees metadata information required to compute totals, for some pricing models",
3921
3970
  "$ref": "#/components/schemas/ExternalFeeMetadata"
3922
3971
  },
3972
+ "external_price_metadata": {
3973
+ "description": "External price metadata information required to compute totals, for some pricing models",
3974
+ "$ref": "#/components/schemas/ExternalPriceMetadata"
3975
+ },
3923
3976
  "_immutable_pricing_details": {
3924
3977
  "description": "Immutable pricing details for external products/prices",
3925
3978
  "$ref": "#/components/schemas/PricingDetails"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.46.0",
3
+ "version": "3.46.1",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",