@epilot/pricing-client 3.40.0 → 3.42.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2022 epilot GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=i(t(240));r.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/pricing:compute":{"post":{"operationId":"$calculatePricingDetails","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID"},{"in":"header","name":"Authorization"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/validate-promo-codes":{"post":{"operationId":"$validatePromoCodes","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}],"responses":{}}},"/v1/public/integration/{integrationId}/external-catalog":{"post":{"operationId":"$searchExternalCatalog","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}}},"components":{}}')}},r={},t=function t(i){var a=r[i];if(void 0!==a)return a.exports;var n=r[i]={exports:{}};return e[i].call(n.exports,n,n.exports,t),n.exports}(914),i=exports;for(var a in t)i[a]=t[a];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={914:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=i(t(240));r.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/pricing:compute":{"post":{"operationId":"$calculatePricingDetails","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID"},{"in":"header","name":"Authorization"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/validate-promo-codes":{"post":{"operationId":"$validatePromoCodes","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}],"responses":{}}},"/v1/public/historicMarketPrices":{"get":{"operationId":"$historicMarketPrices","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true},{"in":"query","name":"frequency","required":true}],"responses":{}}},"/v1/public/averageMarketPrice":{"get":{"operationId":"$averageMarketPrice","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"interval","required":true}],"responses":{}}},"/v1/public/integration/{integrationId}/external-catalog":{"post":{"operationId":"$searchExternalCatalog","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}}},"components":{}}')}},r={},t=function t(i){var a=r[i];if(void 0!==a)return a.exports;var n=r[i]={exports:{}};return e[i].call(n.exports,n,n.exports,t),n.exports}(914),i=exports;for(var a in t)i[a]=t[a];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
@@ -106,9 +106,16 @@
106
106
  "responses": {}
107
107
  }
108
108
  },
