@epilot/pricing-client 3.35.14 → 3.35.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.d.ts CHANGED
@@ -97,6 +97,18 @@ declare namespace Components {
97
97
  * The cashback amount as a string with all the decimal places.
98
98
  */
99
99
  cashback_amount_decimal?: string;
100
+ /**
101
+ * The cashback period, for now it's limited to either 0 months or 12 months
102
+ */
103
+ cashback_period?: "0" | "12";
104
+ /**
105
+ * Total amount after cashback is applied.
106
+ */
107
+ after_cashback_amount_total?: number;
108
+ /**
109
+ * Total amount after cashback is applied as a string with all the decimal places.
110
+ */
111
+ after_cashback_amount_total_decimal?: string;
100
112
  /**
101
113
  * The discount percentage, if the applied coupon had a percentage type.
102
114
  */
@@ -244,6 +256,18 @@ declare namespace Components {
244
256
  * The cashback amount as a string with all the decimal places.
245
257
  */
246
258
  cashback_amount_decimal?: string;
259
+ /**
260
+ * The cashback period, for now it's limited to either 0 months or 12 months
261
+ */
262
+ cashback_period?: "0" | "12";
263
+ /**
264
+ * Total amount after cashback is applied.
265
+ */
266
+ after_cashback_amount_total?: number;
267
+ /**
268
+ * Total amount after cashback is applied as a string with all the decimal places.
269
+ */
270
+ after_cashback_amount_total_decimal?: string;
247
271
  /**
248
272
  * The discount percentage, if the applied coupon had a percentage type.
249
273
  */
@@ -907,6 +931,18 @@ declare namespace Components {
907
931
  * The cashback amount as a string with all the decimal places.
908
932
  */
909
933
  cashback_amount_decimal?: string;
934
+ /**
935
+ * The cashback period, for now it's limited to either 0 months or 12 months
936
+ */
937
+ cashback_period?: "0" | "12";
938
+ /**
939
+ * Total amount after cashback is applied.
940
+ */
941
+ after_cashback_amount_total?: number;
942
+ /**
943
+ * Total amount after cashback is applied as a string with all the decimal places.
944
+ */
945
+ after_cashback_amount_total_decimal?: string;
910
946
  /**
911
947
  * The discount percentage, if the applied coupon had a percentage type.
912
948
  */
@@ -996,6 +1032,19 @@ declare namespace Components {
996
1032
  [name: string]: any;
997
1033
  };
998
1034
  }
1035
+ /**
1036
+ * An amount associated with a specific cashback period.
1037
+ */
1038
+ export interface CashbackAmount {
1039
+ /**
1040
+ * The cashback period, for now it's limited to either 0 months or 12 months
1041
+ */
1042
+ cashback_period?: "0" | "12";
1043
+ /**
1044
+ * The sum of all cashbacks for a specific cashback period
1045
+ */
1046
+ amount_total?: number;
1047
+ }
999
1048
  /**
1000
1049
  * A catalog search payload
1001
1050
  * example:
@@ -1231,6 +1280,18 @@ declare namespace Components {
1231
1280
  * The cashback amount as a string with all the decimal places.
1232
1281
  */
1233
1282
  cashback_amount_decimal?: string;
1283
+ /**
1284
+ * The cashback period, for now it's limited to either 0 months or 12 months
1285
+ */
1286
+ cashback_period?: "0" | "12";
1287
+ /**
1288
+ * Total amount after cashback is applied.
1289
+ */
1290
+ after_cashback_amount_total?: number;
1291
+ /**
1292
+ * Total amount after cashback is applied as a string with all the decimal places.
1293
+ */
1294
+ after_cashback_amount_total_decimal?: string;
1234
1295
  /**
1235
1296
  * The discount percentage, if the applied coupon had a percentage type.
1236
1297
  */
@@ -1992,6 +2053,10 @@ declare namespace Components {
1992
2053
  * EUR
1993
2054
  */
1994
2055
  Currency;
2056
+ /**
2057
+ * The cashback period, for now it's limited to either 0 months or 12 months
2058
+ */
2059
+ cashback_period?: "0" | "12";
1995
2060
  active?: boolean;
1996
2061
  /**
1997
2062
  * The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.
@@ -2082,70 +2147,6 @@ declare namespace Components {
2082
2147
  pricing_details: /* The result from the calculation of a set of price items. */ PricingDetails;
2083
2148
  _meta: /* Signature meta data payload */ SignatureMeta;
2084
2149
  }
2085
- export interface ExternalCompositePrice {
2086
- /**
2087
- * Fees structure with static and variable amounts
2088
- */
2089
- fees?: {
2090
- billing_period: BillingPeriod;
2091
- /**
2092
- * example:
2093
- * 1.00
2094
- */
2095
- amount_total_decimal: string;
2096
- /**
2097
- * example:
2098
- * 1.00
2099
- */
2100
- amount_static_decimal: string;
2101
- /**
2102
- * example:
2103
- * 1.00
2104
- */
2105
- amount_variable_decimal: string;
2106
- /**
2107
- * Breakdown of the fee values
2108
- */
2109
- breakdown: {
2110
- /**
2111
- * Static breakdown of fees
2112
- */
2113
- static?: {
2114
- [name: string]: {
2115
- /**
2116
- * The amount of the fee, as a string with all the decimal places.
2117
- * example:
2118
- * 1.00
2119
- */
2120
- amount_decimal?: string;
2121
- };
2122
- };
2123
- /**
2124
- * Variable breakdown of fees
2125
- */
2126
- variable?: {
2127
- [name: string]: {
2128
- /**
2129
- * example:
2130
- * 1.00
2131
- */
2132
- amount_decimal: string;
2133
- /**
2134
- * The unit of the fee (e.g. kWh) if applicable.
2135
- */
2136
- unit?: string;
2137
- };
2138
- };
2139
- };
2140
- };
2141
- /**
2142
- * The name of the composite price.
2143
- */
2144
- name?: string;
2145
- is_composite_price: true;
2146
- price_components: ExternalSimplePrice[];
2147
- total_details: /* Details of the total price including shipping and tax amounts. */ ExternalPriceTotalDetails;
2148
- }
2149
2150
  /**
2150
2151
  * example:
2151
2152
  * {
@@ -2236,278 +2237,6 @@ declare namespace Components {
2236
2237
  [name: string]: any;
2237
2238
  };
2238
2239
  }
2239
- export interface ExternalPriceFees {
2240
- /**
2241
- * Fees structure with static and variable amounts
2242
- */
2243
- fees?: {
2244
- /**
2245
- * The billing period of the fee values (e.g. monthly).
2246
- */
2247
- billing_period: BillingPeriod;
2248
- /**
2249
- * example:
2250
- * 1.00
2251
- */
2252
- amount_total_decimal: string;
2253
- /**
2254
- * example:
2255
- * 1.00
2256
- */
2257
- amount_static_decimal: string;
2258
- /**
2259
- * example:
2260
- * 1.00
2261
- */
2262
- amount_variable_decimal: string;
2263
- /**
2264
- * Breakdown of the fee values
2265
- */
2266
- breakdown: {
2267
- /**
2268
- * Static breakdown of fees
2269
- */
2270
- static?: {
2271
- [name: string]: {
2272
- /**
2273
- * The amount of the fee, as a string with all the decimal places.
2274
- * example:
2275
- * 1.00
2276
- */
2277
- amount_decimal?: string;
2278
- };
2279
- };
2280
- /**
2281
- * Variable breakdown of fees
2282
- */
2283
- variable?: {
2284
- [name: string]: {
2285
- /**
2286
- * example:
2287
- * 1.00
2288
- */
2289
- amount_decimal: string;
2290
- /**
2291
- * The unit of the fee (e.g. kWh) if applicable.
2292
- */
2293
- unit?: string;
2294
- };
2295
- };
2296
- };
2297
- };
2298
- }
2299
- /**
2300
- * Details of the total price including shipping and tax amounts.
2301
- */
2302
- export interface ExternalPriceTotalDetails {
2303
- /**
2304
- * A breakdown of the recurrences of amounts.
2305
- */
2306
- breakdown: {
2307
- recurrences?: {
2308
- /**
2309
- * Total of all items before discounts or taxes, as a string with all the decimal places.
2310
- * example:
2311
- * 1.00
2312
- */
2313
- amount_subtotal_decimal: string;
2314
- /**
2315
- * Total of all items after discounts and taxes, as a string with all the decimal places.
2316
- * example:
2317
- * 1.19
2318
- */
2319
- amount_total_decimal: string;
2320
- /**
2321
- * The price type.
2322
- * example:
2323
- * one_time
2324
- */
2325
- type: "one_time" | "recurring";
2326
- /**
2327
- * The billing period of the price.
2328
- */
2329
- billing_period?: BillingPeriod;
2330
- }[];
2331
- };
2332
- }
2333
- export interface ExternalSimplePrice {
2334
- /**
2335
- * Fees structure with static and variable amounts
2336
- */
2337
- fees?: {
2338
- billing_period: BillingPeriod;
2339
- /**
2340
- * example:
2341
- * 1.00
2342
- */
2343
- amount_total_decimal: string;
2344
- /**
2345
- * example:
2346
- * 1.00
2347
- */
2348
- amount_static_decimal: string;
2349
- /**
2350
- * example:
2351
- * 1.00
2352
- */
2353
- amount_variable_decimal: string;
2354
- /**
2355
- * Breakdown of the fee values
2356
- */
2357
- breakdown: {
2358
- /**
2359
- * Static breakdown of fees
2360
- */
2361
- static?: {
2362
- [name: string]: {
2363
- /**
2364
- * The amount of the fee, as a string with all the decimal places.
2365
- * example:
2366
- * 1.00
2367
- */
2368
- amount_decimal?: string;
2369
- };
2370
- };
2371
- /**
2372
- * Variable breakdown of fees
2373
- */
2374
- variable?: {
2375
- [name: string]: {
2376
- /**
2377
- * example:
2378
- * 1.00
2379
- */
2380
- amount_decimal: string;
2381
- /**
2382
- * The unit of the fee (e.g. kWh) if applicable.
2383
- */
2384
- unit?: string;
2385
- };
2386
- };
2387
- };
2388
- };
2389
- is_composite_price: false;
2390
- /**
2391
- * A flag to indicate if the price is variable.
2392
- *
2393
- */
2394
- variable_price?: boolean;
2395
- /**
2396
- * The name of the price.
2397
- */
2398
- name?: string;
2399
- /**
2400
- * The unit of measurement used for display purposes and possibly for calculations when the price is variable.
2401
- * example:
2402
- * kWh
2403
- */
2404
- unit?: string;
2405
- /**
2406
- * The currency of the price. ISO 4217 currency code. E.g. EUR.
2407
- * example:
2408
- * EUR
2409
- */
2410
- currency?: string;
2411
- /**
2412
- * The price type.
2413
- */
2414
- type: "one_time" | "recurring";
2415
- billing_period?: BillingPeriod;
2416
- /**
2417
- * The billing period duration
2418
- */
2419
- billing_duration_amount?: number;
2420
- /**
2421
- * The billing period duration unit
2422
- */
2423
- billing_duration_unit?: "weeks" | "months" | "years";
2424
- /**
2425
- * The notice period duration
2426
- */
2427
- notice_time_amount?: number;
2428
- /**
2429
- * The notice period duration unit
2430
- */
2431
- notice_time_unit?: "weeks" | "months" | "years";
2432
- /**
2433
- * The termination period duration
2434
- */
2435
- termination_time_amount?: number;
2436
- /**
2437
- * The termination period duration unit
2438
- */
2439
- termination_time_unit?: "weeks" | "months" | "years";
2440
- /**
2441
- * The renewal period duration
2442
- */
2443
- renewal_duration_amount?: number;
2444
- /**
2445
- * The renewal period duration unit
2446
- */
2447
- renewal_duration_unit?: "weeks" | "months" | "years";
2448
- /**
2449
- * The unit gross amount value, as a string with all the decimal places.
2450
- * example:
2451
- * 1.19
2452
- */
2453
- unit_amount_gross_decimal: string;
2454
- /**
2455
- * The unit net amount value, as a string with all the decimal places.
2456
- * example:
2457
- * 1.00
2458
- */
2459
- unit_amount_net_decimal: string;
2460
- /**
2461
- * Total of all items before discounts or taxes, as a string with all the decimal places.
2462
- * example:
2463
- * 1.00
2464
- */
2465
- amount_subtotal_decimal: string;
2466
- /**
2467
- * Total of all items after discounts and taxes, as a string with all the decimal places.
2468
- * example:
2469
- * 1.19
2470
- */
2471
- amount_total_decimal: string;
2472
- tax?: {
2473
- /**
2474
- * The tax name.
2475
- * example:
2476
- * VAT
2477
- */
2478
- name?: string;
2479
- /**
2480
- * The tax description.
2481
- * example:
2482
- * Value Added Tax
2483
- */
2484
- description?: string;
2485
- /**
2486
- * The type of the tax.
2487
- * example:
2488
- * VAT
2489
- */
2490
- type?: "VAT" | "GST" | "Custom";
2491
- /**
2492
- * The tax rate applied.
2493
- * example:
2494
- * 19
2495
- */
2496
- rate: number;
2497
- /**
2498
- * The region code of the tax.
2499
- * example:
2500
- * DE
2501
- */
2502
- region?: string;
2503
- /**
2504
- * The region label of the tax.
2505
- * example:
2506
- * Germany
2507
- */
2508
- region_label?: string;
2509
- };
2510
- }
2511
2240
  export interface File {
2512
2241
  [name: string]: any;
2513
2242
  _id: string;
@@ -3355,6 +3084,18 @@ declare namespace Components {
3355
3084
  * The cashback amount as a string with all the decimal places.
3356
3085
  */
3357
3086
  cashback_amount_decimal?: string;
3087
+ /**
3088
+ * The cashback period, for now it's limited to either 0 months or 12 months
3089
+ */
3090
+ cashback_period?: "0" | "12";
3091
+ /**
3092
+ * Total amount after cashback is applied.
3093
+ */
3094
+ after_cashback_amount_total?: number;
3095
+ /**
3096
+ * Total amount after cashback is applied as a string with all the decimal places.
3097
+ */
3098
+ after_cashback_amount_total_decimal?: string;
3358
3099
  /**
3359
3100
  * The discount percentage, if the applied coupon had a percentage type.
3360
3101
  */
@@ -4346,6 +4087,18 @@ declare namespace Components {
4346
4087
  * The cashback amount as a string with all the decimal places.
4347
4088
  */
4348
4089
  cashback_amount_decimal?: string;
4090
+ /**
4091
+ * The cashback period, for now it's limited to either 0 months or 12 months
4092
+ */
4093
+ cashback_period?: "0" | "12";
4094
+ /**
4095
+ * Total amount after cashback is applied.
4096
+ */
4097
+ after_cashback_amount_total?: number;
4098
+ /**
4099
+ * Total amount after cashback is applied as a string with all the decimal places.
4100
+ */
4101
+ after_cashback_amount_total_decimal?: string;
4349
4102
  /**
4350
4103
  * The discount percentage, if the applied coupon had a percentage type.
4351
4104
  */
@@ -4423,6 +4176,18 @@ declare namespace Components {
4423
4176
  * The cashback amount as a string with all the decimal places.
4424
4177
  */
4425
4178
  cashback_amount_decimal?: string;
4179
+ /**
4180
+ * The cashback period, for now it's limited to either 0 months or 12 months
4181
+ */
4182
+ cashback_period?: "0" | "12";
4183
+ /**
4184
+ * Total amount after cashback is applied.
4185
+ */
4186
+ after_cashback_amount_total?: number;
4187
+ /**
4188
+ * Total amount after cashback is applied as a string with all the decimal places.
4189
+ */
4190
+ after_cashback_amount_total_decimal?: string;
4426
4191
  /**
4427
4192
  * The discount percentage, if the applied coupon had a percentage type.
4428
4193
  */
@@ -4744,6 +4509,10 @@ declare namespace Components {
4744
4509
  * The aggregated price items tax amount per rate.
4745
4510
  */
4746
4511
  recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
4512
+ /**
4513
+ * The list of cashback sums for each cashback period.
4514
+ */
4515
+ cashbacks?: (/* An amount associated with a specific cashback period. */ CashbackAmount)[];
4747
4516
  /**
4748
4517
  * The aggregated price items recurrences by tax rate
4749
4518
  */
@@ -5471,6 +5240,7 @@ export type BasicAuthCredentials = Components.Schemas.BasicAuthCredentials;
5471
5240
  export type BillingPeriod = Components.Schemas.BillingPeriod;
5472
5241
  export type Cart = Components.Schemas.Cart;
5473
5242
  export type CartDto = Components.Schemas.CartDto;
5243
+ export type CashbackAmount = Components.Schemas.CashbackAmount;
5474
5244
  export type CatalogSearch = Components.Schemas.CatalogSearch;
5475
5245
  export type CatalogSearchResult = Components.Schemas.CatalogSearchResult;
5476
5246
  export type CheckoutCart = Components.Schemas.CheckoutCart;
@@ -5496,13 +5266,9 @@ export type EntityItem = Components.Schemas.EntityItem;
5496
5266
  export type EntityRelation = Components.Schemas.EntityRelation;
5497
5267
  export type Error = Components.Schemas.Error;
5498
5268
  export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
5499
- export type ExternalCompositePrice = Components.Schemas.ExternalCompositePrice;
5500
5269
  export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
5501
5270
  export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
5502
5271
  export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
5503
- export type ExternalPriceFees = Components.Schemas.ExternalPriceFees;
5504
- export type ExternalPriceTotalDetails = Components.Schemas.ExternalPriceTotalDetails;
5505
- export type ExternalSimplePrice = Components.Schemas.ExternalSimplePrice;
5506
5272
  export type File = Components.Schemas.File;
5507
5273
  export type GasConcessionType = Components.Schemas.GasConcessionType;
5508
5274
  export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
package/dist/openapi.json CHANGED
@@ -4099,6 +4099,24 @@
4099
4099
  "description": "The cashback amount as a string with all the decimal places.",
4100
4100
  "readOnly": true
4101
4101
  },
4102
+ "cashback_period": {
4103
+ "type": "string",
4104
+ "description": "The cashback period, for now it's limited to either 0 months or 12 months",
4105
+ "enum": [
4106
+ "0",
4107
+ "12"
4108
+ ]
4109
+ },
4110
+ "after_cashback_amount_total": {
4111
+ "type": "integer",
4112
+ "description": "Total amount after cashback is applied.",
4113
+ "readOnly": true
4114
+ },
4115
+ "after_cashback_amount_total_decimal": {
4116
+ "type": "string",
4117
+ "description": "Total amount after cashback is applied as a string with all the decimal places.",
4118
+ "readOnly": true
4119
+ },
4102
4120
  "discount_percentage": {
4103
4121
  "type": "integer",
4104
4122
  "description": "The discount percentage, if the applied coupon had a percentage type.",
@@ -4267,6 +4285,24 @@
4267
4285
  "amount_total_decimal"
4268
4286
  ]
4269
4287
  },
4288
+ "CashbackAmount": {
4289
+ "type": "object",
4290
+ "description": "An amount associated with a specific cashback period.",
4291
+ "properties": {
4292
+ "cashback_period": {
4293
+ "type": "string",
4294
+ "description": "The cashback period, for now it's limited to either 0 months or 12 months",
4295
+ "enum": [
4296
+ "0",
4297
+ "12"
4298
+ ]
4299
+ },
4300
+ "amount_total": {
4301
+ "type": "integer",
4302
+ "description": "The sum of all cashbacks for a specific cashback period"
4303
+ }
4304
+ }
4305
+ },
4270
4306
  "RecurrenceAmountWithTax": {
4271
4307
  "type": "object",
4272
4308
  "description": "An amount associated with a specific recurrence.",
@@ -4354,6 +4390,17 @@
4354
4390
  ]
4355
4391
  }
4356
4392
  },
4393
+ "cashbacks": {
4394
+ "type": "array",
4395
+ "description": "The list of cashback sums for each cashback period.",
4396
+ "items": {
4397
+ "oneOf": [
4398
+ {
4399
+ "$ref": "#/components/schemas/CashbackAmount"
4400
+ }
4401
+ ]
4402
+ }
4403
+ },
4357
4404
  "recurrencesByTax": {
4358
4405
  "type": "array",
4359
4406
  "description": "The aggregated price items recurrences by tax rate",
@@ -4986,6 +5033,14 @@
4986
5033
  }
4987
5034
  ]
4988
5035
  },
