@epilot/pricing-client 3.36.7 → 3.37.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 +21 -0
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +4 -2
- package/dist/openapi.d.ts +31 -4
- package/dist/openapi.json +64 -3
- package/package.json +2 -2
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.
|
package/dist/definition.js
CHANGED
|
@@ -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":{}}}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/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/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/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})})();
|
|
@@ -49,7 +49,8 @@
|
|
|
49
49
|
"content": {
|
|
50
50
|
"application/json": {}
|
|
51
51
|
}
|
|
52
|
-
}
|
|
52
|
+
},
|
|
53
|
+
"responses": {}
|
|
53
54
|
}
|
|
54
55
|
},
|
|
55
56
|
"/v1/public/cart:checkout": {
|
|
@@ -67,7 +68,8 @@
|
|
|
67
68
|
"content": {
|
|
68
69
|
"application/json": {}
|
|
69
70
|
}
|
|
70
|
-
}
|
|
71
|
+
},
|
|
72
|
+
"responses": {}
|
|
71
73
|
}
|
|
72
74
|
},
|
|
73
75
|
"/v1/public/catalog": {
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2245,6 +2245,14 @@ declare namespace Components {
|
|
|
2245
2245
|
email?: string;
|
|
2246
2246
|
phone?: string;
|
|
2247
2247
|
}
|
|
2248
|
+
/**
|
|
2249
|
+
* The interval of the tariff if a spot market price is used as base.
|
|
2250
|
+
*/
|
|
2251
|
+
export type DynamicTariffInterval = "hourly" | "monthly_average";
|
|
2252
|
+
/**
|
|
2253
|
+
* The mode of the dynamic tariff. `day_ahead_market` uses the Day-Ahead spot market price as base.
|
|
2254
|
+
*/
|
|
2255
|
+
export type DynamicTariffMode = "day_ahead_market" | "manual";
|
|
2248
2256
|
export type EntityId = string; // uuid
|
|
2249
2257
|
/**
|
|
2250
2258
|
* example:
|
|
@@ -2973,10 +2981,11 @@ declare namespace Components {
|
|
|
2973
2981
|
* - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
|
|
2974
2982
|
* - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
|
|
2975
2983
|
* - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
|
|
2984
|
+
* - `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.
|
|
2976
2985
|
* - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
|
|
2977
2986
|
*
|
|
2978
2987
|
*/
|
|
2979
|
-
pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "external_getag";
|
|
2988
|
+
pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "dynamic_tariff" | "external_getag";
|
|
2980
2989
|
/**
|
|
2981
2990
|
* Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
|
|
2982
2991
|
*
|
|
@@ -3103,6 +3112,7 @@ declare namespace Components {
|
|
|
3103
3112
|
*/
|
|
3104
3113
|
unit?: /* The unit of measurement used for display purposes and possibly for calculations when the price is variable. */ ("kw" | "kwh" | "m" | "m2" | "l" | "cubic-meter" | "cubic-meter-h" | "ls" | "a" | "kva" | "w" | "wp" | "kwp") | string;
|
|
3105
3114
|
get_ag?: PriceGetAg;
|
|
3115
|
+
dynamic_tariff?: PriceDynamicTariff;
|
|
3106
3116
|
/**
|
|
3107
3117
|
* The price creation date
|
|
3108
3118
|
*/
|
|
@@ -3144,6 +3154,14 @@ declare namespace Components {
|
|
|
3144
3154
|
*/
|
|
3145
3155
|
_tags?: string[];
|
|
3146
3156
|
}
|
|
3157
|
+
export interface PriceDynamicTariff {
|
|
3158
|
+
mode: /* The mode of the dynamic tariff. `day_ahead_market` uses the Day-Ahead spot market price as base. */ DynamicTariffMode;
|
|
3159
|
+
interval?: /* The interval of the tariff if a spot market price is used as base. */ DynamicTariffInterval;
|
|
3160
|
+
average_price: number;
|
|
3161
|
+
average_price_decimal: string;
|
|
3162
|
+
markup: number;
|
|
3163
|
+
markup_decimal: string;
|
|
3164
|
+
}
|
|
3147
3165
|
export interface PriceGetAg {
|
|
3148
3166
|
category: ProductCategory;
|
|
3149
3167
|
markup_pricing_model?: /**
|
|
@@ -3607,12 +3625,14 @@ declare namespace Components {
|
|
|
3607
3625
|
* - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
|
|
3608
3626
|
* - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
|
|
3609
3627
|
* - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
|
|
3628
|
+
* - `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.
|
|
3610
3629
|
* - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
|
|
3611
3630
|
*
|
|
3612
3631
|
*/
|
|
3613
3632
|
PricingModel;
|
|
3614
3633
|
tiers_details?: TierDetails[];
|
|
3615
3634
|
get_ag?: PriceGetAg;
|
|
3635
|
+
dynamic_tariff?: PriceDynamicTariff;
|
|
3616
3636
|
}
|
|
3617
3637
|
/**
|
|
3618
3638
|
* Represents a price input to the pricing library.
|
|
@@ -3849,10 +3869,11 @@ declare namespace Components {
|
|
|
3849
3869
|
* - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
|
|
3850
3870
|
* - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
|
|
3851
3871
|
* - `tiered_flatfee` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
|
|
3872
|
+
* - `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.
|
|
3852
3873
|
* - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
|
|
3853
3874
|
*
|
|
3854
3875
|
*/
|
|
3855
|
-
pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "external_getag";
|
|
3876
|
+
pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "dynamic_tariff" | "external_getag";
|
|
3856
3877
|
/**
|
|
3857
3878
|
* The snapshot of the price linked to the price item.
|
|
3858
3879
|
* example:
|
|
@@ -3876,10 +3897,11 @@ declare namespace Components {
|
|
|
3876
3897
|
* - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
|
|
3877
3898
|
* - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
|
|
3878
3899
|
* - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
|
|
3900
|
+
* - `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.
|
|
3879
3901
|
* - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
|
|
3880
3902
|
*
|
|
3881
3903
|
*/
|
|
3882
|
-
pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "external_getag";
|
|
3904
|
+
pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "dynamic_tariff" | "external_getag";
|
|
3883
3905
|
/**
|
|
3884
3906
|
* Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
|
|
3885
3907
|
*
|
|
@@ -4006,6 +4028,7 @@ declare namespace Components {
|
|
|
4006
4028
|
*/
|
|
4007
4029
|
unit?: /* The unit of measurement used for display purposes and possibly for calculations when the price is variable. */ ("kw" | "kwh" | "m" | "m2" | "l" | "cubic-meter" | "cubic-meter-h" | "ls" | "a" | "kva" | "w" | "wp" | "kwp") | string;
|
|
4008
4030
|
get_ag?: PriceGetAg;
|
|
4031
|
+
dynamic_tariff?: PriceDynamicTariff;
|
|
4009
4032
|
/**
|
|
4010
4033
|
* The price creation date
|
|
4011
4034
|
*/
|
|
@@ -4179,10 +4202,11 @@ declare namespace Components {
|
|
|
4179
4202
|
* - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
|
|
4180
4203
|
* - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
|
|
4181
4204
|
* - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
|
|
4205
|
+
* - `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.
|
|
4182
4206
|
* - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
|
|
4183
4207
|
*
|
|
4184
4208
|
*/
|
|
4185
|
-
export type PricingModel = "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "external_getag";
|
|
4209
|
+
export type PricingModel = "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "dynamic_tariff" | "external_getag";
|
|
4186
4210
|
/**
|
|
4187
4211
|
* The product entity
|
|
4188
4212
|
* example:
|
|
@@ -5503,6 +5527,8 @@ export type ConsumptionTypeGetAg = Components.Schemas.ConsumptionTypeGetAg;
|
|
|
5503
5527
|
export type Coupon = Components.Schemas.Coupon;
|
|
5504
5528
|
export type Currency = Components.Schemas.Currency;
|
|
5505
5529
|
export type Customer = Components.Schemas.Customer;
|
|
5530
|
+
export type DynamicTariffInterval = Components.Schemas.DynamicTariffInterval;
|
|
5531
|
+
export type DynamicTariffMode = Components.Schemas.DynamicTariffMode;
|
|
5506
5532
|
export type EntityId = Components.Schemas.EntityId;
|
|
5507
5533
|
export type EntityItem = Components.Schemas.EntityItem;
|
|
5508
5534
|
export type EntityRelation = Components.Schemas.EntityRelation;
|
|
@@ -5529,6 +5555,7 @@ export type PaymentMethod = Components.Schemas.PaymentMethod;
|
|
|
5529
5555
|
export type PowerMeterType = Components.Schemas.PowerMeterType;
|
|
5530
5556
|
export type Price = Components.Schemas.Price;
|
|
5531
5557
|
export type PriceComponentRelation = Components.Schemas.PriceComponentRelation;
|
|
5558
|
+
export type PriceDynamicTariff = Components.Schemas.PriceDynamicTariff;
|
|
5532
5559
|
export type PriceGetAg = Components.Schemas.PriceGetAg;
|
|
5533
5560
|
export type PriceInputMapping = Components.Schemas.PriceInputMapping;
|
|
5534
5561
|
export type PriceInputMappings = Components.Schemas.PriceInputMappings;
|
package/dist/openapi.json
CHANGED
|
@@ -112,6 +112,12 @@
|
|
|
112
112
|
}
|
|
113
113
|
],
|
|
114
114
|
"servers": [
|
|
115
|
+
{
|
|
116
|
+
"url": "https://pricing-api.sls.epilot.io"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"url": "https://pricing-api.sls.epilot.io"
|
|
120
|
+
},
|
|
115
121
|
{
|
|
116
122
|
"url": "https://pricing-api.sls.epilot.io"
|
|
117
123
|
}
|
|
@@ -2248,12 +2254,13 @@
|
|
|
2248
2254
|
},
|
|
2249
2255
|
"pricing_model": {
|
|
2250
2256
|
"type": "string",
|
|
2251
|
-
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
2257
|
+
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.\n - `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
2252
2258
|
"enum": [
|
|
2253
2259
|
"per_unit",
|
|
2254
2260
|
"tiered_graduated",
|
|
2255
2261
|
"tiered_volume",
|
|
2256
2262
|
"tiered_flatfee",
|
|
2263
|
+
"dynamic_tariff",
|
|
2257
2264
|
"external_getag"
|
|
2258
2265
|
]
|
|
2259
2266
|
},
|
|
@@ -2436,6 +2443,9 @@
|
|
|
2436
2443
|
"get_ag": {
|
|
2437
2444
|
"$ref": "#/components/schemas/PriceGetAg"
|
|
2438
2445
|
},
|
|
2446
|
+
"dynamic_tariff": {
|
|
2447
|
+
"$ref": "#/components/schemas/PriceDynamicTariff"
|
|
2448
|
+
},
|
|
2439
2449
|
"_created_at": {
|
|
2440
2450
|
"description": "The price creation date",
|
|
2441
2451
|
"type": "string"
|
|
@@ -3114,6 +3124,22 @@
|
|
|
3114
3124
|
"digital"
|
|
3115
3125
|
]
|
|
3116
3126
|
},
|
|
3127
|
+
"DynamicTariffMode": {
|
|
3128
|
+
"description": "The mode of the dynamic tariff. `day_ahead_market` uses the Day-Ahead spot market price as base.",
|
|
3129
|
+
"type": "string",
|
|
3130
|
+
"enum": [
|
|
3131
|
+
"day_ahead_market",
|
|
3132
|
+
"manual"
|
|
3133
|
+
]
|
|
3134
|
+
},
|
|
3135
|
+
"DynamicTariffInterval": {
|
|
3136
|
+
"description": "The interval of the tariff if a spot market price is used as base.",
|
|
3137
|
+
"type": "string",
|
|
3138
|
+
"enum": [
|
|
3139
|
+
"hourly",
|
|
3140
|
+
"monthly_average"
|
|
3141
|
+
]
|
|
3142
|
+
},
|
|
3117
3143
|
"ComputedPriceBreakdown": {
|
|
3118
3144
|
"type": "object",
|
|
3119
3145
|
"description": "Price breakdown",
|
|
@@ -3619,12 +3645,13 @@
|
|
|
3619
3645
|
},
|
|
3620
3646
|
"pricing_model": {
|
|
3621
3647
|
"type": "string",
|
|
3622
|
-
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
3648
|
+
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
3623
3649
|
"enum": [
|
|
3624
3650
|
"per_unit",
|
|
3625
3651
|
"tiered_graduated",
|
|
3626
3652
|
"tiered_volume",
|
|
3627
3653
|
"tiered_flatfee",
|
|
3654
|
+
"dynamic_tariff",
|
|
3628
3655
|
"external_getag"
|
|
3629
3656
|
]
|
|
3630
3657
|
},
|
|
@@ -4260,6 +4287,9 @@
|
|
|
4260
4287
|
},
|
|
4261
4288
|
"get_ag": {
|
|
4262
4289
|
"$ref": "#/components/schemas/PriceGetAg"
|
|
4290
|
+
},
|
|
4291
|
+
"dynamic_tariff": {
|
|
4292
|
+
"$ref": "#/components/schemas/PriceDynamicTariff"
|
|
4263
4293
|
}
|
|
4264
4294
|
},
|
|
4265
4295
|
"required": [
|
|
@@ -5237,12 +5267,13 @@
|
|
|
5237
5267
|
},
|
|
5238
5268
|
"PricingModel": {
|
|
5239
5269
|
"type": "string",
|
|
5240
|
-
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
5270
|
+
"description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.\n- `dynamic_tariff` indicates that the price is dynamically dependend on the (quarter)-hourly spot market price.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
|
|
5241
5271
|
"enum": [
|
|
5242
5272
|
"per_unit",
|
|
5243
5273
|
"tiered_graduated",
|
|
5244
5274
|
"tiered_volume",
|
|
5245
5275
|
"tiered_flatfee",
|
|
5276
|
+
"dynamic_tariff",
|
|
5246
5277
|
"external_getag"
|
|
5247
5278
|
]
|
|
5248
5279
|
},
|
|
@@ -5357,6 +5388,36 @@
|
|
|
5357
5388
|
"unit_amount_net"
|
|
5358
5389
|
]
|
|
5359
5390
|
},
|
|
5391
|
+
"PriceDynamicTariff": {
|
|
5392
|
+
"type": "object",
|
|
5393
|
+
"properties": {
|
|
5394
|
+
"mode": {
|
|
5395
|
+
"$ref": "#/components/schemas/DynamicTariffMode"
|
|
5396
|
+
},
|
|
5397
|
+
"interval": {
|
|
5398
|
+
"$ref": "#/components/schemas/DynamicTariffInterval"
|
|
5399
|
+
},
|
|
5400
|
+
"average_price": {
|
|
5401
|
+
"type": "number"
|
|
5402
|
+
},
|
|
5403
|
+
"average_price_decimal": {
|
|
5404
|
+
"type": "string"
|
|
5405
|
+
},
|
|
5406
|
+
"markup": {
|
|
5407
|
+
"type": "number"
|
|
5408
|
+
},
|
|
5409
|
+
"markup_decimal": {
|
|
5410
|
+
"type": "string"
|
|
5411
|
+
}
|
|
5412
|
+
},
|
|
5413
|
+
"required": [
|
|
5414
|
+
"mode",
|
|
5415
|
+
"markup",
|
|
5416
|
+
"markup_decimal",
|
|
5417
|
+
"average_price",
|
|
5418
|
+
"average_price_decimal"
|
|
5419
|
+
]
|
|
5420
|
+
},
|
|
5360
5421
|
"TierDetails": {
|
|
5361
5422
|
"type": "object",
|
|
5362
5423
|
"properties": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/pricing-client",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.37.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": "
|
|
74
|
+
"gitHead": "d37209e21bd601fe62855eb518b373e838153d34"
|
|
75
75
|
}
|