109
- "/v1/validate-promo-codes": {
109
+ "/v1/public/validate-promo-codes": {
110
110
  "post": {
111
111
  "operationId": "$validatePromoCodes",
112
+ "parameters": [
113
+ {
114
+ "in": "header",
115
+ "name": "X-Ivy-Org-ID",
116
+ "required": true
117
+ }
118
+ ],
112
119
  "requestBody": {
113
120
  "required": true,
114
121
  "content": {
@@ -155,6 +162,52 @@
155
162
  "responses": {}
156
163
  }
157
164
  },
165
+ "/v1/public/historicMarketPrices": {
166
+ "get": {
167
+ "operationId": "$historicMarketPrices",
168
+ "parameters": [
169
+ {
170
+ "in": "query",
171
+ "name": "market",
172
+ "required": true
173
+ },
174
+ {
175
+ "in": "query",
176
+ "name": "from",
177
+ "required": true
178
+ },
179
+ {
180
+ "in": "query",
181
+ "name": "to",
182
+ "required": true
183
+ },
184
+ {
185
+ "in": "query",
186
+ "name": "frequency",
187
+ "required": true
188
+ }
189
+ ],
190
+ "responses": {}
191
+ }
192
+ },
193
+ "/v1/public/averageMarketPrice": {
194
+ "get": {
195
+ "operationId": "$averageMarketPrice",
196
+ "parameters": [
197
+ {
198
+ "in": "query",
199
+ "name": "market",
200
+ "required": true
201
+ },
202
+ {
203
+ "in": "query",
204
+ "name": "interval",
205
+ "required": true
206
+ }
207
+ ],
208
+ "responses": {}
209
+ }
210
+ },
158
211
  "/v1/public/integration/{integrationId}/external-catalog": {
159
212
  "post": {
160
213
  "operationId": "$searchExternalCatalog",
package/dist/openapi.d.ts CHANGED
@@ -2219,9 +2219,17 @@ declare namespace Components {
2219
2219
  */
2220
2220
  static?: /* The computed price components */ ComputedPriceComponents;
2221
2221
  /**
2222
- * The variable price breakdown
2222
+ * The variable price breakdown (day and night)
2223
2223
  */
2224
2224
  variable?: /* The computed price components */ ComputedPriceComponents;
2225
+ /**
2226
+ * The variable price breakdown for the day period
2227
+ */
2228
+ variable_ht?: /* The computed price components */ ComputedPriceComponents;
2229
+ /**
2230
+ * The variable price breakdown for the night period
2231
+ */
2232
+ variable_nt?: /* The computed price components */ ComputedPriceComponents;
2225
2233
  }
2226
2234
  /**
2227
2235
  * The computed price components
@@ -5153,6 +5161,41 @@ declare namespace Paths {
5153
5161
  export type $400 = Components.Schemas.Error;
5154
5162
  }
5155
5163
  }
5164
+ namespace $AverageMarketPrice {
5165
+ namespace Parameters {
5166
+ export type Interval = "previous_week" | "previous_month" | "previous_year";
5167
+ export type Market = "day_ahead";
5168
+ }
5169
+ export interface QueryParameters {
5170
+ market: Parameters.Market;
5171
+ interval: Parameters.Interval;
5172
+ }
5173
+ namespace Responses {
5174
+ export interface $200 {
5175
+ market?: "day_ahead";
5176
+ interval?: "previous_week" | "previous_month" | "previous_year";
5177
+ price?: {
5178
+ /**
5179
+ * ISO 8601 timestamp of the price record in UTC.
5180
+ */
5181
+ timestamp: string; // date-time
5182
+ /**
5183
+ * Cost in tenth of cents, e.g. 123 for 12,3 Cents = 0.123€.
5184
+ * example:
5185
+ * 123
5186
+ */
5187
+ unit_amount: number;
5188
+ /**
5189
+ * Cost in decimal format, e.g. 0.123€.
5190
+ * example:
5191
+ * 0.123
5192
+ */
5193
+ unit_amount_decimal: string;
5194
+ };
5195
+ }
5196
+ export type $400 = Components.Schemas.Error;
5197
+ }
5198
+ }
5156
5199
  namespace $CalculatePricingDetails {
5157
5200
  export interface RequestBody {
5158
5201
  line_items?: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ Components.Schemas.PriceItemsDto;
@@ -5219,6 +5262,39 @@ declare namespace Paths {
5219
5262
  export type $404 = Components.Schemas.Error;
5220
5263
  }
5221
5264
  }
5265
+ namespace $HistoricMarketPrices {
5266
+ namespace Parameters {
5267
+ export type Frequency = "hourly" | "daily" | "monthly";
5268
+ export type From = string; // date
5269
+ export type Market = "day_ahead";
5270
+ export type To = string; // date
5271
+ }
5272
+ export interface QueryParameters {
5273
+ market: Parameters.Market;
5274
+ from: Parameters.From /* date */;
5275
+ to: Parameters.To /* date */;
5276
+ frequency: Parameters.Frequency;
5277
+ }
5278
+ namespace Responses {
5279
+ export interface $200 {
5280
+ market?: "day_ahead";
5281
+ frequency?: "hourly" | "daily" | "monthly";
5282
+ prices?: {
5283
+ /**
5284
+ * ISO 8601 timestamp of the price record in UTC.
5285
+ */
5286
+ timestamp: string; // date-time
5287
+ /**
5288
+ * Cost in tenth of cents, e.g. 123 for 12,3 Cents = 0.123€.
5289
+ * example:
5290
+ * 123
5291
+ */
5292
+ unit_amount: number;
5293
+ }[];
5294
+ }
5295
+ export type $400 = Components.Schemas.Error;
5296
+ }
5297
+ }
5222
5298
  namespace $PrivateSearchCatalog {
5223
5299
  export type RequestBody = /**
5224
5300
  * A catalog search payload
@@ -5388,6 +5464,12 @@ declare namespace Paths {
5388
5464
  }
5389
5465
  }
5390
5466
  namespace $ValidatePromoCodes {
5467
+ export interface HeaderParameters {
5468
+ "X-Ivy-Org-ID": Parameters.XIvyOrgID;
5469
+ }
5470
+ namespace Parameters {
5471
+ export type XIvyOrgID = string;
5472
+ }
5391
5473
  export interface RequestBody {
5392
5474
  /**
5393
5475
  * The list of coupon ids to unlock with promo codes
@@ -5517,7 +5599,7 @@ export interface OperationMethods {
5517
5599
  * Validate a list of promo codes against a list of coupons
5518
5600
  */
5519
5601
  '$validatePromoCodes'(
5520
- parameters?: Parameters<UnknownParamsObject> | null,
5602
+ parameters?: Parameters<Paths.$ValidatePromoCodes.HeaderParameters> | null,
5521
5603
  data?: Paths.$ValidatePromoCodes.RequestBody,
5522
5604
  config?: AxiosRequestConfig
5523
5605
  ): OperationResponse<Paths.$ValidatePromoCodes.Responses.$200>
@@ -5541,6 +5623,28 @@ export interface OperationMethods {
5541
5623
  data?: any,
5542
5624
  config?: AxiosRequestConfig
5543
5625
  ): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
5626
+ /**
5627
+ * $historicMarketPrices - historicMarketPrices
5628
+ *
5629
+ * BETA: Get historic energy prices in a given time period
5630
+ *
5631
+ */
5632
+ '$historicMarketPrices'(
5633
+ parameters?: Parameters<Paths.$HistoricMarketPrices.QueryParameters> | null,
5634
+ data?: any,
5635
+ config?: AxiosRequestConfig
5636
+ ): OperationResponse<Paths.$HistoricMarketPrices.Responses.$200>
5637
+ /**
5638
+ * $averageMarketPrice - averageMarketPrice
5639
+ *
5640
+ * BETA: Get average energy prices in a given time period
5641
+ *
5642
+ */
5643
+ '$averageMarketPrice'(
5644
+ parameters?: Parameters<Paths.$AverageMarketPrice.QueryParameters> | null,
5645
+ data?: any,
5646
+ config?: AxiosRequestConfig
5647
+ ): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
5544
5648
  /**
5545
5649
  * $searchExternalCatalog - searchExternalCatalog
5546
5650
  *
@@ -5697,14 +5801,14 @@ export interface PathsDictionary {
5697
5801
  config?: AxiosRequestConfig
5698
5802
  ): OperationResponse<Paths.$PrivateSearchCatalog.Responses.$200>
5699
5803
  }
5700
- ['/v1/validate-promo-codes']: {
5804
+ ['/v1/public/validate-promo-codes']: {
5701
5805
  /**
5702
5806
  * $validatePromoCodes - validatePromoCodes
5703
5807
  *
5704
5808
  * Validate a list of promo codes against a list of coupons
5705
5809
  */
5706
5810
  'post'(
5707
- parameters?: Parameters<UnknownParamsObject> | null,
5811
+ parameters?: Parameters<Paths.$ValidatePromoCodes.HeaderParameters> | null,
5708
5812
  data?: Paths.$ValidatePromoCodes.RequestBody,
5709
5813
  config?: AxiosRequestConfig
5710
5814
  ): OperationResponse<Paths.$ValidatePromoCodes.Responses.$200>
@@ -5733,6 +5837,32 @@ export interface PathsDictionary {
5733
5837
  config?: AxiosRequestConfig
5734
5838
  ): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
5735
5839
  }
5840
+ ['/v1/public/historicMarketPrices']: {
5841
+ /**
5842
+ * $historicMarketPrices - historicMarketPrices
5843
+ *
5844
+ * BETA: Get historic energy prices in a given time period
5845
+ *
5846
+ */
5847
+ 'get'(
5848
+ parameters?: Parameters<Paths.$HistoricMarketPrices.QueryParameters> | null,
5849
+ data?: any,
5850
+ config?: AxiosRequestConfig
5851
+ ): OperationResponse<Paths.$HistoricMarketPrices.Responses.$200>
5852
+ }
5853
+ ['/v1/public/averageMarketPrice']: {
5854
+ /**
5855
+ * $averageMarketPrice - averageMarketPrice
5856
+ *
5857
+ * BETA: Get average energy prices in a given time period
5858
+ *
5859
+ */
5860
+ 'get'(
5861
+ parameters?: Parameters<Paths.$AverageMarketPrice.QueryParameters> | null,
5862
+ data?: any,
5863
+ config?: AxiosRequestConfig
5864
+ ): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
5865
+ }
5736
5866
  ['/v1/public/integration/{integrationId}/external-catalog']: {
5737
5867
  /**
5738
5868
  * $searchExternalCatalog - searchExternalCatalog
package/dist/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
4
  "title": "Pricing API",
5
- "description": "The `pricing-api` hub sets the foundations for the following Pricing APIs:\n\n### Order API\nThis api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n\n### Shopping Cart API\nUsed to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n\n### Catalog API\nProvides a way to query the entire catalog of products and prices.\n\n### Availability API\nProvides endpoints for querying products availability by a set of predefined dimensions.\n\n### External Integrations API\nProvides endpoints for external integrations.\n",
5
+ "description": "The `pricing-api` hub sets the foundations for the following Pricing APIs:\n\n### Order API\nThis api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n\n### Shopping Cart API\nUsed to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n\n### Catalog API\nProvides a way to query the entire catalog of products and prices.\n\n### Availability API\nProvides endpoints for querying products availability by a set of predefined dimensions.\n\n### Spot Market API\nProvides endpoints to fetch (historic) spot market price data.\n\n### External Integrations API\nProvides endpoints for external integrations.\n",
6
6
  "version": "1.0.0",
7
7
  "termsOfService": "https://epilot.cloud/agb",
8
8
  "contact": {
@@ -32,6 +32,10 @@
32
32
  "name": "Availability API",
33
33
  "description": "Provides endpoints for querying products availability by a set of predefined dimensions.\n"
34
34
  },
35
+ {
36
+ "name": "Spot Market API",
37
+ "description": "Proviodes endpoints to fetch (historic) spot market data.\n"
38
+ },
35
39
  {
36
40
  "name": "External Integrations API",
37
41
  "description": "Provides endpoints for external integrations.\n"
@@ -116,6 +120,12 @@
116
120
  }
117
121
  ],
118
122
  "servers": [
123
+ {
124
+ "url": "https://pricing-api.sls.epilot.io"
125
+ },
126
+ {
127
+ "url": "https://pricing-api.sls.epilot.io"
128
+ },
119
129
  {
120
130
  "url": "https://pricing-api.sls.epilot.io"
121
131
  }
@@ -871,7 +881,7 @@
871
881
  }
872
882
  }
873
883
  },
874
- "/v1/validate-promo-codes": {
884
+ "/v1/public/validate-promo-codes": {
875
885
  "post": {
876
886
  "description": "Validate a list of promo codes against a list of coupons",
877
887
  "summary": "validatePromoCodes",
@@ -879,6 +889,22 @@
879
889
  "tags": [
880
890
  "Promo Codes API"
881
891
  ],
892
+ "security": [
893
+ {
894
+ "EpilotPublicAuth": []
895
+ }
896
+ ],
897
+ "parameters": [
898
+ {
899
+ "in": "header",
900
+ "name": "X-Ivy-Org-ID",
901
+ "description": "The target Organization Id represented by the caller",
902
+ "schema": {
903
+ "type": "string"
904
+ },
905
+ "required": true
906
+ }
907
+ ],
882
908
  "requestBody": {
883
909
  "required": true,
884
910
  "content": {
@@ -1171,6 +1197,235 @@
1171
1197
  }
1172
1198
  }
1173
1199
  },
1200
+ "/v1/public/historicMarketPrices": {
1201
+ "get": {
1202
+ "description": "BETA: Get historic energy prices in a given time period\n",
1203
+ "operationId": "$historicMarketPrices",
1204
+ "summary": "historicMarketPrices",
1205
+ "tags": [
1206
+ "Spot Market API"
1207
+ ],
1208
+ "security": [
1209
+ {
1210
+ "EpilotPublicAuth": []
1211
+ }
1212
+ ],
1213
+ "parameters": [
1214
+ {
1215
+ "in": "query",
1216
+ "name": "market",
1217
+ "schema": {
1218
+ "type": "string",
1219
+ "enum": [
1220
+ "day_ahead"
1221
+ ]
1222
+ },
1223
+ "required": true,
1224
+ "description": "Market to use. For now, only day ahead prices are supported."
1225
+ },
1226
+ {
1227
+ "in": "query",
1228
+ "name": "from",
1229
+ "schema": {
1230
+ "type": "string",
1231
+ "format": "date"
1232
+ },
1233
+ "required": true,
1234
+ "description": "Start date for price data (YYYY-MM-DDD)."
1235
+ },
1236
+ {
1237
+ "in": "query",
1238
+ "name": "to",
1239
+ "schema": {
1240
+ "type": "string",
1241
+ "format": "date"
1242
+ },
1243
+ "required": true,
1244
+ "description": "End date for price data (YYYY-MM-DDD)."
1245
+ },
1246
+ {
1247
+ "in": "query",
1248
+ "name": "frequency",
1249
+ "schema": {
1250
+ "type": "string",
1251
+ "enum": [
1252
+ "hourly",
1253
+ "daily",
1254
+ "monthly"
1255
+ ]
1256
+ },
1257
+ "required": true,
1258
+ "description": "Frequency of the price data points"
1259
+ }
1260
+ ],
1261
+ "responses": {
1262
+ "200": {
1263
+ "description": "Price data returned successfully.",
1264
+ "content": {
1265
+ "application/json": {
1266
+ "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 tenth of cents, e.g. 123 for 12,3 Cents = 0.123€.",
1296
+ "example": 123
1297
+ }
1298
+ },
1299
+ "required": [
1300
+ "timestamp",
1301
+ "unit_amount"
1302
+ ]
1303
+ }
1304
+ }
1305
+ }
1306
+ }
1307
+ }
1308
+ }
1309
+ },
1310
+ "400": {
1311
+ "description": "Invalid payload",
1312
+ "content": {
1313
+ "application/json": {
1314
+ "schema": {
1315
+ "$ref": "#/components/schemas/Error"
1316
+ }
1317
+ }
1318
+ }
1319
+ }
1320
+ }
1321
+ }
1322
+ },
1323
+ "/v1/public/averageMarketPrice": {
1324
+ "get": {
1325
+ "description": "BETA: Get average energy prices in a given time period\n",
1326
+ "operationId": "$averageMarketPrice",
1327
+ "summary": "averageMarketPrice",
1328
+ "tags": [
1329
+ "Spot Market API"
1330
+ ],
1331
+ "security": [
1332
+ {
1333
+ "EpilotPublicAuth": []
1334
+ }
1335
+ ],
1336
+ "parameters": [
1337
+ {
1338
+ "in": "query",
1339
+ "name": "market",
1340
+ "schema": {
1341
+ "type": "string",
1342
+ "enum": [
1343
+ "day_ahead"
1344
+ ]
1345
+ },
1346
+ "required": true,
1347
+ "description": "Market to use. For now, only day ahead prices are supported."
1348
+ },
1349
+ {
1350
+ "in": "query",
1351
+ "name": "interval",
1352
+ "schema": {
1353
+ "type": "string",
1354
+ "enum": [
1355
+ "previous_week",
1356
+ "previous_month",
1357
+ "previous_year"
1358
+ ]
1359
+ },
1360
+ "required": true,
1361
+ "description": "Interval for the average."
1362
+ }
1363
+ ],
1364
+ "responses": {
1365
+ "200": {
1366
+ "description": "Price data returned successfully.",
1367
+ "content": {
1368
+ "application/json": {
1369
+ "schema": {
1370
+ "type": "object",
1371
+ "properties": {
1372
+ "market": {
1373
+ "type": "string",
1374
+ "enum": [
1375
+ "day_ahead"
1376
+ ]
1377
+ },
1378
+ "interval": {
1379
+ "type": "string",
1380
+ "enum": [
1381
+ "previous_week",
1382
+ "previous_month",
1383
+ "previous_year"
1384
+ ]
1385
+ },
1386
+ "price": {
1387
+ "type": "object",
1388
+ "properties": {
1389
+ "timestamp": {
1390
+ "type": "string",
1391
+ "format": "date-time",
1392
+ "description": "ISO 8601 timestamp of the price record in UTC."
1393
+ },
1394
+ "unit_amount": {
1395
+ "type": "integer",
1396
+ "description": "Cost in tenth of cents, e.g. 123 for 12,3 Cents = 0.123€.",
1397
+ "example": 123
1398
+ },
1399
+ "unit_amount_decimal": {
1400
+ "type": "string",
1401
+ "description": "Cost in decimal format, e.g. 0.123€.",
1402
+ "example": "0.123"
1403
+ }
1404
+ },
1405
+ "required": [
1406
+ "timestamp",
1407
+ "unit_amount",
1408
+ "unit_amount_decimal"
1409
+ ]
1410
+ }
1411
+ }
1412
+ }
1413
+ }
1414
+ }
1415
+ },
1416
+ "400": {
1417
+ "description": "Invalid payload",
1418
+ "content": {
1419
+ "application/json": {
1420
+ "schema": {
1421
+ "$ref": "#/components/schemas/Error"
1422
+ }
1423
+ }
1424
+ }
1425
+ }
1426
+ }
1427
+ }
1428
+ },
1174
1429
  "/v1/public/integration/{integrationId}/external-catalog": {
1175
1430
  "post": {
1176
1431
  "description": "Returns the list of available products (including computed prices) based on a given context.",
@@ -3246,7 +3501,15 @@
3246
3501
  "$ref": "#/components/schemas/ComputedPriceComponents"
3247
3502
  },
3248
3503
  "variable": {
3249
- "description": "The variable price breakdown",
3504
+ "description": "The variable price breakdown (day and night)",
3505
+ "$ref": "#/components/schemas/ComputedPriceComponents"
3506
+ },
3507
+ "variable_ht": {
3508
+ "description": "The variable price breakdown for the day period",
3509
+ "$ref": "#/components/schemas/ComputedPriceComponents"
3510
+ },
3511
+ "variable_nt": {
3512
+ "description": "The variable price breakdown for the night period",
3250
3513
  "$ref": "#/components/schemas/ComputedPriceComponents"
3251
3514
  }
3252
3515
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.40.0",
3
+ "version": "3.42.0",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -71,5 +71,5 @@
71
71
  "webpack": "^5.18.0",
72
72
  "webpack-cli": "^4.4.0"
73
73
  },
74
- "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
74
+ "gitHead": "6587961f411ed379b0416075d6f4f047077a561d"
75
75
  }