5036
+ "cashback_period": {
5037
+ "type": "string",
5038
+ "description": "The cashback period, for now it's limited to either 0 months or 12 months",
5039
+ "enum": [
5040
+ "0",
5041
+ "12"
5042
+ ]
5043
+ },
4989
5044
  "active": {
4990
5045
  "type": "boolean"
4991
5046
  },
@@ -5373,344 +5428,6 @@
5373
5428
  "pricing_details",
5374
5429
  "_meta"
5375
5430
  ]
5376
- },
5377
- "ExternalPriceFees": {
5378
- "type": "object",
5379
- "properties": {
5380
- "fees": {
5381
- "type": "object",
5382
- "description": "Fees structure with static and variable amounts",
5383
- "properties": {
5384
- "billing_period": {
5385
- "$ref": "#/components/schemas/BillingPeriod",
5386
- "description": "The billing period of the fee values (e.g. monthly)."
5387
- },
5388
- "amount_total_decimal": {
5389
- "type": "string",
5390
- "example": "1.00"
5391
- },
5392
- "amount_static_decimal": {
5393
- "type": "string",
5394
- "example": "1.00"
5395
- },
5396
- "amount_variable_decimal": {
5397
- "type": "string",
5398
- "example": "1.00"
5399
- },
5400
- "breakdown": {
5401
- "type": "object",
5402
- "description": "Breakdown of the fee values",
5403
- "properties": {
5404
- "static": {
5405
- "type": "object",
5406
- "description": "Static breakdown of fees",
5407
- "additionalProperties": {
5408
- "type": "object",
5409
- "properties": {
5410
- "amount_decimal": {
5411
- "type": "string",
5412
- "description": "The amount of the fee, as a string with all the decimal places.",
5413
- "example": "1.00"
5414
- }
5415
- }
5416
- },
5417
- "required": [
5418
- "amount_decimal"
5419
- ]
5420
- },
5421
- "variable": {
5422
- "type": "object",
5423
- "description": "Variable breakdown of fees",
5424
- "additionalProperties": {
5425
- "type": "object",
5426
- "properties": {
5427
- "amount_decimal": {
5428
- "type": "string",
5429
- "example": "1.00"
5430
- },
5431
- "unit": {
5432
- "type": "string",
5433
- "description": "The unit of the fee (e.g. kWh) if applicable."
5434
- }
5435
- },
5436
- "required": [
5437
- "amount_decimal"
5438
- ]
5439
- }
5440
- }
5441
- }
5442
- }
5443
- },
5444
- "required": [
5445
- "billing_period",
5446
- "amount_total_decimal",
5447
- "amount_static_decimal",
5448
- "amount_variable_decimal",
5449
- "breakdown"
5450
- ]
5451
- }
5452
- }
5453
- },
5454
- "ExternalSimplePrice": {
5455
- "allOf": [
5456
- {
5457
- "$ref": "#/components/schemas/ExternalPriceFees"
5458
- },
5459
- {
5460
- "type": "object",
5461
- "properties": {
5462
- "is_composite_price": {
5463
- "type": "boolean",
5464
- "enum": [
5465
- false
5466
- ]
5467
- },
5468
- "variable_price": {
5469
- "type": "boolean",
5470
- "description": "A flag to indicate if the price is variable.\n"
5471
- },
5472
- "name": {
5473
- "type": "string",
5474
- "description": "The name of the price."
5475
- },
5476
- "unit": {
5477
- "description": "The unit of measurement used for display purposes and possibly for calculations when the price is variable.",
5478
- "type": "string",
5479
- "example": "kWh"
5480
- },
5481
- "currency": {
5482
- "type": "string",
5483
- "description": "The currency of the price. ISO 4217 currency code. E.g. EUR.",
5484
- "default": "EUR",
5485
- "example": "EUR"
5486
- },
5487
- "type": {
5488
- "type": "string",
5489
- "description": "The price type.",
5490
- "enum": [
5491
- "one_time",
5492
- "recurring"
5493
- ]
5494
- },
5495
- "billing_period": {
5496
- "$ref": "#/components/schemas/BillingPeriod",
5497
- "description": "The billing period of the price."
5498
- },
5499
- "billing_duration_amount": {
5500
- "description": "The billing period duration",
5501
- "type": "number"
5502
- },
5503
- "billing_duration_unit": {
5504
- "description": "The billing period duration unit",
5505
- "type": "string",
5506
- "enum": [
5507
- "weeks",
5508
- "months",
5509
- "years"
5510
- ]
5511
- },
5512
- "notice_time_amount": {
5513
- "description": "The notice period duration",
5514
- "type": "number"
5515
- },
5516
- "notice_time_unit": {
5517
- "description": "The notice period duration unit",
5518
- "type": "string",
5519
- "enum": [
5520
- "weeks",
5521
- "months",
5522
- "years"
5523
- ]
5524
- },
5525
- "termination_time_amount": {
5526
- "description": "The termination period duration",
5527
- "type": "number"
5528
- },
5529
- "termination_time_unit": {
5530
- "description": "The termination period duration unit",
5531
- "type": "string",
5532
- "enum": [
5533
- "weeks",
5534
- "months",
5535
- "years"
5536
- ]
5537
- },
5538
- "renewal_duration_amount": {
5539
- "description": "The renewal period duration",
5540
- "type": "number"
5541
- },
5542
- "renewal_duration_unit": {
5543
- "description": "The renewal period duration unit",
5544
- "type": "string",
5545
- "enum": [
5546
- "weeks",
5547
- "months",
5548
- "years"
5549
- ]
5550
- },
5551
- "unit_amount_gross_decimal": {
5552
- "type": "string",
5553
- "example": "1.19",
5554
- "description": "The unit gross amount value, as a string with all the decimal places."
5555
- },
5556
- "unit_amount_net_decimal": {
5557
- "type": "string",
5558
- "description": "The unit net amount value, as a string with all the decimal places.",
5559
- "example": "1.00"
5560
- },
5561
- "amount_subtotal_decimal": {
5562
- "type": "string",
5563
- "description": "Total of all items before discounts or taxes, as a string with all the decimal places.",
5564
- "example": "1.00"
5565
- },
5566
- "amount_total_decimal": {
5567
- "type": "string",
5568
- "description": "Total of all items after discounts and taxes, as a string with all the decimal places.",
5569
- "example": "1.19"
5570
- },
5571
- "tax": {
5572
- "type": "object",
5573
- "properties": {
5574
- "name": {
5575
- "type": "string",
5576
- "description": "The tax name.",
5577
- "example": "VAT"
5578
- },
5579
- "description": {
5580
- "type": "string",
5581
- "description": "The tax description.",
5582
- "example": "Value Added Tax"
5583
- },
5584
- "type": {
5585
- "type": "string",
5586
- "enum": [
5587
- "VAT",
5588
- "GST",
5589
- "Custom"
5590
- ],
5591
- "description": "The type of the tax.",
5592
- "example": "VAT"
5593
- },
5594
- "rate": {
5595
- "type": "number",
5596
- "description": "The tax rate applied.",
5597
- "example": 19
5598
- },
5599
- "region": {
5600
- "type": "string",
5601
- "description": "The region code of the tax.",
5602
- "example": "DE"
5603
- },
5604
- "region_label": {
5605
- "type": "string",
5606
- "description": "The region label of the tax.",
5607
- "example": "Germany"
5608
- }
5609
- },
5610
- "required": [
5611
- "rate"
5612
- ]
5613
- }
5614
- },
5615
- "required": [
5616
- "is_composite_price",
5617
- "type",
5618
- "unit_amount_decimal",
5619
- "unit_amount_gross_decimal",
5620
- "unit_amount_net_decimal",
5621
- "amount_subtotal_decimal",
5622
- "amount_total_decimal"
5623
- ]
5624
- }
5625
- ]
5626
- },
5627
- "ExternalCompositePrice": {
5628
- "allOf": [
5629
- {
5630
- "$ref": "#/components/schemas/ExternalPriceFees"
5631
- },
5632
- {
5633
- "type": "object",
5634
- "properties": {
5635
- "name": {
5636
- "type": "string",
5637
- "description": "The name of the composite price."
5638
- },
5639
- "is_composite_price": {
5640
- "type": "boolean",
5641
- "enum": [
5642
- true
5643
- ]
5644
- },
5645
- "price_components": {
5646
- "type": "array",
5647
- "items": {
5648
- "$ref": "#/components/schemas/ExternalSimplePrice"
5649
- }
5650
- },
5651
- "total_details": {
5652
- "$ref": "#/components/schemas/ExternalPriceTotalDetails"
5653
- }
5654
- },
5655
- "required": [
5656
- "is_composite_price",
5657
- "price_components",
5658
- "total_details"
5659
- ]
5660
- }
5661
- ]
5662
- },
5663
- "ExternalPriceTotalDetails": {
5664
- "type": "object",
5665
- "description": "Details of the total price including shipping and tax amounts.",
5666
- "properties": {
5667
- "breakdown": {
5668
- "type": "object",
5669
- "description": "A breakdown of the recurrences of amounts.",
5670
- "properties": {
5671
- "recurrences": {
5672
- "type": "array",
5673
- "items": {
5674
- "type": "object",
5675
- "description": "Recurrence details including subtotal, total, and tax amounts.",
5676
- "properties": {
5677
- "amount_subtotal_decimal": {
5678
- "type": "string",
5679
- "description": "Total of all items before discounts or taxes, as a string with all the decimal places.",
5680
- "example": "1.00"
5681
- },
5682
- "amount_total_decimal": {
5683
- "type": "string",
5684
- "description": "Total of all items after discounts and taxes, as a string with all the decimal places.",
5685
- "example": "1.19"
5686
- },
5687
- "type": {
5688
- "type": "string",
5689
- "enum": [
5690
- "one_time",
5691
- "recurring"
5692
- ],
5693
- "description": "The price type.",
5694
- "example": "one_time"
5695
- },
5696
- "billing_period": {
5697
- "$ref": "#/components/schemas/BillingPeriod",
5698
- "description": "The billing period of the price."
5699
- }
5700
- },
5701
- "required": [
5702
- "amount_subtotal_decimal",
5703
- "amount_total_decimal",
5704
- "type"
5705
- ]
5706
- }
5707
- }
5708
- }
5709
- }
5710
- },
5711
- "required": [
5712
- "breakdown"
5713
- ]
5714
5431
  }
