@epilot/pricing-client 3.27.2 → 3.27.4
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 +80 -4
- package/dist/openapi.json +78 -16
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -1099,7 +1099,41 @@ declare namespace Components {
|
|
|
1099
1099
|
/**
|
|
1100
1100
|
* The compute price payload
|
|
1101
1101
|
*/
|
|
1102
|
-
export
|
|
1102
|
+
export type ComputePriceParams = /* The compute price payload */ /* The compute price payload for power */ ComputePriceParamsPower | /* The compute price payload for gas */ ComputePriceParamsGas;
|
|
1103
|
+
export interface ComputePriceParamsBase {
|
|
1104
|
+
/**
|
|
1105
|
+
* The postal code to search for providers
|
|
1106
|
+
*/
|
|
1107
|
+
postal_code?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* The consumption type
|
|
1110
|
+
*/
|
|
1111
|
+
consumption_type?: "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
|
|
1112
|
+
/**
|
|
1113
|
+
* The monthly consumption to compute the price in kWh (to be deprecated in favor of consumption_HT)
|
|
1114
|
+
*/
|
|
1115
|
+
consumption?: number;
|
|
1116
|
+
/**
|
|
1117
|
+
* The monthly HT consumption to compute the price in kWh
|
|
1118
|
+
*/
|
|
1119
|
+
consumption_HT?: number;
|
|
1120
|
+
/**
|
|
1121
|
+
* The monthly NT consumption to compute the price in kWh
|
|
1122
|
+
*/
|
|
1123
|
+
consumption_NT?: number;
|
|
1124
|
+
/**
|
|
1125
|
+
* The association id
|
|
1126
|
+
*/
|
|
1127
|
+
association_id?: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* The billing period (defaults to monthly)
|
|
1130
|
+
*/
|
|
1131
|
+
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
|
|
1132
|
+
}
|
|
1133
|
+
/**
|
|
1134
|
+
* The compute price payload for gas
|
|
1135
|
+
*/
|
|
1136
|
+
export interface ComputePriceParamsGas {
|
|
1103
1137
|
/**
|
|
1104
1138
|
* The postal code to search for providers
|
|
1105
1139
|
*/
|
|
@@ -1125,13 +1159,54 @@ declare namespace Components {
|
|
|
1125
1159
|
*/
|
|
1126
1160
|
association_id?: string;
|
|
1127
1161
|
/**
|
|
1128
|
-
* The
|
|
1162
|
+
* The billing period (defaults to monthly)
|
|
1129
1163
|
*/
|
|
1130
|
-
|
|
1164
|
+
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
|
|
1165
|
+
/**
|
|
1166
|
+
* The type of energy to compute the price
|
|
1167
|
+
*/
|
|
1168
|
+
type: "gas";
|
|
1169
|
+
/**
|
|
1170
|
+
* The concession type for gas
|
|
1171
|
+
*/
|
|
1172
|
+
concession_type?: "tarif_ka" | "sonder_ka";
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* The compute price payload for power
|
|
1176
|
+
*/
|
|
1177
|
+
export interface ComputePriceParamsPower {
|
|
1178
|
+
/**
|
|
1179
|
+
* The postal code to search for providers
|
|
1180
|
+
*/
|
|
1181
|
+
postal_code: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* The consumption type
|
|
1184
|
+
*/
|
|
1185
|
+
consumption_type?: "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
|
|
1186
|
+
/**
|
|
1187
|
+
* The monthly consumption to compute the price in kWh (to be deprecated in favor of consumption_HT)
|
|
1188
|
+
*/
|
|
1189
|
+
consumption: number;
|
|
1190
|
+
/**
|
|
1191
|
+
* The monthly HT consumption to compute the price in kWh
|
|
1192
|
+
*/
|
|
1193
|
+
consumption_HT?: number;
|
|
1194
|
+
/**
|
|
1195
|
+
* The monthly NT consumption to compute the price in kWh
|
|
1196
|
+
*/
|
|
1197
|
+
consumption_NT?: number;
|
|
1198
|
+
/**
|
|
1199
|
+
* The association id
|
|
1200
|
+
*/
|
|
1201
|
+
association_id?: string;
|
|
1131
1202
|
/**
|
|
1132
1203
|
* The billing period (defaults to monthly)
|
|
1133
1204
|
*/
|
|
1134
1205
|
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
|
|
1206
|
+
/**
|
|
1207
|
+
* The type of energy to compute the price
|
|
1208
|
+
*/
|
|
1209
|
+
type: "power";
|
|
1135
1210
|
}
|
|
1136
1211
|
export interface ComputePriceResult {
|
|
1137
1212
|
/**
|
|
@@ -2040,7 +2115,7 @@ declare namespace Components {
|
|
|
2040
2115
|
_tags?: string[];
|
|
2041
2116
|
}
|
|
2042
2117
|
export interface PriceGetAg {
|
|
2043
|
-
category:
|
|
2118
|
+
category: ProductCategory;
|
|
2044
2119
|
markup_pricing_model?: /**
|
|
2045
2120
|
* Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
|
|
2046
2121
|
* - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
|
|
@@ -2848,6 +2923,7 @@ declare namespace Components {
|
|
|
2848
2923
|
*/
|
|
2849
2924
|
_updated_at?: string;
|
|
2850
2925
|
}
|
|
2926
|
+
export type ProductCategory = "power" | "gas";
|
|
2851
2927
|
/**
|
|
2852
2928
|
* The provider entity
|
|
2853
2929
|
*/
|
package/dist/openapi.json
CHANGED
|
@@ -2742,8 +2742,7 @@
|
|
|
2742
2742
|
"SaveIntegrationCredentialsParams": {
|
|
2743
2743
|
"$ref": "#/components/schemas/BasicAuthCredentials"
|
|
2744
2744
|
},
|
|
2745
|
-
"
|
|
2746
|
-
"description": "The compute price payload",
|
|
2745
|
+
"ComputePriceParamsBase": {
|
|
2747
2746
|
"type": "object",
|
|
2748
2747
|
"properties": {
|
|
2749
2748
|
"postal_code": {
|
|
@@ -2777,14 +2776,6 @@
|
|
|
2777
2776
|
"description": "The association id",
|
|
2778
2777
|
"type": "string"
|
|
2779
2778
|
},
|
|
2780
|
-
"type": {
|
|
2781
|
-
"description": "The product type",
|
|
2782
|
-
"type": "string",
|
|
2783
|
-
"enum": [
|
|
2784
|
-
"power",
|
|
2785
|
-
"gas"
|
|
2786
|
-
]
|
|
2787
|
-
},
|
|
2788
2779
|
"billing_period": {
|
|
2789
2780
|
"description": "The billing period (defaults to monthly)",
|
|
2790
2781
|
"type": "string",
|
|
@@ -2798,11 +2789,64 @@
|
|
|
2798
2789
|
],
|
|
2799
2790
|
"default": "monthly"
|
|
2800
2791
|
}
|
|
2801
|
-
}
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2792
|
+
}
|
|
2793
|
+
},
|
|
2794
|
+
"ComputePriceParamsPower": {
|
|
2795
|
+
"allOf": [
|
|
2796
|
+
{
|
|
2797
|
+
"$ref": "#/components/schemas/ComputePriceParamsBase"
|
|
2798
|
+
},
|
|
2799
|
+
{
|
|
2800
|
+
"type": "object",
|
|
2801
|
+
"properties": {
|
|
2802
|
+
"type": {
|
|
2803
|
+
"type": "string",
|
|
2804
|
+
"description": "The type of energy to compute the price",
|
|
2805
|
+
"enum": [
|
|
2806
|
+
"power"
|
|
2807
|
+
]
|
|
2808
|
+
}
|
|
2809
|
+
},
|
|
2810
|
+
"description": "The compute price payload for power",
|
|
2811
|
+
"required": [
|
|
2812
|
+
"type",
|
|
2813
|
+
"postal_code",
|
|
2814
|
+
"consumption"
|
|
2815
|
+
]
|
|
2816
|
+
}
|
|
2817
|
+
]
|
|
2818
|
+
},
|
|
2819
|
+
"ComputePriceParamsGas": {
|
|
2820
|
+
"allOf": [
|
|
2821
|
+
{
|
|
2822
|
+
"$ref": "#/components/schemas/ComputePriceParamsBase"
|
|
2823
|
+
},
|
|
2824
|
+
{
|
|
2825
|
+
"type": "object",
|
|
2826
|
+
"properties": {
|
|
2827
|
+
"type": {
|
|
2828
|
+
"type": "string",
|
|
2829
|
+
"description": "The type of energy to compute the price",
|
|
2830
|
+
"enum": [
|
|
2831
|
+
"gas"
|
|
2832
|
+
]
|
|
2833
|
+
},
|
|
2834
|
+
"concession_type": {
|
|
2835
|
+
"description": "The concession type for gas",
|
|
2836
|
+
"type": "string",
|
|
2837
|
+
"enum": [
|
|
2838
|
+
"tarif_ka",
|
|
2839
|
+
"sonder_ka"
|
|
2840
|
+
]
|
|
2841
|
+
}
|
|
2842
|
+
},
|
|
2843
|
+
"description": "The compute price payload for gas",
|
|
2844
|
+
"required": [
|
|
2845
|
+
"type",
|
|
2846
|
+
"postal_code",
|
|
2847
|
+
"consumption"
|
|
2848
|
+
]
|
|
2849
|
+
}
|
|
2806
2850
|
]
|
|
2807
2851
|
},
|
|
2808
2852
|
"SignatureMeta": {
|
|
@@ -2841,6 +2885,17 @@
|
|
|
2841
2885
|
"amount_decimal"
|
|
2842
2886
|
]
|
|
2843
2887
|
},
|
|
2888
|
+
"ComputePriceParams": {
|
|
2889
|
+
"description": "The compute price payload",
|
|
2890
|
+
"oneOf": [
|
|
2891
|
+
{
|
|
2892
|
+
"$ref": "#/components/schemas/ComputePriceParamsPower"
|
|
2893
|
+
},
|
|
2894
|
+
{
|
|
2895
|
+
"$ref": "#/components/schemas/ComputePriceParamsGas"
|
|
2896
|
+
}
|
|
2897
|
+
]
|
|
2898
|
+
},
|
|
2844
2899
|
"ComputedPriceBreakdown": {
|
|
2845
2900
|
"type": "object",
|
|
2846
2901
|
"description": "Price breakdown",
|
|
@@ -4588,11 +4643,18 @@
|
|
|
4588
4643
|
"night_storage_heating_common_meter"
|
|
4589
4644
|
]
|
|
4590
4645
|
},
|
|
4646
|
+
"ProductCategory": {
|
|
4647
|
+
"type": "string",
|
|
4648
|
+
"enum": [
|
|
4649
|
+
"power",
|
|
4650
|
+
"gas"
|
|
4651
|
+
]
|
|
4652
|
+
},
|
|
4591
4653
|
"PriceGetAg": {
|
|
4592
4654
|
"type": "object",
|
|
4593
4655
|
"properties": {
|
|
4594
4656
|
"category": {
|
|
4595
|
-
"
|
|
4657
|
+
"$ref": "#/components/schemas/ProductCategory"
|
|
4596
4658
|
},
|
|
4597
4659
|
"markup_pricing_model": {
|
|
4598
4660
|
"$ref": "#/components/schemas/MarkupPricingModel"
|