@epilot/pricing-client 3.47.0 → 3.47.2
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 +231 -105
- package/dist/openapi.json +147 -70
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -216,10 +216,41 @@ declare namespace Components {
|
|
|
216
216
|
};
|
|
217
217
|
}[];
|
|
218
218
|
}
|
|
219
|
+
/**
|
|
220
|
+
* An average market price over a given period in time.
|
|
221
|
+
*/
|
|
222
|
+
export interface AverageMarketPriceRecord {
|
|
223
|
+
/**
|
|
224
|
+
* Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
|
|
225
|
+
* example:
|
|
226
|
+
* 12.3
|
|
227
|
+
*/
|
|
228
|
+
unit_amount: number;
|
|
229
|
+
/**
|
|
230
|
+
* Cost in decimal format, e.g. 0.123€.
|
|
231
|
+
* example:
|
|
232
|
+
* 0.123
|
|
233
|
+
*/
|
|
234
|
+
unit_amount_decimal: string;
|
|
235
|
+
unit_amount_currency: /**
|
|
236
|
+
* Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
|
237
|
+
* ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
|
|
238
|
+
*
|
|
239
|
+
* example:
|
|
240
|
+
* EUR
|
|
241
|
+
*/
|
|
242
|
+
Currency;
|
|
243
|
+
/**
|
|
244
|
+
* An ISO 8601 interval in the format 'start/end'.
|
|
245
|
+
* example:
|
|
246
|
+
* 2025-01-01T00:00:00Z/2025-01-31T23:59:59Z
|
|
247
|
+
*/
|
|
248
|
+
timestamp: string;
|
|
249
|
+
}
|
|
219
250
|
export interface AverageMarketPriceResult {
|
|
220
251
|
market: /* The market for a spot market price. */ SpotMarketType;
|
|
221
252
|
bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
|
|
222
|
-
price: /*
|
|
253
|
+
price: /* An average market price over a given period in time. */ AverageMarketPriceRecord;
|
|
223
254
|
_meta?: /* Signature meta data payload */ SignatureMeta;
|
|
224
255
|
}
|
|
225
256
|
/**
|
|
@@ -326,6 +357,28 @@ declare namespace Components {
|
|
|
326
357
|
*/
|
|
327
358
|
Price[];
|
|
328
359
|
}
|
|
360
|
+
export interface BaseMarketPriceRecord {
|
|
361
|
+
/**
|
|
362
|
+
* Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
|
|
363
|
+
* example:
|
|
364
|
+
* 12.3
|
|
365
|
+
*/
|
|
366
|
+
unit_amount: number;
|
|
367
|
+
/**
|
|
368
|
+
* Cost in decimal format, e.g. 0.123€.
|
|
369
|
+
* example:
|
|
370
|
+
* 0.123
|
|
371
|
+
*/
|
|
372
|
+
unit_amount_decimal: string;
|
|
373
|
+
unit_amount_currency: /**
|
|
374
|
+
* Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
|
375
|
+
* ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
|
|
376
|
+
*
|
|
377
|
+
* example:
|
|
378
|
+
* EUR
|
|
379
|
+
*/
|
|
380
|
+
Currency;
|
|
381
|
+
}
|
|
329
382
|
/**
|
|
330
383
|
* Represents a price item
|
|
331
384
|
* example:
|
|
@@ -1365,6 +1418,38 @@ declare namespace Components {
|
|
|
1365
1418
|
*/
|
|
1366
1419
|
export interface CompositePrice {
|
|
1367
1420
|
[name: string]: any;
|
|
1421
|
+
/**
|
|
1422
|
+
* The billing period duration
|
|
1423
|
+
*/
|
|
1424
|
+
billing_duration_amount?: number;
|
|
1425
|
+
/**
|
|
1426
|
+
* The billing period duration unit
|
|
1427
|
+
*/
|
|
1428
|
+
billing_duration_unit?: "weeks" | "months" | "years";
|
|
1429
|
+
/**
|
|
1430
|
+
* The notice period duration
|
|
1431
|
+
*/
|
|
1432
|
+
notice_time_amount?: number;
|
|
1433
|
+
/**
|
|
1434
|
+
* The notice period duration unit
|
|
1435
|
+
*/
|
|
1436
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
1437
|
+
/**
|
|
1438
|
+
* The termination period duration
|
|
1439
|
+
*/
|
|
1440
|
+
termination_time_amount?: number;
|
|
1441
|
+
/**
|
|
1442
|
+
* The termination period duration unit
|
|
1443
|
+
*/
|
|
1444
|
+
termination_time_unit?: "weeks" | "months" | "years";
|
|
1445
|
+
/**
|
|
1446
|
+
* The renewal period duration
|
|
1447
|
+
*/
|
|
1448
|
+
renewal_duration_amount?: number;
|
|
1449
|
+
/**
|
|
1450
|
+
* The renewal period duration unit
|
|
1451
|
+
*/
|
|
1452
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
1368
1453
|
/**
|
|
1369
1454
|
* Whether the price can be used for new purchases.
|
|
1370
1455
|
*/
|
|
@@ -2683,7 +2768,7 @@ declare namespace Components {
|
|
|
2683
2768
|
export interface ExternalPriceMetadata {
|
|
2684
2769
|
market: /* The market for a spot market price. */ SpotMarketType;
|
|
2685
2770
|
bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
|
|
2686
|
-
price: /*
|
|
2771
|
+
price: /* An average market price over a given period in time. */ AverageMarketPriceRecord;
|
|
2687
2772
|
_meta?: /* Signature meta data payload */ SignatureMeta;
|
|
2688
2773
|
inputs?: {
|
|
2689
2774
|
[name: string]: any;
|
|
@@ -2712,10 +2797,39 @@ declare namespace Components {
|
|
|
2712
2797
|
* The concession type for gas
|
|
2713
2798
|
*/
|
|
2714
2799
|
export type GasConcessionType = "standard" | "special";
|
|
2800
|
+
/**
|
|
2801
|
+
* A market price at a given point in time.
|
|
2802
|
+
*/
|
|
2803
|
+
export interface HistoricMarketPriceRecord {
|
|
2804
|
+
/**
|
|
2805
|
+
* Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
|
|
2806
|
+
* example:
|
|
2807
|
+
* 12.3
|
|
2808
|
+
*/
|
|
2809
|
+
unit_amount: number;
|
|
2810
|
+
/**
|
|
2811
|
+
* Cost in decimal format, e.g. 0.123€.
|
|
2812
|
+
* example:
|
|
2813
|
+
* 0.123
|
|
2814
|
+
*/
|
|
2815
|
+
unit_amount_decimal: string;
|
|
2816
|
+
unit_amount_currency: /**
|
|
2817
|
+
* Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
|
2818
|
+
* ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
|
|
2819
|
+
*
|
|
2820
|
+
* example:
|
|
2821
|
+
* EUR
|
|
2822
|
+
*/
|
|
2823
|
+
Currency;
|
|
2824
|
+
/**
|
|
2825
|
+
* ISO 8601 timestamp of the price record in UTC.
|
|
2826
|
+
*/
|
|
2827
|
+
timestamp: string; // date-time
|
|
2828
|
+
}
|
|
2715
2829
|
export interface HistoricMarketPricesResult {
|
|
2716
2830
|
market: /* The market for a spot market price. */ SpotMarketType;
|
|
2717
2831
|
bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
|
|
2718
|
-
prices: /* A market price at a given point in time. */
|
|
2832
|
+
prices: /* A market price at a given point in time. */ HistoricMarketPriceRecord[];
|
|
2719
2833
|
}
|
|
2720
2834
|
export type IntegrationCredentialsResult = /* The basic auth credentials */ BasicAuthCredentials;
|
|
2721
2835
|
export type IntegrationId = "getag" | "ikom";
|
|
@@ -2784,35 +2898,6 @@ declare namespace Components {
|
|
|
2784
2898
|
};
|
|
2785
2899
|
}[];
|
|
2786
2900
|
}
|
|
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
|
-
}
|
|
2816
2901
|
/**
|
|
2817
2902
|
* Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
|
|
2818
2903
|
* - `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 {
|
|
|
3276
3361
|
*/
|
|
3277
3362
|
export interface Price {
|
|
3278
3363
|
[name: string]: any;
|
|
3364
|
+
/**
|
|
3365
|
+
* The billing period duration
|
|
3366
|
+
*/
|
|
3367
|
+
billing_duration_amount?: number;
|
|
3368
|
+
/**
|
|
3369
|
+
* The billing period duration unit
|
|
3370
|
+
*/
|
|
3371
|
+
billing_duration_unit?: "weeks" | "months" | "years";
|
|
3372
|
+
/**
|
|
3373
|
+
* The notice period duration
|
|
3374
|
+
*/
|
|
3375
|
+
notice_time_amount?: number;
|
|
3376
|
+
/**
|
|
3377
|
+
* The notice period duration unit
|
|
3378
|
+
*/
|
|
3379
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
3380
|
+
/**
|
|
3381
|
+
* The termination period duration
|
|
3382
|
+
*/
|
|
3383
|
+
termination_time_amount?: number;
|
|
3384
|
+
/**
|
|
3385
|
+
* The termination period duration unit
|
|
3386
|
+
*/
|
|
3387
|
+
termination_time_unit?: "weeks" | "months" | "years";
|
|
3388
|
+
/**
|
|
3389
|
+
* The renewal period duration
|
|
3390
|
+
*/
|
|
3391
|
+
renewal_duration_amount?: number;
|
|
3392
|
+
/**
|
|
3393
|
+
* The renewal period duration unit
|
|
3394
|
+
*/
|
|
3395
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
3279
3396
|
/**
|
|
3280
3397
|
* Whether the price can be used for new purchases.
|
|
3281
3398
|
*/
|
|
@@ -3380,38 +3497,6 @@ declare namespace Components {
|
|
|
3380
3497
|
* Defines the way the price amount is display in epilot journeys.
|
|
3381
3498
|
*/
|
|
3382
3499
|
price_display_in_journeys?: "show_price" | "show_as_starting_price" | "show_as_on_request" | "estimated_price";
|
|
3383
|
-
/**
|
|
3384
|
-
* The billing period duration
|
|
3385
|
-
*/
|
|
3386
|
-
billing_duration_amount?: number;
|
|
3387
|
-
/**
|
|
3388
|
-
* The billing period duration unit
|
|
3389
|
-
*/
|
|
3390
|
-
billing_duration_unit?: "weeks" | "months" | "years";
|
|
3391
|
-
/**
|
|
3392
|
-
* The notice period duration
|
|
3393
|
-
*/
|
|
3394
|
-
notice_time_amount?: number;
|
|
3395
|
-
/**
|
|
3396
|
-
* The notice period duration unit
|
|
3397
|
-
*/
|
|
3398
|
-
notice_time_unit?: "weeks" | "months" | "years";
|
|
3399
|
-
/**
|
|
3400
|
-
* The termination period duration
|
|
3401
|
-
*/
|
|
3402
|
-
termination_time_amount?: number;
|
|
3403
|
-
/**
|
|
3404
|
-
* The termination period duration unit
|
|
3405
|
-
*/
|
|
3406
|
-
termination_time_unit?: "weeks" | "months" | "years";
|
|
3407
|
-
/**
|
|
3408
|
-
* The renewal period duration
|
|
3409
|
-
*/
|
|
3410
|
-
renewal_duration_amount?: number;
|
|
3411
|
-
/**
|
|
3412
|
-
* The renewal period duration unit
|
|
3413
|
-
*/
|
|
3414
|
-
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
3415
3500
|
/**
|
|
3416
3501
|
* The flag for prices that can be influenced by external variables such as user input.
|
|
3417
3502
|
*/
|
|
@@ -3463,6 +3548,40 @@ declare namespace Components {
|
|
|
3463
3548
|
*/
|
|
3464
3549
|
_tags?: string[];
|
|
3465
3550
|
}
|
|
3551
|
+
export interface PriceConditions {
|
|
3552
|
+
/**
|
|
3553
|
+
* The billing period duration
|
|
3554
|
+
*/
|
|
3555
|
+
billing_duration_amount?: number;
|
|
3556
|
+
/**
|
|
3557
|
+
* The billing period duration unit
|
|
3558
|
+
*/
|
|
3559
|
+
billing_duration_unit?: "weeks" | "months" | "years";
|
|
3560
|
+
/**
|
|
3561
|
+
* The notice period duration
|
|
3562
|
+
*/
|
|
3563
|
+
notice_time_amount?: number;
|
|
3564
|
+
/**
|
|
3565
|
+
* The notice period duration unit
|
|
3566
|
+
*/
|
|
3567
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
3568
|
+
/**
|
|
3569
|
+
* The termination period duration
|
|
3570
|
+
*/
|
|
3571
|
+
termination_time_amount?: number;
|
|
3572
|
+
/**
|
|
3573
|
+
* The termination period duration unit
|
|
3574
|
+
*/
|
|
3575
|
+
termination_time_unit?: "weeks" | "months" | "years";
|
|
3576
|
+
/**
|
|
3577
|
+
* The renewal period duration
|
|
3578
|
+
*/
|
|
3579
|
+
renewal_duration_amount?: number;
|
|
3580
|
+
/**
|
|
3581
|
+
* The renewal period duration unit
|
|
3582
|
+
*/
|
|
3583
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
3584
|
+
}
|
|
3466
3585
|
export interface PriceDynamicTariff {
|
|
3467
3586
|
mode: /* The mode of the dynamic tariff. `day_ahead_market` uses the Day-Ahead spot market price as base. */ DynamicTariffMode;
|
|
3468
3587
|
interval?: /* The interval of the tariff if a spot market price is used as base. */ DynamicTariffInterval;
|
|
@@ -4239,6 +4358,38 @@ declare namespace Components {
|
|
|
4239
4358
|
*/
|
|
4240
4359
|
_price?: {
|
|
4241
4360
|
[name: string]: any;
|
|
4361
|
+
/**
|
|
4362
|
+
* The billing period duration
|
|
4363
|
+
*/
|
|
4364
|
+
billing_duration_amount?: number;
|
|
4365
|
+
/**
|
|
4366
|
+
* The billing period duration unit
|
|
4367
|
+
*/
|
|
4368
|
+
billing_duration_unit?: "weeks" | "months" | "years";
|
|
4369
|
+
/**
|
|
4370
|
+
* The notice period duration
|
|
4371
|
+
*/
|
|
4372
|
+
notice_time_amount?: number;
|
|
4373
|
+
/**
|
|
4374
|
+
* The notice period duration unit
|
|
4375
|
+
*/
|
|
4376
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
4377
|
+
/**
|
|
4378
|
+
* The termination period duration
|
|
4379
|
+
*/
|
|
4380
|
+
termination_time_amount?: number;
|
|
4381
|
+
/**
|
|
4382
|
+
* The termination period duration unit
|
|
4383
|
+
*/
|
|
4384
|
+
termination_time_unit?: "weeks" | "months" | "years";
|
|
4385
|
+
/**
|
|
4386
|
+
* The renewal period duration
|
|
4387
|
+
*/
|
|
4388
|
+
renewal_duration_amount?: number;
|
|
4389
|
+
/**
|
|
4390
|
+
* The renewal period duration unit
|
|
4391
|
+
*/
|
|
4392
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
4242
4393
|
/**
|
|
4243
4394
|
* Whether the price can be used for new purchases.
|
|
4244
4395
|
*/
|
|
@@ -4343,38 +4494,6 @@ declare namespace Components {
|
|
|
4343
4494
|
* Defines the way the price amount is display in epilot journeys.
|
|
4344
4495
|
*/
|
|
4345
4496
|
price_display_in_journeys?: "show_price" | "show_as_starting_price" | "show_as_on_request" | "estimated_price";
|
|
4346
|
-
/**
|
|
4347
|
-
* The billing period duration
|
|
4348
|
-
*/
|
|
4349
|
-
billing_duration_amount?: number;
|
|
4350
|
-
/**
|
|
4351
|
-
* The billing period duration unit
|
|
4352
|
-
*/
|
|
4353
|
-
billing_duration_unit?: "weeks" | "months" | "years";
|
|
4354
|
-
/**
|
|
4355
|
-
* The notice period duration
|
|
4356
|
-
*/
|
|
4357
|
-
notice_time_amount?: number;
|
|
4358
|
-
/**
|
|
4359
|
-
* The notice period duration unit
|
|
4360
|
-
*/
|
|
4361
|
-
notice_time_unit?: "weeks" | "months" | "years";
|
|
4362
|
-
/**
|
|
4363
|
-
* The termination period duration
|
|
4364
|
-
*/
|
|
4365
|
-
termination_time_amount?: number;
|
|
4366
|
-
/**
|
|
4367
|
-
* The termination period duration unit
|
|
4368
|
-
*/
|
|
4369
|
-
termination_time_unit?: "weeks" | "months" | "years";
|
|
4370
|
-
/**
|
|
4371
|
-
* The renewal period duration
|
|
4372
|
-
*/
|
|
4373
|
-
renewal_duration_amount?: number;
|
|
4374
|
-
/**
|
|
4375
|
-
* The renewal period duration unit
|
|
4376
|
-
*/
|
|
4377
|
-
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
4378
4497
|
/**
|
|
4379
4498
|
* The flag for prices that can be influenced by external variables such as user input.
|
|
4380
4499
|
*/
|
|
@@ -4822,6 +4941,10 @@ declare namespace Components {
|
|
|
4822
4941
|
* Total of all items taxes, with same recurrence.
|
|
4823
4942
|
*/
|
|
4824
4943
|
amount_tax?: number;
|
|
4944
|
+
/**
|
|
4945
|
+
* Total of all items taxes, with same recurrence, as a string with all the decimal places.
|
|
4946
|
+
*/
|
|
4947
|
+
amount_tax_decimal?: number;
|
|
4825
4948
|
currency?: /**
|
|
4826
4949
|
* Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
|
4827
4950
|
* ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
|
|
@@ -5342,15 +5465,15 @@ declare namespace Paths {
|
|
|
5342
5465
|
namespace $AverageMarketPrice {
|
|
5343
5466
|
namespace Parameters {
|
|
5344
5467
|
export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
|
|
5345
|
-
export type From = string
|
|
5468
|
+
export type From = string /* date */ | string /* date-time */;
|
|
5346
5469
|
export type Market = /* The market for a spot market price. */ Components.Schemas.SpotMarketType;
|
|
5347
|
-
export type To = string
|
|
5470
|
+
export type To = string /* date */ | string /* date-time */;
|
|
5348
5471
|
}
|
|
5349
5472
|
export interface QueryParameters {
|
|
5350
5473
|
market: Parameters.Market;
|
|
5351
5474
|
bidding_zone: Parameters.BiddingZone;
|
|
5352
|
-
from: Parameters.From
|
|
5353
|
-
to: Parameters.To
|
|
5475
|
+
from: Parameters.From;
|
|
5476
|
+
to: Parameters.To;
|
|
5354
5477
|
}
|
|
5355
5478
|
namespace Responses {
|
|
5356
5479
|
export type $200 = Components.Schemas.AverageMarketPriceResult;
|
|
@@ -5428,16 +5551,16 @@ declare namespace Paths {
|
|
|
5428
5551
|
namespace Parameters {
|
|
5429
5552
|
export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
|
|
5430
5553
|
export type Frequency = /* The aggregation frequency for a series of spot market price data. */ Components.Schemas.SpotMarketDataFrequency;
|
|
5431
|
-
export type From = string
|
|
5554
|
+
export type From = string /* date */ | string /* date-time */;
|
|
5432
5555
|
export type Market = /* The market for a spot market price. */ Components.Schemas.SpotMarketType;
|
|
5433
|
-
export type To = string
|
|
5556
|
+
export type To = string /* date */ | string /* date-time */;
|
|
5434
5557
|
}
|
|
5435
5558
|
export interface QueryParameters {
|
|
5436
5559
|
market: Parameters.Market;
|
|
5437
5560
|
bidding_zone: Parameters.BiddingZone;
|
|
5438
5561
|
frequency: Parameters.Frequency;
|
|
5439
|
-
from: Parameters.From
|
|
5440
|
-
to: Parameters.To
|
|
5562
|
+
from: Parameters.From;
|
|
5563
|
+
to: Parameters.To;
|
|
5441
5564
|
}
|
|
5442
5565
|
namespace Responses {
|
|
5443
5566
|
export type $200 = Components.Schemas.HistoricMarketPricesResult;
|
|
@@ -6103,8 +6226,10 @@ export type AvailabilityDate = Components.Schemas.AvailabilityDate;
|
|
|
6103
6226
|
export type AvailabilityFilters = Components.Schemas.AvailabilityFilters;
|
|
6104
6227
|
export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
|
|
6105
6228
|
export type AvailabilityResult = Components.Schemas.AvailabilityResult;
|
|
6229
|
+
export type AverageMarketPriceRecord = Components.Schemas.AverageMarketPriceRecord;
|
|
6106
6230
|
export type AverageMarketPriceResult = Components.Schemas.AverageMarketPriceResult;
|
|
6107
6231
|
export type BaseCoupon = Components.Schemas.BaseCoupon;
|
|
6232
|
+
export type BaseMarketPriceRecord = Components.Schemas.BaseMarketPriceRecord;
|
|
6108
6233
|
export type BasePriceItem = Components.Schemas.BasePriceItem;
|
|
6109
6234
|
export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
|
|
6110
6235
|
export type BasePriceItemDto = Components.Schemas.BasePriceItemDto;
|
|
@@ -6147,11 +6272,11 @@ export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
|
|
|
6147
6272
|
export type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata;
|
|
6148
6273
|
export type File = Components.Schemas.File;
|
|
6149
6274
|
export type GasConcessionType = Components.Schemas.GasConcessionType;
|
|
6275
|
+
export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
|
|
6150
6276
|
export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
|
|
6151
6277
|
export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
|
|
6152
6278
|
export type IntegrationId = Components.Schemas.IntegrationId;
|
|
6153
6279
|
export type JourneyContext = Components.Schemas.JourneyContext;
|
|
6154
|
-
export type MarketPriceRecord = Components.Schemas.MarketPriceRecord;
|
|
6155
6280
|
export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
|
|
6156
6281
|
export type MetaData = Components.Schemas.MetaData;
|
|
6157
6282
|
export type Opportunity = Components.Schemas.Opportunity;
|
|
@@ -6165,6 +6290,7 @@ export type PaymentMethod = Components.Schemas.PaymentMethod;
|
|
|
6165
6290
|
export type PowerMeterType = Components.Schemas.PowerMeterType;
|
|
6166
6291
|
export type Price = Components.Schemas.Price;
|
|
6167
6292
|
export type PriceComponentRelation = Components.Schemas.PriceComponentRelation;
|
|
6293
|
+
export type PriceConditions = Components.Schemas.PriceConditions;
|
|
6168
6294
|
export type PriceDynamicTariff = Components.Schemas.PriceDynamicTariff;
|
|
6169
6295
|
export type PriceGetAg = Components.Schemas.PriceGetAg;
|
|
6170
6296
|
export type PriceInputMapping = Components.Schemas.PriceInputMapping;
|
package/dist/openapi.json
CHANGED
|
@@ -1243,20 +1243,34 @@
|
|
|
1243
1243
|
"name": "from",
|
|
1244
1244
|
"schema": {
|
|
1245
1245
|
"type": "string",
|
|
1246
|
-
"
|
|
1246
|
+
"anyOf": [
|
|
1247
|
+
{
|
|
1248
|
+
"format": "date"
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"format": "date-time"
|
|
1252
|
+
}
|
|
1253
|
+
]
|
|
1247
1254
|
},
|
|
1248
1255
|
"required": true,
|
|
1249
|
-
"description": "Start of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-
|
|
1256
|
+
"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"
|
|
1250
1257
|
},
|
|
1251
1258
|
{
|
|
1252
1259
|
"in": "query",
|
|
1253
1260
|
"name": "to",
|
|
1254
1261
|
"schema": {
|
|
1255
1262
|
"type": "string",
|
|
1256
|
-
"
|
|
1263
|
+
"anyOf": [
|
|
1264
|
+
{
|
|
1265
|
+
"format": "date"
|
|
1266
|
+
},
|
|
1267
|
+
{
|
|
1268
|
+
"format": "date-time"
|
|
1269
|
+
}
|
|
1270
|
+
]
|
|
1257
1271
|
},
|
|
1258
1272
|
"required": true,
|
|
1259
|
-
"description": "End of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-
|
|
1273
|
+
"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"
|
|
1260
1274
|
}
|
|
1261
1275
|
],
|
|
1262
1276
|
"responses": {
|
|
@@ -1320,20 +1334,34 @@
|
|
|
1320
1334
|
"name": "from",
|
|
1321
1335
|
"schema": {
|
|
1322
1336
|
"type": "string",
|
|
1323
|
-
"
|
|
1337
|
+
"anyOf": [
|
|
1338
|
+
{
|
|
1339
|
+
"format": "date"
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"format": "date-time"
|
|
1343
|
+
}
|
|
1344
|
+
]
|
|
1324
1345
|
},
|
|
1325
1346
|
"required": true,
|
|
1326
|
-
"description": "Start of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-
|
|
1347
|
+
"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"
|
|
1327
1348
|
},
|
|
1328
1349
|
{
|
|
1329
1350
|
"in": "query",
|
|
1330
1351
|
"name": "to",
|
|
1331
1352
|
"schema": {
|
|
1332
1353
|
"type": "string",
|
|
1333
|
-
"
|
|
1354
|
+
"anyOf": [
|
|
1355
|
+
{
|
|
1356
|
+
"format": "date"
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"format": "date-time"
|
|
1360
|
+
}
|
|
1361
|
+
]
|
|
1334
1362
|
},
|
|
1335
1363
|
"required": true,
|
|
1336
|
-
"description": "End of price data in ISO 8601 format.\nIf only a date is provided (YYYY-MM-
|
|
1364
|
+
"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"
|
|
1337
1365
|
}
|
|
1338
1366
|
],
|
|
1339
1367
|
"responses": {
|
|
@@ -2529,6 +2557,11 @@
|
|
|
2529
2557
|
}
|
|
2530
2558
|
},
|
|
2531
2559
|
"Price": {
|
|
2560
|
+
"allOf": [
|
|
2561
|
+
{
|
|
2562
|
+
"$ref": "#/components/schemas/PriceConditions"
|
|
2563
|
+
}
|
|
2564
|
+
],
|
|
2532
2565
|
"type": "object",
|
|
2533
2566
|
"description": "The price entity schema for simple pricing",
|
|
2534
2567
|
"example": {
|
|
@@ -2649,58 +2682,6 @@
|
|
|
2649
2682
|
"estimated_price"
|
|
2650
2683
|
]
|
|
2651
2684
|
},
|
|
2652
|
-
"billing_duration_amount": {
|
|
2653
|
-
"description": "The billing period duration",
|
|
2654
|
-
"type": "number"
|
|
2655
|
-
},
|
|
2656
|
-
"billing_duration_unit": {
|
|
2657
|
-
"description": "The billing period duration unit",
|
|
2658
|
-
"type": "string",
|
|
2659
|
-
"enum": [
|
|
2660
|
-
"weeks",
|
|
2661
|
-
"months",
|
|
2662
|
-
"years"
|
|
2663
|
-
]
|
|
2664
|
-
},
|
|
2665
|
-
"notice_time_amount": {
|
|
2666
|
-
"description": "The notice period duration",
|
|
2667
|
-
"type": "number"
|
|
2668
|
-
},
|
|
2669
|
-
"notice_time_unit": {
|
|
2670
|
-
"description": "The notice period duration unit",
|
|
2671
|
-
"type": "string",
|
|
2672
|
-
"enum": [
|
|
2673
|
-
"weeks",
|
|
2674
|
-
"months",
|
|
2675
|
-
"years"
|
|
2676
|
-
]
|
|
2677
|
-
},
|
|
2678
|
-
"termination_time_amount": {
|
|
2679
|
-
"description": "The termination period duration",
|
|
2680
|
-
"type": "number"
|
|
2681
|
-
},
|
|
2682
|
-
"termination_time_unit": {
|
|
2683
|
-
"description": "The termination period duration unit",
|
|
2684
|
-
"type": "string",
|
|
2685
|
-
"enum": [
|
|
2686
|
-
"weeks",
|
|
2687
|
-
"months",
|
|
2688
|
-
"years"
|
|
2689
|
-
]
|
|
2690
|
-
},
|
|
2691
|
-
"renewal_duration_amount": {
|
|
2692
|
-
"description": "The renewal period duration",
|
|
2693
|
-
"type": "number"
|
|
2694
|
-
},
|
|
2695
|
-
"renewal_duration_unit": {
|
|
2696
|
-
"description": "The renewal period duration unit",
|
|
2697
|
-
"type": "string",
|
|
2698
|
-
"enum": [
|
|
2699
|
-
"weeks",
|
|
2700
|
-
"months",
|
|
2701
|
-
"years"
|
|
2702
|
-
]
|
|
2703
|
-
},
|
|
2704
2685
|
"variable_price": {
|
|
2705
2686
|
"description": "The flag for prices that can be influenced by external variables such as user input.",
|
|
2706
2687
|
"type": "boolean"
|
|
@@ -2772,6 +2753,11 @@
|
|
|
2772
2753
|
]
|
|
2773
2754
|
},
|
|
2774
2755
|
"CompositePrice": {
|
|
2756
|
+
"allOf": [
|
|
2757
|
+
{
|
|
2758
|
+
"$ref": "#/components/schemas/PriceConditions"
|
|
2759
|
+
}
|
|
2760
|
+
],
|
|
2775
2761
|
"type": "object",
|
|
2776
2762
|
"description": "The price entity schema for dynamic pricing",
|
|
2777
2763
|
"example": {
|
|
@@ -2952,6 +2938,63 @@
|
|
|
2952
2938
|
}
|
|
2953
2939
|
}
|
|
2954
2940
|
},
|
|
2941
|
+
"PriceConditions": {
|
|
2942
|
+
"type": "object",
|
|
2943
|
+
"properties": {
|
|
2944
|
+
"billing_duration_amount": {
|
|
2945
|
+
"description": "The billing period duration",
|
|
2946
|
+
"type": "number"
|
|
2947
|
+
},
|
|
2948
|
+
"billing_duration_unit": {
|
|
2949
|
+
"description": "The billing period duration unit",
|
|
2950
|
+
"type": "string",
|
|
2951
|
+
"enum": [
|
|
2952
|
+
"weeks",
|
|
2953
|
+
"months",
|
|
2954
|
+
"years"
|
|
2955
|
+
]
|
|
2956
|
+
},
|
|
2957
|
+
"notice_time_amount": {
|
|
2958
|
+
"description": "The notice period duration",
|
|
2959
|
+
"type": "number"
|
|
2960
|
+
},
|
|
2961
|
+
"notice_time_unit": {
|
|
2962
|
+
"description": "The notice period duration unit",
|
|
2963
|
+
"type": "string",
|
|
2964
|
+
"enum": [
|
|
2965
|
+
"weeks",
|
|
2966
|
+
"months",
|
|
2967
|
+
"years"
|
|
2968
|
+
]
|
|
2969
|
+
},
|
|
2970
|
+
"termination_time_amount": {
|
|
2971
|
+
"description": "The termination period duration",
|
|
2972
|
+
"type": "number"
|
|
2973
|
+
},
|
|
2974
|
+
"termination_time_unit": {
|
|
2975
|
+
"description": "The termination period duration unit",
|
|
2976
|
+
"type": "string",
|
|
2977
|
+
"enum": [
|
|
2978
|
+
"weeks",
|
|
2979
|
+
"months",
|
|
2980
|
+
"years"
|
|
2981
|
+
]
|
|
2982
|
+
},
|
|
2983
|
+
"renewal_duration_amount": {
|
|
2984
|
+
"description": "The renewal period duration",
|
|
2985
|
+
"type": "number"
|
|
2986
|
+
},
|
|
2987
|
+
"renewal_duration_unit": {
|
|
2988
|
+
"description": "The renewal period duration unit",
|
|
2989
|
+
"type": "string",
|
|
2990
|
+
"enum": [
|
|
2991
|
+
"weeks",
|
|
2992
|
+
"months",
|
|
2993
|
+
"years"
|
|
2994
|
+
]
|
|
2995
|
+
}
|
|
2996
|
+
}
|
|
2997
|
+
},
|
|
2955
2998
|
"ExternalFeeMetadata": {
|
|
2956
2999
|
"allOf": [
|
|
2957
3000
|
{
|
|
@@ -3598,7 +3641,7 @@
|
|
|
3598
3641
|
"prices": {
|
|
3599
3642
|
"type": "array",
|
|
3600
3643
|
"items": {
|
|
3601
|
-
"$ref": "#/components/schemas/
|
|
3644
|
+
"$ref": "#/components/schemas/HistoricMarketPriceRecord"
|
|
3602
3645
|
}
|
|
3603
3646
|
}
|
|
3604
3647
|
},
|
|
@@ -3618,7 +3661,7 @@
|
|
|
3618
3661
|
"$ref": "#/components/schemas/SpotMarketBiddingZone"
|
|
3619
3662
|
},
|
|
3620
3663
|
"price": {
|
|
3621
|
-
"$ref": "#/components/schemas/
|
|
3664
|
+
"$ref": "#/components/schemas/AverageMarketPriceRecord"
|
|
3622
3665
|
},
|
|
3623
3666
|
"_meta": {
|
|
3624
3667
|
"$ref": "#/components/schemas/SignatureMeta"
|
|
@@ -3630,18 +3673,48 @@
|
|
|
3630
3673
|
"price"
|
|
3631
3674
|
]
|
|
3632
3675
|
},
|
|
3633
|
-
"
|
|
3676
|
+
"AverageMarketPriceRecord": {
|
|
3677
|
+
"description": "An average market price over a given period in time.",
|
|
3678
|
+
"allOf": [
|
|
3679
|
+
{
|
|
3680
|
+
"$ref": "#/components/schemas/BaseMarketPriceRecord"
|
|
3681
|
+
},
|
|
3682
|
+
{
|
|
3683
|
+
"type": "object",
|
|
3684
|
+
"properties": {
|
|
3685
|
+
"timestamp": {
|
|
3686
|
+
"type": "string",
|
|
3687
|
+
"description": "An ISO 8601 interval in the format 'start/end'.",
|
|
3688
|
+
"example": "2025-01-01T00:00:00Z/2025-01-31T23:59:59Z"
|
|
3689
|
+
}
|
|
3690
|
+
}
|
|
3691
|
+
}
|
|
3692
|
+
]
|
|
3693
|
+
},
|
|
3694
|
+
"HistoricMarketPriceRecord": {
|
|
3634
3695
|
"description": "A market price at a given point in time.",
|
|
3696
|
+
"allOf": [
|
|
3697
|
+
{
|
|
3698
|
+
"$ref": "#/components/schemas/BaseMarketPriceRecord"
|
|
3699
|
+
},
|
|
3700
|
+
{
|
|
3701
|
+
"type": "object",
|
|
3702
|
+
"properties": {
|
|
3703
|
+
"timestamp": {
|
|
3704
|
+
"type": "string",
|
|
3705
|
+
"format": "date-time",
|
|
3706
|
+
"description": "ISO 8601 timestamp of the price record in UTC."
|
|
3707
|
+
}
|
|
3708
|
+
}
|
|
3709
|
+
}
|
|
3710
|
+
]
|
|
3711
|
+
},
|
|
3712
|
+
"BaseMarketPriceRecord": {
|
|
3635
3713
|
"type": "object",
|
|
3636
3714
|
"properties": {
|
|
3637
|
-
"timestamp": {
|
|
3638
|
-
"type": "string",
|
|
3639
|
-
"format": "date-time",
|
|
3640
|
-
"description": "ISO 8601 timestamp of the price record in UTC."
|
|
3641
|
-
},
|
|
3642
3715
|
"unit_amount": {
|
|
3643
|
-
"type": "
|
|
3644
|
-
"description": "Cost in Cents, e.g.
|
|
3716
|
+
"type": "number",
|
|
3717
|
+
"description": "Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.",
|
|
3645
3718
|
"example": 12.3
|
|
3646
3719
|
},
|
|
3647
3720
|
"unit_amount_decimal": {
|
|
@@ -4818,6 +4891,10 @@
|
|
|
4818
4891
|
"type": "integer",
|
|
4819
4892
|
"description": "Total of all items taxes, with same recurrence."
|
|
4820
4893
|
},
|
|
4894
|
+
"amount_tax_decimal": {
|
|
4895
|
+
"type": "integer",
|
|
4896
|
+
"description": "Total of all items taxes, with same recurrence, as a string with all the decimal places."
|
|
4897
|
+
},
|
|
4821
4898
|
"currency": {
|
|
4822
4899
|
"$ref": "#/components/schemas/Currency",
|
|
4823
4900
|
"description": "Currency"
|