5715
5432
  },
5716
5433
  "examples": {
@@ -6822,7 +6539,7 @@
6822
6539
  "_schema": "tax",
6823
6540
  "_title": "Tax Without Behaviour",
6824
6541
  "description": "Without Behaviour",
6825
- "rate": 6,
6542
+ "rate": "6",
6826
6543
  "_org": "739224",
6827
6544
  "_created_at": "2022-02-07T14:49:08.831Z",
6828
6545
  "_updated_at": "2022-02-07T14:49:08.831Z"
@@ -7221,108 +6938,92 @@
7221
6938
  }
7222
6939
  },
7223
6940
  "external-catalog-sample-1": {
7224
- "value": [
7225
- {
7226
- "id": "12312414",
7227
- "name": "Home Energy Package",
7228
- "description": "Composite home energy solution with solar panels and battery",
7229
- "features": [
7230
- "4kW solar system",
7231
- "10kWh battery storage",
7232
- "Smart energy management"
7233
- ],
7234
- "product_image_urls": [
7235
- "https://example.com/images/home-energy-package.jpg"
7236
- ],
7237
- "legal_footnotes": "Installation and permitting fees may vary by location.",
7238
- "price": {
7239
- "name": "Home Energy Package",
7240
- "is_composite_price": true,
7241
- "price_components": [
7242
- {
7243
- "name": "Working Price",
7244
- "type": "recurring",
7245
- "billing_period": "monthly",
7246
- "variable_price": true,
7247
- "unit": "kWh",
7248
- "amount_subtotal_decimal": "11.244355742297",
7249
- "amount_total_decimal": "13.380783333333",
7250
- "unit_amount_net_decimal": "11.24",
7251
- "unit_amount_gross_decimal": "13.38",
7252
- "currency": "EUR",
7253
- "tax": {
7254
- "name": "tax",
7255
- "type": "VAT",
7256
- "rate": 19,
7257
- "region": "DE"
6941
+ "value": {
6942
+ "hits": 1,
6943
+ "results": [
6944
+ {
6945
+ "pricing_details": {
6946
+ "items": [
6947
+ {
6948
+ "_id": "price-12312414",
6949
+ "price_id": "price-12312414",
6950
+ "is_composite_price": true,
6951
+ "description": "Home Energy Package Composite",
6952
+ "item_components": [
6953
+ {
6954
+ "_id": "price-12312414-component-0",
6955
+ "price_id": "price-12312414-component-0",
6956
+ "description": "Working Price",
6957
+ "is_tax_inclusive": true,
6958
+ "amount_total_decimal": "100",
6959
+ "amount_total": 10000,
6960
+ "amount_subtotal_decimal": "100",
6961
+ "amount_subtotal": 10000,
6962
+ "unit_amount": 10,
6963
+ "unit_amount_gross": 10,
6964
+ "unit_amount_gross_decimal": "0.10",
6965
+ "unit_amount_net": 10,
6966
+ "unit_amount_net_decimal": "0.10",
6967
+ "billing_period": "monthly",
6968
+ "type": "recurring",
6969
+ "taxes": [],
6970
+ "pricing_model": "per_unit",
6971
+ "quantity": 1,
6972
+ "_price": {
6973
+ "_id": "price-12312414-component-0",
6974
+ "unit_amount_currency": "EUR",
6975
+ "description": "Working Price",
6976
+ "is_tax_inclusive": true,
6977
+ "unit_amount": 10,
6978
+ "unit_amount_decimal": "0.10",
6979
+ "unit": "kWh",
6980
+ "billing_period": "monthly",
6981
+ "type": "recurring",
6982
+ "billing_duration_amount": 24,
6983
+ "billing_duration_unit": "months",
6984
+ "notice_time_amount": 3,
6985
+ "notice_time_unit": "months",
6986
+ "termination_time_amount": 3,
6987
+ "termination_time_unit": "months",
6988
+ "renewal_duration_amount": 12,
6989
+ "renewal_duration_unit": "months",
6990
+ "active": true,
6991
+ "is_composite_price": false,
6992
+ "variable_price": true,
6993
+ "pricing_model": "per_unit",
6994
+ "price_display_in_journeys": "show_price"
6995
+ }
6996
+ }
6997
+ ]
7258
6998
  }
7259
- },
7260
- {
7261
- "name": "Base Price",
7262
- "type": "one_time",
7263
- "unit_amount_net_decimal": "99",
7264
- "unit_amount_gross_decimal": "99",
7265
- "amount_subtotal_decimal": "99",
7266
- "amount_total_decimal": "99",
7267
- "currency": "EUR"
7268
- }
7269
- ],
7270
- "fees": {
7271
- "amount_total_decimal": "410.84",
7272
- "amount_variable_decimal": "356.58",
7273
- "billing_period": "yearly",
7274
- "breakdown": {
7275
- "static": {
7276
- "basic_fee": {
7277
- "amount_decimal": "19.21"
7278
- },
7279
- "maintenance_fee": {
7280
- "amount_decimal": "35.05"
7281
- }
7282
- },
7283
- "variable": {
7284
- "offshore_liability_fee": {
7285
- "amount_decimal": "2.4",
7286
- "unit": "kWh"
7287
- },
7288
- "interruptible_load": {
7289
- "amount_decimal": "0"
7290
- },
7291
- "extra_charge": {
7292
- "amount_decimal": "22.68"
7293
- },
7294
- "chp": {
7295
- "amount_decimal": "26.7"
7296
- },
7297
- "power_kwh": {
7298
- "amount_decimal": "161.4"
7299
- },
7300
- "concession": {
7301
- "amount_decimal": "143.4"
7302
- }
6999
+ ],
7000
+ "currency": "EUR",
7001
+ "amount_subtotal": 10000,
7002
+ "amount_total": 10000,
7003
+ "amount_tax": 0,
7004
+ "total_details": {
7005
+ "amount_tax": 0,
7006
+ "breakdown": {
7007
+ "taxes": [],
7008
+ "recurrences": [
7009
+ {
7010
+ "type": "recurring",
7011
+ "billing_period": "monthly",
7012
+ "amount_subtotal": 10000,
7013
+ "amount_total": 10000,
7014
+ "amount_tax": 0
7015
+ }
7016
+ ]
7303
7017
  }
7304
7018
  }
7305
7019
  },
7306
- "total_details": {
7307
- "breakdown": {
7308
- "recurrences": [
7309
- {
7310
- "type": "recurring",
7311
- "billing_period": "monthly",
7312
- "amount_subtotal_decimal": "419.110616246297",
7313
- "amount_total_decimal": "498.741633333333"
7314
- },
7315
- {
7316
- "type": "one_time",
7317
- "amount_subtotal_decimal": "99",
7318
- "amount_total_decimal": "99"
7319
- }
7320
- ]
7321
- }
7020
+ "_meta": {
7021
+ "signature": "abc123",
7022
+ "timestamp": "2024-01-15T10:00:00Z"
7322
7023
  }
7323
7024
  }
7324
- }
7325
- ]
7025
+ ]
7026
+ }
7326
7027
  }
7327
7028
  }
7328
7029
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.35.14",
3
+ "version": "3.35.16",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",