@epilot/pricing-client 3.35.15 → 3.35.17

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.
@@ -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
@@ -1039,11 +1039,11 @@ declare namespace Components {
1039
1039
  /**
1040
1040
  * The cashback period, for now it's limited to either 0 months or 12 months
1041
1041
  */
1042
- cashback_period?: "0" | "12";
1042
+ cashback_period: "0" | "12";
1043
1043
  /**
1044
1044
  * The sum of all cashbacks for a specific cashback period
1045
1045
  */
1046
- amount_total?: number;
1046
+ amount_total: number;
1047
1047
  }
1048
1048
  /**
1049
1049
  * A catalog search payload
@@ -2140,69 +2140,12 @@ declare namespace Components {
2140
2140
  */
2141
2141
  cause?: string;
2142
2142
  }
2143
- export interface ExternalCompositePrice {
2144
- /**
2145
- * Fees structure with static and variable amounts
2146
- */
2147
- fees?: {
2148
- billing_period: BillingPeriod;
2149
- /**
2150
- * example:
2151
- * 1.00
2152
- */
2153
- amount_total_decimal: string;
2154
- /**
2155
- * example:
2156
- * 1.00
2157
- */
2158
- amount_static_decimal: string;
2159
- /**
2160
- * example:
2161
- * 1.00
2162
- */
2163
- amount_variable_decimal: string;
2164
- /**
2165
- * Breakdown of the fee values
2166
- */
2167
- breakdown: {
2168
- /**
2169
- * Static breakdown of fees
2170
- */
2171
- static?: {
2172
- [name: string]: {
2173
- /**
2174
- * The amount of the fee, as a string with all the decimal places.
2175
- * example:
2176
- * 1.00
2177
- */
2178
- amount_decimal?: string;
2179
- };
2180
- };
2181
- /**
2182
- * Variable breakdown of fees
2183
- */
2184
- variable?: {
2185
- [name: string]: {
2186
- /**
2187
- * example:
2188
- * 1.00
2189
- */
2190
- amount_decimal: string;
2191
- /**
2192
- * The unit of the fee (e.g. kWh) if applicable.
2193
- */
2194
- unit?: string;
2195
- };
2196
- };
2197
- };
2198
- };
2199
- /**
2200
- * The name of the composite price.
2201
- */
2202
- name?: string;
2203
- is_composite_price: true;
2204
- price_components: ExternalSimplePrice[];
2205
- total_details: /* Details of the total price including shipping and tax amounts. */ ExternalPriceTotalDetails;
2143
+ /**
2144
+ * An external product & price information (already computed) from an external catalog.
2145
+ */
2146
+ export interface ExternalCatalogItem {
2147
+ pricing_details: /* The result from the calculation of a set of price items. */ PricingDetails;
2148
+ _meta: /* Signature meta data payload */ SignatureMeta;
2206
2149
  }
2207
2150
  /**
2208
2151
  * example:
@@ -2294,346 +2237,6 @@ declare namespace Components {
2294
2237
  [name: string]: any;
2295
2238
  };
2296
2239
  }
2297
- export interface ExternalPriceFees {
2298
- /**
2299
- * Fees structure with static and variable amounts
2300
- */
2301
- fees?: {
2302
- /**
2303
- * The billing period of the fee values (e.g. monthly).
2304
- */
2305
- billing_period: BillingPeriod;
2306
- /**
2307
- * example:
2308
- * 1.00
2309
- */
2310
- amount_total_decimal: string;
2311
- /**
2312
- * example:
2313
- * 1.00
2314
- */
2315
- amount_static_decimal: string;
2316
- /**
2317
- * example:
2318
- * 1.00
2319
- */
2320
- amount_variable_decimal: string;
2321
- /**
2322
- * Breakdown of the fee values
2323
- */
2324
- breakdown: {
2325
- /**
2326
- * Static breakdown of fees
2327
- */
2328
- static?: {
2329
- [name: string]: {
2330
- /**
2331
- * The amount of the fee, as a string with all the decimal places.
2332
- * example:
2333
- * 1.00
2334
- */
2335
- amount_decimal?: string;
2336
- };
2337
- };
2338
- /**
2339
- * Variable breakdown of fees
2340
- */
2341
- variable?: {
2342
- [name: string]: {
2343
- /**
2344
- * example:
2345
- * 1.00
2346
- */
2347
- amount_decimal: string;
2348
- /**
2349
- * The unit of the fee (e.g. kWh) if applicable.
2350
- */
2351
- unit?: string;
2352
- };
2353
- };
2354
- };
2355
- };
2356
- }
2357
- /**
2358
- * Details of the total price including shipping and tax amounts.
2359
- */
2360
- export interface ExternalPriceTotalDetails {
2361
- /**
2362
- * A breakdown of the recurrences of amounts.
2363
- */
2364
- breakdown: {
2365
- recurrences?: {
2366
- /**
2367
- * Total of all items before discounts or taxes, as a string with all the decimal places.
2368
- * example:
2369
- * 1.00
2370
- */
2371
- amount_subtotal_decimal: string;
2372
- /**
2373
- * Total of all items after discounts and taxes, as a string with all the decimal places.
2374
- * example:
2375
- * 1.19
2376
- */
2377
- amount_total_decimal: string;
2378
- /**
2379
- * The price type.
2380
- * example:
2381
- * one_time
2382
- */
2383
- type: "one_time" | "recurring";
2384
- /**
2385
- * The billing period of the price.
2386
- */
2387
- billing_period?: BillingPeriod;
2388
- }[];
2389
- };
2390
- }
2391
- /**
2392
- * An external product & price information (already computed) from an external catalog.
2393
- */
2394
- export interface ExternalProduct {
2395
- /**
2396
- * The ID of the product in the external catalog.
2397
- */
2398
- id: string;
2399
- /**
2400
- * The name of the product.
2401
- */
2402
- name: string;
2403
- /**
2404
- * A description of the product.
2405
- */
2406
- description?: string;
2407
- /**
2408
- * A list of features of the product.
2409
- */
2410
- features?: string[];
2411
- /**
2412
- * A list of image URLs of the product. RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.
2413
- *
2414
- */
2415
- product_image_urls?: string[];
2416
- /**
2417
- * A list of file/attachment URLs of the product RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.
2418
- *
2419
- */
2420
- product_downloads_urls?: string[];
2421
- /**
2422
- * Legal footnotes for the product.
2423
- */
2424
- legal_footnotes?: string;
2425
- /**
2426
- * Additional notes for the product.
2427
- */
2428
- additional_notes?: string[];
2429
- /**
2430
- * Recommendation settings for the product.
2431
- * example:
2432
- * {
2433
- * "is_recommended": true,
2434
- * "recommended_label": "Best Value",
2435
- * "recommended_color": "#00FF00",
2436
- * "recommended_label_color": "#FFFFFF"
2437
- * }
2438
- */
2439
- recommendation_settings?: {
2440
- /**
2441
- * Flag to enable or disable the recommendation for this product.
2442
- */
2443
- is_recommended?: boolean;
2444
- /**
2445
- * Label to display when the product is recommended.
2446
- */
2447
- recommended_label?: string;
2448
- /**
2449
- * Color to display when the product is recommended.
2450
- */
2451
- recommended_color?: string;
2452
- /**
2453
- * Color of the recommended label.
2454
- */
2455
- recommended_label_color?: string;
2456
- };
2457
- price: ExternalSimplePrice | ExternalCompositePrice;
2458
- }
2459
- export interface ExternalSimplePrice {
2460
- /**
2461
- * Fees structure with static and variable amounts
2462
- */
2463
- fees?: {
2464
- billing_period: BillingPeriod;
2465
- /**
2466
- * example:
2467
- * 1.00
2468
- */
2469
- amount_total_decimal: string;
2470
- /**
2471
- * example:
2472
- * 1.00
2473
- */
2474
- amount_static_decimal: string;
2475
- /**
2476
- * example:
2477
- * 1.00
2478
- */
2479
- amount_variable_decimal: string;
2480
- /**
2481
- * Breakdown of the fee values
2482
- */
2483
- breakdown: {
2484
- /**
2485
- * Static breakdown of fees
2486
- */
2487
- static?: {
2488
- [name: string]: {
2489
- /**
2490
- * The amount of the fee, as a string with all the decimal places.
2491
- * example:
2492
- * 1.00
2493
- */
2494
- amount_decimal?: string;
2495
- };
2496
- };
2497
- /**
2498
- * Variable breakdown of fees
2499
- */
2500
- variable?: {
2501
- [name: string]: {
2502
- /**
2503
- * example:
2504
- * 1.00
2505
- */
2506
- amount_decimal: string;
2507
- /**
2508
- * The unit of the fee (e.g. kWh) if applicable.
2509
- */
2510
- unit?: string;
2511
- };
2512
- };
2513
- };
2514
- };
2515
- is_composite_price: false;
2516
- /**
2517
- * A flag to indicate if the price is variable.
2518
- *
2519
- */
2520
- variable_price?: boolean;
2521
- /**
2522
- * The name of the price.
2523
- */
2524
- name?: string;
2525
- /**
2526
- * The unit of measurement used for display purposes and possibly for calculations when the price is variable.
2527
- * example:
2528
- * kWh
2529
- */
2530
- unit?: string;
2531
- /**
2532
- * The currency of the price. ISO 4217 currency code. E.g. EUR.
2533
- * example:
2534
- * EUR
2535
- */
2536
- currency?: string;
2537
- /**
2538
- * The price type.
2539
- */
2540
- type: "one_time" | "recurring";
2541
- billing_period?: BillingPeriod;
2542
- /**
2543
- * The billing period duration
2544
- */
2545
- billing_duration_amount?: number;
2546
- /**
2547
- * The billing period duration unit
2548
- */
2549
- billing_duration_unit?: "weeks" | "months" | "years";
2550
- /**
2551
- * The notice period duration
2552
- */
2553
- notice_time_amount?: number;
2554
- /**
2555
- * The notice period duration unit
2556
- */
2557
- notice_time_unit?: "weeks" | "months" | "years";
2558
- /**
2559
- * The termination period duration
2560
- */
2561
- termination_time_amount?: number;
2562
- /**
2563
- * The termination period duration unit
2564
- */
2565
- termination_time_unit?: "weeks" | "months" | "years";
2566
- /**
2567
- * The renewal period duration
2568
- */
2569
- renewal_duration_amount?: number;
2570
- /**
2571
- * The renewal period duration unit
2572
- */
2573
- renewal_duration_unit?: "weeks" | "months" | "years";
2574
- /**
2575
- * The unit gross amount value, as a string with all the decimal places.
2576
- * example:
2577
- * 1.19
2578
- */
2579
- unit_amount_gross_decimal: string;
2580
- /**
2581
- * The unit net amount value, as a string with all the decimal places.
2582
- * example:
2583
- * 1.00
2584
- */
2585
- unit_amount_net_decimal: string;
2586
- /**
2587
- * Total of all items before discounts or taxes, as a string with all the decimal places.
2588
- * example:
2589
- * 1.00
2590
- */
2591
- amount_subtotal_decimal: string;
2592
- /**
2593
- * Total of all items after discounts and taxes, as a string with all the decimal places.
2594
- * example:
2595
- * 1.19
2596
- */
2597
- amount_total_decimal: string;
2598
- tax?: {
2599
- /**
2600
- * The tax name.
2601
- * example:
2602
- * VAT
2603
- */
2604
- name?: string;
2605
- /**
2606
- * The tax description.
2607
- * example:
2608
- * Value Added Tax
2609
- */
2610
- description?: string;
2611
- /**
2612
- * The type of the tax.
2613
- * example:
2614
- * VAT
2615
- */
2616
- type?: "VAT" | "GST" | "Custom";
2617
- /**
2618
- * The tax rate applied.
2619
- * example:
2620
- * 19
2621
- */
2622
- rate: number;
2623
- /**
2624
- * The region code of the tax.
2625
- * example:
2626
- * DE
2627
- */
2628
- region?: string;
2629
- /**
2630
- * The region label of the tax.
2631
- * example:
2632
- * Germany
2633
- */
2634
- region_label?: string;
2635
- };
2636
- }
2637
2240
  export interface File {
2638
2241
  [name: string]: any;
2639
2242
  _id: string;
@@ -4659,7 +4262,7 @@ declare namespace Components {
4659
4262
  * The number os results returned.
4660
4263
  */
4661
4264
  hits: number;
4662
- results: /* An external product & price information (already computed) from an external catalog. */ ExternalProduct[];
4265
+ results: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
4663
4266
  }
4664
4267
  /**
4665
4268
  * A search providers payload
@@ -5662,14 +5265,10 @@ export type EntityId = Components.Schemas.EntityId;
5662
5265
  export type EntityItem = Components.Schemas.EntityItem;
5663
5266
  export type EntityRelation = Components.Schemas.EntityRelation;
5664
5267
  export type Error = Components.Schemas.Error;
5665
- export type ExternalCompositePrice = Components.Schemas.ExternalCompositePrice;
5268
+ export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
5666
5269
  export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
5667
5270
  export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
5668
5271
  export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
5669
- export type ExternalPriceFees = Components.Schemas.ExternalPriceFees;
5670
- export type ExternalPriceTotalDetails = Components.Schemas.ExternalPriceTotalDetails;
5671
- export type ExternalProduct = Components.Schemas.ExternalProduct;
5672
- export type ExternalSimplePrice = Components.Schemas.ExternalSimplePrice;
5673
5272
  export type File = Components.Schemas.File;
5674
5273
  export type GasConcessionType = Components.Schemas.GasConcessionType;
5675
5274
  export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
package/dist/openapi.json CHANGED
@@ -4301,7 +4301,11 @@
4301
4301
  "type": "integer",
4302
4302
  "description": "The sum of all cashbacks for a specific cashback period"
4303
4303
  }
4304
- }
4304
+ },
4305
+ "required": [
4306
+ "cashback_period",
4307
+ "amount_total"
4308
+ ]
4305
4309
  },
4306
4310
  "RecurrenceAmountWithTax": {
4307
4311
  "type": "object",
@@ -5404,7 +5408,7 @@
5404
5408
  "results": {
5405
5409
  "type": "array",
5406
5410
  "items": {
5407
- "$ref": "#/components/schemas/ExternalProduct"
5411
+ "$ref": "#/components/schemas/ExternalCatalogItem"
5408
5412
  }
5409
5413
  }
5410
5414
  },
@@ -5413,435 +5417,20 @@
5413
5417
  "hits"
5414
5418
  ]
5415
5419
  },
5416
- "ExternalProduct": {
5420
+ "ExternalCatalogItem": {
5417
5421
  "type": "object",
5418
5422
  "description": "An external product & price information (already computed) from an external catalog.",
5419
5423
  "properties": {
5420
- "id": {
5421
- "type": "string",
5422
- "description": "The ID of the product in the external catalog."
5423
- },
5424
- "name": {
5425
- "type": "string",
5426
- "description": "The name of the product."
5427
- },
5428
- "description": {
5429
- "type": "string",
5430
- "description": "A description of the product."
5431
- },
5432
- "features": {
5433
- "type": "array",
5434
- "description": "A list of features of the product.",
5435
- "items": {
5436
- "type": "string"
5437
- }
5438
- },
5439
- "product_image_urls": {
5440
- "type": "array",
5441
- "items": {
5442
- "type": "string"
5443
- },
5444
- "description": "A list of image URLs of the product. RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.\n"
5445
- },
5446
- "product_downloads_urls": {
5447
- "type": "array",
5448
- "items": {
5449
- "type": "string"
5450
- },
5451
- "description": "A list of file/attachment URLs of the product RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.\n"
5452
- },
5453
- "legal_footnotes": {
5454
- "type": "string",
5455
- "description": "Legal footnotes for the product."
5456
- },
5457
- "additional_notes": {
5458
- "type": "array",
5459
- "description": "Additional notes for the product.",
5460
- "items": {
5461
- "type": "string"
5462
- }
5463
- },
5464
- "recommendation_settings": {
5465
- "type": "object",
5466
- "description": "Recommendation settings for the product.",
5467
- "properties": {
5468
- "is_recommended": {
5469
- "type": "boolean",
5470
- "description": "Flag to enable or disable the recommendation for this product."
5471
- },
5472
- "recommended_label": {
5473
- "type": "string",
5474
- "description": "Label to display when the product is recommended."
5475
- },
5476
- "recommended_color": {
5477
- "type": "string",
5478
- "description": "Color to display when the product is recommended."
5479
- },
5480
- "recommended_label_color": {
5481
- "type": "string",
5482
- "description": "Color of the recommended label."
5483
- }
5484
- },
5485
- "example": {
5486
- "is_recommended": true,
5487
- "recommended_label": "Best Value",
5488
- "recommended_color": "#00FF00",
5489
- "recommended_label_color": "#FFFFFF"
5490
- }
5491
- },
5492
- "price": {
5493
- "oneOf": [
5494
- {
5495
- "$ref": "#/components/schemas/ExternalSimplePrice"
5496
- },
5497
- {
5498
- "$ref": "#/components/schemas/ExternalCompositePrice"
5499
- }
5500
- ]
5501
- }
5502
- },
5503
- "required": [
5504
- "price",
5505
- "name",
5506
- "id"
5507
- ]
5508
- },
5509
- "ExternalPriceFees": {
5510
- "type": "object",
5511
- "properties": {
5512
- "fees": {
5513
- "type": "object",
5514
- "description": "Fees structure with static and variable amounts",
5515
- "properties": {
5516
- "billing_period": {
5517
- "$ref": "#/components/schemas/BillingPeriod",
5518
- "description": "The billing period of the fee values (e.g. monthly)."
5519
- },
5520
- "amount_total_decimal": {
5521
- "type": "string",
5522
- "example": "1.00"
5523
- },
5524
- "amount_static_decimal": {
5525
- "type": "string",
5526
- "example": "1.00"
5527
- },
5528
- "amount_variable_decimal": {
5529
- "type": "string",
5530
- "example": "1.00"
5531
- },
5532
- "breakdown": {
5533
- "type": "object",
5534
- "description": "Breakdown of the fee values",
5535
- "properties": {
5536
- "static": {
5537
- "type": "object",
5538
- "description": "Static breakdown of fees",
5539
- "additionalProperties": {
5540
- "type": "object",
5541
- "properties": {
5542
- "amount_decimal": {
5543
- "type": "string",
5544
- "description": "The amount of the fee, as a string with all the decimal places.",
5545
- "example": "1.00"
5546
- }
5547
- }
5548
- },
5549
- "required": [
5550
- "amount_decimal"
5551
- ]
5552
- },
5553
- "variable": {
5554
- "type": "object",
5555
- "description": "Variable breakdown of fees",
5556
- "additionalProperties": {
5557
- "type": "object",
5558
- "properties": {
5559
- "amount_decimal": {
5560
- "type": "string",
5561
- "example": "1.00"
5562
- },
5563
- "unit": {
5564
- "type": "string",
5565
- "description": "The unit of the fee (e.g. kWh) if applicable."
5566
- }
5567
- },
5568
- "required": [
5569
- "amount_decimal"
5570
- ]
5571
- }
5572
- }
5573
- }
5574
- }
5575
- },
5576
- "required": [
5577
- "billing_period",
5578
- "amount_total_decimal",
5579
- "amount_static_decimal",
5580
- "amount_variable_decimal",
5581
- "breakdown"
5582
- ]
5583
- }
5584
- }
5585
- },
5586
- "ExternalSimplePrice": {
5587
- "allOf": [
5588
- {
5589
- "$ref": "#/components/schemas/ExternalPriceFees"
5590
- },
5591
- {
5592
- "type": "object",
5593
- "properties": {
5594
- "is_composite_price": {
5595
- "type": "boolean",
5596
- "enum": [
5597
- false
5598
- ]
5599
- },
5600
- "variable_price": {
5601
- "type": "boolean",
5602
- "description": "A flag to indicate if the price is variable.\n"
5603
- },
5604
- "name": {
5605
- "type": "string",
5606
- "description": "The name of the price."
5607
- },
5608
- "unit": {
5609
- "description": "The unit of measurement used for display purposes and possibly for calculations when the price is variable.",
5610
- "type": "string",
5611
- "example": "kWh"
5612
- },
5613
- "currency": {
5614
- "type": "string",
5615
- "description": "The currency of the price. ISO 4217 currency code. E.g. EUR.",
5616
- "default": "EUR",
5617
- "example": "EUR"
5618
- },
5619
- "type": {
5620
- "type": "string",
5621
- "description": "The price type.",
5622
- "enum": [
5623
- "one_time",
5624
- "recurring"
5625
- ]
5626
- },
5627
- "billing_period": {
5628
- "$ref": "#/components/schemas/BillingPeriod",
5629
- "description": "The billing period of the price."
5630
- },
5631
- "billing_duration_amount": {
5632
- "description": "The billing period duration",
5633
- "type": "number"
5634
- },
5635
- "billing_duration_unit": {
5636
- "description": "The billing period duration unit",
5637
- "type": "string",
5638
- "enum": [
5639
- "weeks",
5640
- "months",
5641
- "years"
5642
- ]
5643
- },
5644
- "notice_time_amount": {
5645
- "description": "The notice period duration",
5646
- "type": "number"
5647
- },
5648
- "notice_time_unit": {
5649
- "description": "The notice period duration unit",
5650
- "type": "string",
5651
- "enum": [
5652
- "weeks",
5653
- "months",
5654
- "years"
5655
- ]
5656
- },
5657
- "termination_time_amount": {
5658
- "description": "The termination period duration",
5659
- "type": "number"
5660
- },
5661
- "termination_time_unit": {
5662
- "description": "The termination period duration unit",
5663
- "type": "string",
5664
- "enum": [
5665
- "weeks",
5666
- "months",
5667
- "years"
5668
- ]
5669
- },
5670
- "renewal_duration_amount": {
5671
- "description": "The renewal period duration",
5672
- "type": "number"
5673
- },
5674
- "renewal_duration_unit": {
5675
- "description": "The renewal period duration unit",
5676
- "type": "string",
5677
- "enum": [
5678
- "weeks",
5679
- "months",
5680
- "years"
5681
- ]
5682
- },
5683
- "unit_amount_gross_decimal": {
5684
- "type": "string",
5685
- "example": "1.19",
5686
- "description": "The unit gross amount value, as a string with all the decimal places."
5687
- },
5688
- "unit_amount_net_decimal": {
5689
- "type": "string",
5690
- "description": "The unit net amount value, as a string with all the decimal places.",
5691
- "example": "1.00"
5692
- },
5693
- "amount_subtotal_decimal": {
5694
- "type": "string",
5695
- "description": "Total of all items before discounts or taxes, as a string with all the decimal places.",
5696
- "example": "1.00"
5697
- },
5698
- "amount_total_decimal": {
5699
- "type": "string",
5700
- "description": "Total of all items after discounts and taxes, as a string with all the decimal places.",
5701
- "example": "1.19"
5702
- },
5703
- "tax": {
5704
- "type": "object",
5705
- "properties": {
5706
- "name": {
5707
- "type": "string",
5708
- "description": "The tax name.",
5709
- "example": "VAT"
5710
- },
5711
- "description": {
5712
- "type": "string",
5713
- "description": "The tax description.",
5714
- "example": "Value Added Tax"
5715
- },
5716
- "type": {
5717
- "type": "string",
5718
- "enum": [
5719
- "VAT",
5720
- "GST",
5721
- "Custom"
5722
- ],
5723
- "description": "The type of the tax.",
5724
- "example": "VAT"
5725
- },
5726
- "rate": {
5727
- "type": "number",
5728
- "description": "The tax rate applied.",
5729
- "example": 19
5730
- },
5731
- "region": {
5732
- "type": "string",
5733
- "description": "The region code of the tax.",
5734
- "example": "DE"
5735
- },
5736
- "region_label": {
5737
- "type": "string",
5738
- "description": "The region label of the tax.",
5739
- "example": "Germany"
5740
- }
5741
- },
5742
- "required": [
5743
- "rate"
5744
- ]
5745
- }
5746
- },
5747
- "required": [
5748
- "is_composite_price",
5749
- "type",
5750
- "unit_amount_decimal",
5751
- "unit_amount_gross_decimal",
5752
- "unit_amount_net_decimal",
5753
- "amount_subtotal_decimal",
5754
- "amount_total_decimal"
5755
- ]
5756
- }
5757
- ]
5758
- },
5759
- "ExternalCompositePrice": {
5760
- "allOf": [
5761
- {
5762
- "$ref": "#/components/schemas/ExternalPriceFees"
5424
+ "pricing_details": {
5425
+ "$ref": "#/components/schemas/PricingDetails"
5763
5426
  },
5764
- {
5765
- "type": "object",
5766
- "properties": {
5767
- "name": {
5768
- "type": "string",
5769
- "description": "The name of the composite price."
5770
- },
5771
- "is_composite_price": {
5772
- "type": "boolean",
5773
- "enum": [
5774
- true
5775
- ]
5776
- },
5777
- "price_components": {
5778
- "type": "array",
5779
- "items": {
5780
- "$ref": "#/components/schemas/ExternalSimplePrice"
5781
- }
5782
- },
5783
- "total_details": {
5784
- "$ref": "#/components/schemas/ExternalPriceTotalDetails"
5785
- }
5786
- },
5787
- "required": [
5788
- "is_composite_price",
5789
- "price_components",
5790
- "total_details"
5791
- ]
5792
- }
5793
- ]
5794
- },
5795
- "ExternalPriceTotalDetails": {
5796
- "type": "object",
5797
- "description": "Details of the total price including shipping and tax amounts.",
5798
- "properties": {
5799
- "breakdown": {
5800
- "type": "object",
5801
- "description": "A breakdown of the recurrences of amounts.",
5802
- "properties": {
5803
- "recurrences": {
5804
- "type": "array",
5805
- "items": {
5806
- "type": "object",
5807
- "description": "Recurrence details including subtotal, total, and tax amounts.",
5808
- "properties": {
5809
- "amount_subtotal_decimal": {
5810
- "type": "string",
5811
- "description": "Total of all items before discounts or taxes, as a string with all the decimal places.",
5812
- "example": "1.00"
5813
- },
5814
- "amount_total_decimal": {
5815
- "type": "string",
5816
- "description": "Total of all items after discounts and taxes, as a string with all the decimal places.",
5817
- "example": "1.19"
5818
- },
5819
- "type": {
5820
- "type": "string",
5821
- "enum": [
5822
- "one_time",
5823
- "recurring"
5824
- ],
5825
- "description": "The price type.",
5826
- "example": "one_time"
5827
- },
5828
- "billing_period": {
5829
- "$ref": "#/components/schemas/BillingPeriod",
5830
- "description": "The billing period of the price."
5831
- }
5832
- },
5833
- "required": [
5834
- "amount_subtotal_decimal",
5835
- "amount_total_decimal",
5836
- "type"
5837
- ]
5838
- }
5839
- }
5840
- }
5427
+ "_meta": {
5428
+ "$ref": "#/components/schemas/SignatureMeta"
5841
5429
  }
5842
5430
  },
5843
5431
  "required": [
5844
- "breakdown"
5432
+ "pricing_details",
5433
+ "_meta"
5845
5434
  ]
5846
5435
  }
5847
5436
  },
@@ -6954,7 +6543,7 @@
6954
6543
  "_schema": "tax",
6955
6544
  "_title": "Tax Without Behaviour",
6956
6545
  "description": "Without Behaviour",
6957
- "rate": 6,
6546
+ "rate": "6",
6958
6547
  "_org": "739224",
6959
6548
  "_created_at": "2022-02-07T14:49:08.831Z",
6960
6549
  "_updated_at": "2022-02-07T14:49:08.831Z"
@@ -7353,108 +6942,92 @@
7353
6942
  }
7354
6943
  },
7355
6944
  "external-catalog-sample-1": {
7356
- "value": [
7357
- {
7358
- "id": "12312414",
7359
- "name": "Home Energy Package",
7360
- "description": "Composite home energy solution with solar panels and battery",
7361
- "features": [
7362
- "4kW solar system",
7363
- "10kWh battery storage",
7364
- "Smart energy management"
7365
- ],
7366
- "product_image_urls": [
7367
- "https://example.com/images/home-energy-package.jpg"
7368
- ],
7369
- "legal_footnotes": "Installation and permitting fees may vary by location.",
7370
- "price": {
7371
- "name": "Home Energy Package",
7372
- "is_composite_price": true,
7373
- "price_components": [
7374
- {
7375
- "name": "Working Price",
7376
- "type": "recurring",
7377
- "billing_period": "monthly",
7378
- "variable_price": true,
7379
- "unit": "kWh",
7380
- "amount_subtotal_decimal": "11.244355742297",
7381
- "amount_total_decimal": "13.380783333333",
7382
- "unit_amount_net_decimal": "11.24",
7383
- "unit_amount_gross_decimal": "13.38",
7384
- "currency": "EUR",
7385
- "tax": {
7386
- "name": "tax",
7387
- "type": "VAT",
7388
- "rate": 19,
7389
- "region": "DE"
6945
+ "value": {
6946
+ "hits": 1,
6947
+ "results": [
6948
+ {
6949
+ "pricing_details": {
6950
+ "items": [
6951
+ {
6952
+ "_id": "price-12312414",
6953
+ "price_id": "price-12312414",
6954
+ "is_composite_price": true,
6955
+ "description": "Home Energy Package Composite",
6956
+ "item_components": [
6957
+ {
6958
+ "_id": "price-12312414-component-0",
6959
+ "price_id": "price-12312414-component-0",
6960
+ "description": "Working Price",
6961
+ "is_tax_inclusive": true,
6962
+ "amount_total_decimal": "100",
6963
+ "amount_total": 10000,
6964
+ "amount_subtotal_decimal": "100",
6965
+ "amount_subtotal": 10000,
6966
+ "unit_amount": 10,
6967
+ "unit_amount_gross": 10,
6968
+ "unit_amount_gross_decimal": "0.10",
6969
+ "unit_amount_net": 10,
6970
+ "unit_amount_net_decimal": "0.10",
6971
+ "billing_period": "monthly",
6972
+ "type": "recurring",
6973
+ "taxes": [],
6974
+ "pricing_model": "per_unit",
6975
+ "quantity": 1,
6976
+ "_price": {
6977
+ "_id": "price-12312414-component-0",
6978
+ "unit_amount_currency": "EUR",
6979
+ "description": "Working Price",
6980
+ "is_tax_inclusive": true,
6981
+ "unit_amount": 10,
6982
+ "unit_amount_decimal": "0.10",
6983
+ "unit": "kWh",
6984
+ "billing_period": "monthly",
6985
+ "type": "recurring",
6986
+ "billing_duration_amount": 24,
6987
+ "billing_duration_unit": "months",
6988
+ "notice_time_amount": 3,
6989
+ "notice_time_unit": "months",
6990
+ "termination_time_amount": 3,
6991
+ "termination_time_unit": "months",
6992
+ "renewal_duration_amount": 12,
6993
+ "renewal_duration_unit": "months",
6994
+ "active": true,
6995
+ "is_composite_price": false,
6996
+ "variable_price": true,
6997
+ "pricing_model": "per_unit",
6998
+ "price_display_in_journeys": "show_price"
6999
+ }
7000
+ }
7001
+ ]
7390
7002
  }
7391
- },
7392
- {
7393
- "name": "Base Price",
7394
- "type": "one_time",
7395
- "unit_amount_net_decimal": "99",
7396
- "unit_amount_gross_decimal": "99",
7397
- "amount_subtotal_decimal": "99",
7398
- "amount_total_decimal": "99",
7399
- "currency": "EUR"
7400
- }
7401
- ],
7402
- "fees": {
7403
- "amount_total_decimal": "410.84",
7404
- "amount_variable_decimal": "356.58",
7405
- "billing_period": "yearly",
7406
- "breakdown": {
7407
- "static": {
7408
- "basic_fee": {
7409
- "amount_decimal": "19.21"
7410
- },
7411
- "maintenance_fee": {
7412
- "amount_decimal": "35.05"
7413
- }
7414
- },
7415
- "variable": {
7416
- "offshore_liability_fee": {
7417
- "amount_decimal": "2.4",
7418
- "unit": "kWh"
7419
- },
7420
- "interruptible_load": {
7421
- "amount_decimal": "0"
7422
- },
7423
- "extra_charge": {
7424
- "amount_decimal": "22.68"
7425
- },
7426
- "chp": {
7427
- "amount_decimal": "26.7"
7428
- },
7429
- "power_kwh": {
7430
- "amount_decimal": "161.4"
7431
- },
7432
- "concession": {
7433
- "amount_decimal": "143.4"
7434
- }
7003
+ ],
7004
+ "currency": "EUR",
7005
+ "amount_subtotal": 10000,
7006
+ "amount_total": 10000,
7007
+ "amount_tax": 0,
7008
+ "total_details": {
7009
+ "amount_tax": 0,
7010
+ "breakdown": {
7011
+ "taxes": [],
7012
+ "recurrences": [
7013
+ {
7014
+ "type": "recurring",
7015
+ "billing_period": "monthly",
7016
+ "amount_subtotal": 10000,
7017
+ "amount_total": 10000,
7018
+ "amount_tax": 0
7019
+ }
7020
+ ]
7435
7021
  }
7436
7022
  }
7437
7023
  },
7438
- "total_details": {
7439
- "breakdown": {
7440
- "recurrences": [
7441
- {
7442
- "type": "recurring",
7443
- "billing_period": "monthly",
7444
- "amount_subtotal_decimal": "419.110616246297",
7445
- "amount_total_decimal": "498.741633333333"
7446
- },
7447
- {
7448
- "type": "one_time",
7449
- "amount_subtotal_decimal": "99",
7450
- "amount_total_decimal": "99"
7451
- }
7452
- ]
7453
- }
7024
+ "_meta": {
7025
+ "signature": "abc123",
7026
+ "timestamp": "2024-01-15T10:00:00Z"
7454
7027
  }
7455
7028
  }
7456
- }
7457
- ]
7029
+ ]
7030
+ }
7458
7031
  }
7459
7032
  }
7460
7033
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.35.15",
3
+ "version": "3.35.17",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",